sendgrid-actionmailer 2.0.1 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 92aceed9d68cf14a3c461fef95478935b2d6abad
-  data.tar.gz: cda4360a31bddc4dbc8dd02b1ad6bf96519b1f84
+  metadata.gz: bd39b2edccaafaa5842c9ce058a3cb454c128e6c
+  data.tar.gz: 23f300c8fb257f9f06983eaebcb54504fcb2fbcf
 SHA512:
-  metadata.gz: 7687cc4ede183737d615e2892844f1ac538e8b629f74952fd584761a81207c32fdcc44cd031898bc00996edc8a2eb13dbe5c01cbaf4bf951c2f31532d99c553e
-  data.tar.gz: e63c5d2236e329ab7b7898875c0d87fa2ffa34565e9b0ddbd58aa70753be615a4ea22a428b20f4e879e9b97cb0ac50209f3b5dfff80a825863a51c084fc1fdfc
+  metadata.gz: 272cd434acac86b4a069c6d53ab0a9462021d4550cd4f24c2659258ceddf30f10d7c30c42de558d064400f676bd1a7107149ac34c92fb7a8cd115656c307fa2d
+  data.tar.gz: cfeabef756e01eaf744ba91401650495e591f0f1d224d3ac4eca0b6ece405a9629937c86aa1fbdb9fb376a2da798f38a929c65611d3d0ea154265acec3855494

data/.travis.yml

@@ -5,8 +5,8 @@ rvm:
   - 2.4.4
   - 2.3.4
   - 2.3.7
-  - 2.2.10
 before_install:
+  - gem update --system
   - gem install bundler
 gemfile:
   - gemfiles/mail_2.5.gemfile

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## 2.4.0 - 2019-07-9
+
+### Changed
+
+- Compatibility with `sendgrid-ruby` v6.0.
+
+
 ## 2.0.0 - 2018-08-15
 
 ### Changed

data/README.md

@@ -6,7 +6,7 @@ An ActionMailer adapter to send email using SendGrid's HTTPS Web API (instead of
 
 Add this line to your application's Gemfile:
 
-    gem 'sendgrid-actionmailer', github: 'eddiezane/sendgrid-actionmailer'
+    gem 'sendgrid-actionmailer'
 
 ## Usage
 
@@ -45,7 +45,7 @@ The Mail functionality is extended to include additional attributes provided by
 [Sendgrid v3 API Documentation](https://sendgrid.com/docs/API_Reference/api_v3.html)
 
 ### template_id (string)
-The id of a template that you would like to use. If you use a template that contains a subject and content (either text or html), you do not need to specify those at the personalizations nor message level.
+The id of a template that you would like to use. If you use a template that contains a subject, you do not need to specify a subject at the personalizations nor message level. However, because of the way ActionMailer works, a body is required, even if the template contains one. If all your emails use templates with a body, you can add `default body: "not used"` to the top of your mailer.
 
 ```mail(to: 'example@email.com', subject: 'email subject', body: 'email body', template_id: 'template_1')```
 
@@ -215,6 +215,12 @@ The name of the campaign.
 
 ```mail(to: 'example@email.com', subject: 'email subject', body: 'email body',  tracking_settings:{ enable: true, utm_source: 'some source', utm_medium: 'some medium', utm_term: 'some term', utm_content: 'some content', utm_campaign: 'some campaign' }})```
 
+### dynamic_template_data (json)
+
+Data to provide for feeding the new dynamic templates in Sendgrid with valueable data. This also disables the following Unsubscribe links because of deprecation of substitutions in the new template implementaiton.
+
+```mail(to: 'example@email.com', subject: 'email subject', body: 'email body',  dynamic_template_data:{ variable_1: 'foo', variable_2: 'bar'})```
+
 ### Unsubscribe Links
 
 Sendgrid unfortunately uses <% %> for their default substitution syntax, which makes it incompatible with Rails templates. Their proposed solution is to use Personalization Substitutions with the v3 Mail Send Endpoint.  This gem makes that modification to make the following Rails friendly unsubscribe urls.
@@ -222,3 +228,5 @@ Sendgrid unfortunately uses <% %> for their default substitution syntax, which m
  * `<a href="%asm_group_unsubscribe_raw_url%">Unsubscribe</a>`
  * `<a href="%asm_global_unsubscribe_raw_url%">Unsubscribe from List</a>`
  * `<a href="%asm_preferences_raw_url%">Manage Email Preferences</a>`
+
+Note: This feature, and substitutions in general, do not work in combination with dynamic templates.

data/lib/sendgrid_actionmailer/version.rb

@@ -1,3 +1,3 @@
 module SendGridActionMailer
-  VERSION = '2.0.1'.freeze
+  VERSION = '2.4.0'.freeze
 end

data/lib/sendgrid_actionmailer.rb

@@ -23,7 +23,7 @@ module SendGridActionMailer
       sendgrid_mail = Mail.new.tap do |m|
         m.from = to_email(mail.from)
         m.reply_to = to_email(mail.reply_to)
-        m.subject = mail.subject
+        m.subject = mail.subject || ""
         # https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/personalizations.html
         m.add_personalization(to_personalizations(mail))
       end
@@ -34,6 +34,7 @@ module SendGridActionMailer
       add_mail_settings(sendgrid_mail, mail)
       add_tracking_settings(sendgrid_mail, mail)
 
+
       response = perform_send_request(sendgrid_mail)
 
       settings[:return_response] ? response : self
@@ -79,9 +80,14 @@ module SendGridActionMailer
         to_emails(mail.to).each { |to| p.add_to(to) }
         to_emails(mail.cc).each { |cc| p.add_cc(cc) }
         to_emails(mail.bcc).each { |bcc| p.add_bcc(bcc) }
-        p.add_substitution(Substitution.new(key: "%asm_group_unsubscribe_raw_url%", value: "<%asm_group_unsubscribe_raw_url%>"))
-        p.add_substitution(Substitution.new(key: "%asm_global_unsubscribe_raw_url%", value: "<%asm_global_unsubscribe_raw_url%>"))
-        p.add_substitution(Substitution.new(key: "%asm_preferences_raw_url%", value: "<%asm_preferences_raw_url%>"))
+
+        if mail['dynamic_template_data']
+          p.add_dynamic_template_data(json_parse(mail['dynamic_template_data'].value))
+        elsif mail['template_id'].nil?
+          p.add_substitution(Substitution.new(key: "%asm_group_unsubscribe_raw_url%", value: "<%asm_group_unsubscribe_raw_url%>"))
+          p.add_substitution(Substitution.new(key: "%asm_global_unsubscribe_raw_url%", value: "<%asm_global_unsubscribe_raw_url%>"))
+          p.add_substitution(Substitution.new(key: "%asm_preferences_raw_url%", value: "<%asm_preferences_raw_url%>"))
+        end
       end
     end
 
@@ -130,7 +136,7 @@ module SendGridActionMailer
     end
 
     def json_parse(text, symbolize=true)
-      JSON.parse(text.gsub(/:*\"*([\%a-zA-Z0-9_-]*)\"*(( *)=>\ *)/) { "\"#{$1}\":" }, symbolize_names: symbolize)
+      JSON.parse(text.empty? ? '{}' : text.gsub(/:*\"*([\%a-zA-Z0-9_-]*)\"*(( *)=>\ *)/) { "\"#{$1}\":" }, symbolize_names: symbolize)
     end
 
     def add_send_options(sendgrid_mail, mail)
@@ -157,9 +163,11 @@ module SendGridActionMailer
           sendgrid_mail.add_custom_arg(CustomArg.new(key: key, value: value))
         end
       end
-      if mail['send_at'] && mail['batch_id']
+      if mail['send_at']
         sendgrid_mail.send_at = mail['send_at'].value.to_i
-        sendgrid_mail.batch_id= mail['batch_id'].to_s
+      end
+      if mail['batch_id']
+        sendgrid_mail.batch_id = mail['batch_id'].to_s
       end
       if mail['asm']
         asm = json_parse(mail['asm'].value)

data/sendgrid-actionmailer.gemspec

@@ -20,10 +20,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'mail', '~> 2.5'
-  spec.add_dependency 'sendgrid-ruby', '~> 5.2'
+  spec.add_dependency 'sendgrid-ruby', '~> 6.0'
 
   spec.add_development_dependency 'appraisal', '~> 2.1.0'
-  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 3.2'
   spec.add_development_dependency 'webmock'

data/spec/lib/sendgrid_actionmailer_spec.rb

@@ -384,6 +384,27 @@ module SendGridActionMailer
             expect(client.sent_mail['tracking_settings']).to eq(tracking)
           end
         end
+
+        context 'dynamic template data' do
+          it 'sets dynamic_template_data' do
+            template_data = { variable_1: '1', variable_2: '2' }
+            mail['dynamic_template_data'] = template_data
+            mailer.deliver!(mail)
+            expect(client.sent_mail['personalizations'].first['dynamic_template_data']).to eq(template_data)
+          end
+        end
+
+        it 'sets dynamic template data and sandbox_mode' do
+          mail['mail_settings'] = '{}'
+          mailer.deliver!(mail)
+          expect(client.sent_mail['mail_settings']).to eq(nil)
+        end
+
+        it 'sets dynamic template data and sandbox_mode' do
+          mail['mail_settings'] = {}
+          mailer.deliver!(mail)
+          expect(client.sent_mail['mail_settings']).to eq(nil)
+        end
       end
 
       context 'multipart/alternative' do
@@ -443,7 +464,7 @@ module SendGridActionMailer
         end
 
         it 'adds the attachment' do
-          expect(mail.attachments.first.read).to eq(File.read(__FILE__))
+          expect(mail.attachments.first.read).to include("it 'adds the attachment' do")
           mailer.deliver!(mail)
           attachment = client.sent_mail['attachments'].first
           expect(attachment['filename']).to eq('specs.rb')
@@ -480,7 +501,7 @@ module SendGridActionMailer
         end
 
         it 'adds the inline attachment' do
-          expect(mail.attachments.first.read).to eq(File.read(__FILE__))
+          expect(mail.attachments.first.read).to include("it 'adds the inline attachment' do")
           mailer.deliver!(mail)
           content = client.sent_mail['attachments'].first
           expect(content['filename']).to eq('specs.rb')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sendgrid-actionmailer
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.4.0
 platform: ruby
 authors:
 - Eddie Zaneski
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-09 00:00:00.000000000 Z
+date: 2019-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
@@ -32,14 +32,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -58,16 +58,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement