customerio 0.1.0 → 0.2.0

data/CHANGELOG.markdown

@@ -0,0 +1,17 @@
+## 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.
+
+## Customerio 0.1.0 - Nov 15, 2012 ##
+
+* Allow tracking of anonymous events.
+
+## Customerio 0.0.3 - Nov 5, 2012 ## 
+
+* Bump httparty dependency to the latest version.
+
+## Customerio 0.0.2 - May 22, 2012 ##
+
+* First release.

data/Gemfile.lock

@@ -1,17 +1,22 @@
 PATH
   remote: .
   specs:
-    customerio (0.0.3)
+    customerio (0.2.0)
+      activesupport
       httparty (~> 0.9.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (3.2.9)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
     diff-lcs (1.1.3)
     fakeweb (1.3.0)
     httparty (0.9.0)
       multi_json (~> 1.0)
       multi_xml
+    i18n (0.6.1)
     multi_json (1.3.7)
     multi_xml (0.5.1)
     rake (0.9.2.2)

data/customerio.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |gem|
   gem.version       = Customerio::VERSION
 
   gem.add_dependency('httparty', '~> 0.9.0')
+  gem.add_dependency('activesupport')
 
   gem.add_development_dependency('rake')
   gem.add_development_dependency('rspec')

data/lib/customerio/client.rb

@@ -1,13 +1,20 @@
 require 'httparty'
+require 'active_support/hash_with_indifferent_access'
 
 module Customerio
   class Client
 	  include HTTParty
 	  base_uri 'https://app.customer.io'
 
+    CustomerProxy = Struct.new("Customer", :id)
+
+    class MissingIdAttributeError < RuntimeError; end
+    class InvalidResponse < RuntimeError; end
+
 	  @@id_block = nil
 
 	  def self.id(&block)
+      warn "[DEPRECATION] Customerio::Client.id customization is deprecated."
       @@id_block = block
 	  end
 
@@ -19,40 +26,47 @@ module Customerio
 	    @auth = { :username => site_id, :password => secret_key }
 	  end
 
-	  def identify(customer, attributes = {})
-	    create_or_update(customer, attributes)
+	  def identify(*args)
+      attributes = extract_attributes(args)
+
+      if args.any?
+        customer   = args.first
+        attributes = attributes_from(customer).merge(attributes)
+      end
+
+	    create_or_update(attributes)
 	  end
 
 	  def track(*args)
-      hash = args.last.is_a?(Hash) ? args.pop : {}
+      attributes = extract_attributes(args)
 
       if args.length == 1
         # Only passed in an event name, create an anonymous event
-        create_anonymous_event(args.first, hash)
+        event_name = args.first
+        create_anonymous_event(event_name, attributes)
       else
         # Passed in a customer and an event name.
         # Track the event for the given customer
         customer, event_name = args
 
-        identify(customer)
-        create_customer_event(customer, event_name, hash)
+        identify(attributes_from(customer))
+        create_customer_event(id_from(customer), event_name, attributes)
       end
 	  end
 
 	  private
 
-	  def create_or_update(customer, attributes = {})
-	    body = {
-	      :id => id(customer),
-	      :email => customer.email,
-	      :created_at => customer.created_at.to_i
-	    }.merge(attributes)
+	  def create_or_update(attributes = {})
+      raise MissingIdAttributeError.new("Must provide an customer id") unless attributes[:id]
+
+      url = customer_path(attributes[:id])
+      attributes[:id] = custom_id(attributes[:id])
 
-	    self.class.put(customer_path(customer), options.merge(:body => body))
+	    verify_response(self.class.put(url, options.merge(:body => attributes)))
 	  end
 
-	  def create_customer_event(customer, event_name, attributes = {})
-      create_event("#{customer_path(customer)}/events", event_name, attributes)
+	  def create_customer_event(customer_id, event_name, attributes = {})
+      create_event("#{customer_path(customer_id)}/events", event_name, attributes)
 	  end
 
     def create_anonymous_event(event_name, attributes = {})
@@ -61,17 +75,54 @@ module Customerio
 
 	  def create_event(url, event_name, attributes = {})
 	  	body = { :name => event_name, :data => attributes }
-	    self.class.post(url, options.merge(:body => body))
+	    verify_response(self.class.post(url, options.merge(:body => body)))
 	  end
 
-	  def customer_path(customer)
-	    "/api/v1/customers/#{id(customer)}"
+	  def customer_path(id)
+	    "/api/v1/customers/#{custom_id(id)}"
 	  end
 
-	  def id(customer)
-	  	@@id_block ? @@id_block.call(customer) : customer.id
+    def verify_response(response)
+      if response.code >= 200 && response.code < 300
+        response
+      else
+        raise InvalidResponse.new("Customer.io API returned an invalid response: #{response.code}")
+      end
+    end
+
+    def extract_attributes(args)
+      HashWithIndifferentAccess.new(args.last.is_a?(Hash) ? args.pop : {})
+    end
+
+    def attributes_from(customer)
+      if id?(customer)
+        HashWithIndifferentAccess.new(:id => customer)
+      else
+        HashWithIndifferentAccess.new(
+          :id => id_from(customer),
+          :email => customer.email,
+          :created_at => customer.created_at.to_i
+        )
+      end
+    end
+
+    def id_from(customer)
+      if id?(customer)
+        customer
+      else
+        warn "[DEPRECATION] Passing a customer object to Customerio::Client is deprecated. Just pass a hash with an id key."
+        customer.id
+      end
+    end
+
+	  def custom_id(id)
+	  	@@id_block ? @@id_block.call(id) : id
 	  end
 
+    def id?(object)
+      object.is_a?(Integer) || object.is_a?(String)
+    end
+
 	  def options
 	    { :basic_auth => @auth }
 	  end

data/lib/customerio/version.rb

@@ -1,3 +1,3 @@
 module Customerio
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/readme.markdown

@@ -49,12 +49,6 @@ If you're using Rails, create an initializer `config/initializers/customerio.rb`
 
     $customerio = Customerio::Client.new("YOUR SITE ID", "YOUR API SECRET KEY")
 
-By default, this gem identifies customers by just their `id`. However, a common approach is to use `production_2342` as the id attribute for the javascript snippet. You'll want to use the same format by customizing the id in `config/initializers/customerio.rb`:
-
-    Customerio::Client.id do |customer|
-      "#{Rails.env}_#{customer.id}"
-    end
-
 ### Identify logged in customers
 
 Tracking data of logged in customers is a key part of [Customer.io](http://customer.io). In order to
@@ -77,16 +71,17 @@ You'll want to indentify your customers when they sign up for your app and any t
 key information changes. This keeps [Customer.io](http://customer.io) up to date with your customer information.
 
     # Arguments
-    # customer (required)   - a customer object which responds to a few key methods:
-    #                         id          - a unique identifier for the customer
-    #                         email       - the customer's current email address
-    #                         created_at  - a timestamp which represents when the
-    #                                       customer was first created.
-    #
-    # attributes (optional) - a hash of information about the customer. You can pass any
-    #                         information that would be useful in your triggers.
+    # 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(customer, first_name: "Bob", plan: "basic")
+    $customerio.identify(
+      id: 5,
+      email: "bob@example.com,
+      created_at: customer.created_at.to_i,
+      first_name: "Bob",
+      plan: "basic"
+    )
 
 
 ### Tracking a custom event
@@ -97,13 +92,13 @@ with automated emails, and track conversions when you're sending automated email
 encourage your customers to perform an action.
 
     # Arguments
-    # customer (required)   - 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.
+    # 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(user, "purchase", type: "socks", price: "13.99")
+    $customerio.track(5, "purchase", type: "socks", price: "13.99")
 
 ## Contributing
 

data/spec/client_spec.rb

@@ -3,6 +3,13 @@ require 'spec_helper'
 describe Customerio::Client do
 	let(:client)   { Customerio::Client.new("SITE_ID", "API_KEY") }
 	let(:customer) { mock("Customer", :id => 5, :email => "customer@example.com", :created_at => Time.now) }
+  let(:response) { mock("Response", code: 200) }
+
+  before do
+    # Dont call out to customer.io
+    Customerio::Client.stub(:post).and_return(response)
+    Customerio::Client.stub(:put).and_return(response)
+  end
 
   describe ".base_uri" do
   	it "should be set to customer.io's api" do
@@ -11,52 +18,78 @@ describe Customerio::Client do
   end
 
   describe "#identify" do
-  	it "sends a PUT request to customer.io's customer API" do
-  		Customerio::Client.should_receive(:put).with("/api/v1/customers/5", anything())
-      client.identify(customer)
-  	end
+    it "sends a PUT request to customer.io's customer API" do
+      Customerio::Client.should_receive(:put).with("/api/v1/customers/5", anything()).and_return(response)
+      client.identify(:id => 5)
+    end
 
-  	it "uses the site_id and api key for basic auth" do
-  		Customerio::Client.should_receive(:put).with("/api/v1/customers/5", {
-  			:basic_auth => { :username => "SITE_ID", :password => "API_KEY" },
-  			:body => anything()
-  		})
+    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))
+      lambda { client.identify(:id => 5) }.should raise_error(Customerio::Client::InvalidResponse)
+    end
 
-      client.identify(customer)
-  	end
+    it "uses the site_id and api key for basic auth" do
+      Customerio::Client.should_receive(:put).with("/api/v1/customers/5", {
+        :basic_auth => { :username => "SITE_ID", :password => "API_KEY" },
+        :body => anything()
+      }).and_return(response)
 
-  	it "sends the customer's id, email, and created_at timestamp" do
-  		Customerio::Client.should_receive(:put).with("/api/v1/customers/5", {
-  			:basic_auth => anything(),
-  			:body => {
-  				:id => 5,
-	        :email => "customer@example.com",
-	        :created_at => Time.now.to_i
-  			}
-  		})
+      client.identify(:id => 5)
+    end
 
-      client.identify(customer)
-  	end
+    it "sends along all attributes" do
+      Customerio::Client.should_receive(:put).with("/api/v1/customers/5", {
+        :basic_auth => anything(),
+        :body => {
+          :id => 5,
+          :email => "customer@example.com",
+          :created_at => Time.now.to_i,
+          :first_name => "Bob",
+          :plan => "basic"
+        }.stringify_keys
+      }).and_return(response)
+
+      client.identify(:id => 5, :email => "customer@example.com", :created_at => Time.now.to_i, :first_name => "Bob", :plan => "basic")
+    end
 
-  	it "sends any optional attributes" do
-  		Customerio::Client.should_receive(:put).with("/api/v1/customers/5", {
-  			:basic_auth => anything(),
-  			:body => {
-  				:id => 5,
-	        :email => "customer@example.com",
-	        :created_at => Time.now.to_i,
-	        :first_name => "Bob",
-	        :plan => "basic"
-  			}
-  		})
+    it "requires an id attribute" do
+      lambda { client.identify(:email => "customer@example.com") }.should raise_error(Customerio::Client::MissingIdAttributeError)
+    end
 
-      client.identify(customer, :first_name => "Bob", :plan => "basic")
-  	end
+    context "customer object passed in" do
+      it "sends the customer's id, email, and created_at timestamp" do
+        Customerio::Client.should_receive(:put).with("/api/v1/customers/5", {
+          :basic_auth => anything(),
+          :body => {
+            :id => 5,
+            :email => "customer@example.com",
+            :created_at => Time.now.to_i
+          }.stringify_keys
+        }).and_return(response)
+
+        client.identify(customer)
+      end
+
+      it "sends any optional attributes" do
+        Customerio::Client.should_receive(:put).with("/api/v1/customers/5", {
+          :basic_auth => anything(),
+          :body => {
+            :id => 5,
+            :email => "customer@example.com",
+            :created_at => Time.now.to_i,
+            :first_name => "Bob",
+            :plan => "basic"
+          }.stringify_keys
+        }).and_return(response)
+
+        client.identify(customer, :first_name => "Bob", :plan => "basic")
+      end
+    end
 
     context "client has customized identities" do
       before do
-        Customerio::Client.id do |customer|
-          "production_#{customer.id}"
+        Customerio::Client.id do |customer_id|
+          "production_#{customer_id}"
         end
       end
 
@@ -67,28 +100,40 @@ describe Customerio::Client do
             :id => "production_5",
             :email => "customer@example.com",
             :created_at => Time.now.to_i
-          }
-        })
+          }.stringify_keys
+        }).and_return(response)
 
         client.identify(customer)
       end
+
+      it "uses custom identity when using a pure hash" do
+        Customerio::Client.should_receive(:put).with("/api/v1/customers/production_5", {
+          :basic_auth => anything(),
+          :body => {
+            :id => "production_5",
+            :email => "customer@example.com",
+            :created_at => Time.now.to_i
+          }.stringify_keys
+        }).and_return(response)
+
+        client.identify(:id => 5, :email => "customer@example.com", :created_at => Time.now.to_i)
+      end
     end
   end
 
   describe "#track" do
-  	before do
-  		# Don't actually send identify requests
-  		Customerio::Client.stub(:put)
-  	end
-
   	it "sends a POST request to the customer.io's event API" do
-  		Customerio::Client.should_receive(:post).with("/api/v1/customers/5/events", anything())
+  		Customerio::Client.should_receive(:post).with("/api/v1/customers/5/events", anything()).and_return(response)
       client.track(customer, "purchase")
   	end
 
-  	it "calls identify with the user to ensure they've been properly identified" do
-  		Customerio::Client.stub(:post) # don't send the request
-  		client.should_receive(:identify).with(customer)
+    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))
+      lambda { client.track(customer, "purchase") }.should raise_error(Customerio::Client::InvalidResponse)
+    end
+
+  	it "calls identify with the user's attributes to ensure they've been properly identified" do
+  		client.should_receive(:identify).with({ :id => 5, :email => "customer@example.com", :created_at => Time.now.to_i }.stringify_keys).and_return(response)
   		client.track(customer, "purchase")
   	end
 
@@ -105,7 +150,7 @@ describe Customerio::Client do
   		Customerio::Client.should_receive(:post).with("/api/v1/customers/5/events", {
   			:basic_auth => anything(),
   			:body => { :name => "purchase", :data => {} }
-  		})
+  		}).and_return(response)
 
       client.track(customer, "purchase")
   	end
@@ -115,33 +160,54 @@ describe Customerio::Client do
   			:basic_auth => anything(),
   			:body => {
   				:name => "purchase",
-  			  :data => { :type => "socks", :price => "13.99" }
+  			  :data => { :type => "socks", :price => "13.99" }.stringify_keys
   			}
-  		})
+  		}).and_return(response)
 
       client.track(customer, "purchase", :type => "socks", :price => "13.99")
   	end
 
+    it "allows tracking by customer id as well" do
+  		Customerio::Client.should_receive(:post).with("/api/v1/customers/5/events", {
+  			:basic_auth => anything(),
+  			:body => {
+  				:name => "purchase",
+  			  :data => { :type => "socks", :price => "13.99" }.stringify_keys
+  			}
+  		}).and_return(response)
+
+      client.track(5, "purchase", :type => "socks", :price => "13.99")
+    end
+
     context "client has customized identities" do
       before do
-        Customerio::Client.id do |customer|
-          "production_#{customer.id}"
+        Customerio::Client.id do |customer_id|
+          "production_#{customer_id}"
         end
       end
 
       it "identifies the customer with the identification method" do
         Customerio::Client.should_receive(:post).with("/api/v1/customers/production_5/events", {
-        :basic_auth => anything(),
-        :body => anything()
-      })
+          :basic_auth => anything(),
+          :body => anything()
+        }).and_return(response)
 
-      client.track(customer, "purchase")
+        client.track(customer, "purchase")
+      end
+
+      it "uses the identification method when tracking by id" do
+        Customerio::Client.should_receive(:post).with("/api/v1/customers/production_5/events", {
+          :basic_auth => anything(),
+          :body => anything()
+        }).and_return(response)
+
+        client.track(5, "purchase")
       end
     end
 
     context "tracking an anonymous event" do
       it "sends a POST request to the customer.io's anonymous event API" do
-        Customerio::Client.should_receive(:post).with("/api/v1/events", anything())
+        Customerio::Client.should_receive(:post).with("/api/v1/events", anything()).and_return(response)
         client.track("purchase")
       end
 
@@ -149,7 +215,7 @@ describe Customerio::Client do
         Customerio::Client.should_receive(:post).with("/api/v1/events", {
           :basic_auth => { :username => "SITE_ID", :password => "API_KEY" },
           :body => anything()
-        })
+        }).and_return(response)
 
         client.track("purchase")
       end
@@ -158,7 +224,7 @@ describe Customerio::Client do
         Customerio::Client.should_receive(:post).with("/api/v1/events", {
           :basic_auth => anything(),
           :body => { :name => "purchase", :data => {} }
-        })
+        }).and_return(response)
 
         client.track("purchase")
       end
@@ -168,9 +234,9 @@ describe Customerio::Client do
           :basic_auth => anything(),
           :body => {
             :name => "purchase",
-            :data => { :type => "socks", :price => "13.99" }
+            :data => { :type => "socks", :price => "13.99" }.stringify_keys
           }
-        })
+        }).and_return(response)
 
         client.track("purchase", :type => "socks", :price => "13.99")
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: customerio
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-15 00:00:00.000000000 Z
+date: 2012-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -27,6 +27,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -84,6 +100,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- CHANGELOG.markdown
 - Gemfile
 - Gemfile.lock
 - LICENSE