sendgrid-actionmailer 2.6.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a88b2d06241fbea431221f6f1ad9fcde082aefb5467a0f4b3f48aace1f544014
-  data.tar.gz: 5dc1e5a5ca5bd0f8e5bf70f10cc3098962998f82c649a8d9ef19c529d8992038
+  metadata.gz: 68926bb0db0f0f622282b8429b3df0f86911ca0d72c0146bcaf181966130e290
+  data.tar.gz: '048ca01e72420c6f88be723ada69126d31c831f300b0aa539f8f7d236e3c500f'
 SHA512:
-  metadata.gz: c84a47a7a8f1dfe6a795688ad8c351736b5ebd86adaf1358100b6a8ffc3bad0ad0bfdfaf014ba6a9aaa9d13dc35c0491d0415ef1c54df7b405dfd11485bb54fb
-  data.tar.gz: 8a604292f2bb61541fbe7476e5599d392118b0797edbe35751112b181347aab07fef6d28d849977ff76dd022eab9cdef0dea9d7a0aadd82fd7af6f0dd6c09704
+  metadata.gz: 5999a6b88c2eb27869872a42c0f7300198cb9870f20087a9c38c68909b0bdcd6a960d0adc2eb01dfa39c530ff6eabee727e0ad9762b19294d57be8fd26e598f0
+  data.tar.gz: a26c201d0a9466684796371b82d2cb3d2aaad48efd1fc6a5c1ffd22b410bcdb71203379c498c8ae504653d0a2692206003ac3176ecfd32025e555fb38ebc0d2e

data/.travis.yml

@@ -1,6 +1,7 @@
 sudo: false
 language: ruby
 rvm:
+  - 2.7.1
   - 2.6.5
   - 2.5.7
   - 2.4.9
@@ -9,6 +10,4 @@ before_install:
   - gem update --system
   - gem install bundler
 gemfile:
-  - gemfiles/mail_2.5.gemfile
-  - gemfiles/mail_2.6.gemfile
   - gemfiles/mail_2.7.gemfile

data/Appraisals

@@ -1,11 +1,3 @@
-appraise "mail-2.5" do
-  gem "mail", "2.5.4"
-end
-
-appraise "mail-2.6" do
-  gem "mail", "2.6.4"
-end
-
 appraise "mail-2.7" do
   gem "mail", "2.7.0"
 end

data/CHANGELOG.md

@@ -1,5 +1,66 @@
 # Change Log
 
+## 3.1.1 - 2020-11-06
+- #92 globally configured mail_settings
+- #95 add_mail_settings - support global settings
+
+## 3.1.0 - 2020-8-03
+
+### Changes
+
+- #81 Fix warnings with ruby 2.7
+- #83 Allow string type mail.to
+- #84 Content-ID values to fix inline attachments
+
+## 3.0.2 - 2020-4-20
+
+### Changes
+
+- perform_send_request setting for testing perposes
+
+## 3.0.1 - 2020-4-3
+
+### Changes
+
+- Validate error response body for empty string
+
+## 3.0.0 - 2020-3-2
+
+### Removed
+
+- Compatibility with mail gems before version 2.7
+
+## 2.6.0 - 2020-1-23
+
+### Changes
+
+- Dont send content types with dynamic templates (#69)
+
+## 2.5.0 - 2020-1-21
+
+### Changes
+
+- Add personalizations field (#60)
+
+### Fixes
+
+- Revert "Lazy load ActionMailer::Base" (#64)
+- Yank 2.4.1
+
+## 2.4.2 - 2020-1-21
+
+### Fixes
+
+- Revert "Lazy load ActionMailer::Base" (#64)
+- Yank 2.4.1
+
+## 2.4.1 - 2020-1-20
+
+### Changed
+
+- Update Travis CI settings to test on latest Ruby and mail gem version (#55)
+- Lazy load ActionMailer::Base (#57)
+
 ## 2.4.0 - 2019-07-9
 
 ### Changed

data/README.md

@@ -24,6 +24,18 @@ Normal ActionMailer usage will now transparently be sent using SendGrid's Web AP
 
 ```mail(to: 'example@email.com', subject: 'email subject', body: 'email body')```
 
+### Mail Settings
+
+Mail settings, such as sandbox_mode, may be applied globally through the sendgrid_actionmailer_settings configuration.
+
+```ruby
+config.action_mailer.delivery_method = :sendgrid_actionmailer
+config.action_mailer.sendgrid_actionmailer_settings = {
+  api_key: ENV['SENDGRID_API_KEY'],
+  mail_settings: { sandbox_mode: { enable: true }}
+}
+```
+
 ### Dynamic API Key
 
 If you need to send mail for a number of Sendgrid accounts, you can set the API key for these as follows:
@@ -31,11 +43,12 @@ If you need to send mail for a number of Sendgrid accounts, you can set the API
 
 ```ruby
 mail(to: 'example@email.com',
-     subject: 'email subject',
-     body: 'email body',
-     delivery_method_options: {
-       api_key: 'SENDGRID_API_KEY'
-     })
+  subject: 'email subject',
+  body: 'email body',
+  delivery_method_options: {
+    api_key: 'SENDGRID_API_KEY'
+  }
+)
 ```
 
 ## SendGrid Mail Extensions
@@ -86,7 +99,7 @@ The unsubscribe group to associate with this email.
 #### groups_to_display (array[integer])
 An array containing the unsubscribe groups that you would like to be displayed on the unsubscribe preferences page.
 
-```mail(to: 'example@email.com', subject: 'email subject', body: 'email body', asm: group_id: 99, groups_to_display: [4,5,6,7,8])```
+```mail(to: 'example@email.com', subject: 'email subject', body: 'email body', asm: { group_id: 99, groups_to_display: [4,5,6,7,8] })```
 
 ### ip_pool_name (string)
 The IP Pool that you would like to send this email from.
@@ -105,7 +118,7 @@ Indicates if this setting is enabled.
 ##### email (string)
 The email address that you would like to receive the BCC.
 
-```mail(to: 'example@email.com', subject: 'email subject', body: 'email body', mail_settings: {bcc: {enable: true, email: 'bcc@example.com}})```
+```mail(to: 'example@email.com', subject: 'email subject', body: 'email body', mail_settings: { bcc: { enable: true, email: 'bcc@example.com }})```
 
 #### bypass_list_management (object)
 Allows you to bypass all unsubscribe groups and suppressions to ensure that the email is delivered to every single recipient. This should only be used in emergencies when it is absolutely necessary that every recipient receives your email.
@@ -113,7 +126,7 @@ Allows you to bypass all unsubscribe groups and suppressions to ensure that the
 ###### enable (boolean)
 Indicates if this setting is enabled.
 
-```mail(to: 'example@email.com', subject: 'email subject', body: 'email body',  mail_settings:{ bypass_list_management: { enable: true }})```
+```mail(to: 'example@email.com', subject: 'email subject', body: 'email body', mail_settings: { bypass_list_management: { enable: true }})```
 
 #### footer (object)
 The default footer that you would like included on every email.
@@ -127,7 +140,7 @@ The plain text content of your footer.
 ##### html (string)
 The HTML content of your footer.
 
-```mail(to: 'example@email.com', subject: 'email subject', body: 'email body',  mail_settings:{ footer: { enable: true, text: 'FOOTER', html: '<h1>FOOTER</h1>' }})```
+```mail(to: 'example@email.com', subject: 'email subject', body: 'email body', mail_settings: { footer: { enable: true, text: 'FOOTER', html: '<h1>FOOTER</h1>' }})```
 
 #### sandbox_mode (object)
 This allows you to send a test email to ensure that your request body is valid and formatted correctly.
@@ -135,7 +148,7 @@ This allows you to send a test email to ensure that your request body is valid a
 ##### enable (boolean)
 Indicates if this setting is enabled.
 
-```mail(to: 'example@email.com', subject: 'email subject', body: 'email body',  mail_settings:{ sandbox_mode: { enable: true }})```
+```mail(to: 'example@email.com', subject: 'email subject', body: 'email body', mail_settings: { sandbox_mode: { enable: true }})```
 
 #### spam_check (object)
 This allows you to test the content of your email for spam.
@@ -149,7 +162,8 @@ The threshold used to determine if your content qualifies as spam on a scale fro
 ##### post_to_url (string)
 An Inbound Parse URL that you would like a copy of your email along with the spam report to be sent to.
 
-```mail(to: 'example@email.com', subject: 'email subject', body: 'email body',  mail_settings:{ spam_check: {enable: true, threshold: 1, post_to_url: 'https://spamcatcher.sendgrid.com'}})```
+```mail(to: 'example@email.com', subject: 'email subject', body: 'email body', mail_settings: { spam_check: { enable: true, threshold: 1, post_to_url: 'https://spamcatcher.sendgrid.com' }})```
+
 ### tracking_settings(json)
 Settings to determine how you would like to track the metrics of how your recipients interact with your email.
 
@@ -159,10 +173,10 @@ Allows you to track whether a recipient clicked a link in your email.
 ##### enable (boolean)
 Indicates if this setting is enabled.
 
-#####  enable_text (boolean)
+##### enable_text (boolean)
 Indicates if this setting should be included in the text/plain portion of your email.
 
-```mail(to: 'example@email.com', subject: 'email subject', body: 'email body',  tracking_settings:{ enable: false, enable_text: false }})```
+```mail(to: 'example@email.com', subject: 'email subject', body: 'email body', tracking_settings: { click_tracking: { enable: false, enable_text: false }})```
 
 #### open_tracking (object)
 Allows you to track whether the email was opened or not, but including a single pixel image in the body of the content. When the pixel is loaded, we can log that the email was opened.
@@ -173,7 +187,7 @@ Indicates if this setting is enabled.
 ##### substitution_tag (string)
 Allows you to specify a substitution tag that you can insert in the body of your email at a location that you desire. This tag will be replaced by the open tracking pixel.
 
-```mail(to: 'example@email.com', subject: 'email subject', body: 'email body',  tracking_settings:{ enable: true, substitution_tag: 'Optional tag to replace with the open image in the body of the message' }})```
+```mail(to: 'example@email.com', subject: 'email subject', body: 'email body', tracking_settings: { open_tracking: { enable: true, substitution_tag: 'Optional tag to replace with the open image in the body of the message' }})```
 
 #### subscription_tracking (object)
 Allows you to insert a subscription management link at the bottom of the text and html bodies of your email. If you would like to specify the location of the link within your email, you may use the substitution_tag.
@@ -190,7 +204,7 @@ HTML to be appended to the email, with the subscription tracking link. You may c
 ##### substitution_tag (string)
 A tag that will be replaced with the unsubscribe URL. for example: [unsubscribe_url]. If this parameter is used, it will override both the text and html parameters. The URL of the link will be placed at the substitution tag’s location, with no additional formatting.
 
-```mail(to: 'example@email.com', subject: 'email subject', body: 'email body',  tracking_settings:{ enable: true, text: 'text to insert into the text/plain portion of the message', html: 'html to insert into the text/html portion of the message', substitution_tag: 'Optional tag to replace with the open image in the body of the message' }})```
+```mail(to: 'example@email.com', subject: 'email subject', body: 'email body', tracking_settings: { subscription_tracking: { enable: true, text: 'text to insert into the text/plain portion of the message', html: 'html to insert into the text/html portion of the message', substitution_tag: 'Optional tag to replace with the open image in the body of the message' }})```
 
 #### ganalytics (object)
 Allows you to enable tracking provided by Google Analytics.
@@ -213,13 +227,13 @@ Used to differentiate your campaign from advertisements.
 ##### utm_campaign (string)
 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' }})```
+```mail(to: 'example@email.com', subject: 'email subject', body: 'email body', tracking_settings: { ganalytics: { 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.  Variables are available within templates using [{{handlebar syntax}}](https://sendgrid.com/docs/for-developers/sending-email/using-handlebars).
+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. Variables are available within templates using [{{handlebar syntax}}](https://sendgrid.com/docs/for-developers/sending-email/using-handlebars).
 
-```mail(to: 'example@email.com', subject: 'email subject', body: 'email body',  dynamic_template_data:{ variable_1: 'foo', variable_2: 'bar'})```
+```mail(to: 'example@email.com', subject: 'email subject', body: 'email body', dynamic_template_data: { variable_1: 'foo', variable_2: 'bar' })```
 
 ### personalizations (json)
 
@@ -246,19 +260,23 @@ Example usage:
 
 ```
 mail(subject: 'default subject', 'email body', personalizations: [
-  { to: { email: 'example@example.com' }},
-  { to: { email: 'example2@example.com' }}
+  { to: [{ email: 'example@example.com' }]},
+  { to: [{ email: 'example2@example.com' }]}
 ])
-
 ```
 
-
 ### 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.
+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.
 
  * `<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.
+
+## Testing
+
+The setting `perform_send_request` is available to disable sending for testing purposes. Setting perform_send_request false and return_response true enables the testing of the JSON API payload.
+
+

data/lib/sendgrid_actionmailer.rb

@@ -4,6 +4,7 @@ require 'sendgrid-ruby'
 
 module SendGridActionMailer
   class DeliveryMethod
+
     # TODO: use custom class to customer excpetion payload
     SendgridDeliveryError = Class.new(StandardError)
 
@@ -15,7 +16,7 @@ module SendGridActionMailer
 
     attr_accessor :settings, :api_key
 
-    def initialize(**params)
+    def initialize(params = {})
       self.settings = DEFAULTS.merge(params)
     end
 
@@ -33,7 +34,11 @@ module SendGridActionMailer
       add_mail_settings(sendgrid_mail, mail)
       add_tracking_settings(sendgrid_mail, mail)
 
-      response = perform_send_request(sendgrid_mail)
+      if (settings[:perform_send_request] == false)
+        response = sendgrid_mail
+      else
+        response = perform_send_request(sendgrid_mail)
+      end
 
       settings[:return_response] ? response : self
     end
@@ -74,48 +79,50 @@ module SendGridActionMailer
     end
 
     def setup_personalization(mail, personalization_hash)
-      p = Personalization.new
+      personalization = Personalization.new
+
+      personalization_hash =  self.class.transform_keys(personalization_hash, &:to_s)
 
       (personalization_hash['to'] || []).each do |to|
-        p.add_to Email.new(email: to['email'], name: to['name'])
+        personalization.add_to Email.new(email: to['email'], name: to['name'])
       end
       (personalization_hash['cc'] || []).each do |cc|
-        p.add_cc Email.new(email: cc['email'], name: cc['name'])
+        personalization.add_cc Email.new(email: cc['email'], name: cc['name'])
       end
       (personalization_hash['bcc'] || []).each do |bcc|
-        p.add_bcc Email.new(email: bcc['email'], name: bcc['name'])
+        personalization.add_bcc Email.new(email: bcc['email'], name: bcc['name'])
       end
       (personalization_hash['headers'] || []).each do |header_key, header_value|
-        p.add_header Header.new(key: header_key, value: header_value)
+        personalization.add_header Header.new(key: header_key, value: header_value)
       end
       (personalization_hash['substitutions'] || {}).each do |sub_key, sub_value|
-        p.add_substitution(Substitution.new(key: sub_key, value: sub_value))
+        personalization.add_substitution(Substitution.new(key: sub_key, value: sub_value))
       end
       (personalization_hash['custom_args'] || {}).each do |arg_key, arg_value|
-        p.add_custom_arg(CustomArg.new(key: arg_key, value: arg_value))
+        personalization.add_custom_arg(CustomArg.new(key: arg_key, value: arg_value))
       end
       if personalization_hash['send_at']
-        p.send_at = personalization_hash['send_at']
+        personalization.send_at = personalization_hash['send_at']
       end
       if personalization_hash['subject']
-        p.subject = personalization_hash['subject']
+        personalization.subject = personalization_hash['subject']
       end
 
       if mail['dynamic_template_data'] || personalization_hash['dynamic_template_data']
         if mail['dynamic_template_data']
-          data = json_parse(mail['dynamic_template_data'].value, false)
+          data = mail['dynamic_template_data'].unparsed_value
           data.merge!(personalization_hash['dynamic_template_data'] || {})
         else
           data = personalization_hash['dynamic_template_data']
         end
-        p.add_dynamic_template_data(data)
+        personalization.add_dynamic_template_data(data)
       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%>"))
+        personalization.add_substitution(Substitution.new(key: "%asm_group_unsubscribe_raw_url%", value: "<%asm_group_unsubscribe_raw_url%>"))
+        personalization.add_substitution(Substitution.new(key: "%asm_global_unsubscribe_raw_url%", value: "<%asm_global_unsubscribe_raw_url%>"))
+        personalization.add_substitution(Substitution.new(key: "%asm_preferences_raw_url%", value: "<%asm_preferences_raw_url%>"))
       end
 
-      p
+      return personalization
     end
 
     def to_attachment(part)
@@ -128,7 +135,7 @@ module SendGridActionMailer
         a.disposition = disposition unless disposition.nil?
 
         has_content_id = part.header && part.has_content_id?
-        a.content_id = part.header['content_id'].value if has_content_id
+        a.content_id = part.header['content_id'].field.content_id if has_content_id
       end
     end
 
@@ -142,7 +149,7 @@ module SendGridActionMailer
     def add_api_key(sendgrid_mail, mail)
       self.api_key = settings.fetch(:api_key)
       if mail['delivery-method-options'] && mail['delivery-method-options'].value.include?('api_key')
-        self.api_key = JSON.parse(mail['delivery-method-options'].value.gsub('=>', ':'))['api_key']
+        self.api_key = mail['delivery-method-options'].unparsed_value['api_key']
       end
     end
 
@@ -172,25 +179,19 @@ module SendGridActionMailer
       end
     end
 
-    def json_parse(text, symbolize=true)
-      JSON.parse(text.empty? ? '{}' : text.gsub(/:*\"*([\%a-zA-Z0-9_-]*)\"*(( *)=>\ *)/) { "\"#{$1}\":" }, symbolize_names: symbolize)
-    end
-
     def add_personalizations(sendgrid_mail, mail)
-      if (mail.to && mail.to.any?) || (mail.cc && mail.cc.any?) || (mail.bcc && mail.bcc.any?)
+      if mail['personalizations']
+        mail['personalizations'].unparsed_value.each do |p|
+          sendgrid_mail.add_personalization(setup_personalization(mail, p))
+        end
+      end
+      if (mail.to && !mail.to.empty?) || (mail.cc && !mail.cc.empty?) || (mail.bcc && !mail.bcc.empty?)
         personalization = setup_personalization(mail, {})
         to_emails(mail.to).each { |to| personalization.add_to(to) }
         to_emails(mail.cc).each { |cc| personalization.add_cc(cc) }
         to_emails(mail.bcc).each { |bcc| personalization.add_bcc(bcc) }
         sendgrid_mail.add_personalization(personalization)
       end
-
-      if mail['personalizations']
-        personalizations = json_parse('[' + mail['personalizations'].value + ']', false)
-        personalizations.each do |p|
-          sendgrid_mail.add_personalization(setup_personalization(mail, p))
-        end
-      end
     end
 
     def add_send_options(sendgrid_mail, mail)
@@ -198,12 +199,12 @@ module SendGridActionMailer
          sendgrid_mail.template_id = mail['template_id'].to_s
       end
       if mail['sections']
-        json_parse(mail['sections'].value, false).each do |key, value|
+        mail['sections'].unparsed_value.each do |key, value|
           sendgrid_mail.add_section(Section.new(key: key, value: value))
         end
       end
       if mail['headers']
-        json_parse(mail['headers'].value, false).each do |key, value|
+        mail['headers'].unparsed_value.each do |key, value|
           sendgrid_mail.add_header(Header.new(key: key, value: value))
         end
       end
@@ -213,7 +214,7 @@ module SendGridActionMailer
         end
       end
       if mail['custom_args']
-        json_parse(mail['custom_args'].value, false).each do |key, value|
+        mail['custom_args'].unparsed_value.each do |key, value|
           sendgrid_mail.add_custom_arg(CustomArg.new(key: key, value: value))
         end
       end
@@ -224,10 +225,11 @@ module SendGridActionMailer
         sendgrid_mail.batch_id = mail['batch_id'].to_s
       end
       if mail['asm']
-        asm = json_parse(mail['asm'].value)
-        asm =  asm.delete_if { |key, value| !key.to_s.match(/(group_id)|(groups_to_display)/) }
-        if asm[:group_id]
-          sendgrid_mail.asm = ASM.new(asm)
+        asm = mail['asm'].unparsed_value
+        asm =  asm.delete_if { |key, value| 
+          !key.to_s.match(/(group_id)|(groups_to_display)/) }
+        if asm.keys.map(&:to_s).include?('group_id')
+          sendgrid_mail.asm = ASM.new(**self.class.transform_keys(asm, &:to_sym))
         end
       end
       if mail['ip_pool_name']
@@ -236,23 +238,25 @@ module SendGridActionMailer
     end
 
     def add_mail_settings(sendgrid_mail, mail)
-      if mail['mail_settings']
-        settings = json_parse(mail['mail_settings'].value)
+      local_settings = mail['mail_settings'] && mail['mail_settings'].unparsed_value || {}
+      global_settings = self.settings[:mail_settings] || {}
+      settings = global_settings.merge(local_settings)
+      unless settings.empty?
         sendgrid_mail.mail_settings = MailSettings.new.tap do |m|
           if settings[:bcc]
-            m.bcc = BccSettings.new(settings[:bcc])
+            m.bcc = BccSettings.new(**settings[:bcc])
           end
           if settings[:bypass_list_management]
-            m.bypass_list_management = BypassListManagement.new(settings[:bypass_list_management])
+            m.bypass_list_management = BypassListManagement.new(**settings[:bypass_list_management])
           end
           if settings[:footer]
-            m.footer = Footer.new(settings[:footer])
+            m.footer = Footer.new(**settings[:footer])
           end
           if settings[:sandbox_mode]
-            m.sandbox_mode = SandBoxMode.new(settings[:sandbox_mode])
+            m.sandbox_mode = SandBoxMode.new(**settings[:sandbox_mode])
           end
           if settings[:spam_check]
-            m.spam_check = SpamCheck.new(settings[:spam_check])
+            m.spam_check = SpamCheck.new(**settings[:spam_check])
           end
         end
       end
@@ -260,19 +264,19 @@ module SendGridActionMailer
 
     def add_tracking_settings(sendgrid_mail, mail)
       if mail['tracking_settings']
-        settings = json_parse(mail['tracking_settings'].value)
+        settings = mail['tracking_settings'].unparsed_value
         sendgrid_mail.tracking_settings = TrackingSettings.new.tap do |t|
           if settings[:click_tracking]
-            t.click_tracking = ClickTracking.new(settings[:click_tracking])
+            t.click_tracking = ClickTracking.new(**settings[:click_tracking])
           end
           if settings[:open_tracking]
-            t.open_tracking = OpenTracking.new(settings[:open_tracking])
+            t.open_tracking = OpenTracking.new(**settings[:open_tracking])
           end
           if settings[:subscription_tracking]
-            t.subscription_tracking = SubscriptionTracking.new(settings[:subscription_tracking])
+            t.subscription_tracking = SubscriptionTracking.new(**settings[:subscription_tracking])
           end
           if settings[:ganalytics]
-            t.ganalytics = Ganalytics.new(settings[:ganalytics])
+            t.ganalytics = Ganalytics.new(**settings[:ganalytics])
           end
         end
       end
@@ -282,7 +286,7 @@ module SendGridActionMailer
       result = client.mail._('send').post(request_body: email.to_json) # ლ(ಠ益ಠლ) that API
 
       if result.status_code && result.status_code.start_with?('4')
-        message = !!(result.body) ? JSON.parse(result.body).fetch('errors').pop.fetch('message') : 'Sendgrid API Error'
+        message = !(result.body.empty?) ? JSON.parse(result.body).fetch('errors').pop.fetch('message') : 'Sendgrid API Error'
         full_message = "Sendgrid delivery failed with #{result.status_code} #{message}"
 
         settings[:raise_delivery_errors] ? raise(SendgridDeliveryError, full_message) : warn(full_message)
@@ -290,5 +294,17 @@ module SendGridActionMailer
 
       result
     end
+
+    # Recursive key transformation based on Rails deep_transform_values
+    def self.transform_keys(object, &block)
+      case object
+      when Hash
+        object.map { |key, value| [yield(key), transform_keys(value, &block)] }.to_h
+      when Array
+        object.map { |e| transform_keys(e, &block) }
+      else
+        object
+      end
+    end
   end
 end

data/lib/sendgrid_actionmailer/version.rb

@@ -1,3 +1,3 @@
 module SendGridActionMailer
-  VERSION = '2.6.0'.freeze
+  VERSION = '3.1.1'.freeze
 end

data/sendgrid-actionmailer.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'mail', '~> 2.5'
+  spec.add_dependency 'mail', '~> 2.7'
   spec.add_dependency 'sendgrid-ruby', '~> 6.0'
 
   spec.add_development_dependency 'appraisal', '~> 2.1.0'

data/spec/lib/sendgrid_actionmailer_spec.rb

@@ -3,12 +3,8 @@ require 'webmock/rspec'
 
 module SendGridActionMailer
   describe DeliveryMethod do
-    def stringify_keys(hash)
-      result = {}
-      hash.each_key do |key|
-        result[key.to_s] = hash[key]
-      end
-      result
+    def transform_keys(object, &block)
+      SendGridActionMailer::DeliveryMethod.transform_keys(object, &block)
     end
 
     subject(:mailer) do
@@ -63,6 +59,11 @@ module SendGridActionMailer
         m = DeliveryMethod.new(return_response: true)
         expect(m.settings[:return_response]).to eq(true)
       end
+
+      it 'sets perform_deliveries' do
+        m = DeliveryMethod.new(perform_send_request: false)
+        expect(m.settings[:perform_send_request]).to eq(false)
+      end
     end
 
     describe '#deliver!' do
@@ -329,10 +330,10 @@ module SendGridActionMailer
         end
 
         it 'sets asm' do
-          asm = {'group_id' => 99, 'groups_to_display' => [4,5,6,7,8]}
+          asm = {group_id: 99, groups_to_display: [4,5,6,7,8]}
           mail['asm'] = asm
           mailer.deliver!(mail)
-          expect(client.sent_mail['asm']).to eq(asm)
+          expect(client.sent_mail['asm']).to eq(transform_keys(asm, &:to_s))
         end
 
         it 'sets ip_pool_name' do
@@ -341,93 +342,77 @@ module SendGridActionMailer
           expect(client.sent_mail['ip_pool_name']).to eq('marketing')
         end
 
-        context 'parse object' do
-          it "should parse 1.8 hash" do
-            asm = {'group_id' => 99, 'groups_to_display' => [4,5,6,7,8]}
-            mail['asm'] = asm
-            mailer.deliver!(mail)
-            expect(client.sent_mail['asm']).to eq({"group_id" => 99, "groups_to_display" => [4,5,6,7,8]})
-          end
-
-          it "should parse 1.9 hash" do
-            asm = { group_id: 99, groups_to_display: [4,5,6,7,8]}
-            mail['asm'] = asm
-            mailer.deliver!(mail)
-            expect(client.sent_mail['asm']).to eq({"group_id" => 99, "groups_to_display" => [4,5,6,7,8]})
-          end
-
-          it "should parse json" do
-            asm = {'group_id' => 99, 'groups_to_display' => [4,5,6,7,8]}
-            mail['asm'] = asm.to_json
-            mailer.deliver!(mail)
-            expect(client.sent_mail['asm']).to eq({"group_id" => 99, "groups_to_display" => [4,5,6,7,8]})
-          end
+        it 'should not change values inside custom args' do
+          custom_args = { 'text' => 'line with a => in it' }
+          mail['custom_args'] = custom_args
+          mailer.deliver!(mail)
+          expect(client.sent_mail['custom_args']).to eq('text' => 'line with a => in it')
         end
 
         context 'mail_settings' do
           it 'sets bcc' do
-            bcc = { 'bcc' => { 'enable' => true, 'email' => 'test@example.com' }}
+            bcc = { bcc: { enable: true, email: 'test@example.com' }}
             mail['mail_settings'] = bcc
             mailer.deliver!(mail)
-            expect(client.sent_mail['mail_settings']).to eq(bcc)
+            expect(client.sent_mail['mail_settings']).to eq(transform_keys(bcc, &:to_s))
           end
 
           it 'sets bypass_list_management' do
-            bypass = { 'bypass_list_management' => { 'enable' => true }}
+            bypass = { bypass_list_management: { enable: true }}
             mail['mail_settings'] = bypass
             mailer.deliver!(mail)
-            expect(client.sent_mail['mail_settings']).to eq(bypass)
+            expect(client.sent_mail['mail_settings']).to eq(transform_keys(bypass, &:to_s))
           end
 
           it 'sets footer' do
-            footer = {'footer' => { 'enable' => true, 'text' => 'Footer Text', 'html' => '<html><body>Footer Text</body></html>'}}
+            footer = {footer: { enable: true, text: 'Footer Text', html: '<html><body>Footer Text</body></html>'}}
             mail['mail_settings'] = footer
             mailer.deliver!(mail)
-            expect(client.sent_mail['mail_settings']).to eq(footer)
+            expect(client.sent_mail['mail_settings']).to eq(transform_keys(footer, &:to_s))
           end
 
           it 'sets sandbox_mode' do
-            sandbox = {'sandbox_mode' => { 'enable' => true }}
+            sandbox = {sandbox_mode: { enable: true }}
             mail['mail_settings'] = sandbox
             mailer.deliver!(mail)
-            expect(client.sent_mail['mail_settings']).to eq(sandbox)
+            expect(client.sent_mail['mail_settings']).to eq(transform_keys(sandbox, &:to_s))
           end
 
           it 'sets spam_check' do
-            spam_check = {'spam_check' => { 'enable' => true, 'threshold' => 1, 'post_to_url' => 'https://spamcatcher.sendgrid.com'}}
+            spam_check = {spam_check: { enable: true, threshold: 1, post_to_url: 'https://spamcatcher.sendgrid.com'}}
             mail['mail_settings'] = spam_check
             mailer.deliver!(mail)
-            expect(client.sent_mail['mail_settings']).to eq(spam_check)
+            expect(client.sent_mail['mail_settings']).to eq(transform_keys(spam_check, &:to_s))
           end
         end
 
         context 'tracking_settings' do
           it 'sets click_tracking' do
-            tracking = { 'click_tracking' => { 'enable' => false, 'enable_text' => false }}
-            mail['tracking_settings'] = tracking
+            tracking = { click_tracking: { enable: false, enable_text: false }}
+            mail['tracking_settings'] = tracking.dup
             mailer.deliver!(mail)
-            expect(client.sent_mail['tracking_settings']).to eq(tracking)
+            expect(client.sent_mail['tracking_settings']).to eq(transform_keys(tracking, &:to_s))
           end
 
           it 'sets open_tracking' do
-            tracking = { 'open_tracking' => { 'enable' => true, 'substitution_tag' => 'Optional tag to replace with the open image in the body of the message' }}
+            tracking = { open_tracking: { enable: true, substitution_tag: 'Optional tag to replace with the open image in the body of the message' }}
             mail['tracking_settings'] = tracking
             mailer.deliver!(mail)
-            expect(client.sent_mail['tracking_settings']).to eq(tracking)
+            expect(client.sent_mail['tracking_settings']).to eq(transform_keys(tracking, &:to_s))
           end
 
           it 'sets subscription_tracking' do
-            tracking = { 'subscription_tracking' => { 'enable' => true, 'text' => 'text to insert into the text/plain portion of the message', 'html' => 'html to insert into the text/html portion of the message', 'substitution_tag' => 'Optional tag to replace with the open image in the body of the def message' }}
+            tracking = { subscription_tracking: { enable: true, text: 'text to insert into the text/plain portion of the message', html: 'html to insert into the text/html portion of the message', substitution_tag: 'Optional tag to replace with the open image in the body of the def message' }}
             mail['tracking_settings'] = tracking
             mailer.deliver!(mail)
-            expect(client.sent_mail['tracking_settings']).to eq(tracking)
+            expect(client.sent_mail['tracking_settings']).to eq(transform_keys(tracking, &:to_s))
           end
 
           it 'sets ganalytics' do
-            tracking = { 'ganalytics' => {'enable' => true, 'utm_source' => 'some source', 'utm_medium' => 'some medium', 'utm_term' => 'some term', 'utm_content' => 'some content', 'utm_campaign' => 'some campaign' }}
+            tracking = { ganalytics: { enable: true, utm_source: 'some source', utm_medium: 'some medium', utm_term: 'some term', utm_content: 'some content', utm_campaign: 'some campaign' }}
             mail['tracking_settings'] = tracking
             mailer.deliver!(mail)
-            expect(client.sent_mail['tracking_settings']).to eq(tracking)
+            expect(client.sent_mail['tracking_settings']).to eq(transform_keys(tracking, &:to_s))
           end
         end
 
@@ -440,19 +425,26 @@ module SendGridActionMailer
 
           it 'sets dynamic_template_data' do
             mailer.deliver!(mail)
-            expect(client.sent_mail['personalizations'].first['dynamic_template_data']).to eq({'variable_1' => '1', 'variable_2' => '2'})
+            expect(client.sent_mail['personalizations'].first['dynamic_template_data']).to eq(template_data)
           end
 
           it 'does not set unsubscribe substitutions' do
             mailer.deliver!(mail)
             expect(client.sent_mail['personalizations'].first).to_not have_key('substitutions')
           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)
+          context 'containing what looks like hash syntax' do
+            let(:template_data) do
+              { hint: 'Just use => instead of :' }
+            end
+
+            it 'does not change values inside dynamic template data' do
+              mailer.deliver!(mail)
+              expect(
+                client.sent_mail['personalizations'].first['dynamic_template_data']
+              ).to eq(template_data)
+            end
+          end
         end
 
         it 'sets dynamic template data and sandbox_mode' do
@@ -562,6 +554,9 @@ module SendGridActionMailer
           expect(content['filename']).to eq('specs.rb')
           expect(content['type']).to eq('application/x-ruby')
           expect(content['content_id'].class).to eq(String)
+          expect(content['content_id']).to include("@")
+          expect(content['content_id']).not_to include("<")
+          expect(content['content_id']).not_to include(">")
         end
       end
 
@@ -670,20 +665,21 @@ module SendGridActionMailer
         end
 
         context 'with symbols used as keys' do
-          let(:personalizations) do
-            [
-              {
-                to: [
-                  { email: 'john1@example.com', name: 'John 1'}
-                ]
-              }
-            ]
+        let(:personalizations) do
+          [
+            {
+              to: [
+                {email: 'sally1@example.com', name: 'Sally 1'},
+                {email: 'sally2@example.com', name: 'Sally 2'},
+              ]
+            }
+          ]
           end
 
           it 'still works' do
             mailer.deliver!(mail)
             expect(client.sent_mail['personalizations'].length).to eq(1)
-            expected_to = personalizations[0][:to].map { |t| stringify_keys(t) }
+            expected_to = personalizations[0][:to].map { |t| transform_keys(t, &:to_s) }
             expect(client.sent_mail['personalizations'][0]['to']).to eq(expected_to)
           end
         end
@@ -717,7 +713,7 @@ module SendGridActionMailer
               { 'variable_3' => '1', 'variable_4' => '2' }
             end
 
-            before { mail['dynamic_template_data'] = mail_template_data }
+            before { mail['dynamic_template_data'] = mail_template_data.dup }
 
             it 'sets dynamic_template_data where not also provided as a personalization' do
               mailer.deliver!(mail)
@@ -739,9 +735,9 @@ module SendGridActionMailer
           it 'adds that to address as a separate personalization' do
             mailer.deliver!(mail)
             expect(client.sent_mail['personalizations'].length).to eq(3)
-            expect(client.sent_mail['personalizations'][0]['to']).to eq([{"email"=>"test@sendgrid.com"}])
-            expect(client.sent_mail['personalizations'][1]['to']).to eq(personalizations[0]['to'])
-            expect(client.sent_mail['personalizations'][2]['to']).to eq(personalizations[1]['to'])
+            expect(client.sent_mail['personalizations'][0]['to']).to eq(personalizations[0]['to'])
+            expect(client.sent_mail['personalizations'][1]['to']).to eq(personalizations[1]['to'])
+            expect(client.sent_mail['personalizations'][2]['to']).to eq([{"email"=>"test@sendgrid.com"}])
           end
         end
 
@@ -751,9 +747,9 @@ module SendGridActionMailer
           it 'adds that cc address as a separate personalization' do
             mailer.deliver!(mail)
             expect(client.sent_mail['personalizations'].length).to eq(3)
-            expect(client.sent_mail['personalizations'][0]['cc']).to eq([{"email"=>"test@sendgrid.com"}])
-            expect(client.sent_mail['personalizations'][1]['cc']).to eq(personalizations[0]['cc'])
-            expect(client.sent_mail['personalizations'][2]['cc']).to eq(personalizations[1]['cc'])
+            expect(client.sent_mail['personalizations'][0]['cc']).to eq(personalizations[0]['cc'])
+            expect(client.sent_mail['personalizations'][1]['cc']).to eq(personalizations[1]['cc'])
+            expect(client.sent_mail['personalizations'][2]['cc']).to eq([{"email"=>"test@sendgrid.com"}])
           end
         end
 
@@ -763,9 +759,56 @@ module SendGridActionMailer
           it 'adds that bcc address as a separate personalization' do
             mailer.deliver!(mail)
             expect(client.sent_mail['personalizations'].length).to eq(3)
-            expect(client.sent_mail['personalizations'][0]['bcc']).to eq([{"email"=>"test@sendgrid.com"}])
-            expect(client.sent_mail['personalizations'][1]['bcc']).to eq(personalizations[0]['bcc'])
-            expect(client.sent_mail['personalizations'][2]['bcc']).to eq(personalizations[1]['bcc'])
+            expect(client.sent_mail['personalizations'][0]['bcc']).to eq(personalizations[0]['bcc'])
+            expect(client.sent_mail['personalizations'][1]['bcc']).to eq(personalizations[1]['bcc'])
+            expect(client.sent_mail['personalizations'][2]['bcc']).to eq([{"email"=>"test@sendgrid.com"}])
+          end
+        end
+
+        context 'when perform_send_request false' do
+          it 'should not send and email and return json body' do
+            m = DeliveryMethod.new(perform_send_request: false, return_response: true, api_key: 'key')
+            response = m.deliver!(mail)
+            expect(response).to respond_to(:to_json)
+          end
+        end
+
+        context 'when mail_settings are present' do
+          it 'should apply mail_settings to request body' do
+            m = DeliveryMethod.new(api_key: 'key', return_response: true,  mail_settings: { sandbox_mode: {enable: true }})
+            m.deliver!(mail)
+            expect(client.sent_mail['mail_settings']).to eq("sandbox_mode" => {"enable" => true })
+          end
+
+          context 'when mail has mail_settings set' do
+            before { mail['mail_settings'] = { spam_check: { enable: true } } }
+
+            it 'should combine local mail_settings with global settings' do
+              m = DeliveryMethod.new(api_key: 'key', return_response: true,  mail_settings: { sandbox_mode: {enable: true }})
+              m.deliver!(mail)
+              expect(client.sent_mail['mail_settings']).to eq(
+                "sandbox_mode" => {"enable" => true },
+                "spam_check" => {"enable" => true },
+              )
+            end
+          end
+
+          context 'when mail contains the same setting as global settings' do
+            before do
+              mail['mail_settings'] = {
+                sandbox_mode: { enable: false },
+                spam_check: { enable: true }
+              }
+            end
+
+            it 'should apply local mail_settings on top of global settings' do
+              m = DeliveryMethod.new(api_key: 'key', return_response: true,  mail_settings: { sandbox_mode: {enable: true }})
+              m.deliver!(mail)
+              expect(client.sent_mail['mail_settings']).to eq(
+                "sandbox_mode" => {"enable" => false },
+                "spam_check" => {"enable" => true },
+              )
+            end
           end
         end
       end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: sendgrid-actionmailer
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Eddie Zaneski
 - Kristján Pétursson
 - Nick Muerdter
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-23 00:00:00.000000000 Z
+date: 2020-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: sendgrid-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -128,8 +128,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- gemfiles/mail_2.5.gemfile
-- gemfiles/mail_2.6.gemfile
 - gemfiles/mail_2.7.gemfile
 - lib/sendgrid-actionmailer.rb
 - lib/sendgrid_actionmailer.rb
@@ -142,7 +140,7 @@ homepage: https://github.com/eddiezane/sendgrid-actionmailer
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -158,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: SendGrid support for ActionMailer.
 test_files:

data/gemfiles/mail_2.5.gemfile

@@ -1,7 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "mail", "2.5.5"
-
-gemspec :path => "../"

data/gemfiles/mail_2.6.gemfile

@@ -1,7 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "mail", "2.6.6"
-
-gemspec :path => "../"