urbanairship 2.2.3 → 2.2.4

data/README.markdown

@@ -47,6 +47,20 @@ notification = {
   :aps => {:alert => 'You have a new message!', :badge => 1}
 }
 
+Urbanairship.push(notification) # =>
+# {
+#   "scheduled_notifications" => ["https://go.urbanairship.com/api/push/scheduled/123456"]
+# }
+```
+### 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"]
@@ -72,27 +86,6 @@ notifications = [
 Urbanairship.batch_push(notifications)
 ```
 
-Sending notifications to a segment
----------------------------
-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)
-```
-
 Sending broadcast notifications
 -------------------------------
 Urban Airship allows you to send a broadcast notification to all active registered device tokens for your app.
@@ -138,6 +131,43 @@ 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)
+```
+
+### Listing your segments ###
+
+```ruby
+Urbanairship.segments # =>
+# {
+#   "segments" => [
+#     {
+#      "id" => "abcd-efgh-ijkl",
+#      "display_name" => "segment1",
+#      "creation_date" => 1360950614201,
+#      "modification_date" => 1360950614201
+#     }
+#   ]
+# }
+```
+
 Getting a count of your device tokens
 -------------------------------------
 ```ruby

data/lib/urbanairship.rb

@@ -67,6 +67,10 @@ module Urbanairship
       do_request(:get, "/api/tags/", :authenticate_with => :master_secret)
     end
 
+    def segments
+      do_request(:get, "/api/segments", :authenticate_with => :master_secret)
+    end
+
     def add_tag(tag)
       do_request(:put, "/api/tags/#{tag}", :authenticate_with => :master_secret, :content_type => 'text/plain')
     end

data/spec/urbanairship_spec.rb

@@ -67,6 +67,10 @@ shared_examples_for "an Urbanairship client" do
     FakeWeb.register_uri(:delete, /my_app_key\:my_master_secret\@go\.urbanairship.com\/api\/device_tokens\/valid_device_token\/tags\/non_existant_tag/, :status => ["404", "OK"])
     FakeWeb.register_uri(:delete, /my_app_key2\:my_master_secret2\@go\.urbanairship.com\/api\/device_tokens\/a_device_token\/tags\/a_tag/, :status => ["500", "Internal Server Error"])
 
+		#Segments
+		FakeWeb.register_uri(:get, /my_app_key\:my_master_secret\@go\.urbanairship.com\/api\/segments/, :status => ["200", "OK"], :body => '{"segments":[{"id":"abcd-efgh-ijkl", "display_name":"test1", "creation_date":1360950614201, "modification_date":1360950614201}, {"id": "mnop-qrst-uvwx", "display_name": "test2", "creation_date":1360950614202, "modification_date":1360950614202}]}')
+    FakeWeb.register_uri(:get, /my_app_key2\:my_master_secret2\@go\.urbanairship.com\/api\/segments/, :status => ["500", "Internal Server Error"])
+
     # push to segment
     FakeWeb.register_uri(:post, "https://my_app_key:my_master_secret@go.urbanairship.com/api/push/segments", :status => ["200", "OK"])
     FakeWeb.register_uri(:post, "https://my_app_key2:my_master_secret2@go.urbanairship.com/api/push/segments", :status => ["400", "Bad Request"])
@@ -763,6 +767,45 @@ shared_examples_for "an Urbanairship client" do
 
   end
 
+  describe "::segments" 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.segments
+      }.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.segments
+      FakeWeb.last_request['authorization'].should == "Basic #{Base64::encode64('my_app_key:my_master_secret').chomp}"
+    end
+
+    it "returns valid segments" do
+      response = subject.segments
+      response.first.should include("segments")
+      response["segments"].each do |s| 
+        ["id", "display_name", "creation_date", "modification_date"].each do |k|
+          s.should include(k)
+        end
+      end	
+    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.segments.success?.should == false
+    end
+
+  end
+
+
   describe "logging" do
 
     before(:each) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: urbanairship
 version: !ruby/object:Gem::Version
-  version: 2.2.3
+  version: 2.2.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-31 00:00:00.000000000 Z
+date: 2013-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json