customerio 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 142c5aa6d5043fbf69018fc678fc335552c46d65
-  data.tar.gz: 15c5da49d590ac52cbc500d24e9a31b243937092
+  metadata.gz: 977087d789ae0127e8eef651a1546f88db71f3ce
+  data.tar.gz: 49fa6e8a7bf05b10c5c1c1390efcb9d21381a45b
 SHA512:
-  metadata.gz: c612f66e9ba819f88f04659b7ea243d98c4c57e6f6733bee94ca71e85dcd7d2d5b4ecd8458623d4ad3cafa857587e47b17e74977dee302fccb2a3c879d5a53db
-  data.tar.gz: db90752181238ad8626b2a723ae1f74230abbc6a458f39802ee25b21ac2933c653bddf2138b261e7e65b8ecb17d341d7a8234093497421a8c0b30dc811a9c0b2
+  metadata.gz: 84ac7dfbc050d453a25c01e66abb5262b906c73420cebad93c624221d1abf3ff0048aca072e31b2f30ec039bb86b441248ade79821973a8ec0e8dbd57511c11e
+  data.tar.gz: 8abcb4cfa1ba074d8c28d1f2fda6668175e13e49d8133c352a51641938b297cfcd73f39e05658650a3d5763758ff60b6355dbb1cdfc440de5753b471fc4621fa

data/CHANGELOG.markdown

