customerio 1.0.0 → 3.0.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MWFhMDk1ZmMzOTBjZTZhMzYxNGYyZTJmZDFlMTdiZWI1NjdhMTY4YQ==
-  data.tar.gz: !binary |-
-    YmMyODY3OTIxMjhkN2MxYzVlNzdlOWRiOTgxNzc2OWUyYWJjNDc0Ng==
+SHA256:
+  metadata.gz: bd807525a01387116c22f29d0ac98e9b783fe669fd092da9d97cac74a660316d
+  data.tar.gz: 0ff5f3b518f07d5e3432a69e4a5738fd5bdeabc359593960bf9ac8f46081a7fc
 SHA512:
-  metadata.gz: !binary |-
-    NjA5OWUwZDU4ZmJmYjA3YmQ4ZTY0ZDhlNWQzMjU2MDViNzk3NjkxNzI2Zjcw
-    YjFjNDg4N2Q5YzQwMWIxZGJkZWFmNzNlYTEzYjVkNWZlY2Q4MjgyNjM3MWNm
-    M2ZjMzU5MGUyMzljOTg0NTA0OWM5NDZkMDU4MTVlMzViNDEzYWU=
-  data.tar.gz: !binary |-
-    YTMxNjA2NzJjNzU2ZDExNzBjZDYxODBhMDRiMTg1MWE3ZDIzMmI5YzcxYzE5
-    MGNhNTc5YTJmYjRmNjBlYTljODU3YzhiMGZiZGNkM2UyOTZhYzkyMWE0ZTBl
-    MGY2Mzg1YzMyMGYxNzg2NGY1YjY4YmFhZjkwYzVjN2IxYjNkYTE=
+  metadata.gz: 07a1b0e3472abe674a69413e81e6cf2b87c5002a3b074a26053efc0b8da2e7d91d380055c54409922d35ff2d876aeb22c956ce1ea246842ec1ce08ad3079f35b
+  data.tar.gz: eb291aab81e6e802a204d7c0b2d36890fa2ce26cf82c3af773a8cfddcacdc9b0d4fca7c684aee03a884bafdda4ac088c234294d197fe28041bae2573b186a1da

data/.circleci/config.yml

@@ -0,0 +1,61 @@
+---
+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

data/CHANGELOG.markdown

@@ -1,38 +1,71 @@
-## Customerio 1.0.0 - Mar 15, 2016 ##
+## 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
+
+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)
+
+## 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.
 
@@ -44,46 +77,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

@@ -1,6 +1,6 @@
 # Customerio
 
-A ruby client for the [Customer.io](http://customer.io) [event API](http://customer.io/docs/api/overview.html).
+A ruby client for the [Customer.io](http://customer.io) [event API](http://learn.customer.io/api/).
 
 [![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)
@@ -24,7 +24,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://customer.io/docs/basic-integration.html).
+through the [Customer.io JavaScript snippet](http://learn.customer.io/developer-documentation/javascript-quick-start.html).
 
 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:
@@ -43,7 +43,7 @@ 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://manage.customer.io/integration).
+which can be found on the [customer.io integration screen](https://fly.customer.io/account/customerio_integration).
 
 If you're using Rails, create an initializer `config/initializers/customerio.rb`:
 
@@ -51,12 +51,6 @@ If you're using Rails, create an initializer `config/initializers/customerio.rb`
 $customerio = Customerio::Client.new("YOUR SITE ID", "YOUR API SECRET KEY")
 ```
 
-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)
-```
-
 ### Identify logged in customers
 
 Tracking data of logged in customers is a key part of [Customer.io](http://customer.io). In order to
@@ -142,7 +136,93 @@ You can also send anonymous events, for situations where you don't yet have a cu
 $customerio.anonymous_track("help_enquiry", :recipient => 'user@example.com')
 ```
 
-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/invitation-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://learn.customer.io/recipes/invite-emails.html).
+
+### Adding a mobile device
+
+To send push notifications, you can add ios and android device tokens to a customer:
+
+```ruby
+$customerio.add_device(5, "my_ios_device_id", "ios")
+$customerio.add_device(5, "my_android_device_id", "android")
+```
+
+Optionally, `last_used` can be passed in to specify the last touch of the device. Otherwise, this attribute is set by the API.
+
+```ruby
+$customerio.add_device(5, "my_ios_device_id", "ios", {:last_used=>Time.now.to_i})
+```
+
+### Removing a mobile device
+
+Deleting a device token will remove it from the associated customer to stop further push notifications from being sent for that device
+
+```ruby
+$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")
+
+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
 

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')
-  gem.add_development_dependency('rspec')
-  gem.add_development_dependency('webmock')
-  gem.add_development_dependency('addressable', '~> 2.3.6')
+  gem.add_development_dependency('rake', '~> 10.5')
+  gem.add_development_dependency('rspec', '3.3.0')
+  gem.add_development_dependency('webmock', '3.6.0')
   gem.add_development_dependency('json')
 end

data/lib/customerio.rb

@@ -1,6 +1,9 @@
 require "customerio/version"
 
 module Customerio
+  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,34 @@
+require 'net/http'
+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?
+      @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