urbanairship 1.1.1 → 2.0.0

data/README.markdown

@@ -22,13 +22,13 @@ Usage
 Registering a device token
 --------------------------
 ```ruby
-Urbanairship.register_device 'DEVICE-TOKEN' # => true
+Urbanairship.register_device('DEVICE-TOKEN')
 ```
 
 Unregistering a device token
 ----------------------------
 ```ruby
-Urbanairship.unregister_device 'DEVICE-TOKEN' # => true
+Urbanairship.unregister_device('DEVICE-TOKEN')
 ```
 
 Sending a push notification
@@ -40,7 +40,10 @@ notification = {
   :aps => {:alert => 'You have a new message!', :badge => 1}
 }
 
-Urbanairship.push notification # => true
+Urbanairship.push(notification) # =>
+# {
+#   "scheduled_notifications" => ["https://go.urbanairship.com/api/push/scheduled/123456"]
+# }
 ```
 
 Batching push notification sends
@@ -48,7 +51,7 @@ Batching push notification sends
 ```ruby
 notifications = [
   {
-    :schedule_for => [{ :alias => 'deadbeef', :scheduled_time => 1.hour.from_now }],   # assigning an alias to a scheduled push
+    :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}
   },
@@ -59,7 +62,7 @@ notifications = [
   }
 ]
 
-Urbanairship.batch_push notifications # => true
+Urbanairship.batch_push(notifications)
 ```
 
 
@@ -73,7 +76,7 @@ notification = {
   :aps => {:alert => 'Important announcement!', :badge => 1}
 }
 
-Urbanairship.broadcast_push notification # => true
+Urbanairship.broadcast_push(notification)
 ```
 
 Polling the feedback API
@@ -82,7 +85,7 @@ The first time you attempt to send a push notification to a device that has unin
 
 ```ruby
 # find all device tokens deactivated in the past 24 hours
-Urbanairship.feedback 24.hours.ago # =>
+Urbanairship.feedback(24.hours.ago) # =>
 # [
 #   {
 #     "marked_inactive_on"=>"2011-06-03 22:53:23",
@@ -103,7 +106,27 @@ 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") # => true
-Urbanairship.delete_scheduled_push(123456789) # => true
-Urbanairship.delete_scheduled_push(:alias => "deadbeef") # => true
+Urbanairship.delete_scheduled_push("123456789")
+Urbanairship.delete_scheduled_push(123456789)
+Urbanairship.delete_scheduled_push(:alias => "deadbeef")
+```
+
+-----------------------------
+
+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\"}"
 ```

data/lib/urbanairship.rb

@@ -2,6 +2,8 @@ require 'json'
 require 'net/https'
 require 'time'
 
+require File.join(File.dirname(__FILE__), 'urbanairship/response')
+
 module Urbanairship
   begin
     require 'system_timer'
@@ -15,58 +17,39 @@ module Urbanairship
     attr_accessor :application_key, :application_secret, :master_secret, :logger, :request_timeout
 
     def register_device(device_token, options = {})
-      response = do_request(:put, "/api/device_tokens/#{device_token}", :authenticate_with => :application_secret) do |request|
-        request.body = parse_register_options(options).to_json
-        request.add_field "Content-Type", "application/json" unless options.empty?
-      end
-
-      response && %w(200 201).include?(response.code)
+      body = parse_register_options(options).to_json
+      do_request(:put, "/api/device_tokens/#{device_token}", :body => body, :authenticate_with => :application_secret)
     end
 
     def unregister_device(device_token)
-      response = do_request(:delete, "/api/device_tokens/#{device_token}", :authenticate_with => :application_secret)
-      response && response.code == "204"
+      do_request(:delete, "/api/device_tokens/#{device_token}", :authenticate_with => :application_secret)
     end
 
     def delete_scheduled_push(param)
-      path = (param.is_a? Hash) ? "/api/push/scheduled/alias/#{param[:alias].to_s}" : "/api/push/scheduled/#{param.to_s}"
-      response = do_request(:delete, path, :authenticate_with => :master_secret)
-      response && response.code == "204"
+      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 = {})
-      response = do_request(:post, "/api/push/", :authenticate_with => :master_secret) do |request|
-        request.body = parse_push_options(options).to_json
-        request.add_field "Content-Type", "application/json"
-      end
-
-      response && response.code == "200"
+      body = parse_push_options(options).to_json
+      do_request(:post, "/api/push/", :body => body, :authenticate_with => :master_secret)
     end
 
     def batch_push(notifications = [])
-      response = do_request(:post, "/api/push/batch/", :authenticate_with => :master_secret) do |request|
-        request.body = notifications.map{|notification| parse_push_options(notification)}.to_json
-        request.add_field "Content-Type", "application/json"
-      end
-
-      response && response.code == "200"
+      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 = {})
-      response = do_request(:post, "/api/push/broadcast/", :authenticate_with => :master_secret) do |request|
-        request.body = parse_push_options(options).to_json
-        request.add_field "Content-Type", "application/json"
-      end
-
-      response && response.code == "200"
+      body = parse_push_options(options).to_json
+      do_request(:post, "/api/push/broadcast/", :body => body, :authenticate_with => :master_secret)
     end
 
     def feedback(time)
-      response = do_request(:get, "/api/device_tokens/feedback/?since=#{format_time(time)}", :authenticate_with => :master_secret)
-      response && response.code == "200" ? JSON.parse(response.body) : false
+      do_request(:get, "/api/device_tokens/feedback/?since=#{format_time(time)}", :authenticate_with => :master_secret)
     end
 
-  private
+    private
 
     def do_request(http_method, path, options = {})
       verify_configuration_values(:application_key, options[:authenticate_with])
@@ -75,18 +58,18 @@ module Urbanairship
 
       request = klass.new(path)
       request.basic_auth @application_key, instance_variable_get("@#{options[:authenticate_with]}")
-
-      yield(request) if block_given?
+      request.add_field "Content-Type", "application/json"
+      request.body = options[:body] if options[:body]
 
       Timer.timeout(request_timeout) do
         start_time = Time.now
         response = http_client.request(request)
         log_request_and_response(request, response, Time.now - start_time)
-        response
+        Urbanairship::Response.wrap(response)
       end
     rescue Timeout::Error
       logger.error "Urbanairship request timed out after #{request_timeout} seconds: [#{http_method} #{request.path} #{request.body}]"
-      return false
+      Urbanairship::Response.wrap(nil, :body => {:error => 'Request timeout'}, :code => '503')
     end
 
     def verify_configuration_values(*symbols)

data/lib/urbanairship/response.rb

@@ -0,0 +1,33 @@
+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
+          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

@@ -0,0 +1,77 @@
+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

data/spec/spec_helper.rb

@@ -1,4 +1,17 @@
 require 'base64'
 require 'fakeweb'
 
-require File.expand_path(File.dirname(__FILE__) + '/../lib/urbanairship')
+require File.join(File.dirname(__FILE__), '/../lib/urbanairship')
+
+
+RSpec.configure do |config|
+  config.after(:each) do
+    # reset configuration
+    Urbanairship.application_key = nil
+    Urbanairship.application_secret = nil
+    Urbanairship.master_secret = nil
+    Urbanairship.logger = nil
+
+    FakeWeb.instance_variable_set("@last_request", nil)
+  end
+end

data/spec/urbanairship_spec.rb

@@ -35,16 +35,6 @@ describe Urbanairship do
     FakeWeb.register_uri(:get, /my_app_key2\:my_master_secret2\@go\.urbanairship.com\/api\/device_tokens\/feedback/, :status => ["500", "Internal Server Error"])
   end
 
-  after(:each) do
-    # reset configuration
-    Urbanairship.application_key = nil
-    Urbanairship.application_secret = nil
-    Urbanairship.master_secret = nil
-    Urbanairship.logger = nil
-
-    FakeWeb.instance_variable_set("@last_request", nil)
-  end
-
   describe "configuration" do
     it "enables you to configure the application key" do
       Urbanairship.application_key.should be_nil
@@ -92,30 +82,20 @@ describe Urbanairship do
     end
 
     it "returns true when the device is registered for the first time" do
-      Urbanairship.register_device("new_device_token").should == true
+      Urbanairship.register_device("new_device_token").success?.should == true
     end
 
     it "returns true when the device is registered again" do
-      Urbanairship.register_device("existing_device_token").should == true
+      Urbanairship.register_device("existing_device_token").success?.should == true
     end
 
     it "returns false when the authorization is invalid" do
       Urbanairship.application_key = "bad_key"
-      Urbanairship.register_device("new_device_token").should == false
-    end
-
-    it "doesn't set the content-type header to application/json if options are empty" do
-      Urbanairship.register_device("device_token_one")
-      FakeWeb.last_request['content-type'].should_not == 'application/json'
+      Urbanairship.register_device("new_device_token").success?.should == false
     end
 
     it "accepts an alias" do
-      Urbanairship.register_device("device_token_one", @valid_params).should == true
-    end
-
-    it "sets the content-type header to application/json when options are added" do
-      Urbanairship.register_device("device_token_one", @valid_params)
-      FakeWeb.last_request['content-type'].should == 'application/json'
+      Urbanairship.register_device("device_token_one", @valid_params).success?.should == true
     end
 
     it "adds alias to the JSON payload" do
@@ -155,13 +135,13 @@ describe Urbanairship do
     end
 
     it "returns true when the device is successfully unregistered" do
-      Urbanairship.unregister_device("key_to_delete").should == true
+      Urbanairship.unregister_device("key_to_delete").success?.should == true
       FakeWeb.last_request.body.should be_nil
     end
 
     it "returns false when the authorization is invalid" do
       Urbanairship.application_key = "bad_key"
-      Urbanairship.unregister_device("key_to_delete").should == false
+      Urbanairship.unregister_device("key_to_delete").success?.should == false
     end
   end
 
@@ -201,13 +181,13 @@ describe Urbanairship do
     end
 
     it "returns true when the push notification is successfully deleted" do
-      Urbanairship.delete_scheduled_push("123456789").should == true
+      Urbanairship.delete_scheduled_push("123456789").success?.should == true
       FakeWeb.last_request.body.should be_nil
     end
 
     it "returns false when the authorization is invalid" do
       Urbanairship.application_key = "bad_key"
-      Urbanairship.delete_scheduled_push("123456789").should == false
+      Urbanairship.delete_scheduled_push("123456789").success?.should == false
     end
   end
 
@@ -233,17 +213,12 @@ describe Urbanairship do
     end
 
     it "returns true when it successfully pushes a notification" do
-      Urbanairship.push(@valid_params).should == true
+      Urbanairship.push(@valid_params).success?.should == true
     end
 
     it "returns false when the authorization is invalid" do
       Urbanairship.application_key = "bad_key"
-      Urbanairship.push(@valid_params).should == false
-    end
-
-    it "sets the content-type header to application/json" do
-      Urbanairship.push(@valid_params)
-      FakeWeb.last_request['content-type'].should == 'application/json'
+      Urbanairship.push(@valid_params).success?.should == false
     end
 
     it "adds schedule_for to the JSON payload" do
@@ -260,7 +235,7 @@ describe Urbanairship do
     it "returns false if urbanairship responds with a non-200 response" do
       Urbanairship.application_key = "my_app_key2"
       Urbanairship.master_secret = "my_master_secret2"
-      Urbanairship.push.should == false
+      Urbanairship.push.success?.should == false
     end
   end
 
@@ -289,17 +264,12 @@ describe Urbanairship do
     end
 
     it "returns true when it successfully pushes a notification" do
-      Urbanairship.batch_push(@valid_params).should == true
+      Urbanairship.batch_push(@valid_params).success?.should == true
     end
 
     it "returns false when the authorization is invalid" do
       Urbanairship.application_key = "bad_key"
-      Urbanairship.batch_push(@valid_params).should == false
-    end
-
-    it "sets the content-type header to application/json" do
-      Urbanairship.batch_push(@valid_params)
-      FakeWeb.last_request['content-type'].should == 'application/json'
+      Urbanairship.batch_push(@valid_params).success?.should == false
     end
 
     it "adds schedule_for to the JSON payload" do
@@ -318,7 +288,7 @@ describe Urbanairship do
     it "returns false if urbanairship responds with a non-200 response" do
       Urbanairship.application_key = "my_app_key2"
       Urbanairship.master_secret = "my_master_secret2"
-      Urbanairship.batch_push.should == false
+      Urbanairship.batch_push.success?.should == false
     end
   end
 
@@ -344,17 +314,12 @@ describe Urbanairship do
     end
 
     it "returns true when it successfully pushes a notification" do
-      Urbanairship.broadcast_push(@valid_params).should == true
+      Urbanairship.broadcast_push(@valid_params).success?.should == true
     end
 
     it "returns false when the authorization is invalid" do
       Urbanairship.application_key = "bad_key"
-      Urbanairship.broadcast_push(@valid_params).should == false
-    end
-
-    it "sets the content-type header to application/json" do
-      Urbanairship.broadcast_push(@valid_params)
-      FakeWeb.last_request['content-type'].should == 'application/json'
+      Urbanairship.broadcast_push(@valid_params).success?.should == false
     end
 
     it "adds schedule_for to the JSON payload" do
@@ -373,7 +338,7 @@ describe Urbanairship do
     it "returns false if urbanairship responds with a non-200 response" do
       Urbanairship.application_key = "my_app_key2"
       Urbanairship.master_secret = "my_master_secret2"
-      Urbanairship.broadcast_push.should == false
+      Urbanairship.broadcast_push.success?.should == false
     end
   end
 
@@ -411,17 +376,15 @@ describe Urbanairship do
 
     it "returns an array of responses from the feedback API" do
       response = Urbanairship.feedback(Time.now)
-      response.class.should == Array
-      response[0].keys.should include("device_token")
-      response[0].keys.should include("marked_inactive_on")
-      response[0].keys.should include("alias")
+      response[0].should include("device_token")
+      response[0].should include("marked_inactive_on")
+      response[0].should include("alias")
     end
 
-    it "returns false and doesn't parse JSON when the call doesn't return 200" do
+    it "success? is false when the call doesn't return 200" do
       Urbanairship.application_key = "my_app_key2"
       Urbanairship.master_secret = "my_master_secret2"
-      JSON.should_not_receive(:parse)
-      Urbanairship.feedback(Time.now).should == false
+      Urbanairship.feedback(Time.now).success?.should == false
     end
   end
 

metadata

@@ -1,87 +1,120 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: urbanairship
-version: !ruby/object:Gem::Version
-  version: 1.1.1
+version: !ruby/object:Gem::Version 
+  hash: 15
   prerelease: 
+  segments: 
+  - 2
+  - 0
+  - 0
+  version: 2.0.0
 platform: ruby
-authors:
+authors: 
 - Groupon, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-13 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-02-17 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: json
-  requirement: &70262001444660 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *70262001444660
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: rspec
-  requirement: &70262001443460 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *70262001443460
-- !ruby/object:Gem::Dependency
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: fakeweb
-  requirement: &70262001442040 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *70262001442040
-description: Urbanairship is a Ruby library for interacting with the Urban Airship
-  (http://urbanairship.com) API.
-email:
+  version_requirements: *id003
+description: Urbanairship is a Ruby library for interacting with the Urban Airship (http://urbanairship.com) API.
+email: 
 - rubygems@groupon.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - README.markdown
 - LICENSE
 - Rakefile
+- lib/urbanairship/response.rb
 - lib/urbanairship.rb
+- spec/response_spec.rb
 - spec/spec_helper.rb
 - spec/urbanairship_spec.rb
+has_rdoc: true
 homepage: http://github.com/groupon/urbanairship
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 59
+      segments: 
+      - 1
+      - 8
+      - 6
       version: 1.8.6
-required_rubygems_version: !ruby/object:Gem::Requirement
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: A Ruby wrapper for the Urban Airship API
-test_files:
+test_files: 
+- spec/response_spec.rb
 - spec/spec_helper.rb
 - spec/urbanairship_spec.rb