send_with_us 4.3.0 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6a246f1dd54a758295eb1b9ac7fd0d98daa6d0e5f7ffd7f6fa9a0216025ea79
-  data.tar.gz: 8cd25be4990e4c71b1670c9f6e643df17bf959503f51856c158b94e050d26ed6
+  metadata.gz: 2efa88c6d66849b570afab41c19bca7aa13099c84a38ef9a24a3dfc2f0129de7
+  data.tar.gz: a879b26e74f4b57424660bd781d120ed69c59e6da63b20cb7d1b3e6fb9a62028
 SHA512:
-  metadata.gz: 91d8aee785590e548f116dad433c0e04319eaa3fa293ae6c589f1d39e4b436630d6b14eed1c8dbe7d96c62cee379e93dd0bc0730ff4e28b1a813465a2e9ae3cd
-  data.tar.gz: dccfdd92058ab69d73856c885e3df260829ba326d5333c8842201fb8f149e8b71a32db80106b5b43112ff7fbd65829f7f769d868bd06315280a750b70c943773
+  metadata.gz: df2241902f8d3a830e460ff00a63bfdfd5e017dd37beec40b4db341c6f297bce6f0e63a88e03acf08f4cfcac26638b35550d48a155a1d312d577f4e1e8ea8a44
+  data.tar.gz: b90c377b6cdcec73eefb344af32270ef77afc81afba310ff73423bc61208d7d78f1ee68748adc4b3330c5379fb3888b041eb5a25a18dbb12817b79c22efb5be5

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 4.5.0
+- Add optional `template_data` fields to template calls
+
+## 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
 

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,14 +160,15 @@ module SendWithUs
       SendWithUs::ApiRequest.new(@configuration).post(:'render', payload)
     end
 
-    def create_template(name, subject, html, text, preheader='', amp_html='')
+    def create_template(name, subject, html, text, preheader='', amp_html='', template_data={})
       payload = {
         name: name,
         subject: subject,
         html: html,
         text: text,
         preheader: preheader,
-        amp_html: amp_html
+        amp_html: amp_html,
+        template_data: template_data
       }
 
       payload = payload.to_json
@@ -272,28 +273,30 @@ module SendWithUs
       SendWithUs::ApiRequest.new(@configuration).get(endpoint)
     end
 
-    def update_template_version(template_id, version_id, name, subject, html, text, preheader='', amp_html='')
+    def update_template_version(template_id, version_id, name, subject, html, text, preheader='', amp_html='', template_data={})
       payload = {
         name: name,
         subject: subject,
         html: html,
         text: text,
         preheader: preheader,
-        amp_html: amp_html
+        amp_html: amp_html,
+        template_data: template_data
       }
 
       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, preheader='', amp_html='')
+    def create_template_version(template_id, name, subject, html, text, preheader='', amp_html='', template_data={})
       payload = {
         name: name,
         subject: subject,
         html: html,
         text: text,
         preheader: preheader,
-        amp_html: amp_html
+        amp_html: amp_html,
+        template_data: template_data
       }
 
       endpoint = "templates/#{template_id}/versions"

data/lib/send_with_us/version.rb

@@ -1,3 +1,3 @@
 module SendWithUs
-  VERSION = '4.3.0'
+  VERSION = '4.5.0'
 end

data/test/lib/send_with_us/api_request_test.rb

@@ -21,7 +21,8 @@ class TestApiRequest < Minitest::Test
       :name => 'Test Template '.concat(Random.new.rand(100000).to_s),
       :id => 'test_fixture_1',
       :preheader => 'Test preheader',
-      :amp_html => '<html><head></head><body>AMP HTML</body></html>'
+      :amp_html => '<html><head></head><body>AMP HTML</body></html>',
+      :template_data => {data: 'I AM DATA'}
     }
   end
 
@@ -261,7 +262,8 @@ class TestApiRequest < Minitest::Test
       @template[:html],
       'sample text payload',
       preheader=@template[:preheader],
-      amp_html=@template[:amp_html]
+      amp_html=@template[:amp_html],
+      template_data=@template[:template_data]
     )
 
     assert_instance_of( Net::HTTPOK, result )
@@ -289,7 +291,8 @@ class TestApiRequest < Minitest::Test
       @template[:html],
       'sample text payload',
       preheader=@template[:preheader],
-      amp_html=@template[:amp_html]
+      amp_html=@template[:amp_html],
+      template_data=@template[:template_data]
     )
 
     assert_instance_of( Net::HTTPOK, result )

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

data/test/test_helper.rb

@@ -5,6 +5,7 @@ require File.expand_path('../../lib/send_with_us.rb', __FILE__)
 
 require 'rubygems'
 require 'bundler'
+MiniTest = Minitest unless defined?(MiniTest)
 require "mocha/minitest"
 
 begin

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: send_with_us
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.5.0
 platform: ruby
 authors:
 - Matt Harris
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-19 00:00:00.000000000 Z
+date: 2025-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -109,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: SendWithUs.com Ruby Client