sendgrid-actionmailer 2.4.2 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94259db52788333029d0c8fc9160c054a0e0bef5fc40b0ff4a2f825c9a337e54
-  data.tar.gz: eee118a0ebb96bf3c098f6c5ec7a28ec832c2b116b4060d7ef25df18ef36d063
+  metadata.gz: 776fb071876f8748d9d6ab2ae7d304b18d60023afb9e6747aa9b2e5c11757dbb
+  data.tar.gz: 2ac9f378ca1372c581f10d24d1861a6b6b7fe3cbaddd9c5b6fc53f3d4f441ec8
 SHA512:
-  metadata.gz: 1cb7d6f1972707fa631f27512ab36cc219373ca36725b666d05dab7ea128d270f8454cb30d45b0bc4b7d2f0460ca1ae380a2af3410c585d919461b0994d51cf1
-  data.tar.gz: f2852025eecc5f5087a7e8b41df7cae42f93b4978acf3fb4c8a613f2a3f30eefa83b300affc72234b3f398505bab759a977473ee71a4cc8766c4eb27a3762263
+  metadata.gz: fb8c6ed35b214301a578d48b6d241c0a85366ff33767283da5e8d09c33210d960b62477c0de1df8397f144d0e70a95e83ea73c473502a7aa0ed8e949babe1ba7
+  data.tar.gz: 3830c481b115beffd21d53a4140d3a1d6de73ff4fe2952cbdafb63b3133b663a464d0075def2934b61112ab5a791d5c31796a86f1d2eeb25deb54ea3af3a1fdb

data/.travis.yml

@@ -9,6 +9,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,54 @@
 # Change Log
 
+## 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

@@ -31,11 +31,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 +87,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 +106,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 +114,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 +128,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 +136,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 +150,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 +161,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 +175,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 +192,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,20 +215,56 @@ 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' })```
+
+### personalizations (json)
+
+Allows providing a customized [personalizations](https://sendgrid.com/docs/for-developers/sending-email/personalizations/) array for the v3 Mail Send endpoint. This allows customizing how an email is sent and also allows sending multiple different emails to different recipients with a single API call.
+
+The personalizations object supports:
+
+- "to", "cc", "bcc" - The recipients of your email.
+- "subject" - The subject of your email.
+- "headers" - Any headers you would like to include in your email.
+- "substitutions" - Any substitutions you would like to be made for your email.
+- "custom_args" - Any custom arguments you would like to include in your email.
+- "send_at" - A specific time that you would like your email to be sent.
+- "dynamic_template_data" - data for dynamic templates.
+
+The following should be noted about these personalization attributes:
+- to, cc, or bcc: if either to, cc, or bcc is also set when calling mail, those addresses provided to mail will be inserted as a separate personalization from the ones you provide. However, when using personalizations, you are not required to specify `to` when calling the mail function.
+- dynamic_template_data specified in the mail function will be merged with any dynamic_template_data specified in the personalizations object (with the personalizations object keys having priority).
+- Other fields set in the personalizations object will override any global parameters defined outside of personalizations.
+
+Also note that substitutions will not work with dynamic templates.
 
-```mail(to: 'example@email.com', subject: 'email subject', body: 'email body',  dynamic_template_data:{ variable_1: 'foo', variable_2: 'bar'})```
+Example usage:
+
+```
+mail(subject: 'default subject', 'email body', personalizations: [
+  { 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)
 
@@ -24,18 +25,20 @@ module SendGridActionMailer
         m.from = to_email(mail.from)
         m.reply_to = to_email(mail.reply_to)
         m.subject = mail.subject || ""
-        # https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/personalizations.html
-        m.add_personalization(to_personalizations(mail))
       end
 
+      add_personalizations(sendgrid_mail, mail)
       add_api_key(sendgrid_mail, mail)
       add_content(sendgrid_mail, mail)
       add_send_options(sendgrid_mail, mail)
       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
@@ -75,20 +78,51 @@ module SendGridActionMailer
       end
     end
 
-    def to_personalizations(mail)
-      Personalization.new.tap do |p|
-        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) }
+    def setup_personalization(mail, personalization_hash)
+      personalization = Personalization.new
+
+      personalization_hash =  self.class.transform_keys(personalization_hash, &:to_s)
+
+      (personalization_hash['to'] || []).each do |to|
+        personalization.add_to Email.new(email: to['email'], name: to['name'])
+      end
+      (personalization_hash['cc'] || []).each do |cc|
+        personalization.add_cc Email.new(email: cc['email'], name: cc['name'])
+      end
+      (personalization_hash['bcc'] || []).each do |bcc|
+        personalization.add_bcc Email.new(email: bcc['email'], name: bcc['name'])
+      end
+      (personalization_hash['headers'] || []).each do |header_key, header_value|
+        personalization.add_header Header.new(key: header_key, value: header_value)
+      end
+      (personalization_hash['substitutions'] || {}).each do |sub_key, sub_value|
+        personalization.add_substitution(Substitution.new(key: sub_key, value: sub_value))
+      end
+      (personalization_hash['custom_args'] || {}).each do |arg_key, arg_value|
+        personalization.add_custom_arg(CustomArg.new(key: arg_key, value: arg_value))
+      end
+      if personalization_hash['send_at']
+        personalization.send_at = personalization_hash['send_at']
+      end
+      if personalization_hash['subject']
+        personalization.subject = personalization_hash['subject']
+      end
 
+      if mail['dynamic_template_data'] || personalization_hash['dynamic_template_data']
         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%>"))
+          data = mail['dynamic_template_data'].unparsed_value
+          data.merge!(personalization_hash['dynamic_template_data'] || {})
+        else
+          data = personalization_hash['dynamic_template_data']
         end
+        personalization.add_dynamic_template_data(data)
+      elsif mail['template_id'].nil?
+        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
+
+      return personalization
     end
 
     def to_attachment(part)
@@ -115,28 +149,49 @@ 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
+
+    def add_attachments(sendgrid_mail, mail)
+      mail.attachments.each do |part|
+        sendgrid_mail.add_attachment(to_attachment(part))
       end
     end
 
     def add_content(sendgrid_mail, mail)
-      case mail.mime_type
-      when 'text/plain'
-        sendgrid_mail.add_content(to_content(:plain, mail.body.decoded))
-      when 'text/html'
-        sendgrid_mail.add_content(to_content(:html, mail.body.decoded))
-      when 'multipart/alternative', 'multipart/mixed', 'multipart/related'
-        sendgrid_mail.add_content(to_content(:plain, mail.text_part.decoded)) if mail.text_part
-        sendgrid_mail.add_content(to_content(:html, mail.html_part.decoded)) if mail.html_part
-
-        mail.attachments.each do |part|
-          sendgrid_mail.add_attachment(to_attachment(part))
+      if mail['template_id']
+        # We are sending a template, so we don't need to add any content outside
+        # of attachments
+        add_attachments(sendgrid_mail, mail)
+      else
+        case mail.mime_type
+        when 'text/plain'
+          sendgrid_mail.add_content(to_content(:plain, mail.body.decoded))
+        when 'text/html'
+          sendgrid_mail.add_content(to_content(:html, mail.body.decoded))
+        when 'multipart/alternative', 'multipart/mixed', 'multipart/related'
+          sendgrid_mail.add_content(to_content(:plain, mail.text_part.decoded)) if mail.text_part
+          sendgrid_mail.add_content(to_content(:html, mail.html_part.decoded)) if mail.html_part
+
+          add_attachments(sendgrid_mail, mail)
         end
       end
     end
 
-    def json_parse(text, symbolize=true)
-      JSON.parse(text.empty? ? '{}' : text.gsub(/:*\"*([\%a-zA-Z0-9_-]*)\"*(( *)=>\ *)/) { "\"#{$1}\":" }, symbolize_names: symbolize)
+    def add_personalizations(sendgrid_mail, mail)
+      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.any?) || (mail.cc && mail.cc.any?) || (mail.bcc && mail.bcc.any?)
+        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
     end
 
     def add_send_options(sendgrid_mail, mail)
@@ -144,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
@@ -159,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
@@ -170,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']
@@ -183,7 +239,7 @@ module SendGridActionMailer
 
     def add_mail_settings(sendgrid_mail, mail)
       if mail['mail_settings']
-        settings = json_parse(mail['mail_settings'].value)
+        settings = mail['mail_settings'].unparsed_value || {}
         sendgrid_mail.mail_settings = MailSettings.new.tap do |m|
           if settings[:bcc]
             m.bcc = BccSettings.new(settings[:bcc])
@@ -206,7 +262,7 @@ 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])
@@ -228,7 +284,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)
@@ -236,5 +292,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.4.2'.freeze
+  VERSION = '3.0.2'.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,6 +3,10 @@ require 'webmock/rspec'
 
 module SendGridActionMailer
   describe DeliveryMethod do
+    def transform_keys(object, &block)
+      SendGridActionMailer::DeliveryMethod.transform_keys(object, &block)
+    end
+
     subject(:mailer) do
       DeliveryMethod.new(api_key: 'key')
     end
@@ -55,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
@@ -242,13 +251,51 @@ module SendGridActionMailer
         ])
       end
 
-      context 'send options' do
-        it 'sets a template_id' do
+      context 'template_id' do
+        before do
           mail['template_id'] = '1'
+        end
+
+        it 'sets a template_id' do
           mailer.deliver!(mail)
           expect(client.sent_mail['template_id']).to eq('1')
         end
 
+        it 'does not set unsubscribe substitutions' do
+          mailer.deliver!(mail)
+          expect(client.sent_mail['personalizations'].first).to_not have_key('substitutions')
+        end
+
+        it 'does not set send a content type' do
+          mailer.deliver!(mail)
+          expect(client.sent_mail['content']).to eq(nil)
+        end
+
+        it 'does not set send a content type even if body is given' do
+          # This matches the default behavior of ActionMail. body must be
+          # specified and content_type defaults to text/plain.
+          mail.body = 'I heard you like pineapple.'
+          mail.content_type = 'text/plain'
+          mailer.deliver!(mail)
+          expect(client.sent_mail['content']).to eq(nil)
+        end
+      end
+
+      context 'without dynamic template data or a template id' do
+        it 'sets unsubscribe substitutions' do
+          mailer.deliver!(mail)
+          expect(client.sent_mail['personalizations'].first).to have_key('substitutions')
+          substitutions = client.sent_mail['personalizations'].first['substitutions']
+          expect(substitutions).to eq({
+            '%asm_group_unsubscribe_raw_url%' => '<%asm_group_unsubscribe_raw_url%>',
+            '%asm_global_unsubscribe_raw_url%' => '<%asm_global_unsubscribe_raw_url%>',
+            '%asm_preferences_raw_url%' => '<%asm_preferences_raw_url%>'
+          })
+        end
+      end
+
+      context 'send options' do
+
         it 'sets sections' do
           mail['sections'] = {'%foo%' => 'bar'}
           mailer.deliver!(mail)
@@ -283,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
@@ -295,109 +342,109 @@ 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
 
         context 'dynamic template data' do
+          let(:template_data) do
+            { variable_1: '1', variable_2: '2' }
+          end
+          
+          before { mail['dynamic_template_data'] = template_data }
+
           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)
+          it 'does not set unsubscribe substitutions' do
+            mailer.deliver!(mail)
+            expect(client.sent_mail['personalizations'].first).to_not have_key('substitutions')
+          end
+
+          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
@@ -509,6 +556,220 @@ module SendGridActionMailer
           expect(content['content_id'].class).to eq(String)
         end
       end
+
+      context 'with personalizations' do
+        let(:personalizations) do
+          [
+            {
+              'to' => [
+                {'email' => 'john1@example.com', 'name' => 'John 1'},
+                {'email' => 'john2@example.com', 'name' =>  'John 2'},
+              ]
+            },
+            {
+              'to' => [
+                {'email' => 'john3@example.com', 'name' => 'John 3'},
+                {'email' => 'john4@example.com'}
+              ],
+              'cc' => [
+                {'email' => 'cc@example.com'}
+              ],
+              'bcc' => [
+                {'email' => 'bcc@example.com'}
+              ],
+              'substitutions' => {
+                '%fname%' => 'Bob'
+              },
+              'subject' => 'personalized subject',
+              'send_at' => 1443636843,
+              'custom_args' => {
+                'user_id' => '343'
+              },
+              'headers' => {
+                'X-Test' => true
+              }
+            }
+          ]
+        end
+
+        before do
+          mail.to = nil
+          mail.cc = nil
+          mail.bcc = nil
+          mail['personalizations'] = personalizations
+        end
+
+        it 'sets the provided to address personalizations' do
+          mailer.deliver!(mail)
+          expect(client.sent_mail['personalizations'].length).to eq(2)
+          expect(client.sent_mail['personalizations'][0]['to']).to eq(personalizations[0]['to'])
+          expect(client.sent_mail['personalizations'][1]['to']).to eq(personalizations[1]['to'])
+        end
+
+        it 'sets the provided cc address personalizations' do
+          mailer.deliver!(mail)
+          expect(client.sent_mail['personalizations'][0]).to_not have_key('cc')
+          expect(client.sent_mail['personalizations'][1]['cc']).to eq(personalizations[1]['cc'])
+        end
+
+        it 'sets the provided bcc address personalizations' do
+          mailer.deliver!(mail)
+          expect(client.sent_mail['personalizations'][0]).to_not have_key('bcc')
+          expect(client.sent_mail['personalizations'][1]['bcc']).to eq(personalizations[1]['bcc'])
+        end
+
+        it 'sets the provided subject personalizations' do
+          mailer.deliver!(mail)
+          expect(client.sent_mail['personalizations'][0]).to_not have_key('subject')
+          expect(client.sent_mail['personalizations'][1]['subject']).to eq(personalizations[1]['subject'])
+        end
+
+        it 'sets the provided headers personalizations' do
+          mailer.deliver!(mail)
+          expect(client.sent_mail['personalizations'][0]).to_not have_key('headers')
+          expect(client.sent_mail['personalizations'][1]['headers']).to eq(personalizations[1]['headers'])
+        end
+
+        it 'sets the provided custom_arg personalizations' do
+          mailer.deliver!(mail)
+          expect(client.sent_mail['personalizations'][0]).to_not have_key('custom_args')
+          expect(client.sent_mail['personalizations'][1]['custom_args']).to eq(personalizations[1]['custom_args'])
+        end
+
+        it 'sets the provided send_at personalizations' do
+          mailer.deliver!(mail)
+          expect(client.sent_mail['personalizations'][0]).to_not have_key('send_at')
+          expect(client.sent_mail['personalizations'][1]['send_at']).to eq(personalizations[1]['send_at'])
+        end
+
+        it 'sets the provided substitution personalizations' do
+          mailer.deliver!(mail)
+          expect(client.sent_mail['personalizations'][1]['substitutions']).to include(personalizations[1]['substitutions'])
+        end
+
+        it 'adds to the unsubscribe link substitutions' do
+          mailer.deliver!(mail)
+          expect(client.sent_mail['personalizations'][0]['substitutions']).to eq({
+            '%asm_group_unsubscribe_raw_url%' => '<%asm_group_unsubscribe_raw_url%>',
+            '%asm_global_unsubscribe_raw_url%' => '<%asm_global_unsubscribe_raw_url%>',
+            '%asm_preferences_raw_url%' => '<%asm_preferences_raw_url%>'
+          })
+          expect(client.sent_mail['personalizations'][1]['substitutions']).to include({
+            '%asm_group_unsubscribe_raw_url%' => '<%asm_group_unsubscribe_raw_url%>',
+            '%asm_global_unsubscribe_raw_url%' => '<%asm_global_unsubscribe_raw_url%>',
+            '%asm_preferences_raw_url%' => '<%asm_preferences_raw_url%>'
+          })
+        end
+
+        context 'with symbols used as keys' do
+        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| transform_keys(t, &:to_s) }
+            expect(client.sent_mail['personalizations'][0]['to']).to eq(expected_to)
+          end
+        end
+
+        context 'dynamic template data passed into a personalizaiton' do
+          let(:personalization_data) do
+            {
+              'variable_1' => '1', 'variable_2' => '2'
+            }
+          end
+
+          let(:personalizations_with_dynamic_data) do
+            personalizations.tap do |p|
+              p[1]['dynamic_template_data'] = personalization_data
+            end
+          end
+
+          before do
+            mail['personalizations'] = nil
+            mail['personalizations'] = personalizations_with_dynamic_data
+          end
+
+          it 'sets the provided dynamic template data personalizations' do
+            mailer.deliver!(mail)
+            expect(client.sent_mail['personalizations'][0]).to_not have_key('dynamic_template_data')
+            expect(client.sent_mail['personalizations'][1]['dynamic_template_data']).to eq(personalization_data)
+          end
+
+          context 'dynamic template data is also set on the mail object' do
+            let(:mail_template_data) do
+              { 'variable_3' => '1', 'variable_4' => '2' }
+            end
+
+            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)
+              expect(client.sent_mail['personalizations'][0]['dynamic_template_data']).to eq(mail_template_data)
+            end
+
+            it 'merges the template data with a personalizations dynamic data' do
+              mailer.deliver!(mail)
+              expect(client.sent_mail['personalizations'][1]['dynamic_template_data']).to eq(
+                mail_template_data.merge(personalization_data)
+              )
+            end
+          end
+        end
+
+        context 'when to is set on mail object' do
+          before { mail.to = 'test@sendgrid.com' }
+
+          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(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
+
+        context 'when cc is set on mail object' do
+          before { mail.cc = 'test@sendgrid.com' }
+
+          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(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
+
+        context 'when bcc is set on mail object' do
+          before { mail.bcc = 'test@sendgrid.com' }
+
+          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(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
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sendgrid-actionmailer
 version: !ruby/object:Gem::Version
-  version: 2.4.2
+  version: 3.0.2
 platform: ruby
 authors:
 - Eddie Zaneski
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-21 00:00:00.000000000 Z
+date: 2020-04-20 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

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 => "../"