A Ruby wrapper for the Urban Airship API.
The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:
.. image:: https://travis-ci.org/urbanairship/ruby-library.svg?branch=master :target: https://travis-ci.org/urbanairship/ruby-library
urbanairshipis a Ruby library for using the
Airship_ REST API for push notifications, message center messages, email, and SMS.
We officially support the following Ruby versions::
Newer versions should work as well.
Version 5.0 is a major upgrade, as some features have been removed that were present in earlier versions. A more detailed list of changes can be found in the CHANGELOG.
The best place to ask questions or report a problem is our support site: http://support.airship.com/
If you have the
bundlergem (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
In your app initialization, you can do something like the following:
>>> require 'urbanairship' >>> Urbanairship.configure do |config| >>> config.log_path = '/path/to/your/logfile' >>> config.log_level = Logger::WARN >>> config.timeout = 60 >>> end
If you want to use a custom logger (e.g Rails.logger), you can do:
>>> require 'urbanairship' >>> Urbanairship.configure do |config| >>> config.custom_logger = Rails.logger >>> config.log_level = Logger::WARN >>> config.timeout = 60 >>> end
Once the gem has been installed you can start sending pushes! See the
api examples, as well as the
Airship API Documentation_ for more information.
>>> 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.all >>> p.send_push
>>> require 'urbanairship' >>> UA = Urbanairship >>> airship = UA::Client.new(key:'application_key', secret:'master_secret') >>> p = airship.create_push >>> p.audience = UA.tag('some_tag') >>> p.notification = UA.notification(alert: 'Hello') >>> p.device_types = UA.all >>> p.send_push
git checkout -b my-new-feature
git commit -am 'Add some feature'
git push origin my-new-feature
Note: Changes will not be approved and merged without a signed contribution agreement.
After checking out the repo, ensure you have
$ gem install bundler) run::
>>> $ bin/setup
to install dependencies. Then, run::
>>> $ bin/console
for an interactive prompt that will allow you to experiment.
OR you can build a local gem to play with::
>>> $ gem build urbanairship.gemspec >>> $ gem install ./urbanairship-.gem
Having a local build will give you better logging if you are running into issues, but be careful to make sure to use our released public gem in Production.