urbanairship 1.0.1 → 1.0.2

data/README.markdown

@@ -4,6 +4,8 @@ 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
@@ -60,6 +62,19 @@ notifications = [
 Urbanairship.batch_push notifications # => true
 ```
 
+Sending broadcoast 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,
+  :aps => {:alert => 'Important announcement!', :badge => 1}
+}
+
+Urbanairship.broadcast_push notification # => true
+```
+
 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 Urbanairship will register that token in their feedback API. Urbanairship will prevent further attempted notification sends to that device, but it's a good practice to periodically poll Urbanairship's feedback API and mark those tokens as inactive in your own system as well.

data/lib/urbanairship.rb

@@ -44,6 +44,15 @@ module Urbanairship
       response && response.code == "200"
     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"
+    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

data/spec/urbanairship_spec.rb

@@ -21,6 +21,10 @@ describe Urbanairship do
     FakeWeb.register_uri(:post, "https://my_app_key:my_master_secret@go.urbanairship.com/api/push/batch/", :status => ["200", "OK"])
     FakeWeb.register_uri(:post, "https://my_app_key2:my_master_secret2@go.urbanairship.com/api/push/batch/", :status => ["400", "Bad Request"])
 
+    # broadcast push
+    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"])
+
     # 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"])
@@ -320,6 +324,93 @@ describe Urbanairship do
 
   end
 
+  describe "sending broadcast push notifications" do
+
+    before(:each) do
+      @valid_params = {:aps => {:alert => 'foo'}}
+      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.broadcast_push(@valid_params)
+      }.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.broadcast_push(@valid_params)
+      FakeWeb.last_request['authorization'].should == "Basic #{Base64::encode64('my_app_key:my_master_secret').chomp}"
+    end
+
+    it "returns true when it successfully pushes a notification" do
+      Urbanairship.broadcast_push(@valid_params).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'
+    end
+
+    it "adds aliases to the JSON payload" do
+      @valid_params[:aliases] = ["one", "two"]
+      Urbanairship.broadcast_push(@valid_params)
+      request_json['aliases'].should == ["one", "two"]
+    end
+
+    it "adds tags to the JSON payload" do
+      @valid_params[:tags] = ["one", "two"]
+      Urbanairship.broadcast_push(@valid_params)
+      request_json['tags'].should == ["one", "two"]
+    end
+
+    it "adds schedule_for to the JSON payload" do
+      time = Time.parse("Oct 17th, 2010, 8:00 PM UTC")
+      @valid_params[:schedule_for] = [time]
+      Urbanairship.broadcast_push(@valid_params)
+      request_json['schedule_for'].should == ['2010-10-17T20:00:00Z']
+    end
+
+    it "accepts strings as schedule_for values" do
+      @valid_params[:schedule_for] = ["2010-10-10 09:09:09 UTC"]
+      Urbanairship.broadcast_push(@valid_params)
+      request_json['schedule_for'].should == ['2010-10-10T09:09:09Z']
+    end
+
+    it "adds exclude_tokens to the JSON payload" do
+      @valid_params[:exclude_tokens] = ["one", "two"]
+      Urbanairship.broadcast_push(@valid_params)
+      request_json['exclude_tokens'].should == ["one", "two"]
+    end
+
+    it "adds aps parameters to the JSON payload" do
+      @valid_params[:aps] = {:badge => 10, :alert => "Hi!", :sound => "cat.caf"}
+      Urbanairship.broadcast_push(@valid_params)
+      request_json['aps'].should == {'badge' => 10, 'alert' => 'Hi!', 'sound' => 'cat.caf'}
+    end
+
+    it "excludes invalid parameters from the JSON payload" do
+      @valid_params[:foo] = 'bar'
+      Urbanairship.broadcast_push(@valid_params)
+      request_json['foo'].should be_nil
+    end
+
+    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
+    end
+
+  end
+
   describe "feedback service" do
 
     before(:each) do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: urbanairship
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 1
   - 0
-  - 1
-  version: 1.0.1
+  - 2
+  version: 1.0.2
 platform: ruby
 authors: 
 - Groupon, Inc.
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-04 00:00:00 -05:00
+date: 2011-07-14 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -108,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.0
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: A Ruby wrapper for the Urbanairship API