send_with_us 2.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c84fc4a3e66e9b6695c0a3511271dc310216955
-  data.tar.gz: 1708ead51ac8402101d7109cab68b2b98fa9687f
+  metadata.gz: d50c239efd64109971c40b8672b632ca5bfc3919
+  data.tar.gz: bfcf5cb515ac7b97a5c2f0437401970299356b12
 SHA512:
-  metadata.gz: de2168223aa09f4b9f3229946262a44ffb288c94263936115910c131849f54f1700f7bbd537a54617047e73046e6c8d09b20a9f8dfa2d272a0f669ce5d80bdc4
-  data.tar.gz: 67d28bd38f57e27ea39b92dd99959798517ed1159f7714ec00a2e814cf93fe19b5a835ab9e6832e34afe34f302f13bff49baab78d31e5a1dfd78be6943beb5b6
+  metadata.gz: aae51ef349b4cf4632ac6cfd6c944e54973eefe6ac982824c40542284c8a92d2fa164a214c425a32d54436dbce5edff2aa4a76c7f6a05ad3f53fb7f4126e286d
+  data.tar.gz: 9c926d10b52714d17a67e946dd3e18e8bf198d854cf2b0ad4128b73aa211b893c5061d6f734dd91c9db80883d136913bc21a554495cae015b6446220c236e12e

data/CHANGELOG.md

@@ -1,3 +1,5 @@
+3.1.0 - Add `strict` option to the render call
+3.0.0 - Deprecate and remove Conversions API calls
 2.0.0 - Deprecate Customer Groups API
 1.13.0 - Add support to get customer details
 1.12.0 - Customer logs endpoint added and optional parameters for logs fixed when no options sent

data/README.md

@@ -192,6 +192,7 @@ end
 - **version\_id** - *string* - Version ID to render (optional)
 - **data** - *hash* - Email data to render the template with (optional)
 - **data[:locale]** - *hash value* - This option specifies the locale to render (optional)
+- **strict** - *bool* - This option enables strict mode and is disabled by default (optional)
 
 ```ruby
 require 'rubygems'
@@ -204,6 +205,7 @@ begin
         'template_id',
         'version_id',
         { company_name: 'TestCo' },
+		strict=true)
 
     puts result
 rescue => e
@@ -274,7 +276,7 @@ customer = obj.customer_get("visha@example.com")
 
 ```ruby
 customer_data = {:FirstName => "Visha"}
-result = obj.customer_create("visha@example.com", customer_data)
+result = obj.customer_create("visha@example.com")
 ```
 
 ### Delete a Customer
@@ -296,19 +298,6 @@ Optional Arguments:
 obj.customer_email_log('customer@example.com', count: 1)
 ```
 
-### 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.customer_conversion('customer@example.com', 10050)
-
-# Without Revenue
-obj.customer_conversion('customer@example.com')
-```
-
 ## Templates
 
 ```ruby

data/lib/send_with_us/api.rb

@@ -151,12 +151,13 @@ module SendWithUs
 
     alias list_templates emails
 
-    def render(template_id, version_id = nil, template_data = {})
+    def render(template_id, version_id = nil, template_data = {}, strict = false)
       locale = template_data.delete(:locale)
 
       payload = {
-        template_id: template_id,
+        template: template_id,
         template_data: template_data,
+        strict: strict,
       }
 
       payload[:version_id] = version_id if version_id
@@ -221,33 +222,6 @@ module SendWithUs
       SendWithUs::ApiRequest.new(@configuration).get("drip_campaigns/#{drip_campaign_id}/step/#{drip_campaign_step_id}/customers")
     end
 
-    # DEPRECATED: Please use 'customer_conversion' instead.
-    def add_customer_event(customer, event_name, revenue=nil)
-      warn "[DEPRECATED] 'add_customer_event' is deprecated.  Please use 'customer_conversion' instead."
-
-      payload = {event_name: event_name}
-
-      if revenue
-        payload[:revenue] = revenue
-      end
-
-      payload = payload.to_json
-      endpoint = "customers/#{customer}/conversions"
-      SendWithUs::ApiRequest.new(@configuration).post(endpoint, payload)
-    end
-
-    def customer_conversion(customer, revenue=nil)
-      payload = {}
-
-      if revenue
-        payload[:revenue] = revenue
-      end
-
-      payload = payload.to_json
-      endpoint = "customers/#{customer}/conversions"
-      SendWithUs::ApiRequest.new(@configuration).post(endpoint, payload)
-    end
-
     def customer_get(email)
       SendWithUs::ApiRequest.new(@configuration).get("customers/#{email}")
     end

data/lib/send_with_us/api_request.rb

@@ -42,7 +42,7 @@ module SendWithUs
       end
 
       def request(method_klass, path, payload=nil)
