customerio 3.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd807525a01387116c22f29d0ac98e9b783fe669fd092da9d97cac74a660316d
-  data.tar.gz: 0ff5f3b518f07d5e3432a69e4a5738fd5bdeabc359593960bf9ac8f46081a7fc
+  metadata.gz: b4effd60709e999b2530ceb0cdbd5125a163543d5f842657d13bb57b4cf10b92
+  data.tar.gz: 6cb74d720acb7f4ac284c760cd92aa4a774d5762dd886ee7d68d8cacc42dd677
 SHA512:
-  metadata.gz: 07a1b0e3472abe674a69413e81e6cf2b87c5002a3b074a26053efc0b8da2e7d91d380055c54409922d35ff2d876aeb22c956ce1ea246842ec1ce08ad3079f35b
-  data.tar.gz: eb291aab81e6e802a204d7c0b2d36890fa2ce26cf82c3af773a8cfddcacdc9b0d4fca7c684aee03a884bafdda4ac088c234294d197fe28041bae2573b186a1da
+  metadata.gz: 8004b7a1062fabdaa46378a5e9f9a14138ca6bd2c45d6cb246636e112207be11cb68b8a561ca9e507b11ff803ffd8e4f1e0765f6cbecac7dc413c36c9e58adcf
+  data.tar.gz: cf8908e63e075e7a6989c777de2d5bb3f538025bfe6820d6c9d58848fea3ebc3f4a3b054ee94799671f71bf3b1b19678fd0f4051373fcf666c64020eb50b239f

data/.github/workflows/main.yml

@@ -0,0 +1,30 @@
+name: ruby_ci
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        ruby: ['2.5', '2.6', '2.7']
+    runs-on: ubuntu-latest 
+    steps:
+    - uses: actions/checkout@v2
+    - name: set up ruby
+      uses: actions/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

data/CHANGELOG.markdown

@@ -1,3 +1,41 @@
+## 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
+
+## Customerio 4.0.0 - July 6, 2021
+### Removed
+- The `anonymous_track` method.
+
+### Added
+- The `track_anonymous` method replaces `anonymous_track`. This method requires an `anonymous_id` parameter and will no longer trigger campaigns. If you previously used anonymous events to trigger campaigns, you can still do so [directly through the API](https://customer.io/docs/api/#operation/trackAnonymous). We now refer to anonymous events that trigger campaigns as ["invite events"](https://customer.io/docs/anonymous-events/#anonymous-or-invite). 
+
+## Customerio 3.1.0 - March 25, 2021
+### Added
+- Support for EU region
+
+### Removed
+### Changed
+- `Customerio::Client` and `CustomerIO::APIClient`  have a new parameter `region` that can be set to either `Customerio::Regions::EU` or `Customerio::Regions::US` (defaults to `Customerio::Regions::US`)
+
+## Customerio 3.0.0 - Dec 2, 2020
+
+### Added
+- Support for the Transactional API
+
+### Removed
+- `add_to_segment` and `remove_from_segment` methods
+- Support for non-JSON data
+
+### Changed
+- IDs in the URLs are now escaped.
+- Improved validations for data that's passed in.
+- Earlier, if you passed in an event name without a customer ID to the `track` method, we would create an anonymous event. That is now removed. To create an anonymous event, use the `anonymous_track` method.
+
+
 ## Customerio 3.0.0 - Dec 2, 2020
 
 ### Added

data/README.md

@@ -42,15 +42,16 @@ You'll be able to integrate **fully** with [Customer.io](http://customer.io) wit
 
 ### Setup
 
-Create an instance of the client with your [customer.io](http://customer.io) credentials
-which can be found on the [customer.io integration screen](https://fly.customer.io/account/customerio_integration).
+Create an instance of the client with your [Customer.io credentials](https://fly.customer.io/settings/api_credentials).
 
 If you're using Rails, create an initializer `config/initializers/customerio.rb`:
 
 ```ruby
-$customerio = Customerio::Client.new("YOUR SITE ID", "YOUR API SECRET KEY")
+$customerio = Customerio::Client.new("YOUR SITE ID", "YOUR API SECRET KEY", region: Customerio::Regions::US)
 ```
 
+`region` is optional and takes one of two values—`US` or `EU`. If you do not specify your region, we assume that your account is based in the US (`US`). If your account is based in the EU and you do not provide the correct region (`EU`), we'll route requests to our EU data centers accordingly, however this may cause data to be logged in the US. 
+
 ### Identify logged in customers
 
 Tracking data of logged in customers is a key part of [Customer.io](http://customer.io). In order to
@@ -103,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
@@ -121,7 +137,7 @@ encourage your customers to perform an action.
 $customerio.track(5, "purchase", :type => "socks", :price => "13.99")
 ```
 
-**Note:** If you'd like to track events which occurred in the past, you can include a `timestamp` attribute
+**Note:** If you want to track events which occurred in the past, you can include a `timestamp` attribute
 (in seconds since the epoch), and we'll use that as the date the event occurred.
 
 ```ruby
@@ -130,10 +146,18 @@ $customerio.track(5, "purchase", :type => "socks", :price => "13.99", :timestamp
 
 ### Tracking anonymous events
 
-You can also send anonymous events, for situations where you don't yet have a customer record but still want to trigger a campaign:
+You can also send anonymous events, for situations where you don't yet have a customer record yet. An anonymous event requires an `anonymous_id` representing the unknown person and an event `name`. When you identify a person, you can set their `anonymous_id` attribute. If [event merging](https://customer.io/docs/anonymous-events/#turn-on-merging) is turned on in your workspace, and the attribute matches the `anonymous_id` in one or more events that were logged within the last 30 days, we associate those events with the person.
+
+Anonymous events cannot trigger campaigns by themselves. To trigger a campaign, the anonymous event must be associated with a person within 72 hours of the `track_anonymous` request.
 
 ```ruby
-$customerio.anonymous_track("help_enquiry", :recipient => 'user@example.com')
+# 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.
+
+$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).
@@ -195,7 +219,7 @@ Use `send_email` referencing your request to send a transactional message. [Lear
 ```ruby
 require "customerio"
 
-client = Customerio::APIClient.new("your API key")
+client = Customerio::APIClient.new("your API key", region: Customerio::Regions::US)
 
 request = Customerio::SendEmailRequest.new(
   to: "person@example.com",

data/customerio.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |gem|
   gem.version       = Customerio::VERSION
 
   gem.add_dependency('multi_json', "~> 1.0")
-  gem.add_dependency('addressable', '~> 2.7.0')
+  gem.add_dependency('addressable', '~> 2.8.0')
 
   gem.add_development_dependency('rake', '~> 10.5')
   gem.add_development_dependency('rspec', '3.3.0')

data/lib/customerio/api.rb

@@ -3,10 +3,11 @@ require 'multi_json'
 
 module Customerio
   class APIClient
-    DEFAULT_API_URL = 'https://api.customer.io'
-
     def initialize(app_key, options = {})
-      options[:url] = DEFAULT_API_URL if options[:url].nil? || options[:url].empty?
+      options[:region] = Customerio::Regions::US if options[:region].nil?
+      raise "region must be an instance of Customerio::Regions::Region" unless options[:region].is_a?(Customerio::Regions::Region)
+
+      options[:url] = options[:region].api_url if options[:url].nil? || options[:url].empty?
       @client = Customerio::BaseClient.new({ app_key: app_key }, options)
     end
 

data/lib/customerio/client.rb

@@ -1,14 +1,27 @@
 require "addressable/uri"
 
 module Customerio
+  class IdentifierType
+    ID = "id"
+    EMAIL = "email"
+    CIOID = "cio_id"
+  end
+
   class Client
-    DEFAULT_TRACK_URL = 'https://track.customer.io'
+    PUSH_OPENED = 'opened'
+    PUSH_CONVERTED = 'converted'
+    PUSH_DELIVERED = 'delivered'
+
+    VALID_PUSH_EVENTS = [PUSH_OPENED, PUSH_CONVERTED, PUSH_DELIVERED]
 
     class MissingIdAttributeError < RuntimeError; end
     class ParamError < RuntimeError; end
 
     def initialize(site_id, api_key, options = {})
-      options[:url] = DEFAULT_TRACK_URL if options[:url].nil? || options[:url].empty?
+      options[:region] = Customerio::Regions::US if options[:region].nil?
+      raise "region must be an instance of Customerio::Regions::Region" unless options[:region].is_a?(Customerio::Regions::Region)
+
+      options[:url] = options[:region].track_url if options[:url].nil? || options[:url].empty?
       @client = Customerio::BaseClient.new({ site_id: site_id, api_key: api_key }, options)
     end
 
@@ -38,9 +51,11 @@ module Customerio
       create_customer_event(customer_id, event_name, attributes)
     end
 
-    def anonymous_track(event_name, attributes = {})
+    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(event_name, attributes)
+
+      create_anonymous_event(anonymous_id, event_name, attributes)
     end
 
     def add_device(customer_id, device_id, platform, data={})
@@ -69,6 +84,30 @@ module Customerio
       @client.request_and_verify_response(:delete, device_id_path(customer_id, device_id))
     end
 
+    def track_push_notification_event(event_name, attributes = {})
+        keys = [:delivery_id, :device_id, :timestamp]
+        attributes = Hash[attributes.map { |(k,v)| [ k.to_sym, v ] }].
+            select { |k, v| keys.include?(k) }
+
+        raise ParamError.new('event_name must be one of opened, converted, or delivered') unless VALID_PUSH_EVENTS.include?(event_name)
+        raise ParamError.new('delivery_id must be a non-empty string') unless attributes[:delivery_id] != "" and !attributes[:delivery_id].nil?
+        raise ParamError.new('device_id must be a non-empty string') unless attributes[:device_id] != "" and !attributes[:device_id].nil?
+        raise ParamError.new('timestamp must be a valid timestamp') unless valid_timestamp?(attributes[:timestamp])
+
+        @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)
@@ -96,6 +135,14 @@ module Customerio
       "/api/v1/customers/#{escape(customer_id)}/unsuppress"
     end
 
+    def track_push_notification_event_path
+        "/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])
@@ -105,16 +152,27 @@ module Customerio
     end
 
     def create_customer_event(customer_id, event_name, attributes = {})
-      create_event("#{customer_path(customer_id)}/events", event_name, attributes)
+      create_event(
+        url: "#{customer_path(customer_id)}/events",
+        event_name: event_name,
+        attributes: attributes
+      )
     end
 
-    def create_anonymous_event(event_name, attributes = {})
-      create_event("/api/v1/events", event_name, attributes)
+    def create_anonymous_event(anonymous_id, event_name, attributes = {})
+      create_event(
+        url: "/api/v1/events",
+        event_name: event_name,
+        anonymous_id: anonymous_id,
+        attributes: attributes
+      )
     end
 
-    def create_event(url, event_name, attributes = {})
+    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?
+
       @client.request_and_verify_response(:post, url, body)
     end
 
@@ -125,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/regions.rb

@@ -0,0 +1,11 @@
+require 'net/http'
+require 'multi_json'
+
+module Customerio
+  module Regions
+    Region = Struct.new(:track_url, :api_url)
+
+    US = Customerio::Regions::Region.new('https://track.customer.io', 'https://api.customer.io').freeze
+    EU = Customerio::Regions::Region.new('https://track-eu.customer.io', 'https://api-eu.customer.io').freeze
+  end
+end

data/lib/customerio/version.rb

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

data/lib/customerio.rb

@@ -1,6 +1,7 @@
 require "customerio/version"
 
 module Customerio
+  require "customerio/regions"
   require "customerio/base_client"
   require "customerio/client"
   require "customerio/requests/send_email_request"

data/spec/api_client_spec.rb

@@ -21,6 +21,48 @@ describe Customerio::APIClient do
     MultiJson.dump(data)
   end
 
+  it "the base client is initialised with the correct values when no region is passed in" do
+    app_key = "appkey"
+
+    expect(Customerio::BaseClient).to(
+      receive(:new)
+        .with(
+          { app_key: app_key },
+          {
+            region: Customerio::Regions::US,
+            url: Customerio::Regions::US.api_url
+          }
+        )
+    )
+
+    client = Customerio::APIClient.new(app_key)
+  end
+
+  it "raises an error when an incorrect region is passed in" do
+    expect {
+      Customerio::APIClient.new("appkey", region: :au)
+    }.to raise_error /region must be an instance of Customerio::Regions::Region/
+  end
+
+  [Customerio::Regions::US, Customerio::Regions::EU].each do |region|
+    it "the base client is initialised with the correct values when the region \"#{region}\" is passed in" do
+      app_key = "appkey"
+
+      expect(Customerio::BaseClient).to(
+        receive(:new)
+          .with(
+            { app_key: app_key },
+            {
+              region: region,
+              url: region.api_url
+            }
+          )
+      )
+
+      client = Customerio::APIClient.new(app_key, { region: region })
+    end
+  end
+
   describe "#send_email" do
     it "sends a POST request to the /api/send/email path" do
       req = Customerio::SendEmailRequest.new(

data/spec/client_spec.rb

@@ -22,6 +22,50 @@ describe Customerio::Client do
     MultiJson.dump(data)
   end
 
+  it "the base client is initialised with the correct values when no region is passed in" do
+    site_id = "SITE_ID"
+    api_key = "API_KEY"
+
+    expect(Customerio::BaseClient).to(
+      receive(:new)
+        .with(
+          { site_id: site_id, api_key: api_key },
+          {
+            region: Customerio::Regions::US,
+            url: Customerio::Regions::US.track_url
+          }
+        )
+    )
+
+    client = Customerio::Client.new(site_id, api_key)
+  end
+
+  it "raises an error when an incorrect region is passed in" do
+    expect {
+      Customerio::Client.new("siteid", "apikey", region: :au)
+    }.to raise_error /region must be an instance of Customerio::Regions::Region/
+  end
+
+  [Customerio::Regions::US, Customerio::Regions::EU].each do |region|
+    it "the base client is initialised with the correct values when the region \"#{region}\" is passed in" do
+      site_id = "SITE_ID"
+      api_key = "API_KEY"
+
+      expect(Customerio::BaseClient).to(
+        receive(:new)
+          .with(
+            { site_id: site_id, api_key: api_key },
+            {
+              region: region,
+              url: region.track_url
+            }
+          )
+      )
+
+      client = Customerio::Client.new(site_id, api_key, { region: region })
+    end
+  end
+
   it "uses json by default" do
     body = { id: 5, name: "Bob" }
     client = Customerio::Client.new("SITE_ID", "API_KEY")
@@ -106,16 +150,18 @@ describe Customerio::Client do
       time = Time.now.to_i
 
       stub_request(:put, api_uri('/api/v1/customers/5')).with(
-        body: json({
+        body: {
           id: 5,
           email: "customer@example.com",
           created_at: time,
           first_name: "Bob",
-          plan: "basic"
-        })).to_return(status: 200, body: "", headers: {})
+          plan: "basic",
+          anonymous_id: "anon-id"
+        }).to_return(status: 200, body: "", headers: {})
 
       client.identify({
         id: 5,
+        anonymous_id: "anon-id",
         email: "customer@example.com",
         created_at: time,
         first_name: "Bob",
@@ -337,31 +383,35 @@ describe Customerio::Client do
     end
 
     context "tracking an anonymous event" do
+      let(:anon_id) { "anon-id" }
+
       it "sends a POST request to the customer.io's anonymous event API" do
         stub_request(:post, api_uri('/api/v1/events')).
-          with(body: json({ name: "purchase", data: {} })).
+          with(body: { anonymous_id: anon_id, name: "purchase", data: {} }).
           to_return(status: 200, body: "", headers: {})
 
-        client.anonymous_track("purchase")
+        client.track_anonymous(anon_id, "purchase")
       end
 
       it "sends any optional event attributes" do
         stub_request(:post, api_uri('/api/v1/events')).
-          with(body: json({
+          with(body: {
+            anonymous_id: anon_id,
             name: "purchase",
             data: {
               type: "socks",
               price: "13.99"
             }
-          })).
+          }).
           to_return(status: 200, body: "", headers: {})
 
-        client.anonymous_track("purchase", type: "socks", price: "13.99")
+        client.track_anonymous(anon_id, "purchase", type: "socks", price: "13.99")
       end
 
       it "allows sending of a timestamp" do
         stub_request(:post, api_uri('/api/v1/events')).
-          with(body: json({
+          with(body: {
+            anonymous_id: anon_id,
             name: "purchase",
             data: {
               type: "socks",
@@ -369,73 +419,34 @@ describe Customerio::Client do
               timestamp: 1561231234
             },
             timestamp: 1561231234
-          })).
+          }).
           to_return(status: 200, body: "", headers: {})
 
-        client.anonymous_track("purchase", type: "socks", price: "13.99", timestamp: 1561231234)
+        client.track_anonymous(anon_id, "purchase", type: "socks", price: "13.99", timestamp: 1561231234)
       end
-    end
-  end
-
-  describe "#anonymous_track" do
-    it "raises an error if POST doesn't return a 2xx response code" do
-      stub_request(:post, api_uri('/api/v1/events')).
-        with(body: json(name: "purchase", data: {})).
-        to_return(status: 500, body: "", headers: {})
-
-      lambda { client.anonymous_track("purchase") }.should raise_error(Customerio::InvalidResponse)
-    end
-
-    it "throws an error when event_name is missing" do
-      stub_request(:put, /track.customer.io/)
-        .to_return(status: 200, body: "", headers: {})
-
-      lambda { client.anonymous_track(" ") }.should raise_error(Customerio::Client::ParamError, "event_name must be a non-empty string")
-    end
 
-    it "uses the site_id and api key for basic auth and sends the event name" do
-      stub_request(:post, api_uri('/api/v1/events')).
-        with(body: json(name: "purchase", data: {})).
-        to_return(status: 200, body: "", headers: {})
+      it "raises an error if POST doesn't return a 2xx response code" do
+          stub_request(:post, api_uri('/api/v1/events')).
+            with(body: { anonymous_id: anon_id, name: "purchase", data: {} }).
+            to_return(status: 500, body: "", headers: {})
 
-      client.anonymous_track("purchase")
-    end
-
-    it "sends any optional event attributes" do
-      stub_request(:post, api_uri('/api/v1/events')).
-          with(body: {
-            name: "purchase",
-            data: {
-              type: "socks",
-              price: "27.99"
-            },
-          }).
+        lambda { client.track_anonymous(anon_id, "purchase") }.should raise_error(Customerio::InvalidResponse)
+      end
 
-        to_return(status: 200, body: "", headers: {})
+      it "throws an error when anonymous_id is missing" do
+          stub_request(:post, api_uri('/api/v1/events')).
+            with(body: { anonymous_id: anon_id, name: "purchase", data: {} }).
+            to_return(status: 500, body: "", headers: {})
 
-      client.anonymous_track("purchase", type: "socks", price: "27.99")
-    end
-
-    it "allows sending of a timestamp" do
-      stub_request(:post, api_uri('/api/v1/events')).
-          with(body: json({
-            name: "purchase",
-            data: {
-              type: "socks",
-              price: "27.99",
-              timestamp: 1561235678
-            },
-            timestamp: 1561235678
-          })).
-
-        to_return(status: 200, body: "", headers: {})
+        lambda { client.track_anonymous("", "some_event") }.should raise_error(Customerio::Client::ParamError)
+      end
 
-      client.anonymous_track("purchase", type: "socks", price: "27.99", timestamp: 1561235678)
-    end
+      it "throws an error when event_name is missing" do
+          stub_request(:post, api_uri('/api/v1/events')).
+            with(body: { anonymous_id: anon_id, name: "purchase", data: {} }).
+            to_return(status: 500, body: "", headers: {})
 
-    context "too many arguments are passed" do
-      it "throws an error" do
-        lambda { client.anonymous_track("purchase", "text", type: "socks", price: "27.99") }.should raise_error(ArgumentError)
+        lambda { client.track_anonymous(anon_id, "") }.should raise_error(Customerio::Client::ParamError)
       end
     end
   end
@@ -502,4 +513,114 @@ describe Customerio::Client do
        lambda { client.delete_device(5, nil) }.should raise_error(Customerio::Client::ParamError)
     end
   end
+
+  describe "#track_push_notification_event" do
+    attr_accessor :client, :attributes
+
+    before(:each) do
+      @client = Customerio::Client.new("SITE_ID", "API_KEY", :json => true)
+      @attributes = {
+        :delivery_id => 'foo',
+        :device_id => 'bar',
+        :timestamp => Time.now.to_i
+      }
+    end
+
+    it "sends a POST request to customer.io's /push/events endpoint" do
+      stub_request(:post, api_uri('/push/events')).
+        with(
+          :body => json(attributes.merge({
+              :event => 'opened'
+          })),
+          :headers => {
+            'Content-Type' => 'application/json'
+          }).
+        to_return(:status => 200, :body => "", :headers => {})
+
+      client.track_push_notification_event('opened', attributes)
+    end
+
+    it "should raise if event is invalid" do
+      stub_request(:post, api_uri('/push/events')).
+        to_return(:status => 200, :body => "", :headers => {})
+
+      expect {
+        client.track_push_notification_event('closed', attributes.merge({ :delivery_id => nil }))
+      }.to raise_error(Customerio::Client::ParamError, 'event_name must be one of opened, converted, or delivered')
+    end
+
+    it "should raise if delivery_id is invalid" do
+      stub_request(:post, api_uri('/push/events')).
+        to_return(:status => 200, :body => "", :headers => {})
+
+      expect {
+        client.track_push_notification_event('opened', attributes.merge({ :delivery_id => nil }))
+      }.to raise_error(Customerio::Client::ParamError, 'delivery_id must be a non-empty string')
+
+      expect {
+        client.track_push_notification_event('opened', attributes.merge({ :delivery_id => '' }))
+      }.to raise_error(Customerio::Client::ParamError, 'delivery_id must be a non-empty string')
+    end
+
+    it "should raise if device_id is invalid" do
+      stub_request(:post, api_uri('/push/events')).
+        to_return(:status => 200, :body => "", :headers => {})
+
+      expect {
+        client.track_push_notification_event('opened', attributes.merge({ :device_id => nil }))
+      }.to raise_error(Customerio::Client::ParamError, 'device_id must be a non-empty string')
+
+      expect {
+        client.track_push_notification_event('opened', attributes.merge({ :device_id => '' }))
+      }.to raise_error(Customerio::Client::ParamError, 'device_id must be a non-empty string')
+    end
+
+    it "should raise if timestamp is invalid" do
+      stub_request(:post, api_uri('/push/events')).
+        to_return(:status => 200, :body => "", :headers => {})
+
+      expect {
+        client.track_push_notification_event('opened', attributes.merge({ :timestamp => nil }))
+      }.to raise_error(Customerio::Client::ParamError, 'timestamp must be a valid timestamp')
+
+      expect {
+        client.track_push_notification_event('opened', attributes.merge({ :timestamp => 999999999 }))
+      }.to raise_error(Customerio::Client::ParamError, 'timestamp must be a valid timestamp')
+
+      expect {
+        client.track_push_notification_event('opened', attributes.merge({ :timestamp => 100000000000 }))
+      }.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

data/spec/spec_helper.rb

@@ -10,6 +10,6 @@ require 'rspec'
 require 'webmock/rspec'
 
 RSpec.configure do |config|
-  config.expect_with(:rspec) { |c| c.syntax = :should }
-  config.mock_with(:rspec) { |c| c.syntax = :should }
+  config.expect_with(:rspec) { |c| c.syntax = [:should, :expect] }
+  config.mock_with(:rspec) { |c| c.syntax = [:should, :expect] }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: customerio
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - John Allison
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-03 00:00:00.000000000 Z
+date: 2021-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: 2.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: 2.8.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -101,7 +101,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
+- ".github/workflows/main.yml"
 - ".gitignore"
 - CHANGELOG.markdown
 - Gemfile
@@ -114,6 +114,7 @@ files:
 - lib/customerio/base_client.rb
 - lib/customerio/client.rb
 - lib/customerio/param_encoder.rb
+- lib/customerio/regions.rb
 - lib/customerio/requests/send_email_request.rb
 - lib/customerio/version.rb
 - spec/api_client_spec.rb
@@ -124,7 +125,7 @@ homepage: http://customer.io
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -139,8 +140,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key:
+rubygems_version: 3.2.22
+signing_key: 
 specification_version: 4
 summary: A ruby client for the Customer.io event API.
 test_files:

data/.circleci/config.yml

@@ -1,61 +0,0 @@
----
-version: 2
-
-references:
-  restore_cache: &restore_cache
-    type: cache-restore
-    name: Restore bundle cache
-    key: customerio-ruby-{{ checksum "customerio.gemspec" }}
-
-  save_cache: &save_cache
-    type: cache-save
-    name: Store bundle cache
-    key: customerio-ruby-{{ checksum "customerio.gemspec" }}
-    paths:
-      - vendor/bundle
-
-jobs:
-  ruby_27:
-    working_directory: ~/customerio-ruby
-    docker:
-      - image: circleci/ruby:2.7.2
-        environment:
-          RAILS_ENV: test
-    steps:
-      - checkout
-      - *restore_cache
-      - run: bundle install
-      - *save_cache
-      - run: bundle exec rspec
-  ruby_26:
-    working_directory: ~/customerio-ruby
-    docker:
-      - image: circleci/ruby:2.6.6
-        environment:
-          RAILS_ENV: test
-    steps:
-      - checkout
-      - *restore_cache
-      - run: bundle install
-      - *save_cache
-      - run: bundle exec rspec
-  ruby_25:
-    working_directory: ~/customerio-ruby
-    docker:
-      - image: circleci/ruby:2.5.8
-        environment:
-          RAILS_ENV: test
-    steps:
-      - checkout
-      - *restore_cache
-      - run: bundle install
-      - *save_cache
-      - run: bundle exec rspec
-
-workflows:
-  version: 2
-  test:
-    jobs:
-      - ruby_27
-      - ruby_26
-      - ruby_25