mandrill_mailer 0.6.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 81c35ce2aca84771388aeec2c4cfc8e0d4fc5e9c
-  data.tar.gz: b47daef7aff42fe20029c753316387978ec31fb2
+  metadata.gz: 050aa30e1863a63c0e023050c83d720fdf952805
+  data.tar.gz: f2179df6cf50a863c5b70096a8cadbf77ea40dc8
 SHA512:
-  metadata.gz: 2b5f64d9a1ae5961b0e1b9a20fa34ce86d4176d30c71c42468858a40651b34a2863547be480dde19fcd0e37ae23705c6d5796ddfe4ce11a44b9f13db528e61f1
-  data.tar.gz: beec2745dfe5b470e48ae3d96ca8d7ace01a41b2b854317e17ea0bf6ad1b6da50262b927ec51f103a1ac806286b83c4f33a9e18feb2fd1b3182042c2f9ce0286
+  metadata.gz: 5ccb28b3e20348666f2fe2ba80565a24ce06e2550013de771ab7ac7a03a9d69ef7e4773bef4aa5bbef72f93c764494cbc456e428d8c2b0eb0b881f65f52bd6d7
+  data.tar.gz: 31deabd8cace6c79cffe3f8004a3ffcb8e865bac0d71a0361da230790dcd7bae607c060c4ae63cf219c491e5422f7b0dbb476ba149ec5bcfa2a44d9a7229070f

data/CHANGELOG.md

@@ -2,7 +2,10 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## [Unreleased][unreleased]
+## 1.0.0
+- Update manrill_api gem to 1.0.X
+- Change how interceptors work to be more flexible and not overwrite data if needed
+- Make both the template and message mailers compatible with all available attributes in the messages api
 
 ## 0.6.1
 ### Fixed

data/README.md

@@ -331,11 +331,21 @@ More info: https://github.com/mperham/sidekiq/wiki/Delayed-Extensions#actionmail
 
 ## Using an interceptor
 You can set a mailer interceptor to override any params used when you deliver an e-mail.
+The interceptor is a Proc object that gets called with the mail object being sent
+to the api.
 
-Example:
+Example that adds multiple bcc recipients:
 
 ```ruby
 MandrillMailer.configure do |config|
-  config.interceptor_params = { to: [{ email: "emailtothatwillbeusedinall@emailssent.com", name: "name" }] }
+  config.interceptor = Proc.new {|params|
+
+    params[:to] =  [
+                     params[:to],
+                     { email: "bccEmailThatWillBeUsedInAll@emailsSent1.com", name: "name", type: "bcc" },
+                     { email: "bccEmailThatWillBeUsedInAll@emailsSent2.com", name: "name", type: "bcc" },
+                     { email: "bccEmailThatWillBeUsedInAll@emailsSent3.com", name: "name", type: "bcc" }
+                   ].flatten
+  }
 end
 ```

data/lib/mandrill_mailer/arg_formatter.rb

@@ -0,0 +1,119 @@
+require 'base64'
+
+module MandrillMailer
+  class ArgFormatter
+    ACCEPTED_MERGE_LANGUAGES = ['mailchimp', 'handlebars'].freeze
+
+    def self.attachment_args(args)
+      return unless args
+      args.map do |attachment|
+        attachment.symbolize_keys!
+        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 self.images_args(args)
+      return unless args
+      attachment_args(args)
+    end
+
+    # convert a normal hash into the format mandrill needs
+    def self.mandrill_args(args)
+      return [] unless args
+      args.map do |k,v|
+        {'name' => k, 'content' => v}
+      end
+    end
+
+    def self.merge_vars(args)
+      return [] unless args
+      args.map do |item|
+        rcpt = item.keys[0]
+        {'rcpt' => rcpt, 'vars' => mandrill_args(item.fetch(rcpt))}
+      end
+    end
+
+    def self.rcpt_metadata(args)
+      return [] unless args
+      args.map do |item|
+        rcpt = item.keys[0]
+        {'rcpt' => rcpt, 'values' => item.fetch(rcpt)}
+      end
+    end
+
+    # ensure only true or false is returned given arg
+    def self.boolean(arg)
+      !!arg
+    end
+
+    # handle if to params is an array of either hashes or strings or the single string
+    def self.params(to_params)
+      if to_params.kind_of? Array
+        to_params.map do |p|
+          params_item(p)
+        end
+      else
+        [params_item(to_params)]
+      end
+    end
+
+    # single to params item
+    def self.params_item(item)
+      if item.kind_of? Hash
+        item
+      else
+        {"email" => item, "name" => item}
+      end
+    end
+
+    def self.format_messages_api_message_data(args)
+      # If a merge_language attribute is given and it's not one of the accepted
+      # languages Raise an error
+      if args[:merge_language] && !ACCEPTED_MERGE_LANGUAGES.include?(args[:merge_language])
+        raise MandrillMailer::CoreMailer::InvalidMergeLanguageError.new("The :merge_language value `#{args[:merge_language]}`is invalid, value must be one of: #{ACCEPTED_MERGE_LANGUAGES.join(', ')}.")
+      end
+
+      {
+        "html" => args[:html],
+        "text" => args[:text],
+        "subject" => args[:subject],
+        "from_email" => args[:from] || defaults[:from],
+        "from_name" => args[:from_name] || defaults[:from_name] || defaults[:from],
+        "to" => params(args[:to]),
+        "headers" => args[:headers],
+        "important" => boolean(args[:important]),
+        "track_opens" => args.fetch(:track_opens, true),
+        "track_clicks" => boolean(args.fetch(:track_clicks, true)),
+        "auto_text" => boolean(args.fetch(:auto_text, true)),
+        "auto_html" => boolean(args[:auto_html]),
+        "inline_css" => boolean(args[:inline_css]),
+        "url_strip_qs" => boolean(args.fetch(:url_strip_qs, true)),
+        "preserve_recipients" => boolean(args[:preserve_recipients]),
+        "view_content_link" => boolean(args[:view_content_link]),
+        "bcc_address" => args[:bcc],
+        "tracking_domain" => args[:tracking_domain],
+        "signing_domain" => args[:signing_domain],
+        "return_path_domain" => args[:return_path_domain],
+        "merge" => boolean(args[:merge]),
+        "merge_language" => args[:merge_language],
+        "global_merge_vars" => mandrill_args(args[:vars] || args[:global_merge_vars]),
+        "merge_vars" => merge_vars(args[:recipient_vars] || args[:merge_vars] || defaults[:merge_vars]),
+        "tags" => args[:tags],
+        "subaccount" => args[:subaccount],
+        "google_analytics_domains" => args[:google_analytics_domains],
+        "google_analytics_campaign" => args[:google_analytics_campaign],
+        "metadata" => args[:metadata],
+        "recipient_metadata" => args[:recipient_metadata],
+        "attachments" => attachment_args(args[:attachments]),
+        "images" => images_args(args[:images])
+      }
+    end
+
+    def self.defaults
+      MandrillMailer::CoreMailer.defaults
+    end
+  end
+end

data/lib/mandrill_mailer/core_mailer.rb

@@ -105,13 +105,14 @@
 
 # Required for hash.stringify_keys!
 require 'active_support/all'
-require 'base64'
+require 'mandrill_mailer/arg_formatter'
 
 module MandrillMailer
   class CoreMailer
     class InvalidEmail < StandardError; end
     class InvalidMailerMethod < StandardError; end
     class InvalidInterceptorParams < StandardError; end
+    class InvalidMergeLanguageError < StandardError; end
 
     # Public: Other information on the message to send
     attr_accessor :message
@@ -141,7 +142,7 @@ module MandrillMailer
     #
     # Returns options
     def self.defaults
-      @defaults || super_defaults
+      @defaults || super_defaults || {}
     end
 
     def self.super_defaults
@@ -211,14 +212,18 @@ module MandrillMailer
 
     # 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)
+      raise NotImplementedError.new("#{self.class.name}#deliver is not implemented.")
+    end
+
+
+    def mandrill_mail_handler(args)
+      args
     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',
@@ -231,19 +236,19 @@ module MandrillMailer
     #
     # Returns the the mandrill mailer class (this is so you can chain #deliver like a normal mailer)
     def mandrill_mail(args)
-      mesg = "#{self.class.name}#mandrill_mail() is not implemented."
-      raise NotImplementedError.new(mesg)
-    end
+      extract_api_options!(args)
 
-    # Public: Data hash (deprecated)
-    def data
-      mesg = "#{self.class.name}#data() is not implemented."
-      raise NotImplementedError.new(mesg)
-    end
+      # Call the mandrill_mail_handler so mailers can handle the args in custom ways
+      mandrill_mail_handler(args)
+
+      # Construct message hash
+      self.message = MandrillMailer::ArgFormatter.format_messages_api_message_data(args)
 
-    def check_required_options
-      mesg = "#{self.class.name}#check_required_options() is not implemented."
-      raise NotImplementedError.new(mesg)
+      # Apply any interceptors that may be present
+      apply_interceptors!(self.message)
+
+      # return self so we can chain deliver after the method call, like a normal mailer.
+      self
     end
 
     def from
@@ -255,7 +260,7 @@ module MandrillMailer
     end
 
     def to=(values)
-      self.message && self.message['to'] = format_to_params(values)
+      self.message && self.message['to'] = MandrillMailer::ArgFormatter.params(values)
     end
 
     def bcc
@@ -264,20 +269,15 @@ module MandrillMailer
 
     protected
 
-    def mandrill_attachment_args(args)
-      return unless args
-      args.map do |attachment|
-        attachment.symbolize_keys!
-        type = attachment[:mimetype] || attachment[:type]
-        name = attachment[:filename] || attachment[:name]
-        file = attachment[:file] || attachment[:content]
-        {"type" => type, "name" => name, "content" => Base64.encode64(file)}
+    def apply_interceptors!(obj)
+      unless MandrillMailer.config.interceptor.nil?
+        unless MandrillMailer.config.interceptor.is_a?(Proc)
+          raise InvalidInterceptorParams.new "The interceptor_params config must be a proc"
+        end
+        MandrillMailer.config.interceptor.call(obj)
       end
-    end
 
-    def mandrill_images_args(args)
-      return unless args
-      mandrill_attachment_args(args)
+      obj
     end
 
     # Makes this class act as a singleton without it actually being a singleton
@@ -324,56 +324,21 @@ module MandrillMailer
       "#{root_url}#{image_path(image).split('/').reject!(&:empty?).join('/')}"
     end
 
-    # convert a normal hash into the format mandrill needs
-    def mandrill_args(args)
-      args = merge_default_merge_vars(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
+    def api_key
+      MandrillMailer.config.api_key
     end
 
-    def merge_default_merge_vars(args)
-      if args
-        self.class.defaults[:merge_vars].merge(args)
-      else
-        self.class.defaults[:merge_vars]
-      end
+    def mandrill_api
+      @mandrill_api ||= Mandrill::API.new(api_key)
     end
 
-    # ensure only true or false is returned given arg
-    def format_boolean(arg)
-      arg ? true : false
-    end
+    def extract_api_options!(args)
+      self.async = args.delete(:async)
+      self.ip_pool = args.delete(:ip_pool)
 
-    # 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
-        to_params.map do |p|
-          to_params_item(p)
-        end
-      else
-        [to_params_item(to_params)]
+      if args.has_key?(:send_at)
+        self.send_at = args.delete(:send_at).getutc.strftime('%Y-%m-%d %H:%M:%S')
       end
     end
-
-    # single to params item
-    def to_params_item(item)
-      return {"email" => item, "name" => item} unless item.kind_of? Hash
-      item
-    end
-
-    def api_key
-      MandrillMailer.config.api_key
-    end
   end
 end

data/lib/mandrill_mailer/message_mailer.rb

@@ -1,6 +1,4 @@
 # MandrilMailer class for sending transactional emails through mandril.
-# Only template based emails are supported at this time.
-
 # Example usage:
 
 # class InvitationMailer < MandrillMailer::MessageMailer
@@ -93,111 +91,13 @@
 #   message HTML - only for HTML documents less than 256KB in size
 
 # :important - whether or not this message is important, and should be delivered ahead of non-important messages
-require 'base64'
 require 'mandrill_mailer/core_mailer'
 
 module MandrillMailer
   class MessageMailer < MandrillMailer::CoreMailer
-    # Public: The name of the template to use
-    attr_accessor :html
-
-    # Public: Template content
-    attr_accessor :text
-
     # Public: Triggers the stored Mandrill params to be sent to the Mandrill api
     def deliver
-      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:
-    #             :template - Template name in Mandrill
-    #             :subject - Subject of the email
-    #             :to - Email to send the mandrill email to
-    #             :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
-    #             :google_analytics_campaign - Google analytics campaign
-    #             :inline_css - whether or not to automatically inline all CSS styles provided in the message HTML
-    #             :important - whether or not this message is important
-    #             :async - whether or not this message should be sent asynchronously
-    #             :ip_pool - name of the dedicated IP pool that should be used to send the message
-    #             :send_at - when this message should be sent
-    #
-    # Examples
-    #
-    #   mandrill_mail template: 'Group Invite',
-    #               subject: I18n.t('invitation_mailer.invite.subject'),
-    #               to: invitation.email,
-    #               vars: {
-    #                 'OWNER_NAME' => invitation.owner_name,
-    #                 'INVITATION_URL' => new_invitation_url(email: invitation.email, secret: invitation.secret)
-    #               }
-    #
-    # Returns the the mandrill mailer class (this is so you can chain #deliver like a normal mailer)
-    def mandrill_mail(args)
-      # format the :to param to what Mandrill expects if a string or array is passed
-      args[:to] = format_to_params(args[:to])
-
-      self.async = args.delete(:async)
-      self.ip_pool = args.delete(:ip_pool)
-      if args.has_key?(:send_at)
-        self.send_at = args.delete(:send_at).getutc.strftime('%Y-%m-%d %H:%M:%S')
-      end
-
-      # Construct message hash
-      self.message = {
-        "text" => args[:text],
-        "html" => args[:html],
-        "view_content_link" => args[:view_content_link],
-        "subject" => args[:subject],
-        "from_email" => args[:from] || self.class.defaults[:from],
-        "from_name" => args[:from_name] || self.class.defaults[:from_name] || self.class.defaults[:from],
-        "to" => args[:to],
-        "headers" => args[:headers],
-        "important" => args[:important],
-        "track_opens" => args.fetch(:track_opens, true),
-        "track_clicks" => args.fetch(:track_clicks, true),
-        "auto_text" => true,
-        "inline_css" => args[:inline_css],
-        "url_strip_qs" => args.fetch(:url_strip_qs, true),
-        "preserve_recipients" => args[:preserve_recipients],
-        "bcc_address" => args[:bcc],
-        "global_merge_vars" => mandrill_args(args[:vars]),
-        "merge_vars" => mandrill_rcpt_args(args[:recipient_vars] || self.class.defaults[:merge_vars]),
-        "tags" => args[:tags],
-        "subaccount" => args[:subaccount],
-        "google_analytics_domains" => args[:google_analytics_domains],
-        "google_analytics_campaign" => args[:google_analytics_campaign],
-        "metadata" => args[:metadata],
-        "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"
-        end
-        self.message.merge!(MandrillMailer.config.interceptor_params.stringify_keys)
-      end
-
-      # return self so we can chain deliver after the method call, like a normal mailer.
-      return self
-    end
-
-    # Public: Data hash (deprecated)
-    def data
-      {
-        "key" => api_key,
-        "message" => message,
-        "async" => async,
-        "ip_pool" => ip_pool,
-        "send_at" => send_at
-      }
-    end
+      mandrill_api.messages.send(message, async, ip_pool, send_at)
+    end
   end
 end