urbanairship 2.2.4 → 2.3.0

data/README.markdown

@@ -152,6 +152,14 @@ notification = {
 Urbanairship.push_to_segment(notification)
 ```
 
+### Creating a segment ###
+``` ruby
+Urbanairship.create_segment({
+  :display_name => 'segment1',
+  :criteria => {:and => [{:tag => 'one'}, {:tag => 'two'}]}
+}) # => {}
+```
+
 ### Listing your segments ###
 
 ```ruby
@@ -166,6 +174,28 @@ Urbanairship.segments # =>
 #     }
 #   ]
 # }
+
+Urbanairship.segment("abcd-efgh-ijkl") # =>
+# {
+#  "id" => "abcd-efgh-ijkl",
+#  "display_name" => "segment1",
+#  "creation_date" => 1360950614201,
+#  "modification_date" => 1360950614201
+# }
+```
+
+### Modifying a segment ###
+Note that you must provide both the display name and criteria when updating a segment, even if you are only changing one or the other.
+``` ruby
+Urbanairship.update_segment({
+  :display_name => 'segment1',
+  :criteria => {:and => [{:tag => 'asdf'}]}
+}) # => {}
+```
+
+### Deleting a segment ###
+```ruby
+Urbanairship.delete_segment("abcd-efgh-ijkl") # => {}
 ```
 
 Getting a count of your device tokens

data/lib/urbanairship.rb

@@ -67,10 +67,6 @@ 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
@@ -95,6 +91,26 @@ module Urbanairship
       do_request(:get, "/api/device_tokens/count/", :authenticate_with => :master_secret)
     end
 
+    def segments
+      do_request(:get, "/api/segments", :authenticate_with => :master_secret)
+    end
+
+    def create_segment(segment)
+      do_request(:post, "/api/segments", :body => segment.to_json, :authenticate_with => :master_secret)
+    end
+
+    def segment(id)
+      do_request(:get, "/api/segments/#{id}", :authenticate_with => :master_secret)
+    end
+
+    def update_segment(id, segment)
+      do_request(:put, "/api/segments/#{id}", :body => segment.to_json, :authenticate_with => :master_secret)
+    end
+
+    def delete_segment(id)
+      do_request(:delete, "/api/segments/#{id}", :authenticate_with => :master_secret)
+    end
+
     private
 
     def do_request(http_method, path, options = {})

data/spec/urbanairship_spec.rb

@@ -67,9 +67,28 @@ 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"])
+    #Get Segment
+    FakeWeb.register_uri(:get, /my_app_key\:my_master_secret\@go\.urbanairship.com\/api\/segments\/valid_id/, :status => ["200", "OK"], :body => '{"display_name":"Male in NY", "criteria":{"and":[{"tag":"male"}, {"tag":"in NY"}]}}')
+    FakeWeb.register_uri(:get, /my_app_key\:my_master_secret\@go\.urbanairship.com\/api\/segments\/not_found/, :status => ["404", "OK"])
+    FakeWeb.register_uri(:get, /my_app_key2\:my_master_secret2\@go\.urbanairship.com\/api\/segments\/invalid_segment/, :status => ["500", "Internal Server Error"])
+
+    #Get List of 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"])
+
+    #Create Segment
+    FakeWeb.register_uri(:post, /my_app_key\:my_master_secret\@go\.urbanairship.com\/api\/segments/, :status => ["201", "OK"])
+    FakeWeb.register_uri(:post, /my_app_key2\:my_master_secret2\@go\.urbanairship.com\/api\/segments/, :status => ["500", "Internal Server Error"])
+
+    #Update Segment
+    FakeWeb.register_uri(:put, /my_app_key\:my_master_secret\@go\.urbanairship.com\/api\/segments\/valid_segment/, :status => ["200", "OK"])
+    FakeWeb.register_uri(:put, /my_app_key\:my_master_secret\@go\.urbanairship.com\/api\/segments\/invalid_segment/, :status => ["404", "OK"])
+    FakeWeb.register_uri(:put, /my_app_key2\:my_master_secret2\@go\.urbanairship.com\/api\/segments\/a_segment/, :status => ["500", "Internal Server Error"])
+
+    #Delete Segment
+    FakeWeb.register_uri(:delete, /my_app_key\:my_master_secret\@go\.urbanairship.com\/api\/segments\/valid_segment/, :status => ["204", "OK"])
+    FakeWeb.register_uri(:delete, /my_app_key\:my_master_secret\@go\.urbanairship.com\/api\/segments\/invalid_segment/, :status => ["404", "OK"])
+    FakeWeb.register_uri(:delete, /my_app_key2\:my_master_secret2\@go\.urbanairship.com\/api\/segments\/a_segment/, :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"])
@@ -771,6 +790,7 @@ shared_examples_for "an Urbanairship client" do
     before(:each) do
       subject.application_key = "my_app_key"
       subject.master_secret = "my_master_secret"
+      @valid_segment = {:display_name => "Test Male NY", :criteria => {:and => [ {:tag => "male"}, {:tag => "NY"}]} }
     end
 
     it "raises an error if call is made without an app key and master secret configured" do
@@ -790,11 +810,48 @@ shared_examples_for "an Urbanairship client" do
     it "returns valid segments" do
       response = subject.segments
       response.first.should include("segments")
-      response["segments"].each do |s| 
+      response["segments"].each do |s|
         ["id", "display_name", "creation_date", "modification_date"].each do |k|
           s.should include(k)
         end
-      end	
+      end
+    end
+
+    it "can create a valid segment" do
+      response = subject.create_segment(@valid_segment)
+      response.code.should == "201"
+    end
+
+    it "can get a segment given its id" do
+      response = subject.segment("valid_id")
+      response.code.should == "200"
+      response.should include("display_name")
+      response.should include("criteria")
+    end
+
+    it "returns not found if invalid segment id is given" do
+      response = subject.segment("not_found")
+      response.code.should == "404"
+    end
+
+    it "can update a segment given a valid id" do
+      response = subject.update_segment("valid_segment", @valid_segment)
+      response.code.should == "200"
+    end
+
+    it "cant update a segment when given an invalid id" do
+      response = subject.update_segment("invalid_segment", @valid_segment)
+      response.code.should == "404"
+    end
+
+    it "can delete a segment given a valid id" do
+      response = subject.delete_segment("valid_segment")
+      response.code.should == "204"
+    end
+
+    it "cant delete a segment given an invalid id" do
+      response = subject.delete_segment("invalid_segment")
+      response.code.should == "404"
     end
 
     it "success? is false when the call doesn't return 200" do

metadata

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