urbanairship 2.4.1 → 3.0.1

data/README.markdown

@@ -1,369 +0,0 @@
-Urbanairship is a Ruby library for interacting with the [Urban Airship API](http://urbanairship.com).
-
-Installation
-============
-    gem install urbanairship
-
-Note: if you are using Ruby 1.8, you should also install the ```system_timer``` gem for more reliable timeout behaviour. See http://ph7spot.com/musings/system-timer for more information.
-
-Configuration
-=============
-```ruby
-Urbanairship.application_key = 'application-key'
-Urbanairship.application_secret = 'application-secret'
-Urbanairship.master_secret = 'master-secret'
-Urbanairship.logger = Rails.logger
-Urbanairship.request_timeout = 5 # default
-```
-
-Usage
-=====
-
-Registering a device token
---------------------------
-```ruby
-Urbanairship.register_device('DEVICE-TOKEN')
-```
-You can also pass an alias, and a set of tags to device registration.
-```ruby
-Urbanairship.register_device('DEVICE-TOKEN',
-  :alias => 'user-123',
-  :tags => ['san-francisco-users']
-)
-```
-
-Unregistering a device token
-----------------------------
-```ruby
-Urbanairship.unregister_device('DEVICE-TOKEN')
-```
-
-Retrieving Device Info
-----------------------------
-```ruby
-Urbanairship.device_info('DEVICE-TOKEN')
-```
-
-Sending a push notification
----------------------------
-```ruby
-notification = {
-  :schedule_for => [1.hour.from_now],
-  :device_tokens => ['DEVICE-TOKEN-ONE', 'DEVICE-TOKEN-TWO'],
-  :aps => {:alert => 'You have a new message!', :badge => 1}
-}
-
-Urbanairship.push(notification) # =>
-# {
-#   "scheduled_notifications" => ["https://go.urbanairship.com/api/push/scheduled/123456"]
-# }
-```
-
-If you wish to use v3 of the Urbanairship API, just add `version: 3` as an option:
-
-```ruby
-Urbanairship.push(notification, version: 3)
-```
-### Using aliases instead of device tokens ###
-
-```ruby
-notification = {
-  :schedule_for => [1.hour.from_now],
-  :aliases => ['ALIAS-ONE', 'ALIAS-TWO'],
-  :aps => {:alert => 'You have a new message!', :badge => 1}
-}
-
-Urbanairship.push(notification) # =>
-# {
-#   "scheduled_notifications" => ["https://go.urbanairship.com/api/push/scheduled/123456"]
-# }
-```
-
-Batching push notification sends
---------------------------------
-```ruby
-notifications = [
-  {
-    :schedule_for => [{ :alias => 'deadbeef', :scheduled_time => 1.hour.from_now }],
-    :device_tokens => ['DEVICE-TOKEN-ONE', 'DEVICE-TOKEN-TWO'],
-    :aps => {:alert => 'You have a new message!', :badge => 1}
-  },
-  {
-    :schedule_for => [3.hours.from_now],
-    :device_tokens => ['DEVICE-TOKEN-THREE'],
-    :aps => {:alert => 'You have a new message!', :badge => 1}
-  }
-]
-
-Urbanairship.batch_push(notifications)
-```
-
-Sending broadcast notifications
--------------------------------
-Urban Airship allows you to send a broadcast notification to all active registered device tokens for your app.
-
-```ruby
-notification = {
-  :schedule_for => [1.hour.from_now],
-  :aps => {:alert => 'Important announcement!', :badge => 1}
-}
-
-Urbanairship.broadcast_push(notification)
-```
-
-Polling the feedback API
-------------------------
-The first time you attempt to send a push notification to a device that has uninstalled your app (or has opted-out of notifications), both Apple and Urban Airship will register that token in their feedback API. Urban Airship will prevent further attempted notification sends to that device, but it's a good practice to periodically poll Urban Airship's feedback API and mark those tokens as inactive in your own system as well.
-
-```ruby
-# find all device tokens deactivated in the past 24 hours
-Urbanairship.feedback(24.hours.ago) # =>
-# [
-#   {
-#     "marked_inactive_on"=>"2011-06-03 22:53:23",
-#     "alias"=>nil,
-#     "device_token"=>"DEVICE-TOKEN-ONE"
-#   },
-#   {
-#     "marked_inactive_on"=>"2011-06-03 22:53:23",
-#     "alias"=>nil,
-#     "device_token"=>"DEVICE-TOKEN-TWO"
-#   }
-# ]
-```
-
-Deleting scheduled notifications
---------------------------------
-
-If you know the alias or id of a scheduled push notification then you can delete it from Urban Airship's queue and it will not be delivered.
-
-```ruby
-Urbanairship.delete_scheduled_push("123456789")
-Urbanairship.delete_scheduled_push(123456789)
-Urbanairship.delete_scheduled_push(:alias => "deadbeef")
-```
-
-Segments
----------------------------
-Urban Airship segments let you send a push notification to a subset of relevant users based on location, time, preferences, and behavior. You can read more about segments in the [Urban Airship docs](https://docs.urbanairship.com/display/DOCS/Server%3A+Segments+API).
-
-```ruby
-notification = {
-  :schedule_for => [1.hour.from_now],
-  :segments => ['SEGMENT-ID'],
-  :ios => {
-    :aps => {
-      :alert => 'You have a new message!', :badge => 1
-    }
-  },
-  :android => {
-    :alert => 'You have a new message!', :badge => 1
-  }
-}
-
-Urbanairship.push_to_segment(notification)
-```
-
-### Creating a segment ###
-``` ruby
-Urbanairship.create_segment({
-  :display_name => 'segment1',
-  :criteria => {:and => [{:tag => 'one'}, {:tag => 'two'}]}
-}) # => {}
-```
-
-### Listing your segments ###
-
-```ruby
-Urbanairship.segments # =>
-# {
-#   "segments" => [
-#     {
-#      "id" => "abcd-efgh-ijkl",
-#      "display_name" => "segment1",
-#      "creation_date" => 1360950614201,
-#      "modification_date" => 1360950614201
-#     }
-#   ]
-# }
-
-Urbanairship.segment("abcd-efgh-ijkl") # =>
-# {
-#  "id" => "abcd-efgh-ijkl",
-#  "display_name" => "segment1",
-#  "creation_date" => 1360950614201,
-#  "modification_date" => 1360950614201
-# }
-```
-
-### Modifying a segment ###
-Note that you must provide both the display name and criteria when updating a segment, even if you are only changing one or the other.
-``` ruby
-Urbanairship.update_segment('abcd-efgh-ijkl', {
-  :display_name => 'segment1',
-  :criteria => {:and => [{:tag => 'asdf'}]}
-}) # => {}
-```
-
-### Deleting a segment ###
-```ruby
-Urbanairship.delete_segment("abcd-efgh-ijkl") # => {}
-```
-
-Getting your device tokens
--------------------------------------
-```ruby
-Urbanairship.device_tokens # =>
-# {
-#   "device_tokens" => {"device_token"=>"<token>", "active"=>true, "alias"=>"<alias>", "tags"=>[]},
-#   "device_tokens_count" => 3,
-#   "active_device_tokens_count" => 1
-# }
-```
-
-Getting a count of your device tokens
--------------------------------------
-```ruby
-Urbanairship.device_tokens_count # =>
-# {
-#   "device_tokens_count" => 3,
-#   "active_device_tokens_count" => 1
-# }
-```
-
-Tags
-----
-
-Urban Airship allows you to create tags and associate them with devices. Then you can easily send a notification to every device matching a certain tag with a single call to the push API.
-
-### Creating a tag ###
-
-Tags must be registered before you can use them.
-
-```ruby
-Urbanairship.add_tag('TAG')
-```
-
-### Listing your tags ###
-
-```ruby
-Urbanairship.tags
-```
-
-### Removing a tag ##
-
-This will remove a tag from your set of registered tags, as well as removing that tag from any devices that are currently using it.
-
-```ruby
-Urbanairship.remove_tag('TAG')
-```
-
-### View tags associated with device ###
-
-```ruby
-Urbanairship.tags_for_device('DEVICE-TOKEN')
-```
-
-### Tag a device ###
-
-```ruby
-Urbanairship.tag_device(:device_token => 'DEVICE-TOKEN', :tag => 'TAG')
-```
-
-You can also tag a device during device registration.
-
-```ruby
-Urbanairship.register_device('DEVICE-TOKEN', :tags => ['san-francisco-users'])
-```
-
-### Untag a device ###
-
-```ruby
-Urbanairship.untag_device(:device_token => 'DEVICE-TOKEN', :tag => 'TAG')
-```
-
-### Sending a notification to all devices with a given tag ###
-
-```ruby
-notification = {
-  :tags => ['san-francisco-users'],
-  :aps => {:alert => 'Good morning San Francisco!', :badge => 1}
-}
-
-Urbanairship.push(notification)
-```
-
-Using Urbanairship with Android
--------------------------------
-
-The Urban Airship API extends a subset of their push API to Android devices. You can read more about what is currently supported [here](https://docs.urbanairship.com/display/DOCS/Server%3A+Android+Push+API), but as of this writing, only registration, aliases, tags, broadcast, individual push, and batch push are supported.
-
-To use this library with Android devices, you can set the `provider` configuration option to `:android`:
-
-```ruby
-Urbanairship.provider = :android
-```
-
-Alternatively, you can pass the `:provider => :android` option to device registration calls if your app uses Urbanairship to send notifications to both Android and iOS devices.
-
-```ruby
-Urbanairship.register_device("DEVICE-TOKEN", :provider => :android)
-```
-
-Note: all other supported actions use the same API endpoints as iOS, so it is not necessary to specify the provider as `:android` when calling them.
-
-When sending notifications to Android devices, the Urban Airship API expects the following basic structure:
-
-```ruby
-notification = {
-  :schedule_for => [1.hour.from_now],
-  :apids => ['DEVICE-TOKEN-ONE', 'DEVICE-TOKEN-TWO'],
-  :android => {:alert => 'You have a new message!', :extra => {:foo => 'bar'}}
-}
-
-Urbanairship.push(notification)
-```
-
------------------------------
-
-Note: all public library methods will return either an array or a hash, depending on the response from the Urban Airship API. In addition, you can inspect these objects to find out if they were successful or not, and what the http response code from Urban Airship was.
-
-```ruby
-response = Urbanairship.push(payload)
-response.success? # => true
-response.code # => '200'
-response.inspect # => "{\"scheduled_notifications\"=>[\"https://go.urbanairship.com/api/push/scheduled/123456\"]}"
-```
-
-If the call to Urban Airship times out, you'll get a response object with a '503' code.
-
-```ruby
-response = Urbanairship.feedback(1.year.ago)
-response.success? # => false
-response.code # => '503'
-response.inspect # => "{\"error\"=>\"Request timeout\"}"
-```
-
-Instantiating an Urbanairship::Client
--------------------------------------
-
-Anything you can do directly with the Urbanairship module, you can also do with a Client.
-
-```ruby
-client = Urbanairship::Client.new
-client.application_key = 'application-key'
-client.application_secret = 'application-secret'
-client.register_device('DEVICE-TOKEN')
-notification = {
-  :schedule_for => [1.hour.from_now],
-  :device_tokens => ['DEVICE-TOKEN'],
-  :aps => {:alert => 'You have a new message!', :badge => 1}
-}
-
-client.push(notification) # =>
-# {
-#   "scheduled_notifications" => ["https://go.urbanairship.com/api/push/scheduled/123456"]
-# }
-```
-
-This can be used to use clients for different Urbanairship applications in a thread-safe manner.

data/lib/urbanairship/response.rb

@@ -1,33 +0,0 @@
-module Urbanairship
-  module Response
-    module InstanceMethods
-      attr_accessor :ua_response, :ua_options
-
-      def code
-        (ua_options[:code] || ua_response.code).to_s
-      end
-
-      def success?
-        !!(code =~ /^2/)
-      end
-    end
-
-    def self.wrap(response, options = {})
-      if options[:body]
-        output = options[:body]
-      else
-        begin
-          output = JSON.parse(response.body || '{}')
-        rescue JSON::ParserError => e
-          output = {}
-        end
-      end
-
-      output.extend(Urbanairship::Response::InstanceMethods)
-      output.ua_response = response
-      output.ua_options = options
-
-      return output
-    end
-  end
-end

data/spec/response_spec.rb

@@ -1,79 +0,0 @@
-require 'spec_helper'
-
-describe Urbanairship::Response do
-
-  before do
-    FakeWeb.allow_net_connect = false
-  end
-
-  context "#code" do
-    subject { Urbanairship.register_device("new_device_token") }
-
-    before do
-      FakeWeb.register_uri(:put, "https://my_app_key:my_app_secret@go.urbanairship.com/api/device_tokens/new_device_token", :status => ["201", "Created"])
-      FakeWeb.register_uri(:put, /bad_key\:my_app_secret\@go\.urbanairship\.com/, :status => ["401", "Unauthorized"])
-      Urbanairship.application_secret = "my_app_secret"
-    end
-
-    it "should be set correctly on new registraion token" do
-      Urbanairship.application_key = "my_app_key"
-      subject.code.should eql '201'
-    end
-
-    it "should set correctly on unauthhorized" do
-      Urbanairship.application_key = "bad_key"
-      subject.code.should eql '401'
-    end
- end
-
-  context "#success?" do
-    subject { Urbanairship.register_device("new_device_token") }
-
-    before do
-      FakeWeb.register_uri(:put, "https://my_app_key:my_app_secret@go.urbanairship.com/api/device_tokens/new_device_token", :status => ["201", "Created"])
-      FakeWeb.register_uri(:put, /bad_key\:my_app_secret\@go\.urbanairship\.com/, :status => ["401", "Unauthorized"])
-      Urbanairship.application_secret = "my_app_secret"
-    end
-
-    it "should be true with good key" do
-      Urbanairship.application_key = "my_app_key"
-      subject.success?.should == true
-    end
-
-    it "should be false with bad key" do
-      Urbanairship.application_key = "bad_key"
-      subject.success?.should == false
-    end
-  end
-
-  context "body array accessor" do
-    subject { Urbanairship.feedback(Time.now) }
-
-    before do
-      FakeWeb.register_uri(:get, /my_app_key\:my_master_secret\@go\.urbanairship.com\/api\/device_tokens\/feedback/, :status => ["200", "OK"], :body => "[{\"device_token\":\"token\",\"marked_inactive_on\":\"2010-10-14T19:15:13Z\",\"alias\":\"my_alias\"},{\"device_token\":\"token2\",\"marked_inactive_on\":\"2010-10-14T19:15:13Z\",\"alias\":\"my_alias\"}]")
-      Urbanairship.application_secret = "my_app_secret"
-      Urbanairship.application_key = "my_app_key"
-      Urbanairship.master_secret = "my_master_secret"
-    end
-
-    it "should set up correct indexes" do
-      subject[0]['device_token'].should eql "token"
-      subject[1]['device_token'].should eql "token2"
-    end
-  end
-
-  context "non array response" do
-    subject { Urbanairship.feedback(Time.now) }
-
-    before do
-      FakeWeb.register_uri(:get, /my_app_key\:my_master_secret\@go\.urbanairship.com\/api\/device_tokens\/feedback/, :status => ["200", "OK"], :body => "{\"device_token\":\"token\",\"marked_inactive_on\":\"2010-10-14T19:15:13Z\",\"alias\":\"my_alias\"}")
-      Urbanairship.application_secret = "my_app_secret"
-      Urbanairship.application_key = "my_app_key"
-      Urbanairship.master_secret = "my_master_secret"
-    end
-
-    it "should set up correct keys" do
-      subject['device_token'].should eql "token"
-    end
-  end
-end