customerio 0.0.1 → 0.0.2

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby-18mode
+  - jruby-19mode
+  - jruby-head
+  - ree
+  - ruby-head
+  - rbx-18mode
+  - rbx-19mode

data/Gemfile.lock

@@ -14,6 +14,7 @@ GEM
       multi_xml
     multi_json (1.3.5)
     multi_xml (0.5.1)
+    rake (0.9.2.2)
     rspec (2.8.0)
       rspec-core (~> 2.8.0)
       rspec-expectations (~> 2.8.0)
@@ -29,4 +30,5 @@ PLATFORMS
 DEPENDENCIES
   customerio!
   fakeweb
+  rake
   rspec

data/Rakefile

@@ -1,2 +1,8 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+require "rspec/core"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/customerio.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency('httparty', '~> 0.8.0')
 
+  gem.add_development_dependency('rake')
   gem.add_development_dependency('rspec')
   gem.add_development_dependency('fakeweb')
 end

data/lib/customerio/client.rb

@@ -5,8 +5,18 @@ module Customerio
 	  include HTTParty
 	  base_uri 'https://app.customer.io'
 
+	  @@id_block = nil
+
+	  def self.id(&block)
+      @@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 }
+	    @auth = { :username => site_id, :password => secret_key }
 	  end
 
 	  def identify(customer, attributes = {})
@@ -21,26 +31,30 @@ module Customerio
 	  private
 
 	  def create_or_update(customer, attributes = {})
-	    body = { 
-	      id:    customer.id,
-	      email: customer.email,
-	      created_at: customer.created_at.to_i
+	    body = {
+	      :id => id(customer),
+	      :email => customer.email,
+	      :created_at => customer.created_at.to_i
 	    }.merge(attributes)
 
-	    self.class.put(customer_path(customer), options.merge(body: body))
+	    self.class.put(customer_path(customer), options.merge(:body => body))
 	  end
 
 	  def create_event(customer, event_name, attributes = {})
-	  	body = { name: event_name, data: attributes }
-	    self.class.post("#{customer_path(customer)}/events", options.merge(body: body))
+	  	body = { :name => event_name, :data => attributes }
+	    self.class.post("#{customer_path(customer)}/events", options.merge(:body => body))
 	  end
 
 	  def customer_path(customer)
-	    "/api/v1/customers/#{customer.id}"
+	    "/api/v1/customers/#{id(customer)}"
+	  end
+
+	  def id(customer)
+	  	@@id_block ? @@id_block.call(customer) : customer.id
 	  end
 
 	  def options
-	    { basic_auth: @auth }
+	    { :basic_auth => @auth }
 	  end
   end
-end
+end

data/lib/customerio/version.rb

@@ -1,3 +1,3 @@
 module Customerio
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/readme.markdown

@@ -2,6 +2,8 @@
 
 A ruby client for the [Customer.io](http://customer.io) [event API](https://app.customer.io/api/docs/index.html).
 
+[![Build Status](https://secure.travis-ci.org/customerio/customerio-ruby.png?branch=master)](http://travis-ci.org/customerio/customerio-ruby)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -12,7 +14,7 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Or install it yourself:
 
     $ gem install customerio
 
@@ -23,7 +25,7 @@ Or install it yourself as:
 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).
 
-In many cases, using the JavScript snippet will be easier to integrate with
+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:
 
 * You're not planning on triggering emails based on how customers interact with
@@ -31,11 +33,11 @@ your app, but there are several reasons why using the API client is useful:
 * You're using the javascript snippet, but have a few events you'd like to
   send from your backend system.  They will work well together!
 * You'd rather not have another javascript snippet slowing down your frontend.
-  Our snippet is asynchronous and very small, but we understand.
+  Our snippet is asynchronous (doesn't affect initial page load) and very small, but we understand.
 
 In the end, the decision on whether or not to use the API client or
-the JavaScript snippet should be based on what works best for you. 
-You'll be able to integrate fully with [Customer.io](http://customer.io) with either approach.
+the JavaScript snippet should be based on what works best for you.
+You'll be able to integrate **fully** with [Customer.io](http://customer.io) with either approach.
 
 ### Setup
 
@@ -46,6 +48,12 @@ 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 when using the gem:
+
+    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
@@ -60,12 +68,12 @@ the customer's name, you can personalize the triggered email by using it in the
 subject or body.
 
 * As a way to filter who should receive a triggered email.  For instance,
-if you pass along the current subscription plan for your customers, you can
+if you pass along the current subscription plan (free / basic / premium) for your customers, you can
 set up triggers which are only sent to customers who have subscribed to a
-particular plan.
+particular plan (e.g. "premium").
 
-You'll want 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 base.
+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
     # customer (required)   - a customer object which responds to a few key methods:
@@ -73,7 +81,7 @@ key information changes. This keeps [Customer.io](http://customer.io) up to date
     #                         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.
 
@@ -99,7 +107,8 @@ encourage your customers to perform an action.
 ## Contributing
 
 1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+2. Clone your fork (`git clone git@github.com:MY_USERNAME/customerio-ruby.git && cd customerio-ruby`)
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Added some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/spec/client_spec.rb

@@ -2,7 +2,7 @@ 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(:customer) { mock("Customer", :id => 5, :email => "customer@example.com", :created_at => Time.now) }
 
   describe ".base_uri" do
   	it "should be set to customer.io's api" do
@@ -18,8 +18,8 @@ describe Customerio::Client do
 
   	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()
+  			:basic_auth => { :username => "SITE_ID", :password => "API_KEY" },
+  			:body => anything()
   		})
 
       client.identify(customer)
@@ -27,31 +27,52 @@ describe Customerio::Client 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
+  			:basic_auth => anything(),
+  			:body => {
+  				:id => 5,
+	        :email => "customer@example.com",
+	        :created_at => Time.now.to_i
   			}
   		})
-  		
+
       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"
+  			:basic_auth => anything(),
+  			:body => {
+  				:id => 5,
+	        :email => "customer@example.com",
+	        :created_at => Time.now.to_i,
+	        :first_name => "Bob",
+	        :plan => "basic"
   			}
   		})
-  		
-      client.identify(customer, first_name: "Bob", plan: "basic")
+
+      client.identify(customer, :first_name => "Bob", :plan => "basic")
   	end
+
+    context "client has customized identities" do
+      before do
+        Customerio::Client.id do |customer|
+          "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
+          }
+        })
+
+        client.identify(customer)
+      end
+    end
   end
 
   describe "#track" do
@@ -73,8 +94,8 @@ describe Customerio::Client do
 
   	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()
+  			:basic_auth => { :username => "SITE_ID", :password => "API_KEY" },
+  			:body => anything()
   		})
 
       client.track(customer, "purchase")
@@ -82,23 +103,40 @@ describe Customerio::Client do
 
   	it "sends the event name" do
   		Customerio::Client.should_receive(:post).with("/api/v1/customers/5/events", {
-  			basic_auth: anything(),
-  			body: { name: "purchase", data: {} }
+  			:basic_auth => anything(),
+  			:body => { :name => "purchase", :data => {} }
   		})
-  		
+
       client.track(customer, "purchase")
   	end
 
   	it "sends any optional event attributes" do
   		Customerio::Client.should_receive(:post).with("/api/v1/customers/5/events", {
-  			basic_auth: anything(),
-  			body: {
-  				name: "purchase",
-  			  data: { type: "socks", price: "13.99" }
+  			:basic_auth => anything(),
+  			:body => {
+  				:name => "purchase",
+  			  :data => { :type => "socks", :price => "13.99" }
   			}
   		})
-  		
-      client.track(customer, "purchase", type: "socks", price: "13.99")
+
+      client.track(customer, "purchase", :type => "socks", :price => "13.99")
   	end
+
+    context "client has customized identities" do
+      before do
+        Customerio::Client.id do |customer|
+          "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()
+      })
+
+      client.track(customer, "purchase")
+      end
+    end
   end
-end
+end

data/spec/spec_helper.rb

@@ -7,4 +7,7 @@ require 'fakeweb'
 FakeWeb.allow_net_connect = false
 
 RSpec.configure do |config|
-end
+  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.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-22 00:00:00.000000000 Z
+date: 2012-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -27,6 +27,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -67,6 +83,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - LICENSE