customerio 1.0.0 → 2.0.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MWFhMDk1ZmMzOTBjZTZhMzYxNGYyZTJmZDFlMTdiZWI1NjdhMTY4YQ==
+    ZGQ1ZjA4MDkwN2JhMDljOTRjODBhOTdhZjllMDg0YTZmOGRlMmI0Yg==
   data.tar.gz: !binary |-
-    YmMyODY3OTIxMjhkN2MxYzVlNzdlOWRiOTgxNzc2OWUyYWJjNDc0Ng==
+    NTk1ODZkN2MwMDY0ZjI5ZDI4MTk3ZjlmZjI3MDdhZGVlYTdjYTJiNg==
 SHA512:
   metadata.gz: !binary |-
-    NjA5OWUwZDU4ZmJmYjA3YmQ4ZTY0ZDhlNWQzMjU2MDViNzk3NjkxNzI2Zjcw
-    YjFjNDg4N2Q5YzQwMWIxZGJkZWFmNzNlYTEzYjVkNWZlY2Q4MjgyNjM3MWNm
-    M2ZjMzU5MGUyMzljOTg0NTA0OWM5NDZkMDU4MTVlMzViNDEzYWU=
+    YTNmYjQxYmU1YWM1ZmRiYjNjZWFhZjE5NjczZmE2MTI5NWIyMjhjNGYzYjkw
+    YjAxMjYwOTI3ZGZiNDhmZjgwNGNmYzNlMmIwY2Y2ODg3ODQ0NjA3ZGNjODVl
+    OTg5YzU1NWJlYzJjNDAwZWM5OWM3MWE0ZDk5NzY5NmUzMzgyNTU=
   data.tar.gz: !binary |-
-    YTMxNjA2NzJjNzU2ZDExNzBjZDYxODBhMDRiMTg1MWE3ZDIzMmI5YzcxYzE5
-    MGNhNTc5YTJmYjRmNjBlYTljODU3YzhiMGZiZGNkM2UyOTZhYzkyMWE0ZTBl
-    MGY2Mzg1YzMyMGYxNzg2NGY1YjY4YmFhZjkwYzVjN2IxYjNkYTE=
+    YmU2NzM4N2ZiNDI0MmU1MTA5MmQ1N2U1ZDc5OGM3OGY3NTg2ODExY2Y0YzAz
+    YmI2Y2YyOTBkMDVkOGYzMDg0ZWZjMDZhMGI2YjgyMjNjNTBkYWNiMjc1Zjhk
+    YjA5MWZjODg4ZGU1NGFiMWMwNzQxN2VmZTRkNzg4MGUzYTk1MGI=

data/.travis.yml

@@ -1,14 +1,9 @@
 sudo: false
 language: ruby
 rvm:
-  - 1.8.7
   - 1.9.2
   - 1.9.3
   - 2.0.0
   - 2.1.6
   - 2.2.2
-  - jruby-18mode
   - jruby-19mode
-  - jruby-head
-  - ree
-  - ruby-head

data/CHANGELOG.markdown

@@ -1,3 +1,9 @@
+## 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`.

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`:
 
@@ -142,7 +142,30 @@ 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")
+```
 
 ## Contributing
 

data/customerio.gemspec

@@ -17,9 +17,9 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency('multi_json', "~> 1.0")
 
-  gem.add_development_dependency('rake')
-  gem.add_development_dependency('rspec')
-  gem.add_development_dependency('webmock')
+  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('json')
 end

data/lib/customerio/client.rb

@@ -7,6 +7,7 @@ module Customerio
 
   class Client
     class MissingIdAttributeError < RuntimeError; end
+    class ParamError < RuntimeError; end
     class InvalidRequest < RuntimeError; end
     class InvalidResponse < RuntimeError
       attr_reader :response
@@ -53,8 +54,42 @@ module Customerio
       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?
+
+      if data.nil?
+        data = {}
+      end
+
+      raise ParamError.new("data parameter must be a hash") unless data.is_a?(Hash)
+
+      verify_response(request(: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
+
     private
 
+    def device_path(customer_id)
+      "/api/v1/customers/#{customer_id}/devices"
+    end
+
+    def device_id_path(customer_id, device_id)
+      "/api/v1/customers/#{customer_id}/devices/#{device_id}"
+    end
+
     def create_or_update(attributes = {})
       attributes = Hash[attributes.map { |(k,v)| [ k.to_sym, v ] }]
 

data/lib/customerio/version.rb

@@ -1,3 +1,3 @@
 module Customerio
-  VERSION = "1.0.0"
+  VERSION = "2.0.0"
 end

data/spec/client_spec.rb

@@ -355,4 +355,67 @@ describe Customerio::Client do
       end
     end
   end
+
+  describe "#devices" do
+    it "allows for the creation of a new device" do
+      stub_request(:put, api_uri('/api/v1/customers/5/devices')).
+        to_return(:status => 200, :body => "", :headers => {})
+
+      client.add_device(5, "androidDeviceID", "ios", {:last_used=>1561235678})
+      client.add_device(5, "iosDeviceID", "android")
+    end
+    it "requires a valid customer_id when creating" do
+      stub_request(:put, api_uri('/api/v1/customers/5/devices')).
+        to_return(:status => 200, :body => "", :headers => {})
+
+       lambda { client.add_device("", "ios", "myDeviceID") }.should raise_error(Customerio::Client::ParamError)
+       lambda { client.add_device(nil, "ios", "myDeviceID", {:last_used=>1561235678}) }.should raise_error(Customerio::Client::ParamError)
+    end
+    it "requires a valid token when creating" do
+      stub_request(:put, api_uri('/api/v1/customers/5/devices')).
+        to_return(:status => 200, :body => "", :headers => {})
+
+       lambda { client.add_device(5, "", "ios") }.should raise_error(Customerio::Client::ParamError)
+       lambda { client.add_device(5, nil, "ios", {:last_used=>1561235678}) }.should raise_error(Customerio::Client::ParamError)
+    end
+    it "requires a valid platform when creating" do
+      stub_request(:put, api_uri('/api/v1/customers/5/devices')).
+        to_return(:status => 200, :body => "", :headers => {})
+
+       lambda { client.add_device(5, "token", "") }.should raise_error(Customerio::Client::ParamError)
+       lambda { client.add_device(5, "toke", nil, {:last_used=>1561235678}) }.should raise_error(Customerio::Client::ParamError)
+    end
+    it "accepts a nil data param" do
+      stub_request(:put, api_uri('/api/v1/customers/5/devices')).
+        to_return(:status => 200, :body => "", :headers => {})
+
+        client.add_device(5, "ios", "myDeviceID", nil)
+    end
+    it "fails on invalid data param" do
+      stub_request(:put, api_uri('/api/v1/customers/5/devices')).
+        to_return(:status => 200, :body => "", :headers => {})
+
+       lambda { client.add_device(5, "ios", "myDeviceID", 1000) }.should raise_error(Customerio::Client::ParamError)
+    end
+    it "supports deletion of devices by token" do
+      stub_request(:delete, api_uri('/api/v1/customers/5/devices/myDeviceID')).
+        to_return(:status => 200, :body => "", :headers => {})
+
+      client.delete_device(5, "myDeviceID")
+    end
+    it "requires a valid customer_id when deleting" do
+      stub_request(:delete, api_uri('/api/v1/customers/5/devices/myDeviceID')).
+        to_return(:status => 200, :body => "", :headers => {})
+
+       lambda { client.delete_device("", "myDeviceID") }.should raise_error(Customerio::Client::ParamError)
+       lambda { client.delete_device(nil, "myDeviceID") }.should raise_error(Customerio::Client::ParamError)
+    end
+    it "requires a valid device_id when deleting" do
+      stub_request(:delete, api_uri('/api/v1/customers/5/devices/myDeviceID')).
+        to_return(:status => 200, :body => "", :headers => {})
+
+       lambda { client.delete_device(5, "") }.should raise_error(Customerio::Client::ParamError)
+       lambda { client.delete_device(5, nil) }.should raise_error(Customerio::Client::ParamError)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: customerio
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - John Allison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-15 00:00:00.000000000 Z
+date: 2018-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -28,44 +28,44 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.5'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.3.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.24.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.24.2
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -134,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.7
+rubygems_version: 2.6.2
 signing_key: 
 specification_version: 4
 summary: A ruby client for the Customer.io event API.