customerio 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 0bbd80c03cec96e156a839df078eea4f2d58bfde
-  data.tar.gz: fe118df2f5e167994e0f51914812610839eb9bde
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MzQwYTIwYmZjMDliN2UzNGU0ZGVjOWFlYmEyMGI0MTFiNWExNDViYQ==
+  data.tar.gz: !binary |-
+    M2JhZDY0NDQyNTBiMmU4NjBkOGZlNGU3NWM4YzM4ZGRlMDUxYWI2YQ==
 SHA512:
-  metadata.gz: e57f979df8e8fb749178c77e6e21e210ddbacf7eee8eaea0f68f67cf0ec6037d80bd4a3db969325eca55fdae565bbd46d5169dce143950c095b3b777dd1b9949
-  data.tar.gz: a7e39880c576e2f3945f228d09649ee1c281d508d08fbe44f7de9beb982ba46b0dd2dd16b0a2b273e9d027cd485458ac39674423d3e2f6c0c6638a1de5e4e369
+  metadata.gz: !binary |-
+    ZjAyNzRiM2NiMTNiYmZhYjZiOTk4MjAxZWIyMzk3MWMwNjdlZjk2NzBhOTIw
+    MmE4ZmUzNTMzZWE0NDNmY2NiMjNmOGU1NDMyMTdiNzY1YzhhOGY4MDE5NWJl
+    ZWVkNWU3YTk2OTAxNzI1NGIwM2U5ZTVjMzJiZjdiNWU3YWZkMDQ=
+  data.tar.gz: !binary |-
+    NGM4NjAwYjdiZjlhZGZkMWRkZjg2MWU1MGM2OGIxNjU1MjM2ZDk2ZjhjNjgz
+    MjlkYzE0ODdhZjM2ZmZkMWZhYzE2ZThlMzE4ZTg2MDdiYTQwYzg0MmY0Y2Uw
+    M2JkYWVlY2U3MDQ0NzNlNTcxOTgyNTU0NTZmMTZkMjliM2FjNzM=

data/.gitignore

@@ -2,6 +2,7 @@
 *.rbc
 .bundle
 .config
+Gemfile.lock
 coverage
 InstalledFiles
 lib/bundler/man
@@ -11,6 +12,7 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+vendor
 
 # YARD artifacts
 .yardoc

data/.travis.yml

@@ -1,8 +1,12 @@
+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

data/CHANGELOG.markdown

@@ -1,3 +1,19 @@
+## 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.
+
+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)
+```
+
+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)
+
 ## Customerio 0.5.0 - Mar 28, 2014 ##
 
 * Added flag to send body encoded as JSON, rather than the default form encoding.

data/customerio.gemspec

@@ -15,7 +15,8 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Customerio::VERSION
 
-  gem.add_dependency('httparty', ["< 1.0", ">= 0.5"])
+  gem.add_dependency('httparty', ["< 0.12", ">= 0.5"])
+  gem.add_dependency('multi_json', "~> 1.0")
 
   gem.add_development_dependency('rake')
   gem.add_development_dependency('rspec')

data/lib/customerio/client.rb

@@ -1,16 +1,20 @@
 require 'httparty'
-require 'json'
+require 'multi_json'
 
 module Customerio
   class Client
     include HTTParty
     base_uri 'https://track.customer.io'
+    default_timeout 10
 
     class MissingIdAttributeError < RuntimeError; end
     class InvalidResponse < RuntimeError; end
 
     def initialize(site_id, secret_key, options = {})
       @auth = { :username => site_id, :password => secret_key }
+      if options[:json].nil?
+        warn "[DEPRECATION] Customerio::Client: JSON encoding will be the default in the next release. We recommend switching to JSON. To continue to use form-encoding, you must specify `:json => false` in your initializer."
+      end
       @json = options[:json]
     end
 
@@ -41,12 +45,14 @@ module Customerio
     private
 
     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]
 
       url = customer_path(attributes[:id])
 
       if @json
-        verify_response(self.class.put(url, options.merge(:body => attributes.to_json, :headers => {'Content-Type' => 'application/json'})))
+        verify_response(self.class.put(url, options.merge(:body => MultiJson.dump(attributes), :headers => {'Content-Type' => 'application/json'})))
       else
         verify_response(self.class.put(url, options.merge(:body => attributes)))
       end
@@ -63,7 +69,11 @@ 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(self.class.post(url, options.merge(:body => body)))
+      if @json
+        verify_response(self.class.post(url, options.merge(:body => MultiJson.dump(body), :headers => {'Content-Type' => 'application/json'})))
+      else
+        verify_response(self.class.post(url, options.merge(:body => body)))
+      end
     end
 
     def customer_path(id)

data/lib/customerio/version.rb

@@ -1,3 +1,3 @@
 module Customerio
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
 end

data/readme.markdown

@@ -1,9 +1,9 @@
 # Customerio
 
-A ruby client for the [Customer.io](http://customer.io) [event API](https://app.customer.io/api/docs/index.html).
+A ruby client for the [Customer.io](http://customer.io) [event API](http://customer.io/docs/api/overview.html).
 
 [![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/badge.png)](https://codeclimate.com/github/customerio/customerio-ruby)
+[![Code Climate](https://codeclimate.com/github/customerio/customerio-ruby/badges/gpa.svg)](https://codeclimate.com/github/customerio/customerio-ruby)
 
 ## Installation
 
@@ -43,15 +43,19 @@ 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 in your [customer.io settings](https://app.customer.io/settings).
+which can be found on the [customer.io integration screen](https://manage.customer.io/integration).
 
 If you're using Rails, create an initializer `config/initializers/customerio.rb`:
 
-    customerio = Customerio::Client.new("YOUR SITE ID", "YOUR API SECRET KEY")
+```ruby
+$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:
 
-    customerio = Customerio::Client.new("YOUR SITE ID", "YOUR API SECRET KEY", :json => true)
+```ruby
+customerio = Customerio::Client.new("YOUR SITE ID", "YOUR API SECRET KEY", :json => true)
+```
 
 ### Identify logged in customers
 
@@ -74,18 +78,20 @@ particular plan (e.g. "premium").
 You'll want to indentify your customers when they sign up for your app and any time their
 key information changes. This keeps [Customer.io](http://customer.io) up to date with your customer information.
 
-    # Arguments
-    # attributes (required) - a hash of information about the customer. You can pass any
-    #                         information that would be useful in your triggers. You 
-    #                         must at least pass in an id, email, and created_at timestamp.
-
-    customerio.identify(
-      :id => 5,
-      :email => "bob@example.com,
-      :created_at => customer.created_at.to_i,
-      :first_name => "Bob",
-      :plan => "basic"
-    )
+```ruby
+# Arguments
+# attributes (required) - a hash of information about the customer. You can pass any
+#                         information that would be useful in your triggers. You 
+#                         must at least pass in an id, email, and created_at timestamp.
+
+$customerio.identify(
+  :id => 5,
+  :email => "bob@example.com",
+  :created_at => customer.created_at.to_i,
+  :first_name => "Bob",
+  :plan => "basic"
+)
+```
 
 ### Deleting customers
 
@@ -94,12 +100,14 @@ Customer.io.  Note: if you're still sending data to Customer.io via
 other means (such as the javascript snippet), the customer could be
 recreated.
 
-    # Arguments
-    # customer_id (required) - a unique identifier for the customer.  This
-    #                          should be the same id you'd pass into the
-    #                          `identify` command above.
+```ruby
+# Arguments
+# customer_id (required) - a unique identifier for the customer.  This
+#                          should be the same id you'd pass into the
+#                          `identify` command above.
 
-    customerio.delete(5)
+$customerio.delete(5)
+```
 
 ### Tracking a custom event
 
@@ -108,19 +116,23 @@ Now that you're identifying your customers with [Customer.io](http://customer.io
 with automated emails, and track conversions when you're sending automated emails to
 encourage your customers to perform an action.
 
-    # Arguments
-    # customer_id (required) - the id of the customer who you want to associate with the event.
-    # name (required)        - the name of the event you want to track.
-    # attributes (optional)  - any related information you'd like to attach to this
-    #                          event. These attributes can be used in your triggers to control who should
-    #                          receive the triggered email. You can set any number of data values.
+```ruby
+# Arguments
+# customer_id (required) - the id of the customer who you want to associate with the event.
+# name (required)        - the name of the event you want to track.
+# attributes (optional)  - any related information you'd like to attach to this
+#                          event. These attributes can be used in your triggers to control who should
+#                          receive the triggered email. You can set any number of data values.
 
-    customerio.track(5, "purchase", :type => "socks", :price => "13.99")
+$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
 (in seconds since the epoch), and we'll use that as the date the event occurred.
 
-    customerio.track(5, "purchase", :type => "socks", :price => "13.99", :timestamp => 1365436200)
+```ruby
+$customerio.track(5, "purchase", :type => "socks", :price => "13.99", :timestamp => 1365436200)
+```
 
 ## Contributing
 

data/spec/client_spec.rb

@@ -1,8 +1,9 @@
 require 'spec_helper'
+require 'multi_json'
 
 describe Customerio::Client do
-	let(:client)   { Customerio::Client.new("SITE_ID", "API_KEY") }
-  let(:response) { mock("Response", :code => 200) }
+  let(:client)   { Customerio::Client.new("SITE_ID", "API_KEY", :json => false) }
+  let(:response) { double("Response", :code => 200) }
 
   before do
     # Dont call out to customer.io
@@ -24,16 +25,18 @@ describe Customerio::Client do
 
     it "sends a PUT request to customer.io's customer API using json headers" do
       client = Customerio::Client.new("SITE_ID", "API_KEY", :json => true)
+      body = { :id => 5, :name => "Bob" }
+      json = MultiJson.dump(body)
       Customerio::Client.should_receive(:put).with(
         "/api/v1/customers/5",
         {:basic_auth=>{:username=>"SITE_ID", :password=>"API_KEY"},
-          :body=>"{\"id\":5,\"name\":\"Bob\"}",
+          :body=>json,
           :headers=>{"Content-Type"=>"application/json"}}).and_return(response)
-      client.identify(:id => 5, :name => "Bob")
+      client.identify(body)
     end
 
     it "raises an error if PUT doesn't return a 2xx response code" do
-      Customerio::Client.should_receive(:put).and_return(mock("Response", :code => 500))
+      Customerio::Client.should_receive(:put).and_return(double("Response", :code => 500))
       lambda { client.identify(:id => 5) }.should raise_error(Customerio::Client::InvalidResponse)
     end
 
@@ -64,6 +67,12 @@ describe Customerio::Client do
     it "requires an id attribute" do
       lambda { client.identify(:email => "customer@example.com") }.should raise_error(Customerio::Client::MissingIdAttributeError)
     end
+
+    it 'should not raise errors when attribute keys are strings' do
+      attributes = { "id" => 5 }
+
+      lambda { client.identify(attributes) }.should_not raise_error()
+    end
   end
 
   describe "#delete" do
@@ -80,7 +89,7 @@ describe Customerio::Client do
   	end
 
     it "raises an error if POST doesn't return a 2xx response code" do
-      Customerio::Client.should_receive(:post).and_return(mock("Response", :code => 500))
+      Customerio::Client.should_receive(:post).and_return(double("Response", :code => 500))
       lambda { client.track(5, "purchase") }.should raise_error(Customerio::Client::InvalidResponse)
     end
 
@@ -114,6 +123,20 @@ describe Customerio::Client do
       client.track(5, "purchase", :type => "socks", :price => "13.99")
   	end
 
+    it "sends a POST request as json using json headers" do
+      client = Customerio::Client.new("SITE_ID", "API_KEY", :json => true)
+  		Customerio::Client.should_receive(:post).with(
+        "/api/v1/customers/5/events", {
+          :basic_auth => anything(),
+          :body => MultiJson.dump({
+            :name => "purchase",
+            :data => { :type => "socks", :price => "13.99" }
+          }),
+        :headers=>{"Content-Type"=>"application/json"}}).and_return(response)
+      client.track(5, "purchase", :type => "socks", :price => "13.99")
+    end
+
+
   	it "allows sending of a timestamp" do
   		Customerio::Client.should_receive(:post).with("/api/v1/customers/5/events", {
   			:basic_auth => anything(),

data/spec/spec_helper.rb

@@ -5,3 +5,9 @@ require 'customerio'
 require 'fakeweb'
 
 FakeWeb.allow_net_connect = false
+
+require 'rspec'
+RSpec.configure do |config|
+  config.expect_with(:rspec) { |c| c.syntax = :should }
+  config.mock_with(:rspec) { |c| c.syntax = :should }
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: customerio
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - John Allison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-28 00:00:00.000000000 Z
+date: 2015-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -16,8 +16,8 @@ dependencies:
     requirements:
     - - <
       - !ruby/object:Gem::Version
-        version: '1.0'
-    - - '>='
+        version: '0.12'
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0.5'
   type: :runtime
@@ -26,50 +26,64 @@ dependencies:
     requirements:
     - - <
       - !ruby/object:Gem::Version
-        version: '1.0'
-    - - '>='
+        version: '0.12'
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: fakeweb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: A ruby client for the Customer.io event API.
@@ -83,7 +97,6 @@ files:
 - .travis.yml
 - CHANGELOG.markdown
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - Rakefile
 - customerio.gemspec
@@ -102,17 +115,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.4.7
 signing_key: 
 specification_version: 4
 summary: A ruby client for the Customer.io event API.

data/Gemfile.lock

@@ -1,34 +0,0 @@
-PATH
-  remote: .
-  specs:
-    customerio (0.5.0)
-      httparty (>= 0.5, < 1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    diff-lcs (1.1.3)
-    fakeweb (1.3.0)
-    httparty (0.10.2)
-      multi_json (~> 1.0)
-      multi_xml (>= 0.5.2)
-    multi_json (1.7.0)
-    multi_xml (0.5.3)
-    rake (0.9.2.2)
-    rspec (2.8.0)
-      rspec-core (~> 2.8.0)
-      rspec-expectations (~> 2.8.0)
-      rspec-mocks (~> 2.8.0)
-    rspec-core (2.8.0)
-    rspec-expectations (2.8.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.8.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  customerio!
-  fakeweb
-  rake
-  rspec