customerio 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd807525a01387116c22f29d0ac98e9b783fe669fd092da9d97cac74a660316d
-  data.tar.gz: 0ff5f3b518f07d5e3432a69e4a5738fd5bdeabc359593960bf9ac8f46081a7fc
+  metadata.gz: 48f0d7c8bb61994c6bee0e1b846772f7ab304913182a1d1ac87f52a6e4e9beff
+  data.tar.gz: e8df14b0db35439d08687a2ff61161d5d6bfc3a9f8ae6df71ba9c1cd7d4c91e9
 SHA512:
-  metadata.gz: 07a1b0e3472abe674a69413e81e6cf2b87c5002a3b074a26053efc0b8da2e7d91d380055c54409922d35ff2d876aeb22c956ce1ea246842ec1ce08ad3079f35b
-  data.tar.gz: eb291aab81e6e802a204d7c0b2d36890fa2ce26cf82c3af773a8cfddcacdc9b0d4fca7c684aee03a884bafdda4ac088c234294d197fe28041bae2573b186a1da
+  metadata.gz: 7fff0a46a46e90a65f39694abf8713abe1a5e9edd0f388d26fea80d305332ed8425998397822899a9b66f27e77fb98e1051cd332842c73cd20da0a7ad7380a9d
+  data.tar.gz: 1eab0fb3fe94024954b04f77c34029aa2b9a9b6a089d5d6aa86f9070101e0bf13e7019725e8031fcdd7af0ddf76532e4b2b85b6dfe7e482ecb5f407b339df381

data/.github/workflows/main.yml

@@ -0,0 +1,30 @@
+name: ruby_ci
+
+on: [push]
+
+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,27 @@
+
+## 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
@@ -121,7 +122,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
@@ -195,7 +196,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/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/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

@@ -2,13 +2,14 @@ require "addressable/uri"
 
 module Customerio
   class Client
-    DEFAULT_TRACK_URL = 'https://track.customer.io'
-
     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
 

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 = "3.1.0"
 end

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")

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: 3.1.0
 platform: ruby
 authors:
 - John Allison
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-03 00:00:00.000000000 Z
+date: 2021-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -102,6 +102,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".github/workflows/main.yml"
 - ".gitignore"
 - CHANGELOG.markdown
 - Gemfile
@@ -114,6 +115,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
@@ -139,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: A ruby client for the Customer.io event API.