customerio 2.1.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 142c5aa6d5043fbf69018fc678fc335552c46d65
-  data.tar.gz: 15c5da49d590ac52cbc500d24e9a31b243937092
+SHA256:
+  metadata.gz: d874bed91dc92bf20913befe45a204319cfeb6bf82dde6ef7d59bffe76b68f01
+  data.tar.gz: b9d3af66629b47eda01b0f403a50b10f6f5ea7e6680f37505f3b116cce3cae34
 SHA512:
-  metadata.gz: c612f66e9ba819f88f04659b7ea243d98c4c57e6f6733bee94ca71e85dcd7d2d5b4ecd8458623d4ad3cafa857587e47b17e74977dee302fccb2a3c879d5a53db
-  data.tar.gz: db90752181238ad8626b2a723ae1f74230abbc6a458f39802ee25b21ac2933c653bddf2138b261e7e65b8ecb17d341d7a8234093497421a8c0b30dc811a9c0b2
+  metadata.gz: 29ff3dfd708c6485110d013508ec19b93544c3fd89c0a5d65b101e65b9ae0c3d325aab2b8d0b5fe9b9c8b828b1db02ea682aa8a06d6fa6b00ef5b31a0bb64dcb
+  data.tar.gz: 0a8c4eed08c825b5653e8f9630cafda556e958fb405fb73767e0a8f25645b8b3948daa07c5ca17e19b0799abd549cc27a8fc64ada0d5070c4d4a58a78ed80c90

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,48 +1,101 @@
-## Customerio 2.1.0 - May 22, 2018 ##
+## 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
+- 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 2.2.1 - Mar 23, 2020
+
+- Add license to gemspec [#55](https://github.com/customerio/customerio-ruby/pull/55)
+- Bubble up error message [#51](https://github.com/customerio/customerio-ruby/pull/51)
+
+## Customerio 2.2.0 - Oct 18, 2018
+
+Add support for manual segments [#52](https://github.com/customerio/customerio-ruby/pull/52)
+
+## Customerio 2.1.0 - May 22, 2018
 
 Added support for the suppress / unsuppress methods [#49](https://github.com/customerio/customerio-ruby/pull/49)
 
-## Customerio 2.0.0 - Apr 10, 2018 ##
+## Customerio 2.0.0 - Apr 10, 2018
 
 With this release we have dropped the support for ruby 1.8.7.
 
-* Support new add and remove device endpoints for push notifications [#47](https://github.com/customerio/customerio-ruby/pull/47)
+- Support new add and remove device endpoints for push notifications [#47](https://github.com/customerio/customerio-ruby/pull/47)
 
-## Customerio 1.0.0 - Mar 15, 2016 ##
+## Customerio 1.0.0 - Mar 15, 2016
 
 There is a slight breaking change in this release. If you are depending on the HTTP response object included in the InvalidResponse exception (introduced in 0.6.1), note that it is now a `Net::HTTPBadRequest`.
 
-* Remove HTTParty dependency, use Net::HTTP instead. [#42](https://github.com/customerio/customerio-ruby/pull/42)
+- Remove HTTParty dependency, use Net::HTTP instead. [#42](https://github.com/customerio/customerio-ruby/pull/42)
 
-* Update test suite to use webmock, to increase confidence that we're not changing our HTTP requests [#41](https://github.com/customerio/customerio-ruby/pull/41)
+- Update test suite to use webmock, to increase confidence that we're not changing our HTTP requests [#41](https://github.com/customerio/customerio-ruby/pull/41)
 
-## Customerio 0.7.0 - Mar 2, 2016 ##
+## Customerio 0.7.0 - Mar 2, 2016
 
-* Add new method for tracking anonymous events: `anonymous_track`. See README for more details. Many thanks to @sdawson for this contribution! [#36](https://github.com/customerio/customerio-ruby/pull/36)
+- Add new method for tracking anonymous events: `anonymous_track`. See README for more details. Many thanks to @sdawson for this contribution! [#36](https://github.com/customerio/customerio-ruby/pull/36)
 
-* Use JSON encoding by default. [#37](https://github.com/customerio/customerio-ruby/pull/37)
+- Use JSON encoding by default. [#37](https://github.com/customerio/customerio-ruby/pull/37)
 
-    If you want to stick with form-encoding for your integration, you must add `:json => false` to your Customerio::Client initializer. Like this:
+  If you want to stick with form-encoding for your integration, you must add `:json => false` to your Customerio::Client initializer. Like this:
 
-    ```ruby
-    customerio = Customerio::Client.new("YOUR SITE ID", "YOUR API SECRET KEY", :json => false)
-    ```
+  ```ruby
+  customerio = Customerio::Client.new("YOUR SITE ID", "YOUR API SECRET KEY", :json => false)
+  ```
 
-## Customerio 0.6.1 - Oct 8, 2015 ##
+## Customerio 0.6.1 - Oct 8, 2015
 
-* Include HTTP response as an attribute on the InvalidResponse exception to help with debugging failed API requests. For example:
+- Include HTTP response as an attribute on the InvalidResponse exception to help with debugging failed API requests. For example:
 
-    ```ruby
-    begin
-      $customerio.track(1, 'event', { :test => 'testing' })
-    rescue => e
-      puts e.message
-      puts e.response.status
-      puts e.response.body
-    end
-    ```
+  ```ruby
+  begin
+    $customerio.track(1, 'event', { :test => 'testing' })
+  rescue => e
+    puts e.message
+    puts e.response.status
+    puts e.response.body
+  end
+  ```
 
-## Customerio 0.6.0 - Oct 6, 2015 ##
+## Customerio 0.6.0 - Oct 6, 2015
 
 Deprecation warning: we are going to switch to JSON encoding by default for the next release. The current default is form-encoding. This will probably not affect you, unless you rely on how form-encoding arrays work.
 
@@ -54,46 +107,46 @@ customerio = Customerio::Client.new("YOUR SITE ID", "YOUR API SECRET KEY", :json
 
 Other fixes and improvements, with many thanks to the community contributors:
 
-* Added HTTP timeout of 10 seconds (@stayhero)
-* Added JSON support for events (@kemper)
-* Convert attribute keys to symbols (@joshnabbott)
+- Added HTTP timeout of 10 seconds (@stayhero)
+- Added JSON support for events (@kemper)
+- Convert attribute keys to symbols (@joshnabbott)
 
-## Customerio 0.5.0 - Mar 28, 2014 ##
+## Customerio 0.5.0 - Mar 28, 2014
 
-* Added flag to send body encoded as JSON, rather than the default form encoding.
+- Added flag to send body encoded as JSON, rather than the default form encoding.
 
-## Customerio 0.5.0 - Apr 8, 2013 ##
+## Customerio 0.5.0 - Apr 8, 2013
 
-* Removed deprecated methods around using a customer object. All calls simply take a hash of attributes now.
-* Added ability to set a timestamp on a tracked event.  Useful for backfilling past events.
+- Removed deprecated methods around using a customer object. All calls simply take a hash of attributes now.
+- Added ability to set a timestamp on a tracked event. Useful for backfilling past events.
 
-## Customerio 0.4.1 - Feb 18, 2013 ##
+## Customerio 0.4.1 - Feb 18, 2013
 
-* Bug fixes related to the 4.0 change.
+- Bug fixes related to the 4.0 change.
 
-## Customerio 0.4.0 - Feb 18, 2013 ##
+## Customerio 0.4.0 - Feb 18, 2013
 
-* Added support for deleting customers.
+- Added support for deleting customers.
 
-## Customerio 0.3.0 - Dec 28, 2012 ##
+## Customerio 0.3.0 - Dec 28, 2012
 
-* Now raise an error if an API call doesn't respond with a 200 response code
-* Removed dependency on ActiveSupport
+- Now raise an error if an API call doesn't respond with a 200 response code
+- Removed dependency on ActiveSupport
 
-## Customerio 0.2.0 - Nov 21, 2012 ##
+## Customerio 0.2.0 - Nov 21, 2012
 
-* Allow raw hashes to be passed into `identify` and `track` methods rather than a customer object.
-* Passing a customer object has been depreciated.
-* Customizing ids with `Customerio::Client.id` block is deprecated.
+- Allow raw hashes to be passed into `identify` and `track` methods rather than a customer object.
+- Passing a customer object has been depreciated.
+- Customizing ids with `Customerio::Client.id` block is deprecated.
 
-## Customerio 0.1.0 - Nov 15, 2012 ##
+## Customerio 0.1.0 - Nov 15, 2012
 
-* Allow tracking of anonymous events.
+- Allow tracking of anonymous events.
 
-## Customerio 0.0.3 - Nov 5, 2012 ## 
+## Customerio 0.0.3 - Nov 5, 2012
 
-* Bump httparty dependency to the latest version.
+- Bump httparty dependency to the latest version.
 
-## Customerio 0.0.2 - May 22, 2012 ##
+## Customerio 0.0.2 - May 22, 2012
 
-* First release.
+- First release.

data/README.md

@@ -42,20 +42,15 @@ 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)
 ```
 
-If you'd like to send complex data to associate to a user as json, pass a json option:
-
-```ruby
-customerio = Customerio::Client.new("YOUR SITE ID", "YOUR API SECRET KEY", :json => true)
-```
+`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
 
@@ -127,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
@@ -136,10 +131,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).
@@ -167,6 +170,69 @@ Deleting a device token will remove it from the associated customer to stop furt
 $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.
+
+```ruby
+$customerio.suppress(5)
+```
+
+### Unsuppress a user
+
+Start tracking events and identifies again for a previously suppressed customer. Note when a user is suppressed thier history is deleted and unsupressing them wil not recover that history.
+
+```ruby
+$customerio.unsuppress(5)
+```
+
+### Send Transactional Messages
+
+To use the Customer.io [Transactional API](https://customer.io/docs/transactional-api), create an instance of the API client using an [app key](https://customer.io/docs/managing-credentials#app-api-keys).
+
+Create a new `SendEmailRequest` object containing:
+
+* `transactional_message_id`: the ID of the transactional message you want to send, or the `body`, `from`, and `subject` of a new message.
+* `to`: the email address of your recipients 
+* an `identifiers` object containing the `id` of your recipient. If the `id` does not exist, Customer.io creates it.
+* a `message_data` object containing properties that you want reference in your message using liquid.
+* You can also send attachments with your message. Use `attach` to encode attachments.
+
+Use `send_email` referencing your request to send a transactional message. [Learn more about transactional messages and `SendEmailRequest` properties](https://customer.io/docs/transactional-api).
+
+
+```ruby
+require "customerio"
+
+client = Customerio::APIClient.new("your API key", region: Customerio::Regions::US)
+
+request = Customerio::SendEmailRequest.new(
+  to: "person@example.com",
+  transactional_message_id: "3",
+  message_data: {
+    name: "Person",
+    items: {
+      name: "shoes",
+      price: "59.99",
+    },
+    products: [],
+  },
+  identifiers: {
+    id: "2",
+  },
+)
+
+file = File.open('<file-path>', 'r')
+request.attach("filename", file.read)
+
+begin
+  response = client.send_email(request)
+  puts response
+rescue Customerio::InvalidResponse => e
+  puts e.code, e.message
+end
+```
+
 ## Contributing
 
 1. Fork it

data/customerio.gemspec

@@ -7,6 +7,7 @@ Gem::Specification.new do |gem|
   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.license       = "MIT"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
@@ -16,10 +17,10 @@ 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_development_dependency('rake', '~> 10.5')
   gem.add_development_dependency('rspec', '3.3.0')
-  gem.add_development_dependency('webmock', '1.24.2')
-  gem.add_development_dependency('addressable', '~> 2.3.6')
+  gem.add_development_dependency('webmock', '3.6.0')
   gem.add_development_dependency('json')
 end

data/lib/customerio.rb

@@ -1,6 +1,10 @@
 require "customerio/version"
 
 module Customerio
+  require "customerio/regions"
+  require "customerio/base_client"
   require "customerio/client"
+  require "customerio/requests/send_email_request"
+  require "customerio/api"
   require "customerio/param_encoder"
 end

data/lib/customerio/api.rb

@@ -0,0 +1,35 @@
+require 'net/http'
+require 'multi_json'
+
+module Customerio
+  class APIClient
+    def initialize(app_key, options = {})
+      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
+
+    def send_email(req)
+      raise "request must be an instance of Customerio::SendEmailRequest" unless req.is_a?(Customerio::SendEmailRequest)
+      response = @client.request(:post, send_email_path, req.message)
+
+      case response
+      when Net::HTTPSuccess then
+        JSON.parse(response.body)
+      when Net::HTTPBadRequest then
+        json = JSON.parse(response.body)
+        raise Customerio::InvalidResponse.new(response.code, json['meta']['error'], response)
+      else
+        raise InvalidResponse.new(response.code, response.body)
+      end
+    end
+
+    private
+
+    def send_email_path
+      "/v1/send/email"
+    end
+  end
+end

data/lib/customerio/base_client.rb

@@ -0,0 +1,87 @@
+require 'net/http'
+require 'multi_json'
+
+module Customerio
+  DEFAULT_TIMEOUT  = 10
+
+  class InvalidRequest < RuntimeError; end
+  class InvalidResponse < RuntimeError
+    attr_reader :code, :response
+
+    def initialize(code, body, response=nil)
+      @message = body
+      @code = code
+      @response = response
+
+      super(@message)
+    end
+  end
+
+  class BaseClient
+    def initialize(auth, options = {})
+      @auth = auth
+      @timeout = options[:timeout] || DEFAULT_TIMEOUT
+      @base_uri = options[:url]
+    end
+
+    def request(method, path, body = nil, headers = {})
+      execute(method, path, body, headers)
+    end
+
+    def request_and_verify_response(method, path, body = nil, headers = {})
+      verify_response(request(method, path, body, headers))
+    end
+
+    private
+
+    def execute(method, path, body = nil, headers = {})
+      uri = URI.join(@base_uri, path)
+
+      session = Net::HTTP.new(uri.host, uri.port)
+      session.use_ssl = (uri.scheme == 'https')
+      session.open_timeout = @timeout
+      session.read_timeout = @timeout
+
+      req = request_class(method).new(uri.path)
+
+      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]
+      else
+        headers['Authorization'] = "Bearer #{@auth[:app_key]}"
+        req.initialize_http_header(headers)
+      end
+
+      if !body.nil?
+        req.add_field('Content-Type', 'application/json')
+        req.body = MultiJson.dump(body)
+      end
+
+      session.start do |http|
+        http.request(req)
+      end
+    end
+
+    def request_class(method)
+      case method
+      when :post
+        Net::HTTP::Post
+      when :put
+        Net::HTTP::Put
+      when :delete
+        Net::HTTP::Delete
+      else
+        raise InvalidRequest.new("Invalid request method #{method.inspect}")
+      end
+    end
+
+    def verify_response(response)
+      case response
+      when Net::HTTPSuccess then
+        response
+      else
+        raise InvalidResponse.new(response.code, response.body, response)
+      end
+    end
+  end
+end