{"id":16381010,"url":"https://github.com/anthonator/dirigible","last_synced_at":"2025-03-21T01:32:36.995Z","repository":{"id":10334089,"uuid":"12466216","full_name":"anthonator/dirigible","owner":"anthonator","description":"Ruby wrapper for the Urban Airship v3 API","archived":false,"fork":false,"pushed_at":"2015-06-04T19:11:27.000Z","size":468,"stargazers_count":11,"open_issues_count":3,"forks_count":10,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-04-24T00:44:12.349Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/anthonator.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-08-29T17:11:04.000Z","updated_at":"2023-03-17T12:03:04.000Z","dependencies_parsed_at":"2022-08-31T07:20:22.642Z","dependency_job_id":null,"html_url":"https://github.com/anthonator/dirigible","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anthonator%2Fdirigible","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anthonator%2Fdirigible/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anthonator%2Fdirigible/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anthonator%2Fdirigible/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/anthonator","download_url":"https://codeload.github.com/anthonator/dirigible/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244721577,"owners_count":20498978,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-11T03:53:08.177Z","updated_at":"2025-03-21T01:32:36.747Z","avatar_url":"https://github.com/anthonator.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Dirigible\n\nA Ruby wrapper for the Urban Airship v3 API\n\n[![Dependency Status](https://gemnasium.com/anthonator/dirigible.png)](https://gemnasium.com/anthonator/dirigible) [![Code Climate](https://codeclimate.com/github/anthonator/dirigible.png)](https://codeclimate.com/github/anthonator/dirigible)\n\n## Documentation\n\nYou 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.\n\nIf you find any discrepency in our documentation please [file an issue](https://github.com/anthonator/dirigible/issues).\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n    gem 'dirigible'\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install dirigible\n\n## tl;dr\n\nConfigure dirigible...\n\n```ruby\nDirigible.configure do |config|\n  config.app_key = YOUR_APP_KEY\n  config.master_secret = YOUR_MASTER_SECRET\nend\n```\n\nMake an API request...\n\n```ruby\nbegin\n  response = Dirigible::Push.create({\n    audience: { device_token: \"998BAD77A8347EFE7920F5367A4811C4385D526AE42C598A629A73B94EEDBAC8\" },\n    notification: { alert: \"Hello!\" },\n    device_types: \"all\"\n  })\n  puts \"YAY!\" if response[:ok] == true # All JSON responses are converted to hash's\nrescue Dirigible::Error =\u003e e\n  puts \"BUSTED!!! #{e.message}\"\nend\n```\n\n## Configuration\n\nIn order to make any requests you must first configure your app key and master secret...\n\n```ruby\nDirigible.configure do |config|\n  config.app_key = YOUR_APP_KEY\n  config.master_secret = YOUR_MASTER_SECRET\nend\n```\n\nChange the HTTP library used for making requests to Urban Airship. Since we use [Faraday](https://github.com/lostisland/faraday) you can use any supported adapter...\n\n```ruby\nDirigible.configure do |config|\n\n  ...\n  \n  config.http_adapter = :excon\nend\n```\n\n## Supported Endpoints\n\n### Push\n\n* [Send a push notification](http://rdoc.info/github/anthonator/dirigible/master/Dirigible/Push.create)\n* [Validate a push notification](http://rdoc.info/github/anthonator/dirigible/master/Dirigible/Push.validate)\n\n### Schedule\n\n* [Schedule a notification](http://rdoc.info/github/anthonator/dirigible/master/Dirigible/Schedule.create)\n* [List schedules](http://rdoc.info/github/anthonator/dirigible/master/Dirigible/Schedule.list)\n* [List a specific schedule](http://rdoc.info/github/anthonator/dirigible/master/Dirigible/Schedule.get)\n* [Update a schedule](http://rdoc.info/github/anthonator/dirigible/master/Dirigible/Schedule.update)\n* [Delete a schedule](http://rdoc.info/github/anthonator/dirigible/master/Dirigible/Schedule.delete)\n\n### Tag\n\n* [List tags](http://rdoc.info/github/anthonator/dirigible/master/Dirigible/Tag.list)\n* [Create a tag](http://rdoc.info/github/anthonator/dirigible/master/Dirigible/Tag.create)\n* [Adding and removing devices from a tag](http://rdoc.info/github/anthonator/dirigible/master/Dirigible/Tag.add_or_remove)\n* [Delete a tag](http://rdoc.info/github/anthonator/dirigible/master/Dirigible/Tag.delete)\n* [Batch modification of tags](http://rdoc.info/github/anthonator/dirigible/master/Dirigible/Tag.batch)\n\n### Feed\n\n* [Create a feed](http://rdoc.info/github/anthonator/dirigible/master/Dirigible/Feed.create)\n* [Get feed details](http://rdoc.info/github/anthonator/dirigible/master/Dirigible/Feed.get)\n* [Update a feed](http://rdoc.info/github/anthonator/dirigible/master/Dirigible/Feed.update)\n* [Delete a feed](http://rdoc.info/github/anthonator/dirigible/master/Dirigible/Feed.delete)\n\n### Device Information\n\n* [Get Android APID device information](http://rdoc.info/github/anthonator/dirigible/master/Dirigible/DeviceInformation.get_apid)\n* [Get Backberry PIN device information](http://rdoc.info/github/anthonator/dirigible/master/Dirigible/DeviceInformation.get_device_pin)\n* [Get iOS device token information](http://rdoc.info/github/anthonator/dirigible/master/Dirigible/DeviceInformation.get_device_token)\n* [List Android APID's registered to an application](http://rdoc.info/github/anthonator/dirigible/master/Dirigible/DeviceInformation.list_apids)\n* [List Blackberry PIN's registered to an application](http://rdoc.info/github/anthonator/dirigible/master/Dirigible/DeviceInformation.list_device_pins)\n* [Count iOS device tokens registered to an application](http://rdoc.info/github/anthonator/dirigible/master/Dirigible/DeviceInformation.count_device_tokens)\n* [List iOS device tokens registered to an application](http://rdoc.info/github/anthonator/dirigible/master/Dirigible/DeviceInformation.list_device_tokens)\n* [List iOS device tokens that can't recieve messages](http://rdoc.info/github/anthonator/dirigible/master/Dirigible/DeviceInformation.device_token_feedback)\n\n### Device Registration\n\n* [Register an Android APID](http://rdoc.info/github/anthonator/dirigible/master/Dirigible/DeviceRegistration.register_apid)\n* [Register a Blackberry PIN device](http://rdoc.info/github/anthonator/dirigible/master/Dirigible/DeviceRegistration.register_device_pin)\n* [Register an iOS device token](http://rdoc.info/github/anthonator/dirigible/master/Dirigible/DeviceRegistration.register_device_token)\n* [Delete a Blackberry PIN device](http://rdoc.info/github/anthonator/dirigible/master/Dirigible/DeviceRegistration.delete_device_pin)\n* [Delete an iOS device token](http://rdoc.info/github/anthonator/dirigible/master/Dirigible/DeviceRegistration.delete_device_token)\n\n### Segment\n\n* [List all segments for an application](http://rdoc.info/github/anthonator/dirigible/master/Dirigible/Segment.list)\n* [Create a segment](http://rdoc.info/github/anthonator/dirigible/master/Dirigible/Segment.create)\n* [Get a specific segment](http://rdoc.info/github/anthonator/dirigible/master/Dirigible/Segment.get)\n* [Update a segment](http://rdoc.info/github/anthonator/dirigible/master/Dirigible/Segment.update)\n* [Delete a segment](http://rdoc.info/github/anthonator/dirigible/master/Dirigible/Segment.delete)\n\n### Location\n\n* [Retrieve cutoff dates](http://rdoc.info/github/anthonator/dirigible/master/Dirigible/Location.cutoff_dates)\n* [Look up location boundary information](http://rdoc.info/github/anthonator/dirigible/master/Dirigible/Location.from_alias)\n* [Search for locations using a bounding box](http://rdoc.info/github/anthonator/dirigible/master/Dirigible/Location.search_by_bounding_box)\n* [Search for a location by latitude and longitude](http://rdoc.info/github/anthonator/dirigible/master/Dirigible/Location.search_by_latlng)\n* [Search for a location boundary by name](http://rdoc.info/github/anthonator/dirigible/master/Dirigible/Location.search_by_name)\n\n## Contributing\n\n1. Fork it\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create new Pull Request\n\n## Credits\n[![Sticksnleaves](http://sticksnleaves-wordpress.herokuapp.com/wp-content/themes/sticksnleaves/images/snl-logo-116x116.png)](http://www.sticksnleaves.com)\n\nDirigible is maintained and funded by [Sticksnleaves](http://www.sticksnleaves.com)\n\nThanks to all of our [contributors](https://github.com/anthonator/dirigible/graphs/contributors)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanthonator%2Fdirigible","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fanthonator%2Fdirigible","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanthonator%2Fdirigible/lists"}