send_with_us 4.2.1 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4f011c520b1ac7dad2bdcdcec37d6ff1f2f28ed9fa37f769fe2a007f018bb8b
-  data.tar.gz: 6b4dcaa033c8d5664266295611b6d9f806a246cb8a9effeda0d9b017ca3ecc68
+  metadata.gz: f67c0ceffafb13f25e0f582159853931f7ad80cb021c49839d42f3fe950057f9
+  data.tar.gz: fc33de35c98767fef56a58837cd00d80c8a9490e37fb90c7a7ad241854377585
 SHA512:
-  metadata.gz: c6b3e38cdbdf61aca2c9a67eccdc3702dfcd506ed913215bf5f239165bd7f223dd2d521debf9fbfabdf88392a830f1ef4422e38e8521dd3d9ab61df73aa33a51
-  data.tar.gz: 9a116f73ce870f583a9999175fce0b054bb8c4ca102f1954ac3d5e2cc8e0bd745631119330745901dee84deb881e86475c3aade6afc0337eb9717fcdbe985ef6
+  metadata.gz: 247e986c2ed5785fd6c5a719448a57da298056a00ac6a41eb4f44813931456c749856e1ff0b026ad12225483ba4c3a70a8bfb20f7e9cd8209a1bba340919e60f
+  data.tar.gz: 1ea7ae022f32cae2ceb89da6828d3978540218f9a9a02fce7faa7fe5752ac54fa6c0ff8e6cd5977c65cb2408a9a700b319b09cd7ef7684150712fe10d6fa204c

data/CHANGELOG.md

@@ -1,5 +1,11 @@
+## 4.4.0
+- **[#88](https://github.com/sendwithus/sendwithus_ruby/pull/88) Fix problematic `render` implementation.** `template_data` serves two purposes, defining template data and specifying the optional API parameter for `locale`. Previously, `locale` would be stripped out of `template_data` in the API request, preventing users from specifying variables named `locale` in their own template data.
+
+## 4.3.0
+- Add optional `preheader` and `amp_html` fields to template calls
+
 ## 4.2.1
-- Bump `rake` version due to vulnerability 
+- Bump `rake` version due to vulnerability
 
 ## 4.2.0
 - add a `log_events` method to get the events list on a Sendwithus log

data/lib/send_with_us/api.rb

@@ -145,7 +145,7 @@ module SendWithUs
     alias list_templates emails
 
     def render(template_id, version_id = nil, template_data = {}, strict = false)
-      locale = template_data.delete(:locale)
+      locale = template_data[:locale]
 
       payload = {
         template: template_id,
@@ -160,12 +160,14 @@ module SendWithUs
       SendWithUs::ApiRequest.new(@configuration).post(:'render', payload)
     end
 
-    def create_template(name, subject, html, text)
+    def create_template(name, subject, html, text, preheader='', amp_html='')
       payload = {
         name: name,
         subject: subject,
         html: html,
-        text: text
+        text: text,
+        preheader: preheader,
+        amp_html: amp_html
       }
 
       payload = payload.to_json
@@ -254,7 +256,7 @@ module SendWithUs
 
       SendWithUs::ApiRequest.new(@configuration).get(endpoint)
     end
-    
+
     def delete_template(template_id)
       endpoint = "templates/#{template_id}"
       SendWithUs::ApiRequest.new(@configuration).delete(endpoint)
@@ -270,24 +272,28 @@ module SendWithUs
       SendWithUs::ApiRequest.new(@configuration).get(endpoint)
     end
 
-    def update_template_version(template_id, version_id, name, subject, html, text)
+    def update_template_version(template_id, version_id, name, subject, html, text, preheader='', amp_html='')
       payload = {
         name: name,
         subject: subject,
         html: html,
-        text: text
+        text: text,
+        preheader: preheader,
+        amp_html: amp_html
       }
 
       endpoint = "templates/#{template_id}/versions/#{version_id}"
       SendWithUs::ApiRequest.new(@configuration).put(endpoint, payload.to_json)
     end
 
-    def create_template_version(template_id, name, subject, html, text)
+    def create_template_version(template_id, name, subject, html, text, preheader='', amp_html='')
       payload = {
         name: name,
         subject: subject,
         html: html,
-        text: text
+        text: text,
+        preheader: preheader,
+        amp_html: amp_html
       }
 
       endpoint = "templates/#{template_id}/versions"

data/lib/send_with_us/version.rb

@@ -1,3 +1,3 @@
 module SendWithUs
-  VERSION = '4.2.1'
+  VERSION = '4.4.0'
 end

data/test/lib/send_with_us/api_request_test.rb

@@ -19,7 +19,9 @@ class TestApiRequest < Minitest::Test
       :html => '<html><head></head><body>TEST</body></html>',
       :subject  => 'A test template',
       :name => 'Test Template '.concat(Random.new.rand(100000).to_s),
-      :id => 'test_fixture_1'
+      :id => 'test_fixture_1',
+      :preheader => 'Test preheader',
+      :amp_html => '<html><head></head><body>AMP HTML</body></html>'
     }
   end
 
@@ -78,7 +80,7 @@ class TestApiRequest < Minitest::Test
     invalid_payload = {
       template_id:  @template[:id],
       recipient: {name: 'Ruby Unit Test', address: 'stéve@sendwithus.com'}
-    }.to_json    
+    }.to_json
     assert_raises( SendWithUs::ApiBadRequest) { @request.post(:send, invalid_payload) }
   end
 
@@ -93,7 +95,7 @@ class TestApiRequest < Minitest::Test
       bcc: [],
       files: ['README.md']
     )
-    assert_instance_of( Net::HTTPOK, result ) 
+    assert_instance_of( Net::HTTPOK, result )
   end
 
   def test_send_email_with_file
@@ -247,6 +249,24 @@ class TestApiRequest < Minitest::Test
     assert_instance_of( Net::HTTPOK, result )
   end
 
+  def test_update_template_version_with_optional_fields
+    build_objects
+    version_id = get_first_template_version_id(@template[:id])
+
+    result = @api.update_template_version(
+      @template[:id],
+      version_id,
+      @template[:name],
+      @template[:subject],
+      @template[:html],
+      'sample text payload',
+      preheader=@template[:preheader],
+      amp_html=@template[:amp_html]
+    )
+
+    assert_instance_of( Net::HTTPOK, result )
+  end
+
   def test_create_template_version
     build_objects
     result = @api.create_template_version(
@@ -260,6 +280,21 @@ class TestApiRequest < Minitest::Test
     assert_instance_of( Net::HTTPOK, result )
   end
 
+  def test_create_template_version_with_optional_fields
+    build_objects
+    result = @api.create_template_version(
+      @template[:id],
+      @template[:name],
+      @template[:subject],
+      @template[:html],
+      'sample text payload',
+      preheader=@template[:preheader],
+      amp_html=@template[:amp_html]
+    )
+
+    assert_instance_of( Net::HTTPOK, result )
+  end
+
   def test_delete_template
     build_objects
     template = JSON.parse @api.create_template(

data/test/lib/send_with_us/api_test.rb

@@ -99,4 +99,26 @@ describe SendWithUs::Api do
 
       it { subject.customer_get(email) }
   end
+
+  describe '#render' do
+    let(:locale) { 'fr-CA' }
+    let(:template_id) { 'template-id' }
+    let(:template_data) { { foo: 'bar', locale: locale } }
+    let(:strict) { true }
+    let(:version_id) { 'some-version-id' }
+
+    let(:payload) do
+      {
+        template: template_id,
+        template_data: template_data,
+        strict: strict,
+        version_id: version_id,
+        locale: locale,
+      }
+    end
+
+    before { SendWithUs::ApiRequest.any_instance.expects(:post).with(:render, payload.to_json) }
+
+    it { subject.render(template_id, version_id, template_data, strict) }
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: send_with_us
 version: !ruby/object:Gem::Version
-  version: 4.2.1
+  version: 4.4.0
 platform: ruby
 authors:
 - Matt Harris
@@ -9,10 +9,10 @@ authors:
 - Nicholas Rempel
 - Gregory Schier
 - Brad Van Vugt
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-26 00:00:00.000000000 Z
+date: 1980-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -94,7 +94,7 @@ homepage: https://github.com/sendwithus/sendwithus_ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -109,8 +109,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.2.26
+signing_key:
 specification_version: 4
 summary: SendWithUs.com Ruby Client
 test_files: