mandrill_mailer 0.4.13 → 0.5.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YTdmZmQ0MTg2NGUwNmE3NGRiNjQxMTc5MDcyOTBiMDJjMTg5MTY0Yg==
+    Y2VmMGFhYjViZGU1MGI5YTk4NzY3OWNkMzk5N2ZhYzE1ZGY1NWU4OQ==
   data.tar.gz: !binary |-
-    MmNkYjMyZmQxODAzZDhmYmI0Y2YzYWExMGFjYjRhZDYwNzQwNzc4Ng==
+    ZWUwMGI0MjU1ZmExNWY2YmI0NzcyZDM0Yjc1OTY4YmUwYjM4MGZkYw==
 SHA512:
   metadata.gz: !binary |-
-    ZTQ2OGYzMGUxN2Q2N2U2MjJkYWI4ZWYyNjVkNjJiZmU5M2QyNTFjNDUzZjVk
-    YzUwYTgyMmZkMjIxNDkwMTVkM2RjOTllNzRkOGY4ZGI1YzlmYWI5MTgzZTRm
-    NzYwOThlMzI1OGE2OGY5MzJiYTYxNmFlNjQxNjc3ZTVmYTcyMDM=
+    NDhjMzc2Yzk1MGJhZGYzZmE2MTIwNGVlMjBjNDJkYmIzODViN2IzYTZjZjRh
+    MGJjMWVmMWMwMjI3Mzc5YjQwNDBjODExNTVhZTkwMDdiZGIwOTE4Zjc0YTc0
+    ZDc4ODAwMmVjNzFjZWI3MmI3NDhiMDc5YWYyNzg0ZDJiMTlhMTQ=
   data.tar.gz: !binary |-
-    YmQ5OWI4OWE4MWRmMTlkYWZlZWJhZjU2Y2U2YWRmYzYyYTY1OGVjZGUxOGM1
-    NzA5M2M3YTMzZmYzYzc4NGNjZWMzNTlhYmQ1YWI3MzNlMDc5YzFkMGI4Njc4
-    ZGRlOTA0OGZiZjk1YTk4ZTc2MGE3ZTZhMzk2YmNhZGQwMTljMGM=
+    YTI4MTJlNWM1MzdmMTk1NjMwMjM2NzQ1YmRlNmVmMjUxODllYWU2YzIxMTU0
+    NGI0MWE4NGM2NGU0OWY1YmFlNjk5YjVmNjI0MTljNjM4OTc4ZTE0ZDZjZjRl
+    ZDgzY2JhODBkOTI3YjcxZWNjYWE3MjdhYTEzNTU4NTBlMzk5YWY=

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 0.5.0
+- [IMPROVEMENT] Made the file attachment and image apis compatible with mandrill api doc syntax
+
 # 0.4.9
 - [FEATURE] Added offline support for the MandrillMailer::Messenger class. Thanks @arthurtalkgoal
 

data/README.md

@@ -1,6 +1,6 @@
-# Mandrill Mailer 
-[![Gem Version](http://img.shields.io/gem/v/mandrill_mailer.svg)](rubygems.org/gems/mandrill_mailer) 
-[![Code Climate](http://img.shields.io/codeclimate/github/renz45/mandrill_mailer.svg)](https://codeclimate.com/github/renz45/mandrill_mailer) 
+# Mandrill Mailer
+[![Gem Version](http://img.shields.io/gem/v/mandrill_mailer.svg)](rubygems.org/gems/mandrill_mailer)
+[![Code Climate](http://img.shields.io/codeclimate/github/renz45/mandrill_mailer.svg)](https://codeclimate.com/github/renz45/mandrill_mailer)
 [![Dependencies](http://img.shields.io/gemnasium/renz45/mandrill_mailer.svg)](https://gemnasium.com/renz45/mandrill_mailer)
 
 Inherit the MandrillMailer class in your existing Rails mailers to send transactional emails through Mandrill using their template-based emails.
@@ -32,7 +32,7 @@ ActionMailer::Base.smtp_settings = {
     :address   => "smtp.mandrillapp.com",
     :port      => 587,
     :user_name => ENV['MANDRILL_USERNAME'],
-    :password  => ENV['MANDRILL_PASSWORD'],
+    :password  => ENV['MANDRILL_API_KEY'],
     :domain    => 'heroku.com'
   }
 ActionMailer::Base.delivery_method = :smtp
@@ -47,7 +47,7 @@ You don't need to add the ActionMailer stuff unless you're still using ActionMai
 This uses the Mandrill SMTP servers. If you're using template-based emails
 through the Mandrill API you only need the `MandrillMailer.configure` portion.
 
-Do not forget to setup the environment (`ENV`) variables on your server instead 
+Do not forget to setup the environment (`ENV`) variables on your server instead
 of hardcoding your Mandrill username and password in the `mail.rb` initializer.
 
 You will also need to set `default_url_options` for the mailer, similar to ActionMailer
@@ -68,25 +68,30 @@ class InvitationMailer < MandrillMailer::TemplateMailer
     # in this example `invitation.invitees` is an Array
     invitees = invitation.invitees.map { |invitee| { email: invitee.email, name: invitee.name } }
 
-    mandrill_mail template: 'group-invite',
-                  subject: I18n.t('invitation_mailer.invite.subject'),
-                  to: invitees,
-                  # to: invitation.email,
-                  # to: { email: invitation.email, name: 'Honored Guest' },
-                  vars: {
-                    'OWNER_NAME' => invitation.owner_name,
-                    'PROJECT_NAME' => invitation.project_name
-                  },
-                  important: true,
-                  inline_css: true,
-                  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
+    mandrill_mail(
+      template: 'group-invite',
+      subject: I18n.t('invitation_mailer.invite.subject'),
+      to: invitees,
+        # to: invitation.email,
+        # to: { email: invitation.email, name: 'Honored Guest' },
+      vars: {
+        'OWNER_NAME' => invitation.owner_name,
+        'PROJECT_NAME' => invitation.project_name
+      },
+      important: true,
+      inline_css: true,
+      recipient_vars: invitation.invitees.map do |invitee|
+        { invitee.email =>
+          {
+            'INVITEE_NAME' => invitee.name,
+            'INVITATION_URL' => new_invitation_url(
+              invitee.email,
+              secret: invitee.secret_code
+            )
+          }
+        }
+      end
+     )
   end
 end
 ```
@@ -141,14 +146,14 @@ end
    * `:inline_css` - whether or not to automatically inline all CSS styles provided in the message HTML - only for HTML documents less than 256KB in size.
 
    * `:attachments` - An array of file objects with the following keys:
-      * `file:` This is the actual file, it will be converted to byte data in the mailer
-      * `filename:` The name of the file
-      * `mimetype:` This is the mimetype of the file. Ex. png = image/png, pdf = application/pdf, txt = text/plain etc
+     * `content`: The file contents, must be a base64 encoded string
+     * `name`: The name of the file
+     * `type`: This is the mimetype of the file. Ex. png = image/png, pdf = application/pdf, txt = text/plain etc etc
 
    * `:images` - An array of embedded images to add to the message:
-      * `file:` This is the actual file, it will be converted to byte data in the mailer
-      * `filename:` The Content ID of the image - use `<img src="cid:THIS_VALUE">` to reference the image in your HTML content
-      * `mimetype:` The MIME type of the image - must start with "image/"
+     * `content`: The file contents, must be a base64 encoded string
+     * `name`: The name of the file
+     * `type`: This is the mimetype of the file. Ex. png = image/png, pdf = application/pdf, txt = text/plain etc etc etc
 
    * `:async` - Whether or not this message should be sent asynchronously
 
@@ -183,6 +188,13 @@ class InvitationMailer < MandrillMailer::MessageMailer
                   },
                   important: true,
                   inline_css: true,
+                  attachments: [
+                    {
+                      content: Base64.encode64(File.read(File.expand_path('assets/offer.pdf'))),
+                      name: 'offer.pdf',
+                      type: 'application/pdf'
+                    }
+                  ],
                   recipient_vars: invitation.invitees.map do |invitee| # invitation.invitees is an Array
                     { invitee.email =>
                       {

data/lib/mandrill_mailer/core_mailer.rb

@@ -48,7 +48,7 @@
 #         'example@domain.com`
 #       2)
 #         { email: 'someone@email.com', name: 'Bob Bertly' }
-#       3) 
+#       3)
 #         [{ email: 'someone@email.com', name: 'Bob Bertly' },
 #          { email: 'other@email.com', name: 'Claire Nayo' }]
 #
@@ -107,7 +107,7 @@ module MandrillMailer
     class InvalidEmail < StandardError; end
     class InvalidMailerMethod < StandardError; end
     class InvalidInterceptorParams < StandardError; end
-    
+
     # Public: Other information on the message to send
     attr_accessor :message
 
@@ -151,7 +151,7 @@ module MandrillMailer
     # Public: setup a way to test mailer methods
     #
     # mailer_method - Name of the mailer method the test setup is for
-    # 
+    #
     # block - Block of code to execute to perform the test. The mailer
     # and options are passed to the block. The options have to
     # contain at least the :email to send the test to.
@@ -176,7 +176,7 @@ module MandrillMailer
     # Public: Executes a test email
     #
     # mailer_method - Method to execute
-    # 
+    #
     # options - The Hash options used to refine the selection (default: {}):
     #   :email - The email to send the test to.
     #
@@ -197,17 +197,17 @@ module MandrillMailer
       end
 
     end
-    
+
     # Public: Triggers the stored Mandrill params to be sent to the Mandrill api
     def deliver
       mesg = "#{self.class.name}#deliver() is not implemented."
       raise NotImplementedError.new(mesg)
     end
-    
+
     # Public: Build the hash needed to send to the mandrill api
     #
     # args - The Hash options used to refine the selection:
-   
+
     # Examples
     #
     #   mandrill_mail template: 'Group Invite',
@@ -229,7 +229,7 @@ module MandrillMailer
       mesg = "#{self.class.name}#data() is not implemented."
       raise NotImplementedError.new(mesg)
     end
-    
+
     def check_required_options
       mesg = "#{self.class.name}#check_required_options() is not implemented."
       raise NotImplementedError.new(mesg)
@@ -257,22 +257,16 @@ module MandrillMailer
       return unless args
       args.map do |attachment|
         attachment.symbolize_keys!
-        type = attachment[:mimetype]
-        name = attachment[:filename]
-        file = attachment[:file]
+        type = attachment[:mimetype] || attachment[:type]
+        name = attachment[:filename] || attachment[:name]
+        file = attachment[:file] || attachment[:content]
         {"type" => type, "name" => name, "content" => Base64.encode64(file)}
       end
     end
 
     def mandrill_images_args(args)
       return unless args
-      args.map do |attachment|
-        attachment.symbolize_keys!
-        type = attachment[:mimetype]
-        name = attachment[:filename]
-        file = attachment[:file]
-        {"type" => type, "name" => name, "content" => Base64.encode64(file)}
-      end
+      mandrill_attachment_args(args)
     end
 
     # Makes this class act as a singleton without it actually being a singleton
@@ -360,7 +354,5 @@ module MandrillMailer
     def api_key
       MandrillMailer.config.api_key
     end
-    
-    
   end
 end

data/lib/mandrill_mailer/message_mailer.rb

@@ -26,7 +26,7 @@
 #                                       }
 #                                     }
 #                                   end,
-#                   attachments: [{file: File.read(File.expand_path('assets/some_image.png')), filename: 'My Image.png', mimetype: 'image/png'}],
+#                   attachments: [{content: Base64.encode64(File.read(File.expand_path('assets/some_image.png'))), name: 'MyImage.png', type: 'image/png'}],
 #                   important: true,
 #                   inline_css: true
 #   end
@@ -48,7 +48,7 @@
 #         'example@domain.com`
 #       2)
 #         { email: 'someone@email.com', name: 'Bob Bertly' }
-#       3) 
+#       3)
 #         [{ email: 'someone@email.com', name: 'Bob Bertly' },
 #          { email: 'other@email.com', name: 'Claire Nayo' }]
 #
@@ -62,14 +62,14 @@
 #     ex. [{'someone@email.com' => {'INVITEE_NAME' => 'Roger'}}, {'another@email.com' => {'INVITEE_NAME' => 'Tommy'}}]
 
 #   :attachments - An array of file objects with the following keys:
-#       file: This is the actual file, it will be converted to byte data in the mailer
-#       filename: The name of the file
-#       mimetype: This is the mimetype of the file. Ex. png = image/png, pdf = application/pdf, txt = text/plain etc
+#       content: The file contents, must be a base64 encoded string
+#       name: The name of the file
+#       type: This is the mimetype of the file. Ex. png = image/png, pdf = application/pdf, txt = text/plain etc
 
 #   :images - An array of embedded images to add to the message:
-#       file: This is the actual file, it will be converted to byte data in the mailer
-#       filename: The Content ID of the image - use <img src="cid:THIS_VALUE"> to reference the image in your HTML content
-#       mimetype: The MIME type of the image - must start with "image/"
+#       content: The file contents, must be a base64 encoded string
+#       name: The name of the file
+#       type: This is the mimetype of the file. Ex. png = image/png, pdf = application/pdf, txt = text/plain etc
 
 # :headers - Extra headers to add to the message (currently only Reply-To and X-* headers are allowed) {"...": "..."}
 
@@ -109,7 +109,7 @@ module MandrillMailer
       mandrill = Mandrill::API.new(api_key)
       mandrill.messages.send(message, async, ip_pool, send_at)
     end
-    
+
     # Public: Build the hash needed to send to the mandrill api
     #
     # args - The Hash options used to refine the selection:
@@ -151,8 +151,8 @@ module MandrillMailer
 
       # Construct message hash
       self.message = {
-        "text" => args[:text], 
-        "html" => args[:html], 
+        "text" => args[:text],
+        "html" => args[:html],
         "view_content_link" => args[:view_content_link],
         "subject" => args[:subject],
         "from_email" => args[:from] || self.class.defaults[:from],
@@ -177,7 +177,7 @@ module MandrillMailer
         "attachments" => mandrill_attachment_args(args[:attachments]),
         "images" => mandrill_images_args(args[:images])
       }
-      
+
       unless MandrillMailer.config.interceptor_params.nil?
         unless MandrillMailer.config.interceptor_params.is_a?(Hash)
           raise InvalidInterceptorParams.new "The interceptor_params config must be a Hash"

data/lib/mandrill_mailer/template_mailer.rb

@@ -27,7 +27,7 @@
 #                                     }
 #                                   end,
 #                   template_content: {},
-#                   attachments: [{file: File.read(File.expand_path('assets/some_image.png')), filename: 'My Image.png', mimetype: 'image/png'}],
+#                   attachments: [{contents:Base64.encode64(File.read(File.expand_path('assets/some_image.png'))), name: 'MyImage.png', type: 'image/png'}],
 #                   important: true,
 #                   inline_css: true
 #   end
@@ -48,7 +48,7 @@
 #         'example@domain.com`
 #       2)
 #         { email: 'someone@email.com', name: 'Bob Bertly' }
-#       3) 
+#       3)
 #         [{ email: 'someone@email.com', name: 'Bob Bertly' },
 #          { email: 'other@email.com', name: 'Claire Nayo' }]
 #
@@ -67,14 +67,14 @@
 #     these fields by passing a Hash {'header' => 'my email content'}
 
 #   :attachments - An array of file objects with the following keys:
-#       file: This is the actual file, it will be converted to byte data in the mailer
-#       filename: The name of the file
-#       mimetype: This is the mimetype of the file. Ex. png = image/png, pdf = application/pdf, txt = text/plain etc
+#       content: The file contents, must be a base64 encoded string
+#       name: The name of the file
+#       type: This is the mimetype of the file. Ex. png = image/png, pdf = application/pdf, txt = text/plain etc
 
 #   :images - An array of embedded images to add to the message:
-#       file: This is the actual file, it will be converted to byte data in the mailer
-#       filename: The Content ID of the image - use <img src="cid:THIS_VALUE"> to reference the image in your HTML content
-#       mimetype: The MIME type of the image - must start with "image/"
+#       content: The file contents, must be a base64 encoded string
+#       name: The name of the file
+#       type: This is the mimetype of the file. Ex. png = image/png, pdf = application/pdf, txt = text/plain etc
 
 # :headers - Extra headers to add to the message (currently only Reply-To and X-* headers are allowed) {"...": "..."}
 

data/lib/mandrill_mailer/version.rb

@@ -1,3 +1,3 @@
 module MandrillMailer
-  VERSION = "0.4.13"
+  VERSION = "0.5.0"
 end

data/spec/core_mailer_spec.rb

@@ -0,0 +1,67 @@
+require "spec_helper"
+require 'base64'
+
+describe MandrillMailer::CoreMailer do
+  subject(:core_mailer) { described_class }
+
+  let(:file_args) do
+    {
+      mimetype: "some/type",
+      filename: 'test',
+      file: "testing some test test file"
+    }
+  end
+
+  let(:api_args) do
+    {
+      type: "some/type",
+      name: 'test',
+      content: "testing some test test file"
+    }
+  end
+
+
+  describe 'protected#mandrill_attachment_args' do
+    context "with file syntax" do
+      it "formats the correct attachment data" do
+        expect(core_mailer.new.send(:mandrill_attachment_args, [file_args])).to eq([{
+          'type' => "some/type",
+          'name' => 'test',
+          'content' => Base64.encode64("testing some test test file")
+        }])
+      end
+    end
+
+    context "with api syntax" do
+      it "formats the correct attachment data" do
+        expect(core_mailer.new.send(:mandrill_attachment_args, [api_args])).to eq([{
+          'type' => "some/type",
+          'name' => 'test',
+          'content' => Base64.encode64("testing some test test file")
+        }])
+      end
+    end
+  end
+
+  describe '#mandrill_images_args' do
+    context "with file syntax" do
+      it "formats the correct attachment data" do
+        expect(core_mailer.new.send(:mandrill_attachment_args, [file_args])).to eq([{
+          'type' => "some/type",
+          'name' => 'test',
+          'content' => Base64.encode64("testing some test test file")
+        }])
+      end
+    end
+
+    context "with api syntax" do
+      it "formats the correct attachment data" do
+        expect(core_mailer.new.send(:mandrill_attachment_args, [api_args])).to eq([{
+          'type' => "some/type",
+          'name' => 'test',
+          'content' => Base64.encode64("testing some test test file")
+        }])
+      end
+    end
+  end
+end

data/spec/template_mailer_spec.rb

@@ -58,8 +58,8 @@ describe MandrillMailer::TemplateMailer do
       url_strip_qs: false
     }
   end
-  
-  
+
+
   let(:message_args) do
     {
       text: "Example text content",
@@ -97,7 +97,7 @@ describe MandrillMailer::TemplateMailer do
     MandrillMailer.config.default_url_options = { host: default_host }
     #MandrillMailer.config.stub(:image_path).and_return(image_path)
     allow(MandrillMailer.config).to receive(:image_path).and_return(image_path)
-    
+
     MandrillMailer::TemplateMailer.default from: from_email, from_name: from_name
   end
 
@@ -215,7 +215,7 @@ describe MandrillMailer::TemplateMailer do
       expect(subject.template_name).to eq 'Email Template'
     end
 
-    
+
     it 'should set the template content' do
       expect(subject.template_content).to eq [{'name' => template_content_name, 'content' => template_content_content}]
     end
@@ -252,6 +252,7 @@ describe MandrillMailer::TemplateMailer do
           "url_strip_qs" => args[:url_strip_qs],
           "preserve_recipients" => false,
           "bcc_address" => args[:bcc],
+          "merge_language" => args[:merge_language],
           "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],
@@ -299,6 +300,7 @@ describe MandrillMailer::TemplateMailer do
           "url_strip_qs" => args[:url_strip_qs],
           "preserve_recipients" => false,
           "bcc_address" => @intercepted_params[:bcc_address],
+          "merge_language" => args[:merge_language],
           "global_merge_vars" => [{"name" => var_name, "content" => var_content}],
           "merge_vars" => [{"rcpt" => to_email, "vars" => [{"name" => var_rcpt_name, "content" => var_rcpt_content}]}],
           "tags" => @intercepted_params[:tags],
@@ -313,7 +315,7 @@ describe MandrillMailer::TemplateMailer do
     end
   end
 
-    
+
   describe 'url helpers in mailer' do
     subject { mailer.send(:course_url) }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mandrill_mailer
 version: !ruby/object:Gem::Version
-  version: 0.4.13
+  version: 0.5.0
 platform: ruby
 authors:
 - Adam Rensel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-12 00:00:00.000000000 Z
+date: 2014-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -101,6 +101,7 @@ files:
 - lib/mandrill_mailer/template_mailer.rb
 - lib/mandrill_mailer/version.rb
 - mandrill_mailer.gemspec
+- spec/core_mailer_spec.rb
 - spec/fake_rails/fake_rails.rb
 - spec/message_mailer_spec.rb
 - spec/spec_helper.rb
@@ -131,6 +132,7 @@ signing_key:
 specification_version: 4
 summary: Transactional Mailer for Mandrill
 test_files:
+- spec/core_mailer_spec.rb
 - spec/fake_rails/fake_rails.rb
 - spec/message_mailer_spec.rb
 - spec/spec_helper.rb