customerio 4.0.1 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbff37c21ea57a934d671356e89ef06114170d0b753c91048c255b399ce146de
-  data.tar.gz: 1d225801d24005870b63aa2f95850b47cef6ef822f7f3132ea9b7378cffaa852
+  metadata.gz: 16635bdd8c1cfb5e77fbe0c29ca18a69fdbcd48b3824a19a4657f4bb9d6d0991
+  data.tar.gz: ad565a4bf81cb86a956893bdc104bd0967971af84b4dfcb453f47ac6fae0b6ea
 SHA512:
-  metadata.gz: c41f22bc7fe6038432cd9e854c5bd18cd4b117f2320d02c3e142f5256cf0626de05e982db9676fdc3feed48cd26a6343e10717c196ab0e22b7d3798d4b5bb444
-  data.tar.gz: f70520dda7f7defab832cc4efc85771c10e3e042aff034512a261b630f73db2f63474b8103dbf43e4e98be29a0e03a20b0993f1a9e31871f84e2fad41d6d0f8c
+  metadata.gz: 6b944374f304906b7533def39708eb07078390e07a413bf3bec11f46aecc65683a88c1a8d89bf50d65b16fdc2d5c561f2a0b484827c8ac828b3857cf101efba5
+  data.tar.gz: 17fe083a74d404f9d243e0c9e0a9713e4f02fb4009d10807d30f50d192ce020ba33065684bd84aadaf02908fc9de55d950b5f23d9549ffadce1cb36502f2bc8d

data/.github/workflows/main.yml

@@ -1,30 +1,21 @@
-name: ruby_ci
+name: ci
 
 on: [push,pull_request]
 
 jobs:
-  build:
+  test:
     strategy:
       matrix:
         ruby: ['2.5', '2.6', '2.7']
-    runs-on: ubuntu-latest 
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_PATH: ${{ github.workspace }}/vendor/bundle
     steps:
     - uses: actions/checkout@v2
-    - name: set up ruby
-      uses: actions/setup-ruby@v1
+    - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
-    - name: install bundle
-      run: |
-         sudo apt-get -yqq install libpq-dev
-         gem install bundler
-    - name: Cache dependencies
-      uses: actions/cache@v2
-      with:
-        path: vendor/bundle
-        key: customerio-${{ matrix.ruby }}-${{ hashFiles('customerio.gemspec') }}
-        restore-keys: |
-          customerio-${{ matrix.ruby }}-
-    - name: Install dependencies
-      run: bundle install --path vendor/bundle
-    - run: bundle exec rspec
+        bundler-cache: true
+    
+    - name: Unit Test w/ RSpec
+      run: bundle exec rspec

data/.gitpod.yml

@@ -0,0 +1,10 @@
+tasks:
+  - init: |
+      bundle config set --local path 'vendor/bundle'
+      bundle install
+
+vscode:
+  extensions:
+    - connorshea.vscode-ruby-test-adapter
+    - hbenl.vscode-test-explorer
+    - hbenl.test-adapter-converter

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

@@ -1,9 +1,16 @@
-# Customerio
+<p align="center">
+  <a href="https://customer.io">
+    <img src="https://files.gitbook.com/v0/b/gitbook-28427.appspot.com/o/assets%2F-LSFjPaMQn1zKdYh6i89%2F-LU6OglGKqQfqMd5Zl-V%2F-LU6OzOLnOvy8VLwfgdg%2FLogo-Color-Horizontal.png?alt=media&token=add29dd0-cabb-4440-b46b-aed21350ae90" height="60">
+  </a>
+  <p align="center">Power automated communication that people like to receive.</p>
+</p>
 
-A ruby client for the [Customer.io](http://customer.io) [event API](http://learn.customer.io/api/).
+[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blueviolet?logo=gitpod)](https://gitpod.io/#https://github.com/customerio/customerio-ruby/)
+[![ci](https://github.com/customerio/customerio-ruby/actions/workflows/main.yml/badge.svg)](https://github.com/customerio/customerio-ruby/actions/workflows/main.yml)
 
-[![Build Status](https://secure.travis-ci.org/customerio/customerio-ruby.png?branch=master)](http://travis-ci.org/customerio/customerio-ruby)
-[![Code Climate](https://codeclimate.com/github/customerio/customerio-ruby/badges/gpa.svg)](https://codeclimate.com/github/customerio/customerio-ruby)
+# Customer.io Ruby
+
+A ruby client for the [Customer.io Track API](https://customer.io/docs/api/#tag/trackOverview).
 
 ## Installation
 
@@ -24,7 +31,7 @@ Or install it yourself:
 ### Before we get started: API client vs. JavaScript snippet
 
 It's helpful to know that everything below can also be accomplished
-through the [Customer.io JavaScript snippet](http://learn.customer.io/developer-documentation/javascript-quick-start.html).
+through the [Customer.io JavaScript snippet](https://customer.io/docs/javascript-quick-start/).
 
 In many cases, using the JavaScript snippet will be easier to integrate with
 your app, but there are several reasons why using the API client is useful:
@@ -38,7 +45,7 @@ your app, but there are several reasons why using the API client is useful:
 
 In the end, the decision on whether or not to use the API client or
 the JavaScript snippet should be based on what works best for you.
-You'll be able to integrate **fully** with [Customer.io](http://customer.io) with either approach.
+You'll be able to integrate **fully** with [Customer.io](https://customer.io) with either approach.
 
 ### Setup
 
@@ -54,9 +61,9 @@ $customerio = Customerio::Client.new("YOUR SITE ID", "YOUR API SECRET KEY", regi
 
 ### Identify logged in customers
 
-Tracking data of logged in customers is a key part of [Customer.io](http://customer.io). In order to
+Tracking data of logged in customers is a key part of [Customer.io](https://customer.io). In order to
 send triggered emails, we must know the email address of the customer.  You can
-also specify any number of customer attributes which help tailor [Customer.io](http://customer.io) to your
+also specify any number of customer attributes which help tailor [Customer.io](https://customer.io) to your
 business.
 
 Attributes you specify are useful in several ways:
@@ -71,7 +78,7 @@ 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
-key information changes. This keeps [Customer.io](http://customer.io) up to date with your customer information.
+key information changes. This keeps [Customer.io](https://customer.io) up to date with your customer information.
 
 ```ruby
 # Arguments
@@ -104,9 +111,24 @@ 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
+Now that you're identifying your customers with [Customer.io](https://customer.io), you can now send events like
 "purchased" or "watchedIntroVideo".  These allow you to more specifically target your users
 with automated emails, and track conversions when you're sending automated emails to
 encourage your customers to perform an action.
@@ -137,15 +159,22 @@ Anonymous events cannot trigger campaigns by themselves. To trigger a campaign,
 
 ```ruby
 # Arguments
-# anonymous_id (required) - the id representing the unknown person.
-# name (required)         - the name of the event you want to track.
-# attributes (optional)   - any related information you want to attach to the
-#                           event.
+# anonymous_id (required, nullable) - the id representing the unknown person.
+# name (required)                   - the name of the event you want to track.
+# attributes (optional)             - related information you want to attach to the event.
 
 $customerio.track_anonymous(anonymous_id, "product_view", :type => "socks" )
 ```
 
-Use the `recipient` attribute to specify the email address to send the messages to. [See our documentation on how to use anonymous events for more details](https://learn.customer.io/recipes/invite-emails.html).
+Use the `recipient` attribute to specify the email address to send the messages to. [See our documentation on how to use anonymous events for more details](https://customer.io/docs/invite-emails/).
+
+#### Anonymous invite events
+
+If you previously sent [invite events](https://customer.io/docs/anonymous-invite-emails/), you can achieve the same functionality by sending an anonymous event with `nil` for the anonymous identifier. To send anonymous invites, your event *must* include a `recipient` attribute. 
+
+```ruby
+$customerio.track_anonymous(nil, "invite", :recipient => "new.person@example.com" )
+```
 
 ### Adding a mobile device
 
@@ -172,7 +201,7 @@ $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.
+Deletes the customer with the provided id if it exists and suppresses all future events and identifies for that customer.
 
 ```ruby
 $customerio.suppress(5)

data/customerio.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency('addressable', '~> 2.8.0')
 
   gem.add_development_dependency('rake', '~> 10.5')
-  gem.add_development_dependency('rspec', '3.3.0')
+  gem.add_development_dependency('rspec', '~> 3.10')
   gem.add_development_dependency('webmock', '3.6.0')
   gem.add_development_dependency('json')
 end

data/lib/customerio/base_client.rb

@@ -44,6 +44,8 @@ module Customerio
 
       req = request_class(method).new(uri.path)
 
+      headers['User-Agent'] = "Customer.io Ruby Client/" + Customerio::VERSION
+
       if @auth.has_key?(:site_id) && @auth.has_key?(:api_key)
         req.initialize_http_header(headers)
         req.basic_auth @auth[:site_id], @auth[:api_key]

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'
@@ -46,7 +52,6 @@ module Customerio
     end
 
     def track_anonymous(anonymous_id, event_name, attributes = {})
-      raise ParamError.new("anonymous_id must be a non-empty string") if is_empty?(anonymous_id)
       raise ParamError.new("event_name must be a non-empty string") if is_empty?(event_name)
 
       create_anonymous_event(anonymous_id, event_name, attributes)
@@ -91,6 +96,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 +138,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])
@@ -150,7 +170,7 @@ module Customerio
     def create_event(url:, event_name:, anonymous_id: nil, attributes: {})
       body = { :name => event_name, :data => attributes }
       body[:timestamp] = attributes[:timestamp] if valid_timestamp?(attributes[:timestamp])
-      body[:anonymous_id] = anonymous_id unless anonymous_id.nil?
+      body[:anonymous_id] = anonymous_id unless is_empty?(anonymous_id)
 
       @client.request_and_verify_response(:post, url, body)
     end
@@ -162,5 +182,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.3.0"
 end

data/spec/api_client_spec.rb

@@ -14,7 +14,7 @@ describe Customerio::APIClient do
   end
 
   def request_headers
-    { 'Authorization': "Bearer #{app_key}", 'Content-Type': 'application/json' }
+    { 'Authorization': "Bearer #{app_key}", 'Content-Type': 'application/json', 'User-Agent': 'Customer.io Ruby Client/' + Customerio::VERSION }
   end
 
   def json(data)

data/spec/base_client_spec.rb

@@ -18,11 +18,11 @@ describe Customerio::BaseClient do
 
   def track_client_request_headers
     token = Base64.strict_encode64("#{site_id}:#{api_key}")
-    { 'Authorization': "Basic #{token}", 'Content-Type': 'application/json' }
+    { 'Authorization': "Basic #{token}", 'Content-Type': 'application/json', 'User-Agent': 'Customer.io Ruby Client/' + Customerio::VERSION }
   end
 
   def api_client_request_headers
-    { 'Authorization': "Bearer #{app_key}", 'Content-Type': 'application/json' }
+    { 'Authorization': "Bearer #{app_key}", 'Content-Type': 'application/json', 'User-Agent': 'Customer.io Ruby Client/' + Customerio::VERSION }
   end
 
   describe "with a site ID and API key" do

data/spec/client_spec.rb

@@ -433,12 +433,20 @@ describe Customerio::Client do
         lambda { client.track_anonymous(anon_id, "purchase") }.should raise_error(Customerio::InvalidResponse)
       end
 
-      it "throws an error when anonymous_id is missing" do
+      it "doesn't pass along anonymous_id if it is blank" do
           stub_request(:post, api_uri('/api/v1/events')).
-            with(body: { anonymous_id: anon_id, name: "purchase", data: {} }).
-            to_return(status: 500, body: "", headers: {})
+            with(body: { name: "some_event", data: {} }).
+            to_return(status: 200, body: "", headers: {})
+
+        client.track_anonymous("", "some_event")
+      end
+
+      it "doesn't pass along anonymous_id if it is nil" do
+        stub_request(:post, api_uri('/api/v1/events')).
+          with(body: { name: "some_event", data: {} }).
+          to_return(status: 200, body: "", headers: {})
 
-        lambda { client.track_anonymous("", "some_event") }.should raise_error(Customerio::Client::ParamError)
+        client.track_anonymous(nil, "some_event")
       end
 
       it "throws an error when event_name is missing" do
@@ -592,4 +600,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.3.0
 platform: ruby
 authors:
 - John Allison
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-13 00:00:00.000000000 Z
+date: 2022-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -56,16 +56,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -103,6 +103,7 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/main.yml"
 - ".gitignore"
+- ".gitpod.yml"
 - CHANGELOG.markdown
 - Gemfile
 - LICENSE
@@ -125,7 +126,7 @@ homepage: http://customer.io
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -140,8 +141,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.5
+signing_key: 
 specification_version: 4
 summary: A ruby client for the Customer.io event API.
 test_files: