customerio 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in customerio.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    customerio (0.0.1)
+      httparty (~> 0.8.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    fakeweb (1.3.0)
+    httparty (0.8.3)
+      multi_json (~> 1.0)
+      multi_xml
+    multi_json (1.3.5)
+    multi_xml (0.5.1)
+    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
+  rspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 John Allison
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/customerio.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/customerio/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["John Allison"]
+  gem.email         = ["john@customer.io"]
+  gem.description   = "A ruby client for the Customer.io event API."
+  gem.summary       = "A ruby client for the Customer.io event API."
+  gem.homepage      = "http://customer.io"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "customerio"
+  gem.require_paths = ["lib"]
+  gem.version       = Customerio::VERSION
+
+  gem.add_dependency('httparty', '~> 0.8.0')
+
+  gem.add_development_dependency('rspec')
+  gem.add_development_dependency('fakeweb')
+end

data/lib/customerio.rb

@@ -0,0 +1,5 @@
+require "customerio/version"
+
+module Customerio
+  autoload :Client, 'customerio/client'
+end

data/lib/customerio/client.rb

@@ -0,0 +1,46 @@
+require 'httparty'
+
+module Customerio
+  class Client
+	  include HTTParty
+	  base_uri 'https://app.customer.io'
+
+	  def initialize(site_id, secret_key)
+	    @auth = { username: site_id, password: secret_key }
+	  end
+
+	  def identify(customer, attributes = {})
+	    create_or_update(customer, attributes)
+	  end
+
+	  def track(customer, event_name, hash = {})
+	    identify(customer)
+	    create_event(customer, event_name, hash)
+	  end
+
+	  private
+
+	  def create_or_update(customer, attributes = {})
+	    body = { 
+	      id:    customer.id,
+	      email: customer.email,
+	      created_at: customer.created_at.to_i
+	    }.merge(attributes)
+
+	    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))
+	  end
+
+	  def customer_path(customer)
+	    "/api/v1/customers/#{customer.id}"
+	  end
+
+	  def options
+	    { basic_auth: @auth }
+	  end
+  end
+end

data/lib/customerio/version.rb

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

data/readme.markdown

@@ -0,0 +1,105 @@
+# Customerio
+
+A ruby client for the [Customer.io](http://customer.io) [event API](https://app.customer.io/api/docs/index.html).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'customerio'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install customerio
+
+## Usage
+
+### 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).
+
+In many cases, using the JavScript 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
+  your website (e.g. users who haven't visited the site in X days)
+* 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.
+
+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.
+
+### 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).
+
+If you're using Rails, create an initializer `config/initializers/customerio.rb`:
+
+    $customerio = Customerio::Client.new("YOUR SITE ID", "YOUR API SECRET KEY")
+
+### Identify logged in customers
+
+Tracking data of logged in customers is a key part of [Customer.io](http://customer.io). In order to
+send triggered emails, we must know the email address of the customer.  You can
+also specify any number of customer attributes which help tailor [Customer.io](http://customer.io) to your
+business.
+
+Attributes you specify are useful in several ways:
+
+* As customer variables in your triggered emails.  For instance, if you specify
+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
+set up triggers which are only sent to customers who have subscribed to a
+particular plan.
+
+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.
+
+    # 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.
+
+    $customerio.identify(customer, first_name: "Bob", plan: "basic")
+
+
+### Tracking a custom event
+
+Now that you're identifying your customers with [Customer.io](http://customer.io), you can now send events like
+"purchased" or "watchedIntroVideo".  These allow you to more specifically target your users
+with automated emails, and track conversions when you're sending automated emails to
+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.
+
+    $customerio.track(user, "purchase", type: "socks", price: "13.99")
+
+## 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

data/spec/client_spec.rb

@@ -0,0 +1,104 @@
+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) }
+
+  describe ".base_uri" do
+  	it "should be set to customer.io's api" do
+  		Customerio::Client.base_uri.should == "https://app.customer.io"
+  	end
+  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 "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()
+  		})
+
+      client.identify(customer)
+  	end
+
+  	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(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"
+  			}
+  		})
+  		
+      client.identify(customer, first_name: "Bob", plan: "basic")
+  	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())
+      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)
+  		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")
+  	end
+
+  	it "sends the event name" do
+  		Customerio::Client.should_receive(:post).with("/api/v1/customers/5/events", {
+  			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" }
+  			}
+  		})
+  		
+      client.track(customer, "purchase", type: "socks", price: "13.99")
+  	end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'customerio'
+require 'fakeweb'
+
+FakeWeb.allow_net_connect = false
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: customerio
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- John Allison
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: fakeweb
+  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'
+description: A ruby client for the Customer.io event API.
+email:
+- john@customer.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- Rakefile
+- customerio.gemspec
+- lib/customerio.rb
+- lib/customerio/client.rb
+- lib/customerio/version.rb
+- readme.markdown
+- spec/client_spec.rb
+- spec/spec_helper.rb
+homepage: http://customer.io
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A ruby client for the Customer.io event API.
+test_files:
+- spec/client_spec.rb
+- spec/spec_helper.rb