-        request = method_klass.new(path, initheader = {'Content-Type' =>'application/json'})
+        request = method_klass.new(path, {'Content-Type' =>'application/json'})
         request.add_field('X-SWU-API-KEY', @configuration.api_key)
         request.add_field('X-SWU-API-CLIENT', @configuration.client_stub)
 

data/lib/send_with_us/version.rb

@@ -1,3 +1,3 @@
 module SendWithUs
-  VERSION = '2.0.0'
+  VERSION = '3.1.0'
 end

data/test/lib/send_with_us/api_request_test.rb

@@ -17,7 +17,7 @@ class TestApiRequest < Minitest::Test
     @template = {
       :html => '<html><head></head><body>TEST</body></html>',
       :subject  => 'A test template',
-      :name => 'Test Template',
+      :name => 'Test Template '.concat(Random.new.rand(100000).to_s),
       :id => 'test_fixture_1'
     }
   end
@@ -74,14 +74,14 @@ class TestApiRequest < Minitest::Test
 
   def test_send_with_with_attachment
     build_objects
-    result = @api.send_with(
+    result = @api.send_email(
       @template[:id],
       {name: 'Ruby Unit Test', address: 'matt@example.com'},
-      {data: 'I AM DATA'},
-      {name: 'sendwithus', address: 'matt@example.com'},
-      [],
-      [],
-      ['README.md']
+      data: {data: 'I AM DATA'},
+      from: {name: 'sendwithus', address: 'matt@example.com'},
+      cc: [],
+      bcc: [],
+      files: ['README.md']
     )
     assert_instance_of( Net::HTTPOK, result )
   end
@@ -89,16 +89,16 @@ class TestApiRequest < Minitest::Test
   def test_send_with_with_version
     build_objects
     email_id = 'tem_9YvYsaLW2Mw4tmPiLcVvpC'
-    result = @api.send_with(
+    result = @api.send_email(
       email_id,
       {name: 'Ruby Unit Test', address: 'matt@example.com'},
-      {data: 'I AM DATA'},
-      {name: 'sendwithus', address: 'matt@example.com'},
-      [],
-      [],
-      [],
-      '',
-      'v2'
+      data: {data: 'I AM DATA'},
+      from: {name: 'sendwithus', address: 'matt@example.com'},
+      cc: [],
+      bcc: [],
+      files: [],
+      esp_account: '',
+      version_name: 'v2'
     )
     assert_instance_of( Net::HTTPOK, result )
   end
@@ -106,17 +106,17 @@ class TestApiRequest < Minitest::Test
   def test_send_with_with_headers
     build_objects
     email_id = 'tem_9YvYsaLW2Mw4tmPiLcVvpC'
-    result = @api.send_with(
+    result = @api.send_email(
       email_id,
       {name: 'Ruby Unit Test', address: 'matt@example.com'},
-      {data: 'I AM DATA'},
-      {name: 'sendwithus', address: 'matt@example.com'},
-      [],
-      [],
-      [],
-      '',
-      'v2',
-      {'X-MY-HEADER' => 'foo'}
+      data: {data: 'I AM DATA'},
+      from: {name: 'sendwithus', address: 'matt@example.com'},
+      cc: [],
+      bcc: [],
+      files: [],
+      esp_account: '',
+      version_name: 'v2',
+      headers: {'X-MY-HEADER' => 'foo'}
     )
     assert_instance_of( Net::HTTPOK, result )
   end
@@ -124,18 +124,18 @@ class TestApiRequest < Minitest::Test
   def test_send_with_with_tags
     build_objects
     email_id = 'tem_9YvYsaLW2Mw4tmPiLcVvpC'
-    result = @api.send_with(
+    result = @api.send_email(
       email_id,
       {name: 'Ruby Unit Test', address: 'matt@example.com'},
-      {data: 'I AM DATA'},
-      {name: 'sendwithus', address: 'matt@example.com'},
-      [],
-      [],
-      [],
-      '',
-      'v2',
-      {},
-      ['tag1', 'tag2']
+      data: {data: 'I AM DATA'},
+      from: {name: 'sendwithus', address: 'matt@example.com'},
+      cc: [],
+      bcc: [],
+      files: [],
+      esp_account: '',
+      version_name: 'v2',
+      headers: {},
+      tags: ['tag1', 'tag2']
     )
     assert_instance_of( Net::HTTPOK, result )
   end
@@ -301,18 +301,6 @@ class TestApiRequest < Minitest::Test
     assert_equal( true, @request.send(:request_path, :send) == '/api/v1_0/send' )
   end
 
-  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/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
-
   def test_customer_create
     build_objects
     Net::HTTP.any_instance.stubs(:request).returns(Net::HTTPSuccess.new(1.0, 200, "OK"))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: send_with_us
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Matt Harris
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-09 00:00:00.000000000 Z
+date: 2017-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -107,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: SendWithUs.com Ruby Client