send_with_us 1.5.0 → 1.6.0

data/README.md

@@ -21,7 +21,19 @@ bundle install
 
 ## Usage
 
-### General
+### Send
+
+#### send_with parameters
+- **email\_id** - *string* - Template ID being sent
+- **to** - *hash* - Recipients' email address
+- **data** - *hash* - Email data
+- **from** - *hash* - From name/address/reply\_to
+- **cc** - *array* - array of CC addresses
+- **bcc** - *array* - array of BCC addresses
+- **files** - *array* - array of files to attach
+- **esp\_account** - *string* - ESP account used to send email
+- **version\_name** - *string* - version of template to send
+- **headers** - *hash* - custom email headers **NOTE** only supported by some ESPs
 
 For any Ruby project:
 ```ruby
@@ -33,25 +45,25 @@ begin
 
     # only required params
     result = obj.send_with(
-        'EMAIL_ID',
+        'template_id',
         { address: "user@example.com" })
     puts result
 
     # with all optional params
     result = obj.send_with(
-        'email_id',
+        'template_id',
         { name: 'Matt', address: 'recipient@example.com' },
         { company_name: 'TestCo' },
         { name: 'Company',
             address: 'company@example.com',
             reply_to: 'info@example.com' },
-		'esp_MYESPACCOUNT',	
-		'v2') # version name	
+		'esp_MYESPACCOUNT',
+		'v2') # version name
     puts result
 
     # full cc/bcc support
     result = obj.send_with(
-        'email_id',
+        'template_id',
         { name: 'Matt', address: 'recipient@example.com' },
         { company_name: 'TestCo' },
         { name: 'Company',
@@ -71,7 +83,7 @@ begin
 
     # Attachment support
     result = obj.send_with(
-        'email_id',
+        'template_id',
         { name: 'Matt', address: 'recipient@example.com' },
         { company_name: 'TestCo' },
         { name: 'Company',
@@ -85,7 +97,7 @@ begin
     # Set ESP account
     # See: https://help.sendwithus.com/support/solutions/articles/1000088976-set-up-and-use-multiple
     result = obj.send_with(
-        'email_id',
+        'template_id',
         { name: 'Matt', address: 'recipient@example.com' },
         { company_name: 'TestCo' },
         { name: 'Company',
@@ -101,6 +113,30 @@ rescue => e
 end
 ```
 
+### Render a Template
+
+- **email\_id** - *string* - Template ID being rendered
+- **version\_id** - *string* - Version ID to render (optional)
+- **data** - *hash* - Email data to render the template with
+
+```ruby
+require 'rubygems'
+require 'send_with_us'
+
+begin
+    obj = SendWithUs::Api.new( api_key: 'YOUR API KEY', debug: true )
+
+    result = obj.render(
+        'template_id',
+        'version_id',
+        { company_name: 'TestCo' },
+
+    puts result
+rescue => e
+    puts "Error - #{e.class.name}: #{e.message}"
+end
+```
+
 ### Remove Customer from Drip Campaign
 ```ruby
 require 'rubygems'
@@ -141,7 +177,7 @@ begin
     # Remove customer@example.com from campaign dc_asdf1234
     result = obj.remove_from_drip_campaign('cusomter@example.com', 'dc_asdf1234')
     puts result
-rescue => e
+    rescue => e
     puts "error - #{e.class.name}: #{e.message}"
 end
 ```
@@ -190,7 +226,7 @@ In your application code where you want to send an email:
 
 ```ruby
 begin
-    result = SendWithUs::Api.new.send_with('email_id', { address: 'recipient@example.com' }, { company_name: 'TestCo' })
+    result = SendWithUs::Api.new.send_with('template_id', { address: 'recipient@example.com' }, { company_name: 'TestCo' })
     puts result
 rescue => e
     puts "Error - #{e.class.name}: #{e.message}"
@@ -207,7 +243,7 @@ Take a look at our Mailer that you can use to replace ActionMailer
 The following errors may be generated:
 
 ```ruby
-SendWithUs::ApiInvalidEndpoint - the target URI is probably incorrect or email_id is invalid
+SendWithUs::ApiInvalidEndpoint - the target URI is probably incorrect or template_id is invalid
 SendWithUs::ApiInvalidKey - the sendwithus API key is invalid
 SendWithUs::ApiBadRequest - the API request is invalid
 SendWithUs::ApiConnectionRefused - the target URI is probably incorrect

data/lib/send_with_us/api.rb

@@ -81,6 +81,17 @@ module SendWithUs
       SendWithUs::ApiRequest.new(@configuration).get(:emails)
     end
 
+    def render(template_id, version_id = nil, template_data = {})
+      payload = {
+        template_id: template_id,
+        template_data: template_data,
+      }
+      payload[:version_id] = version_id if version_id
+      payload = payload.to_json
+
+      SendWithUs::ApiRequest.new(@configuration).post(:'render', payload)
+    end
+
     def create_template(name, subject, html, text)
       payload = {
         name: name,

data/lib/send_with_us/version.rb

@@ -1,3 +1,3 @@
 module SendWithUs
-  VERSION = '1.5.0'
+  VERSION = '1.6.0'
 end

data/test/lib/send_with_us/api_request_test.rb

@@ -103,6 +103,36 @@ class TestApiRequest < MiniTest::Unit::TestCase
     assert_instance_of( Net::HTTPOK, result )
   end
 
+  def test_render
+    build_objects
+    email_id = 'tem_9YvYsaLW2Mw4tmPiLcVvpC'
+    result = @api.render(
+      email_id
+    )
+    assert_instance_of( Net::HTTPOK, result )
+  end
+
+  def test_render_with_version
+    build_objects
+    email_id = 'tem_9YvYsaLW2Mw4tmPiLcVvpC'
+    result = @api.render(
+      email_id,
+      'ver_UQuRkPN7aJjEoNfoHzvffD'
+    )
+    assert_instance_of( Net::HTTPOK, result )
+  end
+
+  def test_render_with_version_and_data
+    build_objects
+    email_id = 'tem_9YvYsaLW2Mw4tmPiLcVvpC'
+    result = @api.render(
+      email_id,
+      'ver_UQuRkPN7aJjEoNfoHzvffD',
+      {'foo' => 'bar'}
+    )
+    assert_instance_of( Net::HTTPOK, result )
+  end
+
   def test_emails
     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: 1.5.0
+  version: 1.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-28 00:00:00.000000000 Z
+date: 2014-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake