Airship Ruby Library ========================== ``urbanairship`` is a Ruby library for using the `Airship `_ web service API for push notifications and rich app pages. Installation ------------ If you have the ``bundler`` gem (if not you can get it with ``$ gem install bundler``) add this line to your application's Gemfile:: >>> gem 'urbanairship' And then execute:: >>> $ bundle OR install it yourself as:: >>> gem install urbanairship Using the library ----------------- The library is intended to be used with the small footprint of a single import. To get started, import the package, and create an :rb:class:`Airship` object representing a single Airship project. Note that channels are preferred over ``device_token`` and ``apid``. See: `documentation on channels `_. .. code-block:: ruby require 'urbanairship' UA = Urbanairship airship = UA::Client.new(key:'application_key', secret:'master_secret') p = airship.create_push p.audience = UA.all p.notification = UA.notification(alert: 'Hello') p.device_types = UA.device_types(['ios','android']) p.send_push The library uses `unirest`_ for communication with the UA API. Development ----------- The library source code is `available on GitHub `_. Tests can be run with rspec_: Contents: .. toctree:: :maxdepth: 2 push.rst segment.rst devices.rst channel_uninstall.rst tags.rst named_user.rst reports.rst static_lists.rst tag_lists.rst exceptions.rst examples.rst create_and_send.rst email.rst open_channels.rst sms.rst automations.rst ab_tests.rst attributes.rst Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` .. _channels: http://docs.airship.com/topic-guides/channels.html .. _unirest: http://unirest.io/ruby.html .. _github: https://github.com/urbanairship/ruby-library .. _rspec: https://nose.readthedocs.org/en/latest/