customerio 4.0.1 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbff37c21ea57a934d671356e89ef06114170d0b753c91048c255b399ce146de
-  data.tar.gz: 1d225801d24005870b63aa2f95850b47cef6ef822f7f3132ea9b7378cffaa852
+  metadata.gz: b4effd60709e999b2530ceb0cdbd5125a163543d5f842657d13bb57b4cf10b92
+  data.tar.gz: 6cb74d720acb7f4ac284c760cd92aa4a774d5762dd886ee7d68d8cacc42dd677
 SHA512:
-  metadata.gz: c41f22bc7fe6038432cd9e854c5bd18cd4b117f2320d02c3e142f5256cf0626de05e982db9676fdc3feed48cd26a6343e10717c196ab0e22b7d3798d4b5bb444
-  data.tar.gz: f70520dda7f7defab832cc4efc85771c10e3e042aff034512a261b630f73db2f63474b8103dbf43e4e98be29a0e03a20b0993f1a9e31871f84e2fad41d6d0f8c
+  metadata.gz: 8004b7a1062fabdaa46378a5e9f9a14138ca6bd2c45d6cb246636e112207be11cb68b8a561ca9e507b11ff803ffd8e4f1e0765f6cbecac7dc413c36c9e58adcf
+  data.tar.gz: cf8908e63e075e7a6989c777de2d5bb3f538025bfe6820d6c9d58848fea3ebc3f4a3b054ee94799671f71bf3b1b19678fd0f4051373fcf666c64020eb50b239f

data/CHANGELOG.markdown

@@ -1,3 +1,7 @@
+## Customerio 4.1.0 - Sep 27, 2021
+### Added
+- Added support for [merge customers](https://customer.io/docs/api/#operation/merge) API
+
 ## Customerio 4.0.1 - July 13, 2021
 ### Changed
 - Update addressable gem dependency to v2.8.0

data/README.md

@@ -104,6 +104,21 @@ recreated.
 $customerio.delete(5)
 ```
 
+### Merge duplicate customer profiles
+
+When you merge two people, you pick a primary person and merge a secondary, duplicate person into it. The primary person remains after the merge and the secondary is deleted. This process is permanent: you cannot recover the secondary person.
+
+The first and third parameters represent the identifier for the primary and secondary people respectively—one of `id`, `email`, or `cio_id`. The second and fourth parameters are the identifier values for the primary and secondary people respectively.
+
+```ruby
+# $customerio.merge_customers("primaryType", "primaryIdentifier", "secondaryType", "secondaryIdentifier")
+# primaryType / secondaryType are one of "id", "email", or "cio_id"
+# primaryIdentifier / secondaryIdentifier are the identifier value corresponding to the type.
+
+# merge customer "cperson@gmail.com" into "cool.person@company.com"
+$customerio.merge_customers("email", "cool.person@company.com", "email", "cperson@gmail.com")
+```
+
 ### Tracking a custom event
 
 Now that you're identifying your customers with [Customer.io](http://customer.io), you can now send events like

data/lib/customerio/client.rb

@@ -1,6 +1,12 @@
 require "addressable/uri"
 
 module Customerio
+  class IdentifierType
+    ID = "id"
+    EMAIL = "email"
+    CIOID = "cio_id"
+  end
+
   class Client
     PUSH_OPENED = 'opened'
     PUSH_CONVERTED = 'converted'
@@ -91,6 +97,17 @@ module Customerio
         @client.request_and_verify_response(:post, track_push_notification_event_path, attributes.merge(event: event_name))
     end
 
+    def merge_customers(primary_id_type, primary_id, secondary_id_type, secondary_id)
+      raise ParamError.new("invalid primary_id_type") if !is_valid_id_type?(primary_id_type)
+      raise ParamError.new("primary_id must be a non-empty string") if is_empty?(primary_id)
+      raise ParamError.new("invalid secondary_id_type") if !is_valid_id_type?(secondary_id_type)
+      raise ParamError.new("secondary_id must be a non-empty string") if is_empty?(secondary_id)
+
+      body = { :primary => {primary_id_type => primary_id}, :secondary => {secondary_id_type => secondary_id} }
+
+      @client.request_and_verify_response(:post, merge_customers_path, body)
+    end
+
     private
 
     def escape(val)
@@ -122,6 +139,10 @@ module Customerio
         "/push/events"
     end
 
+    def merge_customers_path
+      "/api/v1/merge_customers"
+    end
+
     def create_or_update(attributes = {})
       attributes = Hash[attributes.map { |(k,v)| [ k.to_sym, v ] }]
       raise MissingIdAttributeError.new("Must provide a customer id") if is_empty?(attributes[:id])
@@ -162,5 +183,9 @@ module Customerio
     def is_empty?(val)
       val.nil? || (val.is_a?(String) && val.strip == "")
     end
+
+    def is_valid_id_type?(input)
+      [IdentifierType::ID, IdentifierType::CIOID, IdentifierType::EMAIL].include? input
+    end
   end
 end

data/lib/customerio/version.rb

@@ -1,3 +1,3 @@
 module Customerio
-  VERSION = "4.0.1"
+  VERSION = "4.1.0"
 end

data/spec/client_spec.rb

@@ -592,4 +592,35 @@ describe Customerio::Client do
       }.to raise_error(Customerio::Client::ParamError, 'timestamp must be a valid timestamp')
     end
   end
+  
+  describe "#merge_customers" do
+    before(:each) do
+      @client = Customerio::Client.new("SITE_ID", "API_KEY", :json => true)
+    end
+
+    it "should raise validation errors on merge params" do
+      expect {
+        client.merge_customers("", "id1", Customerio::IdentifierType::ID, "id2")
+      }.to raise_error(Customerio::Client::ParamError, 'invalid primary_id_type')
+
+      expect {
+        client.merge_customers(Customerio::IdentifierType::EMAIL, "", Customerio::IdentifierType::ID, "id2")
+      }.to raise_error(Customerio::Client::ParamError, 'primary_id must be a non-empty string')
+
+      expect {
+        client.merge_customers(Customerio::IdentifierType::CIOID, "id1", "", "id2")
+      }.to raise_error(Customerio::Client::ParamError, 'invalid secondary_id_type')
+
+      expect {
+        client.merge_customers(Customerio::IdentifierType::ID, "id1", Customerio::IdentifierType::ID, "")
+      }.to raise_error(Customerio::Client::ParamError, 'secondary_id must be a non-empty string')
+    end
+
+    it "requires a valid customer_id when creating" do
+      stub_request(:post, api_uri('/api/v1/merge_customers')).
+        to_return(status: 200, body: "", headers: {})
+
+      client.merge_customers(Customerio::IdentifierType::ID, "ID1", Customerio::IdentifierType::EMAIL, "hello@company.com")
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: customerio
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.1.0
 platform: ruby
 authors:
 - John Allison
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-13 00:00:00.000000000 Z
+date: 2021-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -125,7 +125,7 @@ homepage: http://customer.io
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -140,8 +140,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key:
+rubygems_version: 3.2.22
+signing_key: 
 specification_version: 4
 summary: A ruby client for the Customer.io event API.
 test_files: