customerio 2.2.1 → 3.0.0

checksums.yaml

@@ -1,17 +1,7 @@
 ---
-!binary "U0hBMjU2":
-  metadata.gz: !binary |-
-    NGJmMGRlMjNmNzZmNzFiZDI5NjM4YzRhNTczOWY1MzUzY2Y1MzVhMmMwZDg3
-    YTcyNTM4NDY5MjM4OTBiOTNlOA==
-  data.tar.gz: !binary |-
-    NDE5YWFjYmM4NjQxYWU2YThhZDNhYzM0ZDdmOTU2OWExNWZmODM4YjEwY2Ri
-    ZTZlOWIzNzU5ZDUyZmY4ZDg5Yg==
+SHA256:
+  metadata.gz: bd807525a01387116c22f29d0ac98e9b783fe669fd092da9d97cac74a660316d
+  data.tar.gz: 0ff5f3b518f07d5e3432a69e4a5738fd5bdeabc359593960bf9ac8f46081a7fc
 SHA512:
-  metadata.gz: !binary |-
-    MDkxMTRkNGZjYWQyYjIzZjEwODM2YzQxN2Y4YzVmZmZiOWE5YmU3NjUwYzdi
-    Zjg5NzE2ZDg1YWI0YTg2MDY5NTkzM2QwOWNlNTAwN2U3MThmODMwODU5YTVi
-    YzA1ZmM2OTFmYzVkNWIxMjhhMGViNjhhODQ1ZWJkODIxODlhODg=
-  data.tar.gz: !binary |-
-    YjNiNTRlZTNkMjg2NGEwNjNiZmEyMTQyZWZhNTMyYjgxZDI1MDkxOGM4MDI1
-    NjRlY2U4OTBmMTM0ZTM1ZDU5M2FkNjJjNjE2ZjhmZTRiMzE0ZmE1MWJkMTQx
-    NDE1MDNhMWYzYmFmZTBlMTJlZDU5OGQzOGQwYjM5ZWNkMGZhOTU=
+  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,3 +1,17 @@
+## 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)

data/README.md

@@ -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
@@ -183,20 +177,51 @@ Start tracking events and identifies again for a previously suppressed customer.
 $customerio.unsuppress(5)
 ```
 
-### Add customers to a manual segment
+### Send Transactional Messages
 
-Add the list of customer ids to the specified manual segment. If you send customer ids that don't exist yet in an add_to_segment request, we will automatically create customer profiles for the new customer ids.
+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).
 
-```ruby
-$customerio.add_to_segment(segment_id=1,customer_ids=['1','2','3'])
-```
+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.
 
-### Remove customers from a manual segment
+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).
 
-Remove the list of customer ids from the specified manual segment.
 
 ```ruby
-$customerio.remove_from_segment(segment_id=1,customer_ids=['1','2','3'])
+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

@@ -17,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,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

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

data/lib/customerio/client.rb

@@ -1,29 +1,15 @@
-require 'net/http'
-require 'multi_json'
+require "addressable/uri"
 
 module Customerio
-  DEFAULT_BASE_URI = 'https://track.customer.io'
-  DEFAULT_TIMEOUT  = 10
-
   class Client
+    DEFAULT_TRACK_URL = 'https://track.customer.io'
+
     class MissingIdAttributeError < RuntimeError; end
     class ParamError < RuntimeError; end
-    class InvalidRequest < RuntimeError; end
-    class InvalidResponse < RuntimeError
-      attr_reader :response
-
-      def initialize(message, response)
-        super(message)
-        @response = response
-      end
-    end
 
-    def initialize(site_id, secret_key, options = {})
-      @username = site_id
-      @password = secret_key
-      @json = options.has_key?(:json) ? options[:json] : true
-      @base_uri = options[:base_uri] || DEFAULT_BASE_URI
-      @timeout = options[:timeout] || DEFAULT_TIMEOUT
+    def initialize(site_id, api_key, options = {})
+      options[:url] = DEFAULT_TRACK_URL if options[:url].nil? || options[:url].empty?
+      @client = Customerio::BaseClient.new({ site_id: site_id, api_key: api_key }, options)
     end
 
     def identify(attributes)
@@ -31,41 +17,36 @@ module Customerio
     end
 
     def delete(customer_id)
-      verify_response(request(:delete, customer_path(customer_id)))
+      raise ParamError.new("customer_id must be a non-empty string") if is_empty?(customer_id)
+      @client.request_and_verify_response(:delete, customer_path(customer_id))
     end
 
     def suppress(customer_id)
-      verify_response(request(:post, suppress_path(customer_id)))
+      raise ParamError.new("customer_id must be a non-empty string") if is_empty?(customer_id)
+      @client.request_and_verify_response(:post, suppress_path(customer_id))
     end
 
     def unsuppress(customer_id)
-      verify_response(request(:post, unsuppress_path(customer_id)))
+      raise ParamError.new("customer_id must be a non-empty string") if is_empty?(customer_id)
+      @client.request_and_verify_response(:post, unsuppress_path(customer_id))
     end
 
-    def track(*args)
-      attributes = extract_attributes(args)
-
-      if args.length == 1
-        # Only passed in an event name, create an anonymous event
-        event_name = args.first
-        create_anonymous_event(event_name, attributes)
-      else
-        # Passed in a customer id and an event name.
-        # Track the event for the given customer
-        customer_id, event_name = args
+    def track(customer_id, event_name, attributes = {})
+      raise ParamError.new("customer_id must be a non-empty string") if is_empty?(customer_id)
+      raise ParamError.new("event_name must be a non-empty string") if is_empty?(event_name)
 
-        create_customer_event(customer_id, event_name, attributes)
-      end
+      create_customer_event(customer_id, event_name, attributes)
     end
 
     def anonymous_track(event_name, attributes = {})
+      raise ParamError.new("event_name must be a non-empty string") if is_empty?(event_name)
       create_anonymous_event(event_name, attributes)
     end
 
     def add_device(customer_id, device_id, platform, data={})
-      raise ParamError.new("customer_id must be a non-empty string") unless customer_id != "" and !customer_id.nil?
-      raise ParamError.new("device_id must be a non-empty string") unless device_id != "" and !device_id.nil?
-      raise ParamError.new("platform must be a non-empty string") unless platform != "" and !platform.nil?
+      raise ParamError.new("customer_id must be a non-empty string") if is_empty?(customer_id)
+      raise ParamError.new("device_id must be a non-empty string") if is_empty?(device_id)
+      raise ParamError.new("platform must be a non-empty string") if is_empty?(platform)
 
       if data.nil?
         data = {}
@@ -73,69 +54,54 @@ module Customerio
 
       raise ParamError.new("data parameter must be a hash") unless data.is_a?(Hash)
 
-      verify_response(request(:put, device_path(customer_id), {
+      @client.request_and_verify_response(:put, device_path(customer_id), {
         :device => data.update({
           :id => device_id,
           :platform => platform,
         })
-      }))
+      })
     end
 
     def delete_device(customer_id, device_id)
-      raise ParamError.new("customer_id must be a non-empty string") unless customer_id != "" and !customer_id.nil?
-      raise ParamError.new("device_id must be a non-empty string") unless device_id != "" and !device_id.nil?
-      
-      verify_response(request(:delete, device_id_path(customer_id, device_id)))
-    end
-
-    def add_to_segment(segment_id, customer_ids)
-      raise ParamError.new("segment_id must be an integer") unless segment_id.is_a? Integer
-      raise ParamError.new("customer_ids must be a list of values") unless customer_ids.is_a? Array
+      raise ParamError.new("customer_id must be a non-empty string") if is_empty?(customer_id)
+      raise ParamError.new("device_id must be a non-empty string") if is_empty?(device_id)
 
-      customer_ids = customer_ids.map{ |id| id.to_s }
-
-      verify_response(request(:post, add_to_segment_path(segment_id), {
-        :ids => customer_ids,
-      }))
+      @client.request_and_verify_response(:delete, device_id_path(customer_id, device_id))
     end
 
-    def remove_from_segment(segment_id, customer_ids)
-      raise ParamError.new("segment_id must be an integer") unless segment_id.is_a? Integer
-      raise ParamError.new("customer_ids must be a list of values") unless customer_ids.is_a? Array
+    private
 
-      customer_ids = customer_ids.map{ |id| id.to_s }
-      
-      verify_response(request(:post, remove_from_segment_path(segment_id), {
-        :ids => customer_ids,
-      }))
+    def escape(val)
+      # CGI.escape is recommended for escaping, however, it doesn't correctly escape spaces.
+      Addressable::URI.encode_component(val.to_s, Addressable::URI::CharacterClasses::UNRESERVED)
     end
 
-    private
+    def device_path(customer_id)
+      "/api/v1/customers/#{escape(customer_id)}/devices"
+    end
 
-    def add_to_segment_path(segment_id)
-      "/api/v1/segments/#{segment_id}/add_customers"
+    def device_id_path(customer_id, device_id)
+      "/api/v1/customers/#{escape(customer_id)}/devices/#{escape(device_id)}"
     end
 
-    def remove_from_segment_path(segment_id)
-      "/api/v1/segments/#{segment_id}/remove_customers"
+    def customer_path(id)
+      "/api/v1/customers/#{escape(id)}"
     end
 
-    def device_path(customer_id)
-      "/api/v1/customers/#{customer_id}/devices"
+    def suppress_path(customer_id)
+      "/api/v1/customers/#{escape(customer_id)}/suppress"
     end
 
-    def device_id_path(customer_id, device_id)
-      "/api/v1/customers/#{customer_id}/devices/#{device_id}"
+    def unsuppress_path(customer_id)
+      "/api/v1/customers/#{escape(customer_id)}/unsuppress"
     end
 
     def create_or_update(attributes = {})
       attributes = Hash[attributes.map { |(k,v)| [ k.to_sym, v ] }]
-
-      raise MissingIdAttributeError.new("Must provide a customer id") unless attributes[:id]
+      raise MissingIdAttributeError.new("Must provide a customer id") if is_empty?(attributes[:id])
 
       url = customer_path(attributes[:id])
-
-      verify_response(request(:put, url, attributes))
+      @client.request_and_verify_response(:put, url, attributes)
     end
 
     def create_customer_event(customer_id, event_name, attributes = {})
@@ -149,79 +115,15 @@ module Customerio
     def create_event(url, event_name, attributes = {})
       body = { :name => event_name, :data => attributes }
       body[:timestamp] = attributes[:timestamp] if valid_timestamp?(attributes[:timestamp])
-      verify_response(request(:post, url, body))
-    end
-
-    def customer_path(id)
-      "/api/v1/customers/#{id}"
-    end
-
-    def suppress_path(customer_id)
-      "/api/v1/customers/#{customer_id}/suppress"
-    end
-
-    def unsuppress_path(customer_id)
-      "/api/v1/customers/#{customer_id}/unsuppress"
+      @client.request_and_verify_response(:post, url, body)
     end
 
     def valid_timestamp?(timestamp)
       timestamp && timestamp.is_a?(Integer) && timestamp > 999999999 && timestamp < 100000000000
     end
 
-
-    def verify_response(response)
-      if response.code.to_i >= 200 && response.code.to_i < 300
-        response
-      else
-        raise InvalidResponse.new("Customer.io API returned an invalid response: #{response.code}", response)
-      end
-    end
-
-    def extract_attributes(args)
-      hash = args.last.is_a?(Hash) ? args.pop : {}
-      hash.inject({}){ |hash, (k,v)| hash[k.to_sym] = v; hash }
-    end
-
-    def request(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)
-      req.initialize_http_header(headers)
-      req.basic_auth @username, @password
-
-      add_request_body(req, body) unless body.nil?
-
-      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 add_request_body(req, body)
-      if @json
-        req.add_field('Content-Type', 'application/json')
-        req.body = MultiJson.dump(body)
-      else
-        req.add_field('Content-Type', 'application/x-www-form-urlencoded')
-        req.body = ParamEncoder.to_params(body)
-      end
+    def is_empty?(val)
+      val.nil? || (val.is_a?(String) && val.strip == "")
     end
   end
 end