urbanairship 2.3.3 → 2.4.0

data/README.markdown

@@ -38,6 +38,12 @@ Unregistering a device token
 Urbanairship.unregister_device('DEVICE-TOKEN')
 ```
 
+Retrieving Device Info
+----------------------------
+```ruby
+Urbanairship.device_info('DEVICE-TOKEN')
+```
+
 Sending a push notification
 ---------------------------
 ```ruby
@@ -52,6 +58,12 @@ 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
@@ -198,6 +210,17 @@ Urbanairship.update_segment('abcd-efgh-ijkl', {
 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

data/lib/urbanairship.rb

@@ -34,27 +34,39 @@ module Urbanairship
       end
     end
 
+    def device_info(device_token, options = {})
+      if ( (options[:provider] || @provider) == :android ) || ( (options[:provider] || @provider) == 'android' )
+        do_request(:get, "/api/apids/#{device_token}", :authenticate_with => :application_secret)
+      else
+        do_request(:get, "/api/device_tokens/#{device_token}", :authenticate_with => :application_secret)
+      end
+    end
+
     def delete_scheduled_push(param)
+      warn "[DEPRECATED] http://docs.urbanairship.com/reference/api/v3/api-v3-migration-guide.html#api-push-batch"
       path = param.is_a?(Hash) ? "/api/push/scheduled/alias/#{param[:alias].to_s}" : "/api/push/scheduled/#{param.to_s}"
       do_request(:delete, path, :authenticate_with => :master_secret)
     end
 
     def push(options = {})
-      body = parse_push_options(options).to_json
-      do_request(:post, "/api/push/", :body => body, :authenticate_with => :master_secret)
+      body = parse_push_options(options.dup).to_json
+      do_request(:post, "/api/push/", :body => body, :authenticate_with => :master_secret, :version => options[:version])
     end
 
     def push_to_segment(options = {})
+      warn "[DEPRECATED] http://docs.urbanairship.com/reference/api/v3/api-v3-migration-guide.html#api-push-segments"
       body = parse_push_options(options).to_json
       do_request(:post, "/api/push/segments", :body => body, :authenticate_with => :master_secret)
     end
 
     def batch_push(notifications = [])
+      warn "[DEPRECATION] http://docs.urbanairship.com/reference/api/v3/api-v3-migration-guide.html#api-push-batch"
       body = notifications.map{|notification| parse_push_options(notification)}.to_json
       do_request(:post, "/api/push/batch/", :body => body, :authenticate_with => :master_secret)
     end
 
     def broadcast_push(options = {})
+      warn "[DEPRECATED] http://docs.urbanairship.com/reference/api/v3/api-v3-migration-guide.html#api-push-broadcast"
       body = parse_push_options(options).to_json
       do_request(:post, "/api/push/broadcast/", :body => body, :authenticate_with => :master_secret)
     end
@@ -89,6 +101,10 @@ module Urbanairship
       do_request(:post, "/api/tags/#{params[:tag]}", :body => {provider_field => {:remove => [params[:device_token]]}}.to_json, :authenticate_with => :master_secret)
     end
 
+    def device_tokens
+      do_request(:get, "/api/device_tokens/", :authenticate_with => :master_secret)
+    end
+
     def device_tokens_count
       do_request(:get, "/api/device_tokens/count/", :authenticate_with => :master_secret)
     end
@@ -124,6 +140,7 @@ module Urbanairship
       request.basic_auth @application_key, instance_variable_get("@#{options[:authenticate_with]}")
       request.add_field "Content-Type", options[:content_type] || "application/json"
       request.body = options[:body] if options[:body]
+      request["Accept"] = "application/vnd.urbanairship+json; version=#{options[:version]};"  if options[:version]
 
       Timer.timeout(request_timeout) do
         start_time = Time.now
@@ -135,7 +152,7 @@ module Urbanairship
       unless logger.nil?
         logger.error "Urbanairship request timed out after #{request_timeout} seconds: [#{http_method} #{request.path} #{request.body}]"
       end
-      Urbanairship::Response.wrap(nil, :body => {:error => 'Request timeout'}, :code => '503')
+      Urbanairship::Response.wrap(nil, :body => {'error' => 'Request timeout'}, :code => '503')
     end
 
     def verify_configuration_values(*symbols)
@@ -155,6 +172,7 @@ module Urbanairship
     def parse_push_options(hash = {})
       hash[:aliases] = hash[:aliases].map{|a| a.to_s} unless hash[:aliases].nil?
       hash[:schedule_for] = hash[:schedule_for].map{|elem| process_scheduled_elem(elem)} unless hash[:schedule_for].nil?
+      hash.delete(:version)
       hash
     end
 

data/lib/urbanairship/response.rb

@@ -18,7 +18,7 @@ module Urbanairship
       else
         begin
           output = JSON.parse(response.body || '{}')
-        rescue JSON::ParserError
+        rescue JSON::ParserError => e
           output = {}
         end
       end

data/spec/urbanairship_spec.rb

@@ -16,6 +16,15 @@ shared_examples_for "an Urbanairship client" do
     FakeWeb.register_uri(:delete, /my_app_key\:my_app_secret\@go\.urbanairship.com\/api\/device_tokens\/.+/, :status => ["204", "No Content"])
     FakeWeb.register_uri(:delete, /bad_key\:my_app_secret\@go\.urbanairship.com\/api\/device_tokens\/.+/, :status => ["401", "Unauthorized"])
 
+    # device_info
+    FakeWeb.register_uri(:get, /my_app_key\:my_app_secret\@go\.urbanairship.com\/api\/apids\/.+/, :status => ["200", "OK"], :body => "{\"active\":true,\"alias\":null}")
+    FakeWeb.register_uri(:get, /my_app_key\:my_app_secret\@go\.urbanairship.com\/api\/device_tokens\/.+/, :status => ["200", "OK"], :body => "{\"active\":true,\"alias\":null}")
+    FakeWeb.register_uri(:get, /bad_key\:my_app_secret\@go\.urbanairship.com\/api\/device_tokens\/.+/, :status => ["401", "Unauthorized"])
+
+    # device_tokens
+    FakeWeb.register_uri(:get, "https://my_app_key:my_master_secret@go.urbanairship.com/api/device_tokens/", :status => ["200", "OK"], :body => '{"device_tokens":[{"device_token": "0101F9929660BAD9FFF31A0B5FA32620FA988507DFFA52BD6C1C1F4783EDA2DB","active": false,"alias": null, "tags": []}], "device_tokens_count":50, "active_device_tokens_count":55}')
+    FakeWeb.register_uri(:get, "https://my_app_key2:my_master_secret2@go.urbanairship.com/api/device_tokens/", :status => ["401", "OK"])
+
     # push
     FakeWeb.register_uri(:post, "https://my_app_key:my_master_secret@go.urbanairship.com/api/push/", :status => ["200", "OK"])
     FakeWeb.register_uri(:post, "https://my_app_key2:my_master_secret2@go.urbanairship.com/api/push/", :status => ["400", "Bad Request"])
@@ -485,6 +494,68 @@ shared_examples_for "an Urbanairship client" do
 
   end
 
+  describe "::device_info" do
+    before(:each) do
+      @valid_params = {:alias => 'one'}
+      subject.application_key = "my_app_key"
+      subject.application_secret = "my_app_secret"
+    end
+
+    it "raises an error if call is made without an app key and secret configured" do
+      subject.application_key = nil
+      subject.application_secret = nil
+
+      lambda {
+        subject.device_info("asdf1234")
+      }.should raise_error(RuntimeError, "Must configure application_key, application_secret before making this request.")
+    end
+
+    it "uses app key and secret to sign the request" do
+      subject.device_info("device_token")
+      FakeWeb.last_request['authorization'].should == "Basic #{Base64::encode64('my_app_key:my_app_secret').chomp}"
+    end
+
+    it "takes and sends a device token" do
+      subject.device_info("device_token")
+      FakeWeb.last_request.path.should == "/api/device_tokens/device_token"
+    end
+
+    it "returns false when the authorization is invalid" do
+      subject.application_key = "bad_key"
+      subject.device_info("device_token").success?.should == false
+    end
+
+    it "uses the iOS interface by default" do
+      subject.device_info("device_token")
+      FakeWeb.last_request.path.should == "/api/device_tokens/device_token"
+    end
+
+    it "uses the android interface if 'provider' configuration option is set to :android Symbol" do
+      subject.provider = :android
+      subject.device_info("device_token")
+      FakeWeb.last_request.path.should == "/api/apids/device_token"
+      subject.provider = nil
+    end
+
+    it "uses the android interface if 'provider' configuration option is set to 'android' String" do
+      subject.provider = 'android'
+      subject.device_info("device_token")
+      FakeWeb.last_request.path.should == "/api/apids/device_token"
+      subject.provider = nil
+    end
+
+    it "uses the android interface if :provider Symbol key is passed an :android Symbol value" do
+      subject.device_info("device_token", :provider => :android)
+      FakeWeb.last_request.path.should == "/api/apids/device_token"
+    end
+
+    it "uses the android interface if 'provider' Symbol key is passed an 'android' String value" do
+      subject.device_info("device_token", :provider => "android")
+      FakeWeb.last_request.path.should == "/api/apids/device_token"
+    end
+
+  end
+
   describe "::delete_scheduled_push" do
     before(:each) do
       subject.application_key = "my_app_key"
@@ -561,6 +632,11 @@ shared_examples_for "an Urbanairship client" do
       subject.push(@valid_params).success?.should == false
     end
 
+    it "uses v3 of the API when requested" do
+      subject.push(@valid_params.merge(:version => 3)).success?.should == true
+      FakeWeb.last_request["Accept"].should == "application/vnd.urbanairship+json; version=3;"
+    end
+
     it "adds schedule_for to the JSON payload" do
       time = Time.parse("Oct 17th, 2010, 8:00 PM UTC")
       subject.push(@valid_params.merge(:schedule_for => [time]))
@@ -781,6 +857,42 @@ shared_examples_for "an Urbanairship client" do
     end
   end
 
+  describe "::device_tokens" do
+
+    before(:each) do
+      subject.application_key = "my_app_key"
+      subject.master_secret = "my_master_secret"
+    end
+
+    it "raises an error if call is made without an app key and master secret configured" do
+      subject.application_key = nil
+      subject.master_secret = nil
+
+      lambda {
+        subject.device_tokens_count
+      }.should raise_error(RuntimeError, "Must configure application_key, master_secret before making this request.")
+    end
+
+    it "uses app key and secret to sign the request" do
+      subject.device_tokens_count
+      FakeWeb.last_request['authorization'].should == "Basic #{Base64::encode64('my_app_key:my_master_secret').chomp}"
+    end
+
+    it "returns a hash as response from the Device Token List API with an array of device tokens" do
+      response = subject.device_tokens
+      response["device_tokens"].class.should == Array
+      response["device_tokens_count"].should == 50
+      response["active_device_tokens_count"].should == 55
+    end
+
+    it "success? is false when the call doesn't return 200" do
+      subject.application_key = "my_app_key2"
+      subject.master_secret = "my_master_secret2"
+      subject.device_tokens.success?.should == false
+    end
+
+  end
+
   describe "::device_tokens_count" do
 
     before(:each) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: urbanairship
 version: !ruby/object:Gem::Version
-  version: 2.3.3
+  version: 2.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -76,7 +76,8 @@ files:
 - spec/spec_helper.rb
 - spec/urbanairship_spec.rb
 homepage: http://github.com/groupon/urbanairship
-licenses: []
+licenses:
+- BSD
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -95,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A Ruby wrapper for the Urban Airship API