Dirigible

A Ruby wrapper for the Urban Airship v3 API

Documentation

You can view detailed documentation of this library at http://rdoc.info/github/anthonator/dirigible/master/frames. We try to make sure that our documentation is up-to-date and thorough. However, we do recommend keeping the Urban Airship v3 API documentation handy.

If you find any discrepency in our documentation please file an issue.

Installation

Add this line to your application's Gemfile:

gem 'dirigible'

And then execute:

$ bundle

Or install it yourself as:

$ gem install dirigible

tl;dr

Configure dirigible...

Dirigible.configure do |config|
  config.app_key = YOUR_APP_KEY
  config.master_secret = YOUR_MASTER_SECRET
end

Make an API request...

begin
  response = Dirigible::Push.create({
    audience: { device_token: "998BAD77A8347EFE7920F5367A4811C4385D526AE42C598A629A73B94EEDBAC8" },
    notification: { alert: "Hello!" },
    device_types: "all"
  })
  puts "YAY!" if response[:ok] == true # All JSON responses are converted to hash's
rescue Dirigible::Error => e
  puts "BUSTED!!! #{e.message}"
end

Configuration

In order to make any requests you must first configure your app key and master secret...

Dirigible.configure do |config|
  config.app_key = YOUR_APP_KEY
  config.master_secret = YOUR_MASTER_SECRET
end

Change the HTTP library used for making requests to Urban Airship. Since we use Faraday you can use any supported adapter...

Dirigible.configure do |config|

  ...
  
  config.http_adapter = :excon
end

Supported Endpoints

Push

Schedule

Feed

Device Information

Device Registration

Segment

Location

Contributing

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request

Credits

Dirigible is maintained and funded by Sticksnleaves

Thanks to all of our contributors

anthonator/dirigible