mandrill_mailer 0.3.2 → 0.3.3

data/README.md

@@ -42,11 +42,20 @@ Creating a new Mandrill Mailer is similar to a normal Rails mailer:
    def invite(invitation)
      mandrill_mail template: 'Group Invite',
        subject: I18n.t('invitation_mailer.invite.subject'),
-       to: {email: invitation.email, name: 'Honored Guest'},
+       to: invitation.invitees.map {|invitee| { email: invitee.email, name: invitee.name }},
+       # to: {email: invitation.email, name: 'Honored Guest'},
        vars: {
          'OWNER_NAME' => invitation.owner_name,
-         'INVITATION_URL' => new_invitation_url(email: invitation.email, secret: invitation.secret)
-       }
+         'PROJECT_NAME' => invitation.project_name
+       },
+       recipient_vars: invitation.invitees.map do |invitee| # invitation.invitees is an Array                  ,
+                         { invitee.email =>
+                           {
+                             'INVITEE_NAME' => invitee.name,
+                             'INVITATION_URL' => new_invitation_url(invitee.email, secret: invitee.secret_code)
+                           }
+                         }
+                       end
    end
  end
  ```
@@ -67,6 +76,10 @@ Creating a new Mandrill Mailer is similar to a normal Rails mailer:
      email by wrapping them in `*||*` vars: {'OWNER_NAME' => 'Suzy'} is used
      by doing: `*|OWNER_NAME|*` in the email template within Mandrill
 
+   * `:recipient_vars` - Similar to `:vars`, this is a Hash of merge tags specific to a particular recipient.
+     Use this if you are sending batch transactions and hence need to send multiple emails at one go.
+     ex. `[{'someone@email.com' => {'INVITEE_NAME' => 'Roger'}}, {'another@email.com' => {'INVITEE_NAME' => 'Tommy'}}]`
+
    * `:template_content` - A Hash of values and content for Mandrill editable content blocks.
      In MailChimp templates there are editable regions with 'mc:edit' attributes that look
      a little like: `<div mc:edit="header">My email content</div>` You can insert content directly into

data/lib/mandrill_mailer/template_mailer.rb

@@ -9,11 +9,20 @@
 #   def invite(invitation)
 #     mandrill_mail template: 'Group Invite',
 #                   subject: I18n.t('invitation_mailer.invite.subject'),
-#                   to: {email: invitation.email, name: 'user level 1'},
+#                   to: invitation.invitees.map {|invitee| { email: invitee.email, name: invitee.name }},
+#                   # to: { email: invitation.email, name: invitation.recipient_name }
 #                   vars: {
 #                     'OWNER_NAME' => invitation.owner_name,
-#                     'INVITATION_URL' => new_invitation_url(email: invitation.email, secret: invitation.secret)
+#                     'PROJECT_NAME' => invitation.project_name
 #                   },
+#                   recipient_vars: invitation.invitees.map do |invitee| # invitation.invitees is an Array
+#                                     { invitee.email =>
+#                                       {
+#                                         'INVITEE_NAME' => invitee.name,
+#                                         'INVITATION_URL' => new_invitation_url(invitee.email, secret: invitee.secret_code)
+#                                       }
+#                                     }
+#                                   end,
 #                   template_content: {}
 #   end
 # end
@@ -32,6 +41,10 @@
 #   :vars - A Hash of merge tags made available to the email. Use them in the
 #     email by wrapping them in '*||*' vars: {'OWNER_NAME' => 'Suzy'} is used
 #     by doing: *|OWNER_NAME|* in the email template within Mandrill
+#
+#   :recipient_vars - Similar to :vars, this is a Hash of merge tags specific to a particular recipient.
+#     Use this if you are sending batch transactions and hence need to send multiple emails at one go.
+#     ex. [{'someone@email.com' => {'INVITEE_NAME' => 'Roger'}}, {'another@email.com' => {'INVITEE_NAME' => 'Tommy'}}]
 
 #   :template_content - A Hash of values and content for Mandrill editable content blocks.
 #     In MailChimp templates there are editable regions with 'mc:edit' attributes that look
@@ -163,7 +176,8 @@ module MandrillMailer
     #             :template - Template name in Mandrill
     #             :subject - Subject of the email
     #             :to - Email to send the mandrill email to
-    #             :vars - Merge vars used in the email for dynamic data
+    #             :vars - Global merge vars used in the email for dynamic data
+    #             :recipient_vars - Merge vars used in the email for recipient-specific dynamic data
     #             :bcc - bcc email for the mandrill email
     #             :tags - Tags for the email
     #             :google_analytics_domains - Google analytics domains
@@ -188,6 +202,9 @@ module MandrillMailer
       # format the :to param to what Mandrill expects if a string or array is passed
       args[:to] = format_to_params(args[:to])
 
+      # if not provided (nil), set to true (Mandrill default). Otherwise, set to either true or false
+      args[:preserve_recipients] = args[:preserve_recipients].nil? ? true : format_boolean(args[:preserve_recipients])
+
       # Set the template name
       self.template_name = args.delete(:template)
 
@@ -205,15 +222,10 @@ module MandrillMailer
         "track_clicks" => true,
         "auto_text" => true,
         "url_strip_qs" => true,
+        "preserve_recipients" => args[:preserve_recipients],
         "bcc_address" => args[:bcc],
         "global_merge_vars" => mandrill_args(args[:vars]),
-        # "merge_vars" =>[
-        #   {
-        #     "rcpt" => "email@email.com"
-        #     "vars" => {"name" => "VARS", "content" => "vars content"}
-        #   }
-        # ]
-
+        "merge_vars" => mandrill_rcpt_args(args[:recipient_vars]),
         "tags" => args[:tags],
         "google_analytics_domains" => args[:google_analytics_domains],
         "google_analytics_campaign" => args[:google_analytics_campaign]
@@ -285,11 +297,25 @@ module MandrillMailer
 
     # convert a normal hash into the format mandrill needs
     def mandrill_args(args)
+      return [] unless args
       args.map do |k,v|
         {'name' => k, 'content' => v}
       end
     end
 
+    def mandrill_rcpt_args(args)
+      return [] unless args
+      args.map do |item|
+        rcpt = item.keys[0]
+        {'rcpt' => rcpt, 'vars' => mandrill_args(item.fetch(rcpt))}
+      end
+    end
+
+    # ensure only true or false is returned given arg
+    def format_boolean(arg)
+      arg ? true : false
+    end
+
     # handle if to params is an array of either hashes or strings or the single string
     def format_to_params(to_params)
       if to_params.kind_of? Array

data/lib/mandrill_mailer/version.rb

@@ -1,3 +1,3 @@
 module MandrillMailer
-  VERSION = "0.3.2"
+  VERSION = "0.3.3"
 end

data/spec/template_mailer_spec.rb

@@ -55,6 +55,28 @@ describe MandrillMailer::TemplateMailer do
     end
   end
 
+  describe '#mandrill_rcpt_args' do
+    let(:rcpt) { 'email@email.com' }
+    let(:arg_name) { 'USER_NAME' }
+    let(:arg_value) { 'bob' }
+
+    subject { mailer.send(:mandrill_rcpt_args, [{rcpt => {arg_name => arg_value}}]) }
+
+    it 'should convert the args to the merge_vars format' do
+      should eq [{'rcpt' => rcpt, 'vars' => [{'name' => arg_name, 'content' => arg_value}]}]
+    end
+  end
+
+  describe '#format_boolean' do
+    it 'only returns true or false' do
+      mailer.send(:format_boolean, 1).should eq true
+      mailer.send(:format_boolean, '1').should eq true
+      mailer.send(:format_boolean, nil).should eq false
+      mailer.send(:format_boolean, false).should eq false
+      mailer.send(:format_boolean, true).should eq true
+    end
+  end
+
   describe '#format_to_params' do
     let(:email) { 'bob@email.com' }
     let(:name) { 'bob' }
@@ -99,6 +121,8 @@ describe MandrillMailer::TemplateMailer do
     let(:from_name) { 'Example Name' }
     let(:var_name) { 'USER_NAME' }
     let(:var_content) { 'bobert' }
+    let(:var_rcpt_name) { 'USER_INFO' }
+    let(:var_rcpt_content) { 'boboblacksheep' }
     let(:to_email) { 'bob@email.com' }
     let(:to_name) { 'bob' }
 
@@ -107,9 +131,13 @@ describe MandrillMailer::TemplateMailer do
         template: 'Email Template',
         subject: "super secret",
         to: {'email' => to_email, 'name' => to_name},
+        preserve_recipients: false,
         vars: {
           var_name => var_content
         },
+        recipient_vars: [
+          { to_email => { var_rcpt_name => var_rcpt_content } }
+        ],
         template_content: {template_content_name => template_content_content},
         headers: {"Reply-To" => "support@email.com"},
         bcc: 'email@email.com',
@@ -148,8 +176,10 @@ describe MandrillMailer::TemplateMailer do
         "track_clicks" => true,
         "auto_text" => true,
         "url_strip_qs" => true,
+        "preserve_recipients" => false,
         "bcc_address" => args[:bcc],
         "global_merge_vars" => [{"name" => var_name, "content" => var_content}],
+        "merge_vars" => [{"rcpt" => to_email, "vars" => [{"name" => var_rcpt_name, "content" => var_rcpt_content}]}],
         "tags" => args[:tags],
         "google_analytics_domains" => args[:google_analytics_domains],
         "google_analytics_campaign" => args[:google_analytics_campaign]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mandrill_mailer
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-14 00:00:00.000000000 Z
+date: 2013-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -139,4 +139,3 @@ test_files:
 - spec/fake_rails/fake_rails.rb
 - spec/spec_helper.rb
 - spec/template_mailer_spec.rb
-has_rdoc: