customerio 0.6.1 → 0.7.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZTZjMjYyNzc2NDA2ZjViNGM3YzY0MjM2ZmU1MGNkZmRmOTRmNmYzOA==
+    ZGI2YjQwMzVhYWJlNGE2ZWRiNDA4ZmY2MjQ3ZGJiMzEwNDlhNGU2ZA==
   data.tar.gz: !binary |-
-    NzljMDM4NjY5ZDljN2MwOTYyMWMzOGFiYzFiOGEzNjM5ZTgyMjc1MA==
+    OWFlNzY0YzcwZDczMGU4NzRiNDQxMDIzY2FhYzEyMTlhNjU4N2ZjMw==
 SHA512:
   metadata.gz: !binary |-
-    YmQzNDE4OTMyMTFmODE0NWNkMTc4NGYzYmZkNjJkMjlkZTVlNTBkYTIyNWE4
-    YWVkMTA5NzBmNjkxZTEzZTNkMmFmNDRlNTlkNWRhNTQ0NzM3ZTM5YzlhYTAy
-    ODg2OWU3ZWQ4MjcwY2IwODY4Mzk2ODdjM2UxNDkyNzNkZDUxODQ=
+    NjIxNDhlYzU0OGRmMWI3Y2I5YmViYWExZDNlYTEyNjUyYTRmYjgwZDM1NTM2
+    ZjE4YzdkNzBmYmRkZWY2MDM5YmYxOTI0YjE1YmVlYjdiZjJlZGYyYTQ3ZWRm
+    Y2IwOGMzYzQ3OWE4YWUxMzM1OWRjODIwZDQzODU2N2ExMjM4NTY=
   data.tar.gz: !binary |-
-    NGU3MjIzNDFjN2ZiN2I5MmZiY2FlY2YwNGU5MjE0OGFkZjJjY2RhNDc5NmM5
-    NDNmMDFlMjI2N2Q0YjEzZWQ1ZGRiYjY3MzE1YTg1ZDFhNjZiZTY0MGMzYjI5
-    ODYxZDQ4OTZmMTc5NDU3MmRmNDNmNDQyNzViZmVkYzQ1OWIzZjc=
+    YzI0Nzk1NGNkOTFkMWQxZDcyZjkwNzQ3OTlhZGExYjQ5NjhhNWU4ZDUxZTdl
+    OWZlZWFjNzk5MDkzZDU0OGVkZGU0MzI2ZmU0N2U4NDI2OWRjOTIxODc4YzUy
+    YTU1NDAyNGJlNzgxMDc1NWU4YjYxNWNiNDdiMjgxNGVmMzU5MDg=

data/CHANGELOG.markdown

@@ -1,3 +1,15 @@
+## Customerio 0.7.0 - Mar 2, 2016 ##
+
+* Add new method for tracking anonymous events: `anonymous_track`. See README for more details. Many thanks to @sdawson for this contribution! [#36](https://github.com/customerio/customerio-ruby/pull/36)
+
+* Use JSON encoding by default. [#37](https://github.com/customerio/customerio-ruby/pull/37)
+
+    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)
+    ```
+
 ## Customerio 0.6.1 - Oct 8, 2015 ##
 
 * Include HTTP response as an attribute on the InvalidResponse exception to help with debugging failed API requests. For example:

data/{readme.markdown → README.md}

@@ -134,6 +134,16 @@ $customerio.track(5, "purchase", :type => "socks", :price => "13.99")
 $customerio.track(5, "purchase", :type => "socks", :price => "13.99", :timestamp => 1365436200)
 ```
 
+### Tracking anonymous events
+
+You can also send anonymous events, for situations where you don't yet have a customer record but still want to trigger a campaign:
+
+```ruby
+$customerio.anonymous_track("help_enquiry", :recipient => 'user@example.com')
+```
+
+Use the `recipient` attribute to specify the email address to send the messages to. [See our documentation on how to use anonymous events for more details](https://customer.io/docs/invitation-emails.html).
+
 ## Contributing
 
 1. Fork it

data/lib/customerio/client.rb

@@ -19,10 +19,7 @@ module Customerio
 
     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]
+      @json = options.has_key?(:json) ? options[:json] : true
     end
 
     def identify(attributes)
@@ -49,6 +46,10 @@ module Customerio
       end
     end
 
+    def anonymous_track(event_name, attributes = {})
+      create_anonymous_event(event_name, attributes)
+    end
+
     private
 
     def create_or_update(attributes = {})

data/lib/customerio/version.rb

@@ -1,3 +1,3 @@
 module Customerio
-  VERSION = "0.6.1"
+  VERSION = "0.7.0"
 end

data/spec/client_spec.rb

@@ -11,6 +11,36 @@ describe Customerio::Client do
     Customerio::Client.stub(:put).and_return(response)
   end
 
+  describe "json option" do
+    let(:body) { { :id => 5, :name => "Bob" } }
+
+    it "uses json by default" do
+      client = Customerio::Client.new("SITE_ID", "API_KEY")
+
+      json = MultiJson.dump(body)
+      Customerio::Client.should_receive(:put).with(
+        "/api/v1/customers/5",
+        {
+          :basic_auth=>{:username=>"SITE_ID", :password=>"API_KEY"},
+          :body=>json,
+          :headers=>{"Content-Type"=>"application/json"}
+        }).and_return(response)
+      client.identify(body)
+    end
+
+    it "allows disabling json" do
+      client = Customerio::Client.new("SITE_ID", "API_KEY", :json => false)
+
+      Customerio::Client.should_receive(:put).with(
+        "/api/v1/customers/5",
+        {
+          :basic_auth=>{:username=>"SITE_ID", :password=>"API_KEY"},
+          :body=>body
+        }).and_return(response)
+      client.identify(body)
+    end
+  end
+
   describe ".base_uri" do
   	it "should be set to customer.io's api" do
   		Customerio::Client.base_uri.should == "https://track.customer.io"
@@ -247,4 +277,65 @@ describe Customerio::Client do
       end
     end
   end
+
+  describe "#anonymous_track" do
+    it "sends a POST request to the customer.io event API" do
+      Customerio::Client.should_receive(:post).with("/api/v1/events", anything()).and_return(response)
+      client.anonymous_track("purchase")
+    end
+
+    it "raises an error if POST doesn't return a 2xx response code" do
+      Customerio::Client.should_receive(:post).and_return(double("Response", :code => 500))
+      lambda { client.anonymous_track("purchase") }.should raise_error(Customerio::Client::InvalidResponse)
+    end
+
+    it "uses the site_id and api key for basic auth" do
+      Customerio::Client.should_receive(:post).with("/api/v1/events", {
+        :basic_auth => { :username => "SITE_ID", :password => "API_KEY" },
+        :body => anything()
+      })
+
+      client.anonymous_track("purchase")
+    end
+
+    it "sends the event name" do
+      Customerio::Client.should_receive(:post).with("/api/v1/events", {
+        :basic_auth => anything(),
+        :body => { :name => "purchase", :data => {} }
+      }).and_return(response)
+
+      client.anonymous_track("purchase")
+    end
+
+    it "sends any optional event attributes" do
+      Customerio::Client.should_receive(:post).with("/api/v1/events", {
+        :basic_auth => anything(),
+        :body => {
+          :name => "purchase",
+          :data => { :type => "socks", :price => "27.99" }
+        }
+      }).and_return(response)
+
+      client.anonymous_track("purchase", :type => "socks", :price => "27.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 => "27.99", :timestamp => 1561235678 },
+          :timestamp => 1561235678
+        }
+      }).and_return(response)
+
+      client.anonymous_track("purchase", :type => "socks", :price => "27.99", :timestamp => 1561235678)
+    end
+
+    context "too many arguments are passed" do
+      it "throws an error" do
+        lambda { client.anonymous_track("purchase", "text", :type => "socks", :price => "27.99") }.should raise_error(ArgumentError)
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: customerio
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - John Allison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-08 00:00:00.000000000 Z
+date: 2016-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -98,12 +98,12 @@ files:
 - CHANGELOG.markdown
 - Gemfile
 - LICENSE
+- README.md
 - 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