@@ -1,3 +1,7 @@
+## Customerio 2.2.0 - Oct 18, 2018 ##
+
+Add support for manual segments [#52](https://github.com/customerio/customerio-ruby/pull/52)
+
 ## Customerio 2.1.0 - May 22, 2018 ##
 
 Added support for the suppress / unsuppress methods [#49](https://github.com/customerio/customerio-ruby/pull/49)

data/README.md

@@ -167,6 +167,38 @@ Deleting a device token will remove it from the associated customer to stop furt
 $customerio.delete_device(5, "my_device_token")
 ```
 
+### Suppress a user
+
+Deletes the customer with the provided id if it exists and suppresses all future events and identifies for for that customer.
+
+```ruby
+$customerio.suppress(5)
+```
+
+### Unsuppress a user
+
+Start tracking events and identifies again for a previously suppressed customer. Note when a user is suppressed thier history is deleted and unsupressing them wil not recover that history.
+
+```ruby
+$customerio.unsuppress(5)
+```
+
+### Add customers to a manual segment
+
+Add the list of customer ids to the specified manual segment. If you send customer ids that don't exist yet in an add_to_segment request, we will automatically create customer profiles for the new customer ids.
+
+```ruby
+$customerio.add_to_segment(segment_id=1,customer_ids=['1','2','3'])
+```
+
+### Remove customers from a manual segment
+
+Remove the list of customer ids from the specified manual segment.
+
+```ruby
+$customerio.remove_from_segment(segment_id=1,customer_ids=['1','2','3'])
+```
+
 ## Contributing
 
 1. Fork it

data/lib/customerio/client.rb

@@ -88,8 +88,38 @@ module Customerio
       verify_response(request(:delete, device_id_path(customer_id, device_id)))
     end
 
+    def add_to_segment(segment_id, customer_ids)
+      raise ParamError.new("segment_id must be an integer") unless segment_id.is_a? Integer
+      raise ParamError.new("customer_ids must be a list of values") unless customer_ids.is_a? Array
+
+      customer_ids = customer_ids.map{ |id| id.to_s }
+
+      verify_response(request(:post, add_to_segment_path(segment_id), {
+        :ids => customer_ids,
+      }))
+    end
+
+    def remove_from_segment(segment_id, customer_ids)
+      raise ParamError.new("segment_id must be an integer") unless segment_id.is_a? Integer
+      raise ParamError.new("customer_ids must be a list of values") unless customer_ids.is_a? Array
+
+      customer_ids = customer_ids.map{ |id| id.to_s }
+      
+      verify_response(request(:post, remove_from_segment_path(segment_id), {
+        :ids => customer_ids,
+      }))
+    end
+
     private
 
+    def add_to_segment_path(segment_id)
+      "/api/v1/segments/#{segment_id}/add_customers"
+    end
+
+    def remove_from_segment_path(segment_id)
+      "/api/v1/segments/#{segment_id}/remove_customers"
+    end
+
     def device_path(customer_id)
       "/api/v1/customers/#{customer_id}/devices"
     end

data/lib/customerio/version.rb

@@ -1,3 +1,3 @@
 module Customerio
-  VERSION = "2.1.0"
+  VERSION = "2.2.0"
 end

data/spec/client_spec.rb

@@ -436,4 +436,50 @@ describe Customerio::Client do
        lambda { client.delete_device(5, nil) }.should raise_error(Customerio::Client::ParamError)
     end
   end
+
+  describe "#manual_segments" do
+
+    client = Customerio::Client.new("SITE_ID", "API_KEY", :json=>true)
+
+    it "allows adding customers to a manual segment" do
+      stub_request(:post, api_uri('/api/v1/segments/1/add_customers')).to_return(:status => 200, :body => "", :headers => {})
+
+      client.add_to_segment(1, ["customer1", "customer2", "customer3"])
+    end
+    it "requires a valid segment id when adding customers" do
+      stub_request(:post, api_uri('/api/v1/segments/1/add_customers')).to_return(:status => 200, :body => "", :headers => {})
+
+      lambda { client.add_to_segment("not_valid", ["customer1", "customer2", "customer3"]).should raise_error(Customerio::Client::ParamError) }
+    end
+    it "requires a valid customer list when adding customers" do
+      stub_request(:post, api_uri('/api/v1/segments/1/add_customers')).to_return(:status => 200, :body => "", :headers => {})
+
+      lambda { client.add_to_segment(1, "not_valid").should raise_error(Customerio::Client::ParamError) }
+    end
+    it "coerces non-string values to strings when adding customers" do
+      stub_request(:post, api_uri('/api/v1/segments/1/add_customers')).with(:body=>json({:ids=>["1", "2", "3"]})).to_return(:status => 200, :body => "", :headers => {})
+
+      client.add_to_segment(1, [1, 2, 3])
+    end
+    it "allows removing customers from a manual segment" do
+      stub_request(:post, api_uri('/api/v1/segments/1/remove_customers')).to_return(:status => 200, :body => "", :headers => {})
+
+      client.remove_from_segment(1, ["customer1", "customer2", "customer3"])
+    end
+    it "requires a valid segment id when removing customers" do
+      stub_request(:post, api_uri('/api/v1/segments/1/remove_customers')).to_return(:status => 200, :body => "", :headers => {})
+
+      lambda { client.remove_from_segment("not_valid", ["customer1", "customer2", "customer3"]).should raise_error(Customerio::Client::ParamError) }
+    end
+    it "requires a valid customer list when removing customers" do
+      stub_request(:post, api_uri('/api/v1/segments/1/remove_customers')).to_return(:status => 200, :body => "", :headers => {})
+
+      lambda { client.remove_from_segment(1, "not_valid").should raise_error(Customerio::Client::ParamError) }
+    end
+    it "coerces non-string values to strings when removing customers" do
+      stub_request(:post, api_uri('/api/v1/segments/1/remove_customers')).with(:body=>json({:ids=>["1", "2", "3"]})).to_return(:status => 200, :body => "", :headers => {})
+
+      client.remove_from_segment(1, [1, 2, 3])
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: customerio
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - John Allison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-22 00:00:00.000000000 Z
+date: 2018-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -141,3 +141,4 @@ summary: A ruby client for the Customer.io event API.
 test_files:
 - spec/client_spec.rb
 - spec/spec_helper.rb
+has_rdoc: