multi_mail 0.1.3 → 0.1.4

data/lib/multi_mail/mailgun/message.rb

@@ -2,6 +2,8 @@ module MultiMail
   module Message
     # @see http://documentation.mailgun.com/api-sending.html
     class Mailgun < MultiMail::Message::Base
+      attr_accessor :stripped_text, :stripped_signature, :stripped_html, :content_id_map
+
       # Returns the message headers in Mailgun format.
       #
       # @return [Multimap] the message headers in Mailgun format

data/lib/multi_mail/mailgun/receiver.rb

@@ -34,7 +34,7 @@ module MultiMail
       # Transforms the content of Mailgun's webhook into a list of messages.
       #
       # @param [Hash] params the content of Mailgun's webhook
-      # @return [Array<Mail::Message>] messages
+      # @return [Array<MultiMail::Message::Mailgun>] messages
       # @see http://documentation.mailgun.net/user_manual.html#mime-messages-parameters
       # @see http://documentation.mailgun.net/user_manual.html#parsed-messages-parameters
       def transform(params)
@@ -44,7 +44,7 @@ module MultiMail
           headers = self.class.multimap(JSON.load(params['message-headers']))
           this = self
 
-          message = Mail.new do
+          message = Message::Mailgun.new do
             headers headers
 
             # The following are redundant with `body-mime` in raw MIME format
@@ -78,27 +78,27 @@ module MultiMail
           end
 
           # Extra Mailgun parameters.
-          extra = [
-            'stripped-text',
-            'stripped-signature',
-            'stripped-html',
-            'content-id-map',
-          ]
-
-          # Non-plain, non-HTML body parts.
-          extra += params.keys.select do |key|
-            key[/\Abody-(?!html|plain)/]
+          if params.key?('stripped-text') && !params['stripped-text'].empty?
+            message.stripped_text = params['stripped-text']
           end
-
-          extra.each do |key|
-            if params.key?(key) && !params[key].empty?
-              message[key] = params[key]
-            end
+          if params.key?('stripped-signature') && !params['stripped-signature'].empty?
+            message.stripped_signature = params['stripped-signature']
           end
+          if params.key?('stripped-html') && !params['stripped-html'].empty?
+            message.stripped_html = params['stripped-html']
+          end
+          if params.key?('content-id-map') && !params['content-id-map'].empty?
+            message.content_id_map = params['content-id-map']
+          end
+
+          # @todo Store non-plain, non-HTML body parts.
+          # params.keys.select do |key|
+          #   key[/\Abody-(?!html|plain)/]
+          # end
 
           [message]
         when 'raw'
-          message = self.class.condense(Mail.new(params['body-mime']))
+          message = self.class.condense(Message::Mailgun.new(Mail.new(params['body-mime'])))
           [message]
         else
           raise ArgumentError, "Can't handle Mailgun #{@http_post_format} HTTP POST format"

data/lib/multi_mail/mailgun/sender.rb

@@ -17,7 +17,7 @@ module MultiMail
       def initialize(options = {})
         super
         @api_key = settings.delete(:api_key)
-        @domain  = settings.delete(:domain)
+        @domain = settings.delete(:domain)
       end
 
       # Returns the additional parameters for the API call.

data/lib/multi_mail/mandrill/message.rb

@@ -2,6 +2,8 @@ module MultiMail
   module Message
     # @see https://mandrillapp.com/api/docs/messages.ruby.html#method-send
     class Mandrill < MultiMail::Message::Base
+      attr_accessor :ts, :email, :dkim_signed, :dkim_valid, :spam_report_score, :spf_result
+
       # Returns the To header in Mandrill format.
       #
       # @return [Array<Hash>] the To header in Mandrill format

data/lib/multi_mail/mandrill/receiver.rb

@@ -39,7 +39,7 @@ module MultiMail
       # Transforms the content of Mandrill's webhook into a list of messages.
       #
       # @param [Hash] params the content of Mandrill's webhook
-      # @return [Array<Mail::Message>] messages
+      # @return [Array<MultiMail::Message::Mandrill>] messages
       # @see http://help.mandrill.com/entries/22092308-What-is-the-format-of-inbound-email-webhooks-
       def transform(params)
         # JSON is necessarily UTF-8.
@@ -52,7 +52,7 @@ module MultiMail
           headers = self.class.multimap(msg['headers'])
           this = self
 
-          message = Mail.new do
+          message = Message::Mandrill.new do
             headers headers
 
             # The following are redundant with `message-headers`:
@@ -71,7 +71,7 @@ module MultiMail
             # If an email contains multiple HTML parts, Mandrill will only
             # include the first HTML part in its `html` parameter. We therefore
             # parse its `raw_msg` parameter to set the HTML part correctly.
-            html = this.class.condense(Mail.new(msg['raw_msg'])).parts.find do |part|
+            html = this.class.condense(Message::Mandrill.new(Mail.new(msg['raw_msg']))).parts.find do |part|
               part.content_type == 'text/html; charset=UTF-8'
             end
 
@@ -98,12 +98,12 @@ module MultiMail
           # null according to the docs, `matched_rules` within `spam_report`,
           # and `detail` within `spf`, which is just a human-readable version of
           # `result`.
-          message['ts']                = event['ts']
-          message['email']             = msg['email']
-          message['dkim-signed']       = msg['dkim']['signed'].to_s
-          message['dkim-valid']        = msg['dkim']['valid'].to_s
-          message['spam_report-score'] = msg['spam_report']['score']
-          message['spf-result']        = msg['spf']['result']
+          message.ts                = event['ts']
+          message.email             = msg['email']
+          message.dkim_signed       = msg['dkim']['signed']
+          message.dkim_valid        = msg['dkim']['valid']
+          message.spam_report_score = msg['spam_report']['score']
+          message.spf_result        = msg['spf']['result']
 
           message
         end
@@ -114,7 +114,7 @@ module MultiMail
       # @param [Mail::Message] message a message
       # @return [Boolean] whether the message is spam
       def spam?(message)
-        message['spam_report-score'] && message['spam_report-score'].value.to_f > @spamassassin_threshold
+        message.spam_report_score > @spamassassin_threshold
       end
 
     private

data/lib/multi_mail/mandrill/sender.rb

@@ -6,7 +6,7 @@ module MultiMail
 
       requires :api_key
 
-      attr_reader :api_key, :async, :ip_pool, :send_at
+      attr_reader :api_key, :async, :ip_pool, :send_at, :template_name, :template_content
 
       # Initializes a Mandrill outgoing email sender.
       #
@@ -16,16 +16,23 @@ module MultiMail
       #   mode optimized for bulk sending
       # @option options [String] :ip_pool the name of the dedicated IP pool that
       #   should be used to send the message
+      # @option options [String] :template_name the slug or name of a template
+      #   that exists in the user's Mandrill account
+      # @option options [Array<Hash>] :template_content an array of hashes, each
+      #   with a `"name"` key for the editable region to inject into and a
+      #  `"content"` key for the content to inject
       # @option options [Time,String] :send_at when this message should be sent
       # @see https://mandrillapp.com/api/docs/index.ruby.html
       # @see https://mandrillapp.com/api/docs/messages.JSON.html#method-send
       def initialize(options = {})
         super
         @api_key = settings.delete(:api_key)
-        @async   = settings.delete(:async) || false
+        @async = settings.delete(:async) || false
         @ip_pool = settings.delete(:ip_pool)
         @send_at = settings.delete(:send_at)
-        unless @send_at.nil? or String === @send_at
+        @template_name = settings.delete(:template_name)
+        @template_content = settings.delete(:template_content)
+        unless @send_at.nil? || String === @send_at
           @send_at = @send_at.utc.strftime('%Y-%m-%d %T')
         end
       end
@@ -60,15 +67,28 @@ module MultiMail
       # @see https://bitbucket.org/mailchimp/mandrill-api-ruby/src/d0950a6f9c4fac1dd2d5198a4f72c12c626ab149/lib/mandrill/api.rb?at=master#cl-738
       # @see https://bitbucket.org/mailchimp/mandrill-api-ruby/src/d0950a6f9c4fac1dd2d5198a4f72c12c626ab149/lib/mandrill.rb?at=master#cl-32
       def deliver!(mail)
+        @template_name = settings.delete(:template_name)
+        @template_content = settings.delete(:template_content)
+
         message = MultiMail::Message::Mandrill.new(mail).to_mandrill_hash.merge(parameters)
 
-        response = Faraday.post('https://mandrillapp.com/api/1.0/messages/send.json', JSON.dump({
+        api_params = {
           :key     => api_key,
           :message => message,
           :async   => async,
           :ip_pool => ip_pool,
           :send_at => send_at,
-        }))
+        }
+
+        if template_name
+          api_method = 'send-template'
+          api_params[:template_name] = template_name
+          api_params[:template_content] = template_content
+        else
+          api_method = 'send'
+        end
+
+        response = Faraday.post("https://mandrillapp.com/api/1.0/messages/#{api_method}.json", JSON.dump(api_params))
 
         body = JSON.load(response.body)
 
@@ -77,8 +97,10 @@ module MultiMail
             case body['name']
             when 'Invalid_Key'
               raise InvalidAPIKey, body['message']
+            when 'Unknown_Template'
+              raise InvalidTemplate, body['message']
             else
-              raise body['message']
+              raise "#{body['name']}: #{body['message']}"
             end
           else
             raise body['message']

data/lib/multi_mail/postmark/message.rb

@@ -2,6 +2,8 @@ module MultiMail
   module Message
     # @see http://developer.postmarkapp.com/developer-build.html#message-format
     class Postmark < MultiMail::Message::Base
+      attr_accessor :mailboxhash, :messageid, :tag
+
       # Returns the message headers in Postmark format.
       #
       # @return [Array<Hash>] the message headers in Postmark format

data/lib/multi_mail/postmark/receiver.rb

@@ -4,6 +4,10 @@ module MultiMail
     class Postmark
       include MultiMail::Receiver::Base
 
+      # Transforms the content of Postmark's webhook into a list of messages.
+      #
+      # @param [Hash] params the content of Postmark's webhook
+      # @return [Array<MultiMail::Message::Postmark>] messages
       def transform(params)
         headers = Multimap.new
         params['Headers'].each do |header|
@@ -15,7 +19,7 @@ module MultiMail
         to   = params['ToFull'].map{|hash| transform_address(hash)}
         cc   = params['CcFull'].map{|hash| transform_address(hash)}
 
-        message = Mail.new do
+        message = Message::Postmark.new do
           headers    headers
           message_id params['MessageID']
 
@@ -41,10 +45,14 @@ module MultiMail
         end
 
         # Extra Postmark parameters.
-        %w(MailboxHash MessageID Tag).each do |key|
-          if params.key?(key) && !params[key].empty?
-            message[key] = params[key]
-          end
+        if params.key?('MailboxHash') && !params['MailboxHash'].empty?
+          message.mailboxhash = params['MailboxHash']
+        end
+        if params.key?('MessageID') && !params['MessageID'].empty?
+          message.messageid = params['MessageID']
+        end
+        if params.key?('Tag') && !params['Tag'].empty?
+          message.tag = params['Tag']
         end
 
         [message]

data/lib/multi_mail/postmark/sender.rb

@@ -18,6 +18,28 @@ module MultiMail
         @api_key = settings.delete(:api_key)
       end
 
+      # Returns the additional parameters for the API call.
+      #
+      # @return [Hash] the additional parameters for the API call
+      def parameters
+        parameters = settings.dup
+        parameters.delete(:return_response)
+
+        if tracking.key?(:opens)
+          parameter = :TrackOpens
+          case tracking[:opens]
+          when true, false, nil
+            parameters[parameter] = tracking[:opens]
+          when 'yes'
+            parameters[parameter] = true
+          when 'no'
+            parameters[parameter] = false
+          end # ignore "htmlonly"
+        end
+
+        parameters
+      end
+
       # Delivers a message via the Postmark API.
       #
       # @param [Mail::Message] mail a message
@@ -25,8 +47,6 @@ module MultiMail
       # @see http://developer.postmarkapp.com/developer-build.html#http-response-codes
       # @see http://developer.postmarkapp.com/developer-build.html#api-error-codes
       def deliver!(mail)
-        parameters = settings.dup
-        parameters.delete(:return_response)
         message = MultiMail::Message::Postmark.new(mail).to_postmark_hash.merge(parameters)
 
         response = Faraday.post do |request|

data/lib/multi_mail/sendgrid/message.rb

@@ -2,6 +2,8 @@ module MultiMail
   module Message
     # @see http://sendgrid.com/docs/API_Reference/Web_API/mail.html
     class SendGrid < MultiMail::Message::Base
+      attr_accessor :dkim, :spf, :spam_report, :spam_score
+
       # Returns the message headers in SendGrid format.
       #
       # @return [Hash] the message headers in SendGrid format

data/lib/multi_mail/sendgrid/receiver.rb

@@ -16,7 +16,7 @@ module MultiMail
       # Transforms the content of SendGrid's webook into a list of messages.
       #
       # @param [Hash] params the content of Mandrill's webhook
-      # @return [Array<Mail::Messages>] messages
+      # @return [Array<MultiMail::Message::SendGrid>] messages
       # @see http://sendgrid.com/docs/API_Reference/Webhooks/parse.html
       def transform(params)
         # Make variables available to the `encode` method.
@@ -26,7 +26,7 @@ module MultiMail
         # Mail changes `self`.
         this = self
 
-        message = Mail.new do
+        message = Message::SendGrid.new do
           # SendGrid includes a `charsets` parameter, which describes the
           # encodings of the `from`, `to`, `cc` and `subject` parameters, which
           # we don't need because we parse the headers directly.
@@ -57,10 +57,11 @@ module MultiMail
           end
         end
 
-        # Extra SendGrid parameters. Discard
-        %w(dkim SPF spam_report spam_score).each do |key|
-          message[key] = params[key]
-        end
+        # Extra SendGrid parameters.
+        message.dkim = params['dkim']
+        message.spf = params['SPF']
+        message.spam_report = params['spam_report']
+        message.spam_score = params['spam_score']
 
         # Discard `envelope`, which contains `to` and `from`, and the
         # undocumented `attachment-info`.
@@ -72,7 +73,7 @@ module MultiMail
       # @param [Mail::Message] message a message
       # @return [Boolean] whether the message is spam
       def spam?(message)
-        message['spam_score'] && message['spam_score'].value.to_f > @spamassassin_threshold
+        message.spam_score.to_f > @spamassassin_threshold
       end
 
       def encode(key)

data/lib/multi_mail/version.rb

@@ -1,3 +1,3 @@
 module MultiMail
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/multi_mail.gemspec

@@ -5,9 +5,8 @@ Gem::Specification.new do |s|
   s.name        = "multi_mail"
   s.version     = MultiMail::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Open North"]
-  s.email       = ["info@opennorth.ca"]
-  s.homepage    = "http://github.com/opennorth/multi_mail"
+  s.authors     = ["James McKinney"]
+  s.homepage    = "https://github.com/jpmckinney/multi_mail"
   s.summary     = %q{Easily switch between email APIs}
   s.license     = 'MIT'
 
@@ -16,20 +15,19 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency 'faraday', '~> 0.8.0'
-  s.add_runtime_dependency 'mail', '~> 2.5.3' # Rails 3.2.13, less buggy than 2.4.x
-  s.add_runtime_dependency 'rack', '~> 1.4'
+  s.add_runtime_dependency('faraday', '~> 0.9.0')
+  s.add_runtime_dependency('mail', '~> 2.5')
+  s.add_runtime_dependency('rack', '~> 1.5')
 
   # For testing
-  s.add_development_dependency 'coveralls'
-  s.add_development_dependency 'json', '~> 1.7.7' # to silence coveralls warning
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'rspec', '~> 2.10'
-  s.add_development_dependency 'vcr', '~> 2.4.0'
+  s.add_development_dependency('coveralls')
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rspec', '~> 2.10')
 
   # For Rake tasks
-  s.add_development_dependency 'mandrill-api', '~> 1.0.35'
-  s.add_development_dependency 'postmark'
-  s.add_development_dependency 'rest-client', '~> 1.6.7'
-  s.add_development_dependency 'sendgrid_webapi'
+  s.add_development_dependency('mandrill-api', '~> 1.0.35')
+  s.add_development_dependency('postmark')
+  s.add_development_dependency('rest-client', '~> 1.8.0')
+  # sendgrid_webapi 0.0.2 depends on Faraday 0.8.
+  # s.add_development_dependency('sendgrid_webapi', '0.0.2')
 end

data/spec/cloudmailin/receiver_spec.rb

@@ -63,8 +63,8 @@ describe MultiMail::Receiver::Cloudmailin do
             message.subject.should == 'Test'
 
             # Body
-            message.multipart?.should    == true
-            message.parts.size.should    == 4
+            message.multipart?.should == true
+            message.parts.size.should == 4
             text_part = message.parts.find{|part| part.content_type == 'text/plain'}
             html_part = message.parts.find{|part| part.content_type == 'text/html; charset=UTF-8'}
             text_part.body.decoded.should == "bold text\n\n\n\nsome more bold text\n\n\n\nsome italic text\n\n> multiline\n> quoted\n> text\n\n\n--\nSignature block"
@@ -92,11 +92,11 @@ describe MultiMail::Receiver::Cloudmailin do
 
             # Extra Cloudmailin parameters
             if actual_http_post_format == 'raw'
-              message['reply_plain'].should be_nil
+              message.reply_plain.should be_nil
             else
-              message['reply_plain'].value.should == "bold text\n\n\n\nsome more bold text\n\n\n\nsome italic text\n"
+              message.reply_plain.should == "bold text\n\n\n\nsome more bold text\n\n\n\nsome italic text\n"
             end
-            message['spf-result'].value.should == 'pass'
+            message.spf_result.should == 'pass'
           end
         end
 

data/spec/mailgun/receiver_spec.rb

@@ -92,8 +92,8 @@ describe MultiMail::Receiver::Mailgun do
             message.subject.should == 'Test'
 
             # Body
-            message.multipart?.should            == true
-            message.parts.size.should            == 4
+            message.multipart?.should == true
+            message.parts.size.should == 4
             text_part = message.parts.find{|part| part.content_type == 'text/plain'}
             html_part = message.parts.find{|part| part.content_type == 'text/html; charset=UTF-8'}
             text_part.body.decoded.should == "bold text\n\n\n\nsome more bold text\n\n\n\nsome italic text\n\n> multiline\n> quoted\n> text\n\n\n--\nSignature block"
@@ -110,13 +110,13 @@ describe MultiMail::Receiver::Mailgun do
             #    text" but `stripped-html` doesn't. `stripped-signature` and
             #    `stripped-text` use CRLF line endings.
             if actual_http_post_format == 'raw'
-              message['stripped-text'].should be_nil
-              message['stripped-signature'].should be_nil
-              message['stripped-html'].should be_nil
+              message.stripped_text.should be_nil
+              message.stripped_signature.should be_nil
+              message.stripped_html.should be_nil
             else
-              message['stripped-text'].value.should      == "bold text\r\n\r\n\r\n\r\nsome more bold text\r\n\r\n\r\n\r\nsome italic text"
-              message['stripped-signature'].value.should == "--\r\nSignature block"
-              message['stripped-html'].value.should      == '<html><head></head><body style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space; "><b>bold text</b><div><br></div><div></div></body><html><body style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space; "><br><div></div><div><br></div><div><b>some more bold text</b></div><div><b><br></b></div><div><b></b></div></body></html><html><head></head></html></html>'
+              message.stripped_text.should      == "bold text\r\n\r\n\r\n\r\nsome more bold text\r\n\r\n\r\n\r\nsome italic text"
+              message.stripped_signature.should == "--\r\nSignature block"
+              message.stripped_html.should      == '<html><head></head><body style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space; "><b>bold text</b><div><br></div><div></div></body><html><body style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space; "><br><div></div><div><br></div><div><b>some more bold text</b></div><div><b><br></b></div><div><b></b></div></body></html><html><head></head></html></html>'
             end
           end
         end