customerio 5.1.0 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18279a486386052aa99a48c56652ac566bf6abc973a6428af4d5886ec2ac3b85
-  data.tar.gz: dcaef6f328effd4cf6dc820e81b27661e440ce79d2af33b6736da544be30a0e7
+  metadata.gz: d03e20b960d7934a624f045a54d3d367d35822bbe9cd7f3c39374716256e15a5
+  data.tar.gz: fe48ba820bb31d76d86d66dadc3dcf63dc7dc89d88b25c3b836a631a356e4fb9
 SHA512:
-  metadata.gz: bad65a5e1d2097aa9db014e71d2c1c310546ec57ce4efa002484a28d6a9031fd5db48a221659d74861ce7a7ff07489b4b8ac956ba11b7b7cadab4eabed730a98
-  data.tar.gz: ce94e157fd6145afdaf303b1a6a91a5f2eeb9e8ea581d60acad95834e39bba788489c50e164070e83d4232bdb4c692315772bc52c0220676c216d26eeb217f1a
+  metadata.gz: be98051f37025cd4cf23693790663e908f6a4718ed195653fe66931c84f072fdb555ccecbe18d0d587a3ad4297fe48d84677c074edbcf1c821849cfda41fe471
+  data.tar.gz: a77fed86492d234f04a062fa2a0acb3c287b9f8d53601ddfcf033f0563069c705b21dc04ae8912ca22023542e198ca1980360e4885a36517b3d049e58d4e6ad7

data/.github/workflows/main.yml

@@ -6,7 +6,7 @@ jobs:
   test:
     strategy:
       matrix:
-        ruby: ['2.5', '2.6', '2.7']
+        ruby: ['2.5', '2.6', '2.7', '3.0', '3.1', '3.2']
     runs-on: ubuntu-latest
     env:
       BUNDLE_PATH: ${{ github.workspace }}/vendor/bundle

data/CHANGELOG.markdown

@@ -1,3 +1,12 @@
+## Customerio 5.3.0 - December 8, 2023
+### Changed
+- The `identify` method has been updated to allow the customer ID to be specified separately from the attributes, using the `customer_id` attribute. This allows a person to be updated by identifying them by e.g.: their email address. Thanks to trwalzer, jrbeck and jeremyw for the original changes that this is based on.
+- It is no longer possible to set the `customer_id` attribute on a person. This is a side-effect of the changes to the `identify` method.
+
+## Customerio 5.2.0 - December 8, 2023
+### Changed
+- The `identify` method will now automatically use the `cio_id` attribute as the customer ID when calling the track service. This allows a customer to be updated using `identify` to modify the `id` and `email` attributes.
+
 ## Customerio 5.1.0 - May 5, 2023
 ### Added
 - Added `send_push` to `APIClient` and `SendPushRequest` to support sending transactional push notifications.

data/README.md

@@ -77,7 +77,7 @@ if you pass along the current subscription plan (free / basic / premium) for you
 set up triggers which are only sent to customers who have subscribed to a
 particular plan (e.g. "premium").
 
-You'll want to indentify your customers when they sign up for your app and any time their
+You'll want to identify your customers when they sign up for your app and any time their
 key information changes. This keeps [Customer.io](https://customer.io) up to date with your customer information.
 
 ```ruby
@@ -95,6 +95,53 @@ $customerio.identify(
 )
 ```
 
+### Updating customers: Changing identifiers
+
+You can use the identify operation to update customers.
+If you need to change the `id` or `email` identifiers for a customer,
+you will need to pass in the `cio_id` identifier.
+`cio_id` is a unique identifier set by Customer.io, used to reference a person,
+and cannot be changed.
+
+E.g.: if the customer created in the identify operation above was given the `cio_id` of `"f000000d"`, you could change its ID and email address using:
+
+```ruby
+$customerio.identify(
+  :cio_id => "f000000d",
+  :id => 1005,
+  :email => "bob.fullname@example.com"
+)
+```
+
+This method requires either the `id` or `cio_id` for the person. It does not work with email addresses.
+
+You can also use this method to make other updates to the person using the `cio_id`.
+
+### Updating customers: Using email address
+
+If you need to identify a person using their email address, then you can do so
+by passing in a customer ID to the `identify` method. This allows you to specify
+a customer ID that is different than the one used in the `id` attribute. E.g.:
+
+```ruby
+# Arguments
+# customer_id (required) - the customer ID to use for this customer, may be an id, email address, or the cio_id.
+#                         This will be used to construct the URL but not sent in the body attributes.
+# attributes (required) - a hash of information about the customer. You can pass any
+#                         information that would be useful in your triggers. You
+#                         must at least pass in an id, email, and created_at timestamp.
+
+$customerio.identify(
+  :customer_id => "bob@example.com",
+  :location => "Australia"
+)
+```
+
+Note:
+
+ * If you want to use the `cio_id` in the `customer_id` field of `identify_customer_id`, you will need to prefix it with `"cio_"`. E.g.: `"cio_f000000d"` for a `cio_id` of `f000000d`.
+ * The `identify` method can identify the person using one of `customer_id`, `cio_id` or `id`. The order of precedence is `customer_id` > `cio_id` > `id`.
+
 ### Deleting customers
 
 Deleting a customer will remove them, and all their information from

data/customerio.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["john@customer.io"]
   gem.description   = "A ruby client for the Customer.io event API."
   gem.summary       = "A ruby client for the Customer.io event API."
-  gem.homepage      = "http://customer.io"
+  gem.homepage      = "https://customer.io"
   gem.license       = "MIT"
 
   gem.files         = `git ls-files`.split($\)

data/lib/customerio/client.rb

@@ -151,9 +151,34 @@ module Customerio
 
     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])
+      if is_empty?(attributes[:id]) && is_empty?(attributes[:cio_id]) && is_empty?(attributes[:customer_id])
+        raise MissingIdAttributeError.new("Must provide a customer id")
+      end
+
+      # Use cio_id as the identifier, if present,
+      # to allow the id and email identifiers to be updated.
+      # The person is identified by a customer ID, which is included
+      # in the path to the Track v1 API. Choose the ID in this order
+      # from highest to lowest precedence:
+      #
+      # 1. customer_id: "id", an email address, or "cio_id" value.
+      #    Any "cio_id" values need to be prefixed "cio_"
+      #    so that the Track v1 API knows it's a cio_id.
+      #
+      # 2. cio_id: The cio_id value (no prefix required).
+      #
+      # 3. id: The id value.
+      customer_id = attributes[:id]
+      if !is_empty?(attributes[:cio_id])
+        customer_id = "cio_" + attributes[:cio_id]
+      end
+      if !is_empty?(attributes[:customer_id])
+        customer_id = attributes[:customer_id]
+      end
+      # customer_id is not an attribute, so remove it.
+      attributes.delete(:customer_id)
 
-      url = customer_path(attributes[:id])
+      url = customer_path(customer_id)
       @client.request_and_verify_response(:put, url, attributes)
     end
 

data/lib/customerio/param_encoder.rb

@@ -55,7 +55,7 @@ module Customerio
       param
     end
 
-    # Prefer ERB::Util.url_encode, fall baack to deprecation URI.encode for
+    # Prefer ERB::Util.url_encode, fall back to deprecation URI.encode for
     # old Ruby support
     def self.escape_value(value)
       if ERB::Util.respond_to? :url_encode

data/lib/customerio/version.rb

@@ -1,3 +1,3 @@
 module Customerio
-  VERSION = "5.1.0"
+  VERSION = "5.3.0"
 end

data/spec/client_spec.rb

@@ -172,6 +172,8 @@ describe Customerio::Client do
     it "requires an id attribute" do
       lambda { client.identify(email: "customer@example.com") }.should raise_error(Customerio::Client::MissingIdAttributeError)
       lambda { client.identify(id: "") }.should raise_error(Customerio::Client::MissingIdAttributeError)
+      lambda { client.identify(cio_id: "") }.should raise_error(Customerio::Client::MissingIdAttributeError)
+      lambda { client.identify(customer_id: "") }.should raise_error(Customerio::Client::MissingIdAttributeError)
     end
 
     it 'should not raise errors when attribute keys are strings' do
@@ -183,6 +185,78 @@ describe Customerio::Client do
 
       lambda { client.identify(attributes) }.should_not raise_error()
     end
+
+    it 'uses cio_id for customer id, when present, for id updates' do
+      stub_request(:put, api_uri('/api/v1/customers/cio_347f00d')).with(
+        body: {
+          cio_id: "347f00d",
+          id: 5
+        }).to_return(status: 200, body: "", headers: {})
+
+      client.identify({
+        cio_id: "347f00d",
+        id: 5
+      })
+    end
+
+    it 'uses cio_id for customer id, when present, for email updates' do
+      stub_request(:put, api_uri('/api/v1/customers/cio_347f00d')).with(
+        body: {
+          cio_id: "347f00d",
+          email: "different.customer@example.com"
+        }).to_return(status: 200, body: "", headers: {})
+
+      client.identify({
+        cio_id: "347f00d",
+        email: "different.customer@example.com"
+      })
+    end
+
+    it 'allows updates with cio_id as the only id' do
+      stub_request(:put, api_uri('/api/v1/customers/cio_347f00d')).with(
+        body: {
+          cio_id: "347f00d",
+          location: "here"
+        }).to_return(status: 200, body: "", headers: {})
+
+      client.identify({
+        cio_id: "347f00d",
+        location: "here"
+      })
+    end
+
+    it "uses provided id rather than id" do
+      stub_request(:put, api_uri('/api/v1/customers/1234')).
+        with(body: json(id: "5")).
+        to_return(status: 200, body: "", headers: {})
+
+      client.identify(
+        customer_id: "1234",
+        id: "5"
+      )
+    end
+
+    it "uses provided cio_id rather than id" do
+      stub_request(:put, api_uri('/api/v1/customers/cio_5')).
+        with(body: json(id: "5")).
+        to_return(status: 200, body: "", headers: {})
+
+      client.identify(
+        customer_id: "cio_5",
+        id: "5"
+      )
+    end
+
+    it "uses provided email rather than id" do
+      stub_request(:put, api_uri('/api/v1/customers/customer@example.com')).
+        with(body: json(id: "5")).
+        to_return(status: 200, body: "", headers: {})
+
+      client.identify(
+        customer_id: "customer@example.com",
+        id: "5"
+      )
+    end
   end
 
   describe "#delete" do
@@ -610,7 +684,7 @@ 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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: customerio
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.3.0
 platform: ruby
 authors:
 - John Allison
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-08 00:00:00.000000000 Z
+date: 2023-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -123,11 +123,11 @@ files:
 - spec/base_client_spec.rb
 - spec/client_spec.rb
 - spec/spec_helper.rb
-homepage: http://customer.io
+homepage: https://customer.io
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -142,8 +142,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.2.33
+signing_key:
 specification_version: 4
 summary: A ruby client for the Customer.io event API.
 test_files: