customerio 3.1.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48f0d7c8bb61994c6bee0e1b846772f7ab304913182a1d1ac87f52a6e4e9beff
-  data.tar.gz: e8df14b0db35439d08687a2ff61161d5d6bfc3a9f8ae6df71ba9c1cd7d4c91e9
+  metadata.gz: fbff37c21ea57a934d671356e89ef06114170d0b753c91048c255b399ce146de
+  data.tar.gz: 1d225801d24005870b63aa2f95850b47cef6ef822f7f3132ea9b7378cffaa852
 SHA512:
-  metadata.gz: 7fff0a46a46e90a65f39694abf8713abe1a5e9edd0f388d26fea80d305332ed8425998397822899a9b66f27e77fb98e1051cd332842c73cd20da0a7ad7380a9d
-  data.tar.gz: 1eab0fb3fe94024954b04f77c34029aa2b9a9b6a089d5d6aa86f9070101e0bf13e7019725e8031fcdd7af0ddf76532e4b2b85b6dfe7e482ecb5f407b339df381
+  metadata.gz: c41f22bc7fe6038432cd9e854c5bd18cd4b117f2320d02c3e142f5256cf0626de05e982db9676fdc3feed48cd26a6343e10717c196ab0e22b7d3798d4b5bb444
+  data.tar.gz: f70520dda7f7defab832cc4efc85771c10e3e042aff034512a261b630f73db2f63474b8103dbf43e4e98be29a0e03a20b0993f1a9e31871f84e2fad41d6d0f8c

data/.github/workflows/main.yml

@@ -1,6 +1,6 @@
 name: ruby_ci
 
-on: [push]
+on: [push,pull_request]
 
 jobs:
   build:

data/CHANGELOG.markdown

@@ -1,3 +1,13 @@
+## 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

data/README.md

@@ -131,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).

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/client.rb

@@ -2,6 +2,12 @@ require "addressable/uri"
 
 module Customerio
   class Client
+    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
 
@@ -39,9 +45,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={})
@@ -70,6 +78,19 @@ 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
+
     private
 
     def escape(val)
@@ -97,6 +118,10 @@ module Customerio
       "/api/v1/customers/#{escape(customer_id)}/unsuppress"
     end
 
+    def track_push_notification_event_path
+        "/push/events"
+    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])
@@ -106,16 +131,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
 

data/lib/customerio/version.rb

@@ -1,3 +1,3 @@
 module Customerio
-  VERSION = "3.1.0"
+  VERSION = "4.0.1"
 end

data/spec/client_spec.rb

@@ -150,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",
@@ -381,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",
@@ -413,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"
-            },
-          }).
-
-        to_return(status: 200, body: "", headers: {})
-
-      client.anonymous_track("purchase", type: "socks", price: "27.99")
-    end
+        lambda { client.track_anonymous(anon_id, "purchase") }.should raise_error(Customerio::InvalidResponse)
+      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
-          })).
+      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: {})
 
-        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
@@ -546,4 +513,83 @@ 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
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: customerio
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 4.0.1
 platform: ruby
 authors:
 - John Allison
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-25 00:00:00.000000000 Z
+date: 2021-07-13 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,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
 - ".github/workflows/main.yml"
 - ".gitignore"
 - CHANGELOG.markdown
@@ -141,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.0.1
 signing_key:
 specification_version: 4
 summary: A ruby client for the Customer.io event API.

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