customerio 0.4.1 → 0.5.0

data/CHANGELOG.markdown

@@ -1,3 +1,16 @@
+## Customerio 0.5.0 - Apr 8, 2013 ##
+
+* Removed deprecated methods around using a customer object. All calls simply take a hash of attributes now.
+* Added ability to set a timestamp on a tracked event.  Useful for backfilling past events.
+
+## Customerio 0.4.1 - Feb 18, 2013 ##
+
+* Bug fixes related to the 4.0 change.
+
+## Customerio 0.4.0 - Feb 18, 2013 ##
+
+* Added support for deleting customers.
+
 ## Customerio 0.3.0 - Dec 28, 2012 ##
 
 * Now raise an error if an API call doesn't respond with a 200 response code

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    customerio (0.4.0)
+    customerio (0.5.0)
       httparty (>= 0.5, < 1.0)
 
 GEM
@@ -12,7 +12,7 @@ GEM
     httparty (0.10.2)
       multi_json (~> 1.0)
       multi_xml (>= 0.5.2)
-    multi_json (1.6.1)
+    multi_json (1.7.0)
     multi_xml (0.5.3)
     rake (0.9.2.2)
     rspec (2.8.0)

data/lib/customerio/client.rb

@@ -3,36 +3,16 @@ require 'httparty'
 module Customerio
   class Client
     include HTTParty
-    base_uri 'https://app.customer.io'
-
-    CustomerProxy = Struct.new("Customer", :id)
+    base_uri 'https://track.customer.io'
 
     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
-
-    def self.default_config
-      @@id_block = nil
-    end
-
     def initialize(site_id, secret_key)
       @auth = { :username => site_id, :password => secret_key }
     end
 
-    def identify(*args)
-      attributes = extract_attributes(args)
-
-      if args.any?
-        customer   = args.first
-        attributes = attributes_from(customer).merge(attributes)
-      end
-
+    def identify(attributes)
       create_or_update(attributes)
     end
 
@@ -48,12 +28,11 @@ module Customerio
         event_name = args.first
         create_anonymous_event(event_name, attributes)
       else
-        # Passed in a customer and an event name.
+        # Passed in a customer id and an event name.
         # Track the event for the given customer
-        customer, event_name = args
+        customer_id, event_name = args
 
-        identify(attributes_from(customer))
-        create_customer_event(id_from(customer), event_name, attributes)
+        create_customer_event(customer_id, event_name, attributes)
       end
     end
 
@@ -63,7 +42,6 @@ module Customerio
       raise MissingIdAttributeError.new("Must provide a customer id") unless attributes[:id]
 
       url = customer_path(attributes[:id])
-      attributes[:id] = custom_id(attributes[:id])
 
       verify_response(self.class.put(url, options.merge(:body => attributes)))
     end
@@ -78,13 +56,19 @@ 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)))
     end
 
     def customer_path(id)
-      "/api/v1/customers/#{custom_id(id)}"
+      "/api/v1/customers/#{id}"
     end
 
+    def valid_timestamp?(timestamp)
+      timestamp && timestamp.is_a?(Integer) && timestamp > 999999999 && timestamp < 100000000000
+    end
+
+
     def verify_response(response)
       if response.code >= 200 && response.code < 300
         response
@@ -98,35 +82,6 @@ module Customerio
       hash.inject({}){ |hash, (k,v)| hash[k.to_sym] = v; hash }
     end
 
-    def attributes_from(customer)
-      if id?(customer)
-        { :id => customer }
-      else
-        {
-          :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.4.1"
+  VERSION = "0.5.0"
 end

data/readme.markdown

@@ -76,13 +76,26 @@ key information changes. This keeps [Customer.io](http://customer.io) up to date
     #                         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"
+      :id => 5,
+      :email => "bob@example.com,
+      :created_at => customer.created_at.to_i,
+      :first_name => "Bob",
+      :plan => "basic"
     )
 
+### Deleting customers
+
+Deleting a customer will remove them, and all their information from
+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.
+
+    $customerio.delete(5)
 
 ### Tracking a custom event
 
@@ -98,7 +111,12 @@ encourage your customers to perform an action.
     #                          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)
 
 ## Contributing
 

data/spec/client_spec.rb

@@ -2,7 +2,6 @@ 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
@@ -13,7 +12,7 @@ describe Customerio::Client do
 
   describe ".base_uri" do
   	it "should be set to customer.io's api" do
-  		Customerio::Client.base_uri.should == "https://app.customer.io"
+  		Customerio::Client.base_uri.should == "https://track.customer.io"
   	end
   end
 
@@ -55,85 +54,6 @@ describe Customerio::Client do
     it "requires an id attribute" do
       lambda { client.identify(:email => "customer@example.com") }.should raise_error(Customerio::Client::MissingIdAttributeError)
     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
-          }
-        }).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"
-          }
-        }).and_return(response)
-
-        client.identify(customer, :first_name => "Bob", :plan => "basic")
-      end
-
-      it "allows customer object attributes to be overriden" do
-        Customerio::Client.should_receive(:put).with("/api/v1/customers/5", {
-          :basic_auth => anything(),
-          :body => {
-            :id => 5,
-            :email => "customer2@example.com",
-            :created_at => Time.now.to_i,
-            :first_name => "Bob",
-            :plan => "basic"
-          }
-        }).and_return(response)
-
-        client.identify(customer, "email" => "customer2@example.com", :first_name => "Bob", :plan => "basic")
-      end
-    end
-
-    context "client has customized identities" do
-      before do
-        Customerio::Client.id do |customer_id|
-          "production_#{customer_id}"
-        end
-      end
-
-      it "identifies the customer with the identification method" 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
-          }
-        }).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
-          }
-        }).and_return(response)
-
-        client.identify(:id => 5, :email => "customer@example.com", :created_at => Time.now.to_i)
-      end
-    end
   end
 
   describe "#delete" do
@@ -146,26 +66,21 @@ describe Customerio::Client do
   describe "#track" do
   	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()).and_return(response)
-      client.track(customer, "purchase")
+      client.track(5, "purchase")
   	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))
-      lambda { client.track(customer, "purchase") }.should raise_error(Customerio::Client::InvalidResponse)
+      lambda { client.track(5, "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 }).and_return(response)
-  		client.track(customer, "purchase")
-  	end
-
   	it "uses the site_id and api key for basic auth" do
   		Customerio::Client.should_receive(:post).with("/api/v1/customers/5/events", {
   			:basic_auth => { :username => "SITE_ID", :password => "API_KEY" },
   			:body => anything()
   		})
 
-      client.track(customer, "purchase")
+      client.track(5, "purchase")
   	end
 
   	it "sends the event name" do
@@ -174,7 +89,7 @@ describe Customerio::Client do
   			:body => { :name => "purchase", :data => {} }
   		}).and_return(response)
 
-      client.track(customer, "purchase")
+      client.track(5, "purchase")
   	end
 
   	it "sends any optional event attributes" do
@@ -186,45 +101,58 @@ describe Customerio::Client do
   			}
   		}).and_return(response)
 
-      client.track(customer, "purchase", :type => "socks", :price => "13.99")
+      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(),
+  			:body => {
+  				:name => "purchase",
+  			  :data => { :type => "socks", :price => "13.99", :timestamp => 1561231234 },
+          :timestamp => 1561231234
+  			}
+  		}).and_return(response)
+
+      client.track(5, "purchase", :type => "socks", :price => "13.99", :timestamp => 1561231234)
   	end
 
-    it "allows tracking by customer id as well" do
+    it "doesn't send timestamp if timestamp is in milliseconds" do
   		Customerio::Client.should_receive(:post).with("/api/v1/customers/5/events", {
   			:basic_auth => anything(),
   			:body => {
   				:name => "purchase",
-  			  :data => { :type => "socks", :price => "13.99" }
+  			  :data => { :type => "socks", :price => "13.99", :timestamp => 1561231234000 }
   			}
   		}).and_return(response)
 
-      client.track(5, "purchase", :type => "socks", :price => "13.99")
+      client.track(5, "purchase", :type => "socks", :price => "13.99", :timestamp => 1561231234000)
     end
 
-    context "client has customized identities" do
-      before do
-        Customerio::Client.id do |customer_id|
-          "production_#{customer_id}"
-        end
-      end
+    it "doesn't send timestamp if timestamp is a date" do
+      date = Time.now
 
-      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()
-        }).and_return(response)
+  		Customerio::Client.should_receive(:post).with("/api/v1/customers/5/events", {
+  			:basic_auth => anything(),
+  			:body => {
+  				:name => "purchase",
+  			  :data => { :type => "socks", :price => "13.99", :timestamp => date }
+  			}
+  		}).and_return(response)
 
-        client.track(customer, "purchase")
-      end
+      client.track(5, "purchase", :type => "socks", :price => "13.99", :timestamp => date)
+    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)
+    it "doesn't send timestamp if timestamp isn't a integer" do
+  		Customerio::Client.should_receive(:post).with("/api/v1/customers/5/events", {
+  			:basic_auth => anything(),
+  			:body => {
+  				:name => "purchase",
+  			  :data => { :type => "socks", :price => "13.99", :timestamp => "Hello world" }
+  			}
+  		}).and_return(response)
 
-        client.track(5, "purchase")
-      end
+      client.track(5, "purchase", :type => "socks", :price => "13.99", :timestamp => "Hello world")
     end
 
     context "tracking an anonymous event" do
@@ -262,6 +190,19 @@ describe Customerio::Client do
 
         client.track("purchase", :type => "socks", :price => "13.99")
       end
+
+      it "allows sending of a timestamp" do
+        Customerio::Client.should_receive(:post).with("/api/v1/events", {
+          :basic_auth => anything(),
+          :body => {
+            :name => "purchase",
+  			    :data => { :type => "socks", :price => "13.99", :timestamp => 1561231234 },
+            :timestamp => 1561231234
+          }
+        }).and_return(response)
+
+        client.track("purchase", :type => "socks", :price => "13.99", :timestamp => 1561231234)
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -5,9 +5,3 @@ require 'customerio'
 require 'fakeweb'
 
 FakeWeb.allow_net_connect = false
-
-RSpec.configure do |config|
-  config.before(:each) do
-    Customerio::Client.default_config
-  end
-end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: customerio
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-18 00:00:00.000000000 Z
+date: 2013-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty