dirigible 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 04e5bfef8a995e173c23c747ff7a0345a3b4e28a
+  data.tar.gz: a2f95a51950025b8141beaf4d635dc596a63d3c7
+SHA512:
+  metadata.gz: c3172ce4ddc17ccf705d7d41d256a8a6b4d9abaa89d1f4b5a0bfa44ee61dcc8cee011eff1532baa1b17e1e0d429ef0534b93c8e3fdb41ba016db49651f813d62
+  data.tar.gz: c557c64fcfffbe5a2f494047c4241739bede5a73c4448e08abb9fb4c7250b6c34df317608373339e536cb82121beda722c9a7d19b5bc73273aa1cfe7584b7762

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rbenv*

data/Gemfile

@@ -0,0 +1,20 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dirigible.gemspec
+gemspec
+
+platforms :rbx do
+  gem 'json'
+end
+
+group :development do
+  gem 'bundler'
+  gem 'coveralls', require: false
+  gem 'rake'
+  gem 'yard'
+end
+
+group :test do
+  gem 'rspec'
+  gem 'simplecov'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Anthony Smith
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+# 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](https://github.com/anthonator/dirigible/issues).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dirigible'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dirigible
+
+## Getting Started
+
+Configure dirigible...
+
+```ruby
+Dirigible.configure do |config|
+  config.app_key = YOUR_APP_KEY
+  config.master_secret = YOUR_MASTER_SECRET
+end
+```
+
+Make an API request...
+
+```ruby
+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!!!"
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Credits
+[![Sticksnleaves](http://sticksnleaves-wordpress.herokuapp.com/wp-content/themes/sticksnleaves/images/snl-logo-116x116.png)](http://www.sticksnleaves.com)
+
+Dirigible is maintained and funded by [Sticksnleaves](http://www.sticksnleaves.com)
+
+Thanks to all of our [contributors](https://github.com/anthonator/dirigible/graphs/contributors)

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task default: :spec

data/dirigible.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dirigible/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dirigible"
+  spec.version       = Dirigible::VERSION
+  spec.authors       = ["Anthony Smith"]
+  spec.email         = ["anthony@sticksnleaves.com"]
+  spec.description   = %q{An Urban Airship v3 API wrapper written in Ruby}
+  spec.summary       = %q{Urban Airship REST API client library for Ruby}
+  spec.homepage      = "https://github.com/anthonator/dirigible"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  # Runtime dependencies
+  spec.add_dependency "faraday",            "~> 0.8"
+  spec.add_dependency "faraday_middleware", "~> 0.9"
+  spec.add_dependency "hashie",             "~> 2.0"
+  spec.add_dependency "multi_json",         "~> 1.8"
+end

data/lib/dirigible/api.rb

@@ -0,0 +1,16 @@
+module Dirigible
+  # @private
+  class API
+    attr_accessor *Configuration::VALID_OPTION_KEYS
+
+    def initialize(options = {})
+      options = Dirigible.options.merge(options)
+      Configuration::VALID_OPTION_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    include Connection
+    include Request
+  end
+end

data/lib/dirigible/configuration.rb

@@ -0,0 +1,62 @@
+module Dirigible
+  module Configuration
+    VALID_OPTION_KEYS = [
+      :app_key,
+      :master_secret,
+      :endpoint,
+      :http_adapter,
+      :proxy,
+      :user_agent
+    ]
+
+    # By default, don't set app key.
+    DEFAULT_APP_KEY = nil.freeze
+
+    # By default, don't set the master secret.
+    DEFAULT_MASTER_SECRET = nil.freeze
+
+    # The endpoint that will be used to authorize a user if none is set.
+    DEFAULT_ENDPOINT = 'https://go.urbanairship.com/api'.freeze
+
+    # The Faraday HTTP adapter to be used.
+    DEFAULT_HTTP_ADAPTER = Faraday.default_adapter
+
+    # By default, don't set a proxy server.
+    DEFAULT_PROXY = nil.freeze
+
+    # The user agent that will be sent to the API endpoint if none is set.
+    DEFAULT_USER_AGENT = "dirigible gem v#{Dirigible::VERSION}"
+
+    # @private
+    attr_accessor(*VALID_OPTION_KEYS)
+
+    # When this module is extended, set all configuration options to their
+    # default values.
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a
+    # block.
+    def configure
+      yield self
+    end
+
+    # Create a hash of options and their values.
+    def options
+      VALID_OPTION_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    # Reset all configuration options to default.
+    def reset
+      self.app_key = DEFAULT_APP_KEY
+      self.master_secret = DEFAULT_MASTER_SECRET
+      self.endpoint = DEFAULT_ENDPOINT
+      self.http_adapter = DEFAULT_HTTP_ADAPTER
+      self.proxy = DEFAULT_PROXY
+      self.user_agent = DEFAULT_USER_AGENT
+    end
+  end
+end

data/lib/dirigible/connection.rb

@@ -0,0 +1,14 @@
+module Dirigible
+  # @private
+  module Connection
+    private
+    def connection
+      options = { ssl: { verify: true }, proxy: proxy }
+      Faraday.new(endpoint, options) do |faraday|
+        faraday.request(:json)
+        faraday.basic_auth(app_key, master_secret)
+        faraday.adapter(http_adapter)
+      end
+    end
+  end
+end

data/lib/dirigible/device_information.rb

@@ -0,0 +1,77 @@
+class Dirigible::DeviceInformation
+  # Get information on a particular iOS device token. For
+  # information on particular keys, see the device token
+  # registration API.
+  #
+  # @example Example request:
+  #   Dirigible::DeviceInformation.get_device_token('FE66489F304DC75B8D6E8200DFF8A456E8DAEACEC428B427E9518741C92C6660')
+  #
+  # @see http://docs.urbanairship.com/reference/api/v3/device_information.html#individual-device-lookup
+  def self.get_device_token(id)
+    Dirigible.get("/device_tokens/#{id}")
+  end
+
+  # Get information on a particular Android APID.
+  #
+  # @example Example request:
+  #   Dirigible::DeviceInformation.get_apid('11111111-1111-1111-1111-111111111111')
+  #
+  # @see http://docs.urbanairship.com/reference/api/v3/device_information.html#individual-device-lookup
+  def self.get_apid(id)
+    Dirigible.get("/apids/#{id}")
+  end
+
+  # Get information on a particular BlackBerry PIN.
+  #
+  # @example Example request:
+  #   Dirigible::DeviceInformation.get_device_pin('12345678')
+  #
+  # @see http://docs.urbanairship.com/reference/api/v3/device_information.html#individual-device-lookup
+  def self.get_device_pin(id)
+    Dirigible.get("/device_pins/#{id}")
+  end
+
+  # Fetch iOS device tokens registered to this application
+  # and associated metadata.
+  #
+  # @example Example request:
+  #   Dirigible::DeviceInformation.list_device_tokens
+  #
+  # @see http://docs.urbanairship.com/reference/api/v3/device_information.html#device-listing
+  def self.list_device_tokens
+    Dirigible.get('/device_tokens')
+  end
+
+  # Fetch Android APIDs registered to this application and
+  # associated metadata.
+  #
+  # @example Example request:
+  #   Dirigible::DeviceInformation.list_apids
+  #
+  # @see http://docs.urbanairship.com/reference/api/v3/device_information.html#device-listing
+  def self.list_apids
+    Dirigible.get('/apids')
+  end
+
+  # Fetch BlackBerry PINs registered to this application and
+  # associated metadata.
+  #
+  # @example Example request:
+  #   Dirigible::DeviceInformation.list_device_pins
+  #
+  # @see http://docs.urbanairship.com/reference/api/v3/device_information.html#device-listing
+  def self.list_device_pins
+    Dirigible.get('/device_pins')
+  end
+
+  # Fetch device tokens that can't recieve messages because
+  # the app has been uninstalled.
+  #
+  # @example Example request:
+  #   Dirigible::DeviceInformation.device_token_feedback('2009-06-15')
+  #
+  # @see http://docs.urbanairship.com/reference/api/v3/device_information.html#feedback
+  def self.device_token_feedback(since)
+    Dirigible.get("/device_tokens/feedback", { since: since })
+  end
+end

data/lib/dirigible/device_registration.rb

@@ -0,0 +1,79 @@
+class Dirigible::DeviceRegistration
+  # Register the device token with this application. This
+  # will mark the device token as active in our system.
+  # Optionally set metadata.
+  #
+  # @example Example request:
+  #   Dirigible::DeviceRegistration.register_device_token('FE66489F304DC75B8D6E8200DFF8A456E8DAEACEC428B427E9518741C92C6660')
+  #
+  # @example Full capability:
+  #   Dirigible::DeviceRegistration.register_device_token('FE66489F304DC75B8D6E8200DFF8A456E8DAEACEC428B427E9518741C92C6660', {
+  #     alias: "your_user_id",
+  #     tags: ["tag1", "tag2"],
+  #     badge: 2,
+  #     quiettime: {
+  #       start: "22:00",
+  #       end: "8:00"
+  #     },
+  #     tz: "America/Los_Angeles"
+  #   })
+  #
+  # @see http://docs.urbanairship.com/reference/api/v3/registration.html#device-token-registration
+  def self.register_device_token(id, options = {})
+    Dirigible.put("/device_tokens/#{id}", options)
+  end
+
+  # Deactivate the device token and clear metadata. Pushes
+  # will not be sent to inactive device tokens. A future
+  # registration will reactivate the device token.
+  #
+  # @example Example request:
+  #   Dirigible::DeviceRegistration.delete_device_token('FE66489F304DC75B8D6E8200DFF8A456E8DAEACEC428B427E9518741C92C6660')
+  #
+  # @see http://docs.urbanairship.com/reference/api/v3/registration.html#device-token-registration
+  def self.delete_device_token(id)
+    Dirigible.delete("/device_tokens/#{id}")
+  end
+
+  # Register the APID and options with Urban Airship.
+  #
+  # @example Example request:
+  #   Dirigible::DeviceRegistration.register_apid('11111111-1111-1111-1111-111111111111', {
+  #     alias: "example_alias",
+  #     tags: ["tag1", "tag2"]
+  #   })
+  #
+  # @see http://docs.urbanairship.com/reference/api/v3/registration.html#apid-registration
+  def self.register_apid(id, params)
+    Dirigible.put("/apids/#{id}", params)
+  end
+
+  # Register this PIN with this application. This will mark
+  # the PIN as active in our system. Optionally set metadata.
+  #
+  # @example Example request:
+  #   Dirigible::DeviceRegistration.register_device_pin('12345678')
+  #
+  # @example Full capability:
+  #   Dirigible::DeviceRegistration.register_device_pin('12345678', {
+  #     alias: "your_user_id",
+  #     tags: ["tag1", "tag2"]
+  #   })
+  #
+  # @see http://docs.urbanairship.com/reference/api/v3/registration.html#blackberry-pin-registration
+  def self.register_device_pin(id, options = {})
+    Dirigible.put("/device_pins/#{id}", options)
+  end
+
+  # Deactivate the PIN and clear metadata. Pushes will not
+  # be sent to inactive PINs. A future registration will
+  # reactivate the PIN.
+  #
+  # @example Example request:
+  #   Dirigible::DeviceRegistration.delete_device_pin('12345678')
+  #
+  # @see http://docs.urbanairship.com/reference/api/v3/registration.html#blackberry-pin-registration
+  def self.delete_device_pin(id)
+    Dirigible.delete("/device_pins/#{id}")
+  end
+end

data/lib/dirigible/error.rb

@@ -0,0 +1,19 @@
+module Dirigible
+  # Custom error class for rescuing from all known Urban Airship errors
+  class Error < StandardError; attr_accessor :error end
+
+  # Raised when Urban Airship returns HTTP status code 400
+  class BadRequest < Error; end
+
+  # Raised when Urban Airship returns HTTP status code 401
+  class Unauthorized < Error; end
+
+  # Raised when Urban Airship returns HTTP status code 404
+  class NotFound < Error; end
+
+  # Raised when Urban Airship returns HTTP status code 405
+  class MethodNotAllowed < Error; end
+
+  # Raised when Urban Airship returns HTTP status code 406
+  class NotAcceptable < Error; end
+end

data/lib/dirigible/feed.rb

@@ -0,0 +1,61 @@
+# @note The Feed API still uses the version 1 Push API. In the future it will be upgraded to use the V3 push API.
+# @see http://docs.urbanairship.com/reference/api/v3/feeds.html
+class Dirigible::Feed
+  # Creates a new feed.
+  #
+  # @example Example request:
+  #   Dirigible::Feed.create({
+  #     feed_url: "http://example.com/atom.xml",
+  #     template: {
+  #       aps: {
+  #         badge: 1,
+  #         sound: "cat.caf",
+  #         alert: "New item from some place! {{ title }}"
+  #       }
+  #     }
+  #   })
+  #
+  # @see http://docs.urbanairship.com/reference/api/v3/feeds.html#creating-a-new-feed
+  def self.create(params)
+    Dirigible.post('/feeds', params)
+  end
+
+  # Returns information about that particular feed.
+  #
+  # @example Example request:
+  #   Dirigible::Feed.get('<feed_id>')
+  #
+  # @see http://docs.urbanairship.com/reference/api/v3/feeds.html#feed-details
+  def self.get(id)
+    Dirigible.get("/feeds/#{id}")
+  end
+
+  # Updates a feed with a new template
+  #
+  # @example Example request:
+  #   Dirigible::Feed.update('<feed_id>', {
+  #     template: {
+  #       aps: {
+  #         sound: "frog.caf",
+  #         alert: "New update from Someplace! - {{ title }}"
+  #       }
+  #     },
+  #     feed_url: "<new_feed_url>"
+  #   })
+  #
+  # @see http://docs.urbanairship.com/reference/api/v3/feeds.html#updating-a-feed
+  def self.update(id, params)
+    Dirigible.put("/feeds/#{id}", params)
+  end
+
+  # Removes a feed from the monitoring service, and stops new
+  # pushes from being sent.
+  #
+  # @example Example request:
+  #   Dirigible::Feed.delete('<feed_id>')
+  #
+  # @see http://docs.urbanairship.com/reference/api/v3/feeds.html#deleting-a-feed
+  def self.delete(id)
+    Dirigible.delete("/feeds/#{id}")
+  end
+end

data/lib/dirigible/location.rb

@@ -0,0 +1,65 @@
+# @see http://docs.urbanairship.com/reference/api/v3/location.html
+class Dirigible::Location
+  # Search for a location boundary by name.
+  #
+  # @param query [String] Text search query.
+  # @param boundary_type [String] Optional location type, e.g. city, province, or country.
+  #
+  # @example Example request:
+  #   Dirigible::Location.search_by_name("Indianapolis", "city")
+  #
+  # @see http://docs.urbanairship.com/reference/api/v3/location.html#location-boundary-information
+  def self.search_by_name(query, boundary_type = nil)
+    Dirigible.get('/location', { q: query, type: boundary_type })
+  end
+
+  # Search for a location by latitude and longitude.
+  #
+  # @param lat [Decimal] Latitude coordinate.
+  # @param lng [Decimal] Longitude coordinate.
+  # @param boundary_type [String] Optional location type, e.g. city, province, or country.
+  #
+  # @example Example request:
+  #   Dirigible::Location.search_by_latlng("37.7749295", "-122.4194155", "city")
+  #
+  # http://docs.urbanairship.com/reference/api/v3/location.html#location-boundary-information
+  def self.search_by_latlng(lat, lng, boundary_type = nil)
+    Dirigible.get("/location/#{lat},#{lng}", { type: boundary_type })
+  end
+
+  # Search for locations using a bounding box. A bounding box
+  # is a rectangle that covers part of the earth.
+  #
+  # @param bounding_box [Decimal Array] Multi-dimentional array of latitude and longitude pairs.
+  # @param boundary_type [String] Optional location type, e.g. city, province, or country.
+  #
+  # @example Example request:
+  #   Dirigible::Location.search_by_bounding_box([["37.805172690644405", "-122.44863510131836"], ["37.77654930110633", "-122.39404678344727"]], "postalcode")
+  #
+  # @see http://docs.urbanairship.com/reference/api/v3/location.html#location-boundary-information
+  def self.search_by_bounding_box(bounding_box, boundary_type = nil)
+    Dirigible.get("/location/#{bounding_box.join(',')}", { type: boundary_type })
+  end
+
+  # Look up location boundary information based on
+  # real-world references. Multiple queries may be passed
+  # in one API call.
+  #
+  # @example Example request:
+  #   Dirigible::Location.from_alias({ us_state: "IN" })
+  #
+  # @see http://docs.urbanairship.com/reference/api/v3/location.html#location-boundary-information
+  def self.from_alias(query)
+    Dirigible.get("/location/from-alias", query)
+  end
+
+  # Retrieve cutoff dates for each time granularity.
+  #
+  # @example Example request:
+  #   Dirigible::Location.cutoff_dates
+  #
+  # @see http://docs.urbanairship.com/reference/api/v3/location.html#location-data-ranges
+  def self.cutoff_dates
+    Dirigible.get("/segments/dates")
+  end
+end

data/lib/dirigible/push.rb

@@ -0,0 +1,51 @@
+# @see http://docs.urbanairship.com/reference/api/v3/push.html
+class Dirigible::Push
+  # Send a push notification to a specified device or list
+  # of devices. Must be one of:
+  #
+  # * A single [Push Object](http://docs.urbanairship.com/reference/api/v3/push.html#push-object)
+  # * An array of one or more [Push Objects](http://docs.urbanairship.com/reference/api/v3/push.html#push-object)
+  #
+  # @example Example request:
+  #   Dirigible::Push.create({
+  #     audience: { device_token: "998BAD77A8347EFE7920F5367A4811C4385D526AE42C598A629A73B94EEDBAC8" },
+  #     notification: { alert: "Hello"! },
+  #     device_types: "all"
+  #   })
+  #
+  # @see http://docs.urbanairship.com/reference/api/v3/push.html#push
+  def self.create(params)
+    Dirigible.post('/push', params)
+  end
+
+  # Accept the same range of payloads as /api/push, but parse
+  # and validate only, without sending any pushes.
+  #
+  # @example Missing payload:
+  #   Dirigible::Push.validate({
+  #     audience: "all",
+  #     device_types: ["ios", "android"],
+  #     notification: {
+  #       ios: { alert: "Boo" }
+  #     }
+  #   })
+  #
+  # @example Device identifier/restriction mismatch:
+  #   Dirigible::Push.validate({
+  #     audience: {
+  #       or: [
+  #         device_pin: "1fd34210",
+  #         device_token: "645A5C6C06AFB2AE095B079135168A04A5F974FBF27163F3EC6FE1F2D5AFE008"
+  #       ]
+  #     },
+  #     device_types: ["blackberry"],
+  #     notification: {
+  #       alert: "WAT"
+  #     }
+  #   })
+  #
+  # @see http://docs.urbanairship.com/reference/api/v3/push.html#validate
+  def self.validate(params)
+    Dirigible.post('/push/validate')
+  end
+end

data/lib/dirigible/request.rb

@@ -0,0 +1,38 @@
+module Dirigible
+  module Request
+    def get(path, options = {}, headers = {})
+      request(:get, path, options, headers)
+    end
+
+    def post(path, options = {}, headers = {})
+      request(:post, path, options, headers)
+    end
+
+    def put(path, options = {}, headers = {})
+      request(:put, path, options, headers)
+    end
+
+    def delete(path, options = {}, headers = {})
+      request(:delete, path, options, headers)
+    end
+
+    private
+    # Perform an HTTP request.
+    def request(method, path, options, headers)
+      headers.merge!({
+        'User-Agent' => user_agent,
+        'Accept' => 'application/vnd.urbanairship+json; version=3;',
+      })
+
+      response = connection.send(method) do |request|
+        request.url("#{endpoint}#{path}/")
+        request.body = options.to_json
+        request.headers.merge!(headers)
+      end
+
+      Utils.handle_api_error(response) unless (200..399).include?(response.status)
+
+      Utils.parse_json(response.body) unless response.body == ''
+    end
+  end
+end

data/lib/dirigible/schedule.rb

@@ -0,0 +1,77 @@
+# @see http://docs.urbanairship.com/reference/api/v3/schedule.html
+class Dirigible::Schedule
+  # Scheduled notifications are created by POSTing to the
+  # schedule URI. The body of the request must be one of:
+  #
+  # * A single {http://docs.urbanairship.com/reference/api/v3/schedule.html#schedule-object schedule object}.
+  # * An array of one or more {http://docs.urbanairship.com/reference/api/v3/schedule.html#schedule-object schedule objects}.
+  #
+  # @example Example request:
+  #   Dirigible::Schedule.create({
+  #     name: "Booyah Sports",
+  #     schedule: { scheduled_time: "2013-04-01T18:45:00" },
+  #     push: {
+  #       audience: { tag: "spoaaaarts" },
+  #       notification: { alert: "Booyah!" },
+  #       device_types: "all"
+  #     }
+  #   })
+  #
+  # @see http://docs.urbanairship.com/reference/api/v3/schedule.html#schedule-a-notification
+  def self.create(params)
+    Dirigible.post('/schedules', params)
+  end
+
+  # List all existing schedules. Returns an array of schedule
+  # objects in the "schedules" attribute.
+  #
+  # @example Example request:
+  #   Dirigible::Schedule.list
+  #
+  # @see http://docs.urbanairship.com/reference/api/v3/schedule.html#list-schedules
+  def self.list
+    Dirigible.get('/schedules')
+  end
+
+  # Fetch the current definition of a single schedule
+  # resource. Returns a single schedule object.
+  #
+  # @example Example request:
+  #   Dirigible::Schedule.get('5cde3564-ead8-9743-63af-821e12337812')
+  #
+  # @see http://docs.urbanairship.com/reference/api/v3/schedule.html#list-a-specific-schedule
+  def self.get(id)
+    Dirigible.get("/schedules/#{id}")
+  end
+
+  # Update the state of a single schedule resource. The body
+  # must contain a single schedule object.
+  #
+  # @example Example request:
+  #   Dirigible::Schedule.update('5cde3564-ead8-9743-63af-821e12337812', {
+  #     name: "Booyah Sports",
+  #     schedule: { scheduled_time: "2013-04-01T18:45:30" },
+  #     push: {
+  #       audience: { tag: ["spoaaaarts", "Beyonce", "Nickelback"] },
+  #       notification: { alert: "Booyah!" },
+  #       device_types: "all"
+  #     }
+  #   })
+  #
+  # @see http://docs.urbanairship.com/reference/api/v3/schedule.html#update-schedule
+  def self.update(id, params)
+    Dirigible.put("/schedules/#{id}", params)
+  end
+
+  # Delete a schedule resource, which will result in no more
+  # pushes being sent. If the resource is succesfully
+  # deleted, the response does not include a body.
+  #
+  # @example Example request:
+  #   Dirigible::Schedule.delete('b384ca54-0a1d-9cb3-2dfd-ae5964630e66')
+  #
+  # @see http://docs.urbanairship.com/reference/api/v3/schedule.html#delete-schedule
+  def self.delete(id)
+    Dirigible.delete("/schedules/#{id}")
+  end
+end

data/lib/dirigible/segment.rb

@@ -0,0 +1,68 @@
+# @see http://docs.urbanairship.com/reference/api/v3/segments.html
+class Dirigible::Segment
+  # List all of the segments for the application.
+  #
+  # @example Example request:
+  #   Dirigible::Segment.list
+  #
+  # @see http://docs.urbanairship.com/reference/api/v3/segments.html#segments-information
+  def self.list
+    Dirigible.get('/segments')
+  end
+
+  # Fetch information about a particular segment.
+  #
+  # @example Example request:
+  #   Dirigible::Segment.get("0c0d899-a595-4c66-9071-bc59374bbe6b")
+  #
+  # @see http://docs.urbanairship.com/reference/api/v3/segments.html#segments-information
+  def self.get(id)
+    Dirigible.get("/segments/#{id}")
+  end
+
+  # Create a new segment.
+  #
+  # @example Example request:
+  #   Dirigible::Segment.create({
+  #     display_name: "News but not sports",
+  #     criteria: {
+  #       and: [
+  #         { tag: "news" },
+  #         { not: { tag: "sports" } }
+  #       ]
+  #     }
+  #   })
+  #
+  # @see http://docs.urbanairship.com/reference/api/v3/segments.html#segment-creation
+  def self.create(params)
+    Dirigible.post('/segments', params)
+  end
+
+  # Change the definition of the segment.
+  #
+  # @example Example request:
+  #   Dirigible::Segment.update("00c0d899-a595-4c66-9071-bc59374bbe6b", {
+  #     display_name: "Entertainment but not sports",
+  #     criteria: {
+  #       and: [
+  #         { tag: "news" },
+  #         { not: { tag: "entertainment" } }
+  #       ]
+  #     }
+  #   })
+  #
+  # @see http://docs.urbanairship.com/reference/api/v3/segments.html#segment-creation
+  def self.update(id, params)
+    Dirigible.put("/segments/#{id}", params)
+  end
+
+  # Remove the segment.
+  #
+  # @example Example request:
+  #   Dirigible::Segment.delete("00c0d899-a595-4c66-9071-bc59374bbe6b")
+  #
+  # @see http://docs.urbanairship.com/reference/api/v3/segments.html#segment-creation
+  def self.delete(id)
+    Dirigible.delete("/segments/#{id}")
+  end
+end

data/lib/dirigible/tag.rb

@@ -0,0 +1,112 @@
+# @see http://docs.urbanairship.com/reference/api/v3/tags.html
+class Dirigible::Tag
+  # List tags that exist for this application.
+  #
+  # @example Example request:
+  #   Dirigible::Tag.list
+  #
+  # @see http://docs.urbanairship.com/reference/api/v3/tags.html#tag-listing
+  def self.list
+    Dirigible.get('/tags')
+  end
+
+  # Explicitly create a tag with no devices associated with
+  # it.
+  #
+  # @example Example request:
+  #   Dirigible::Tag.create("some_new_tag")
+  #
+  # @note This call is optional; tags are created implicitly when devices are added to them. You might use this to pre-create the list for your Push Composer users, however.
+  # @see http://docs.urbanairship.com/reference/api/v3/tags.html#tag-creation
+  def self.create(tag)
+    Dirigible.put("/tags/#{tag}")
+  end
+
+  # Delete a tag and remove it from all devices.
+  #
+  # A tag can be fully removed from Urban Airship by issuing
+  # a delete. This will remove the master record of the tag,
+  # and will remove the tag from all devices.
+  #
+  # @example Example request:
+  #   Dirigible::Tag.delete("some_new_tag")
+  #
+  # @note The removal process can take a long time if many devices use this tag.
+  # @see http://docs.urbanairship.com/reference/api/v3/tags.html#deleting-a-tag
+  def self.delete(tag)
+    Dirigible.delete("/tags/#{tag}")
+  end
+
+  # Add or remove one or more device tokens, APIDs, or PINs
+  # to a particular tag.
+  #
+  # @example Example request:
+  #   Dirigible::Tag.add_or_remove("some_new_tag", {
+  #     device_tokens: {
+  #       add: ["device_token_1_to_add", "device_token_2_to_add"]
+  #     },
+  #     apids: {
+  #       remove: ["apid_1_to_remove"]
+  #     }
+  #   })
+  #
+  # @example Full capability:
+  #   Dirigible::Tag.add_or_remove("some_new_tag", {
+  #     device_tokens: {
+  #       add: ["device_token_1_to_add", "device_token_2_to_add"],
+  #       remove: ["device_token_to_remove"]
+  #     },
+  #     device_pins: {
+  #       add: ["device_pin_1_to_add", "device_pin_2_to_add"],
+  #       remove: ["device_pin_to_remove"]
+  #     },
+  #     apids: {
+  #       add: ["apid_1_to_add", "apid_2_to_add"],
+  #       remove: ["apid_to_remove"]
+  #     }
+  #   })
+  #
+  # @see http://docs.urbanairship.com/reference/api/v3/tags.html#adding-and-removing-devices-from-a-tag
+  def self.add_or_remove(tag, params)
+    Dirigible.post("/tags/#{tag}", params)
+  end
+
+  # Modify the tags for a number of device tokens or apids.
+  #
+  # You must include an object containing either a
+  # device_token or apid section and also containing a tags
+  # section to apply the tags.
+  #
+  # @example Example request:
+  #   Dirigible::Tag.batch([
+  #     {
+  #       device_token: "device_token_tag_tag_1",
+  #       tags: [
+  #         "tag_to_apply_1",
+  #         "tag_to_apply_2",
+  #         "tag_to_apply_3"
+  #       ]
+  #     },
+  #     {
+  #       device_token: "device_token_to_tag_2",
+  #       tags: [
+  #         "tag_to_apply_1",
+  #         "tag_to_apply_4",
+  #         "tag_to_apply_5"
+  #       ]
+  #     },
+  #     {
+  #       apid: "apid_to_tag_2",
+  #       tags: [
+  #         "tag_to_apply_1",
+  #         "tag_to_apply_4",
+  #         "tag_to_apply_5"
+  #       ]
+  #     }
+  #   ])
+  #
+  # @see http://docs.urbanairship.com/reference/api/v3/tags.html#batch-modification-of-tags
+  def self.batch(params)
+    Dirigible.post("/tags/batch", params)
+  end
+end

data/lib/dirigible/utils.rb

@@ -0,0 +1,21 @@
+module Dirigible
+  # @private
+  module Utils
+    def self.handle_api_error(response)
+      error = case response.status
+      when 400 then BadRequest.new
+      when 401 then Unauthorized.new
+      when 404 then NotFound.new
+      when 405 then MethodNotAllowed.new
+      when 406 then NotAcceptable.new
+      else Error.new
+      end
+      error.error = parse_json(response.body)
+      raise error
+    end
+
+    def self.parse_json(json)
+      MultiJson.load(json, symbolize_keys: true)
+    end
+  end
+end

data/lib/dirigible/version.rb

@@ -0,0 +1,3 @@
+module Dirigible
+  VERSION = "0.0.1"
+end

data/lib/dirigible.rb

@@ -0,0 +1,39 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'hashie'
+require 'multi_json'
+
+require 'dirigible/version'
+require 'dirigible/error'
+require 'dirigible/utils'
+
+require 'dirigible/configuration'
+require 'dirigible/connection'
+require 'dirigible/request'
+require 'dirigible/api'
+
+require 'dirigible/push'
+require 'dirigible/schedule'
+require 'dirigible/tag'
+require 'dirigible/feed'
+require 'dirigible/device_information'
+require 'dirigible/device_registration'
+require 'dirigible/segment'
+require 'dirigible/location'
+
+module Dirigible
+  extend Configuration
+
+  def self.api(options = {})
+    Dirigible::API.new(options)
+  end
+
+  def self.method_missing(method, *args, &block)
+    return super unless api.respond_to?(method)
+    api.send(method, *args, &block)
+  end
+
+  def self.respond_to?(method)
+    api.respond_to?(method) || super
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: dirigible
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Anthony Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: An Urban Airship v3 API wrapper written in Ruby
+email:
+- anthony@sticksnleaves.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dirigible.gemspec
+- lib/dirigible.rb
+- lib/dirigible/api.rb
+- lib/dirigible/configuration.rb
+- lib/dirigible/connection.rb
+- lib/dirigible/device_information.rb
+- lib/dirigible/device_registration.rb
+- lib/dirigible/error.rb
+- lib/dirigible/feed.rb
+- lib/dirigible/location.rb
+- lib/dirigible/push.rb
+- lib/dirigible/request.rb
+- lib/dirigible/schedule.rb
+- lib/dirigible/segment.rb
+- lib/dirigible/tag.rb
+- lib/dirigible/utils.rb
+- lib/dirigible/version.rb
+- spec/.gitkeep
+homepage: https://github.com/anthonator/dirigible
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.0
+signing_key: 
+specification_version: 4
+summary: Urban Airship REST API client library for Ruby
+test_files:
+- spec/.gitkeep
+has_rdoc: