urbanairship 1.0.2 → 1.0.3

data/README.markdown

@@ -35,7 +35,7 @@ Sending a push notification
 ---------------------------
 ```ruby
 notification = {
-  :schedule_for => 1.hour.from_now,
+  :schedule_for => [1.hour.from_now],
   :device_tokens => ['DEVICE-TOKEN-ONE', 'DEVICE-TOKEN-TWO'],
   :aps => {:alert => 'You have a new message!', :badge => 1}
 }
@@ -48,12 +48,12 @@ Batching push notification sends
 ```ruby
 notifications = [
   {
-    :schedule_for => 1.hour.from_now,
+    :schedule_for => [{ :alias => 'deadbeef', :scheduled_time => 1.hour.from_now }],   # assigning an alias to a scheduled push
     :device_tokens => ['DEVICE-TOKEN-ONE', 'DEVICE-TOKEN-TWO'],
     :aps => {:alert => 'You have a new message!', :badge => 1}
   },
   {
-    :schedule_for => 3.hours.from_now,
+    :schedule_for => [3.hours.from_now],
     :device_tokens => ['DEVICE-TOKEN-THREE'],
     :aps => {:alert => 'You have a new message!', :badge => 1}
   }
@@ -62,13 +62,14 @@ notifications = [
 Urbanairship.batch_push notifications # => true
 ```
 
-Sending broadcoast notifications
---------------------------------
+
+Sending broadcast notifications
+-------------------------------
 Urbanairship allows you to send a broadcast notification to all active registered device tokens for your app.
 
 ```ruby
 notification = {
-  :schedule_for => 1.hour.from_now,
+  :schedule_for => [1.hour.from_now],
   :aps => {:alert => 'Important announcement!', :badge => 1}
 }
 
@@ -95,3 +96,14 @@ Urbanairship.feedback 24.hours.ago # =>
 #   }
 # ]
 ```
+
+Deleting scheduled notifications
+--------------------------------
+
+If you know the alias or id of a scheduled push notification then you can delete it from Urbanairship'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
+```

data/lib/urbanairship.rb

@@ -12,12 +12,17 @@ module Urbanairship
   end
 
   VALID_PUSH_PARAMS = %w(device_tokens aliases tags schedule_for exclude_tokens aps)
+  VALID_REGISTER_PARAMS = %w(alias)
 
   class << self
     attr_accessor :application_key, :application_secret, :master_secret, :logger, :request_timeout
 
-    def register_device(device_token)
-      response = do_request(:put, "/api/device_tokens/#{device_token}", :authenticate_with => :application_secret)
+    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)
     end
 
@@ -26,6 +31,12 @@ module Urbanairship
       response && response.code == "204"
     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"
+    end
+
     def push(options = {})
       response = do_request(:post, "/api/push/", :authenticate_with => :master_secret) do |request|
         request.body = parse_push_options(options).to_json
@@ -90,8 +101,13 @@ module Urbanairship
       Net::HTTP.new("go.urbanairship.com", 443).tap{|http| http.use_ssl = true}
     end
 
+    def parse_register_options(hash = {})
+      hash[:alias] = hash[:alias].to_s unless hash[:alias].nil?
+      hash.delete_if{|key, value| !VALID_REGISTER_PARAMS.include?(key.to_s)}
+    end
+
     def parse_push_options(hash = {})
-      hash[:schedule_for] = hash[:schedule_for].map{|time| format_time(time)} unless hash[:schedule_for].nil?
+      hash[:schedule_for] = hash[:schedule_for].map{|elem| process_scheduled_elem(elem)} unless hash[:schedule_for].nil?
       hash.delete_if{|key, value| !VALID_PUSH_PARAMS.include?(key.to_s)}
     end
 
@@ -109,6 +125,14 @@ module Urbanairship
       time.utc.strftime("%Y-%m-%dT%H:%M:%SZ")
     end
 
+    def process_scheduled_elem(elem)
+      if elem.class == Hash
+        elem.merge!(:scheduled_time => format_time(elem[:scheduled_time]))
+      else
+        format_time(elem)
+      end
+    end
+
     def request_timeout
       @request_timeout || 5.0
     end

data/spec/urbanairship_spec.rb

@@ -6,6 +6,7 @@ describe Urbanairship do
     # register_device
     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, "https://my_app_key:my_app_secret@go.urbanairship.com/api/device_tokens/existing_device_token", :status => ["200", "OK"])
+    FakeWeb.register_uri(:put, "https://my_app_key:my_app_secret@go.urbanairship.com/api/device_tokens/device_token_one", :status => ["201", "Created"])
     FakeWeb.register_uri(:put, /bad_key\:my_app_secret\@go\.urbanairship\.com/, :status => ["401", "Unauthorized"])
 
     # unregister_device
@@ -25,6 +26,11 @@ describe Urbanairship do
     FakeWeb.register_uri(:post, "https://my_app_key:my_master_secret@go.urbanairship.com/api/push/broadcast/", :status => ["200", "OK"])
     FakeWeb.register_uri(:post, "https://my_app_key2:my_master_secret2@go.urbanairship.com/api/push/broadcast/", :status => ["400", "Bad Request"])
 
+    # delete_scheduled_push
+    FakeWeb.register_uri(:delete, /my_app_key\:my_master_secret\@go\.urbanairship.com\/api\/push\/scheduled\/[0-9]+/, :status => ["204", "No Content"])
+    FakeWeb.register_uri(:delete, /my_app_key\:my_master_secret\@go\.urbanairship.com\/api\/push\/scheduled\/alias\/.+/, :status => ["204", "No Content"])
+    FakeWeb.register_uri(:delete, /bad_key\:my_master_secret\@go\.urbanairship.com\/api\/push\/scheduled\/[0-9]+/, :status => ["401", "Unauthorized"])
+
     # feedback
     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\"}]")
     FakeWeb.register_uri(:get, /my_app_key2\:my_master_secret2\@go\.urbanairship.com\/api\/device_tokens\/feedback/, :status => ["500", "Internal Server Error"])
@@ -65,6 +71,7 @@ describe Urbanairship do
   describe "registering a device" do
 
     before(:each) do
+      @valid_params = {:alias => 'one'}
       Urbanairship.application_key = "my_app_key"
       Urbanairship.application_secret = "my_app_secret"
     end
@@ -101,8 +108,35 @@ describe Urbanairship do
       Urbanairship.register_device("new_device_token").should == false
     end
 
-    # TODO:
-    # it "accepts additional parameters (EXPAND THIS)"
+    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'
+    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'
+    end
+
+    it "adds alias to the JSON payload" do
+      Urbanairship.register_device("device_token_one", @valid_params)
+      request_json['alias'].should == "one"
+    end
+
+    it "converts alias param to string" do
+      Urbanairship.register_device("device_token_one", :alias => 11)
+      request_json['alias'].should be_a_kind_of String
+    end
+
+    it "excludes invalid parameters from the JSON payload" do
+      @valid_params.merge!(:foo => 'bar')
+      Urbanairship.register_device("device_token_one", @valid_params)
+      request_json['foo'].should be_nil
+    end
 
   end
 
@@ -143,6 +177,53 @@ describe Urbanairship do
 
   end
 
+  describe "deleting a scheduled push notification" do
+    before(:each) do
+      Urbanairship.application_key = "my_app_key"
+      Urbanairship.master_secret = "my_master_secret"
+    end
+
+    it "raises an error if call is made without an app key and master secret configured" do
+      Urbanairship.application_key = nil
+      Urbanairship.master_secret = nil
+
+      lambda {
+        Urbanairship.delete_scheduled_push("123456789")
+      }.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
+      Urbanairship.delete_scheduled_push("123456789")
+      FakeWeb.last_request['authorization'].should == "Basic #{Base64::encode64('my_app_key:my_master_secret').chomp}"
+    end
+
+    it "sends the key that needs to be deleted" do
+      Urbanairship.delete_scheduled_push("123456789")
+      FakeWeb.last_request.path.should == "/api/push/scheduled/123456789"
+    end
+
+    it "sends the key that needs to be deleted" do
+      Urbanairship.delete_scheduled_push(123456789)
+      FakeWeb.last_request.path.should == "/api/push/scheduled/123456789"
+    end
+
+    it "sends the alias that needs to be deleted" do
+      Urbanairship.delete_scheduled_push(:alias => "alias_to_delete")
+      FakeWeb.last_request.path.should == "/api/push/scheduled/alias/alias_to_delete"
+    end
+
+    it "returns true when the push notification is successfully deleted" do
+      Urbanairship.delete_scheduled_push("123456789").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
+    end
+
+  end
+
   describe "sending multiple push notifications" do
 
     before(:each) do
@@ -205,6 +286,13 @@ describe Urbanairship do
       request_json['schedule_for'].should == ['2010-10-10T09:09:09Z']
     end
 
+    it "adds an aliased schedule_for to the JSON payload" do
+      time = Time.parse("Oct 17th, 2010, 8:00 PM UTC")
+      alias_str = 'cafebabe'
+      Urbanairship.push(@valid_params.merge(:schedule_for => [{ :alias => alias_str, :scheduled_time => time }]))
+      request_json['schedule_for'].should == [{ 'alias' => alias_str, 'scheduled_time' => '2010-10-17T20:00:00Z' }]
+    end
+
     it "adds exclude_tokens to the JSON payload" do
       Urbanairship.push(@valid_params.merge(:exclude_tokens => ["one", "two"]))
       request_json['exclude_tokens'].should == ["one", "two"]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: urbanairship
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 1
   - 0
-  - 2
-  version: 1.0.2
+  - 3
+  version: 1.0.3
 platform: ruby
 authors: 
 - Groupon, Inc.
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-14 00:00:00 -05:00
+date: 2011-11-14 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency