send_with_us 1.2.3 → 1.3.3

data/README.md

@@ -146,6 +146,19 @@ rescue => e
 end
 ```
 
+### Customer conversion event
+You can use the Conversion API to track conversion and revenue data events against your sent emails
+
+**NOTE:** Revenue is in cents (eg. $100.50 = 10050)
+
+```ruby
+# With Revenue
+obj.conversion_event('customer@example.com', 10050)
+
+# Without Revenue
+obj.conversion_event('customer@example.com')
+```
+
 ### Rails
 
 For a Rails app, create `send_with_us.rb` in `/config/initializers/`

data/lib/send_with_us/api.rb

@@ -30,7 +30,7 @@ module SendWithUs
       end
 
       payload = { email_id: email_id, recipient: to,
-        email_data: data }
+                  email_data: data }
 
       if from.any?
         payload[:sender] = from
@@ -90,45 +90,46 @@ module SendWithUs
     end
 
     def list_drip_campaigns()
-        SendWithUs::ApiRequest.new(@configuration).get(:drip_campaigns)
+      SendWithUs::ApiRequest.new(@configuration).get(:drip_campaigns)
     end
 
     def start_on_drip_campaign(recipient_address, drip_campaign_id, email_data={})
 
-        if email_data.nil?
-            payload = {
-                recipient_address: recipient_address
-            }.to_json
-        else
-            payload = {
-                recipient_address: recipient_address,
-                email_data: email_data
-            }.to_json
-       end
-
-        SendWithUs::ApiRequest.new(@configuration).post("drip_campaigns/#{drip_campaign_id}/activate", payload)
+      if email_data.nil?
+        payload = {
+          recipient_address: recipient_address
+        }.to_json
+      else
+        payload = {
+          recipient_address: recipient_address,
+          email_data: email_data
+        }.to_json
+      end
+
+      SendWithUs::ApiRequest.new(@configuration).post("drip_campaigns/#{drip_campaign_id}/activate", payload)
     end
 
     def remove_from_drip_campaign(recipient_address, drip_campaign_id)
-        payload = {
-            recipient_address: recipient_address
-        }.to_json
+      payload = {
+        recipient_address: recipient_address
+      }.to_json
 
-        SendWithUs::ApiRequest.new(@configuration).post("drip_campaigns/#{drip_campaign_id}/deactivate", payload)
+      SendWithUs::ApiRequest.new(@configuration).post("drip_campaigns/#{drip_campaign_id}/deactivate", payload)
     end
 
     def drip_campaign_details(drip_campaign_id)
-        SendWithUs::ApiRequest.new(@configuration).get("drip_campaigns/#{drip_campaign_id}")
+      SendWithUs::ApiRequest.new(@configuration).get("drip_campaigns/#{drip_campaign_id}")
     end
-    
+
     def list_customers_on_campaign(drip_campaign_id)
-        SendWithUs::ApiRequest.new(@configuration).get("drip_campaigns/#{drip_campaign_id}/customers")
+      SendWithUs::ApiRequest.new(@configuration).get("drip_campaigns/#{drip_campaign_id}/customers")
     end
 
     def list_customers_on_campaign_step(drip_campaign_id, drip_campaign_step_id)
-        SendWithUs::ApiRequest.new(@configuration).get("drip_campaigns/#{drip_campaign_id}/step/#{drip_campaign_step_id}/customers")
+      SendWithUs::ApiRequest.new(@configuration).get("drip_campaigns/#{drip_campaign_id}/step/#{drip_campaign_step_id}/customers")
     end
-    
+
+    # DEPRECATED - use customer_conversion now
     def add_customer_event(customer, event_name, revenue=nil)
 
       if revenue.nil?
@@ -138,9 +139,19 @@ module SendWithUs
       end
 
       payload = payload.to_json
-      endpoint = 'customers/' + customer + '/events'
+      endpoint = 'customers/' + customer + '/conversions'
+      SendWithUs::ApiRequest.new(@configuration).post(endpoint, payload)
+    end
+
+    def customer_conversion(customer, revenue=nil)
+      payload = {}.to_json
+
+      if revenue
+        payload = { revenue: revenue }.to_json
+      end
+
+      endpoint = "customers/#{customer}/conversions"
       SendWithUs::ApiRequest.new(@configuration).post(endpoint, payload)
     end
   end
 end
-

data/lib/send_with_us/version.rb

@@ -1,3 +1,3 @@
 module SendWithUs
-  VERSION = '1.2.3'
+  VERSION = '1.3.3'
 end

data/test/lib/send_with_us/api_request_test.rb

@@ -20,13 +20,13 @@ class TestApiRequest < MiniTest::Unit::TestCase
     build_objects
     email_id = 'test_fixture_1'
     result = @api.send_with(
-        email_id,
-        {name: 'Ruby Unit Test', address: 'matt@example.com'},
-        {name: 'sendwithus', address: 'matt@example.com'},
-        {},
-        [],
-        [],
-        ['README.md']
+      email_id,
+      {name: 'Ruby Unit Test', address: 'matt@example.com'},
+      {name: 'sendwithus', address: 'matt@example.com'},
+      {},
+      [],
+      [],
+      ['README.md']
     )
     assert_instance_of( Net::HTTPOK, result )
   end
@@ -71,15 +71,15 @@ class TestApiRequest < MiniTest::Unit::TestCase
     build_objects
     email_id = 'tem_9YvYsaLW2Mw4tmPiLcVvpC'
     result = @api.send_with(
-        email_id,
-        {name: 'Ruby Unit Test', address: 'matt@example.com'},
-        {name: 'sendwithus', address: 'matt@example.com'},
-        {},
-        [],
-        [],
-        [],
-        '',
-        'v2'
+      email_id,
+      {name: 'Ruby Unit Test', address: 'matt@example.com'},
+      {name: 'sendwithus', address: 'matt@example.com'},
+      {},
+      [],
+      [],
+      [],
+      '',
+      'v2'
     )
     assert_instance_of( Net::HTTPOK, result )
   end
@@ -134,7 +134,13 @@ class TestApiRequest < MiniTest::Unit::TestCase
   def test_add_user_event()
     build_objects
     Net::HTTP.any_instance.stubs(:request).returns(Net::HTTPSuccess.new(1.0, 200, "OK"))
-    assert_instance_of( Net::HTTPSuccess, @request.post(:'customers/test@sendwithus.com/events', @payload))
+    assert_instance_of( Net::HTTPSuccess, @request.post(:'customers/test@sendwithus.com/conversions', @payload))
+  end
+
+  def test_conversion_event()
+    build_objects
+    Net::HTTP.any_instance.stubs(:request).returns(Net::HTTPSuccess.new(1.0, 200, "OK"))
+    assert_instance_of( Net::HTTPSuccess, @request.post(:'customers/test@sendwithus.com/conversions', @payload))
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: send_with_us
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.3.3
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-24 00:00:00.000000000 Z
+date: 2014-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake