multi_mail 0.1.0 → 0.1.1

data/lib/multi_mail/mailgun/sender.rb

@@ -1,5 +1,3 @@
-require 'multi_mail/mailgun/message'
-
 module MultiMail
   module Sender
     # Mailgun's outgoing mail sender.
@@ -14,6 +12,8 @@ module MultiMail
       #
       # @param [Hash] options required and optional arguments
       # @option options [String] :api_key a Mailgun API key
+      # @option options [String] :domain the Mailgun email domain
+      # @see http://documentation.mailgun.com/api-intro.html#base-url
       def initialize(options = {})
         super
         @api_key = settings.delete(:api_key)
@@ -62,7 +62,7 @@ module MultiMail
         case response.status
         when 401
           raise InvalidAPIKey, response.body
-        when 400
+        when 400, 404
           body = JSON.load(response.body)
           case body['message']
           when "'from' parameter is missing"
@@ -72,7 +72,7 @@ module MultiMail
           when "Need at least one of 'text' or 'html' parameters specified"
             raise MissingBody, body['message']
           else
-            raise InvalidMessage, body['message']
+            raise InvalidRequest, body['message']
           end
         when 200
           body = JSON.load(response.body)

data/lib/multi_mail/mandrill/message.rb

@@ -22,16 +22,16 @@ module MultiMail
       #
       # @return [Hash] the message headers in Mandrill format
       def mandrill_headers
-        headers = {}
+        hash = {}
         header_fields.each do |field|
           key = field.name.downcase
           # Mandrill only allows Reply-To and X-* headers currently.
           # https://mandrillapp.com/api/docs/messages.ruby.html
           if key == 'reply-to' || key.start_with?('x-')
-            headers[field.name] = field.value
+            hash[field.name] = field.value
           end
         end
-        headers
+        hash
       end
 
       # Returns the message's attachments in Mandrill format.
@@ -65,6 +65,7 @@ module MultiMail
           'headers'     => mandrill_headers,
           'attachments' => attachments,
           'images'      => images,
+          'tags'        => tags,
         }
 
         normalize(hash)

data/lib/multi_mail/mandrill/sender.rb

@@ -1,5 +1,3 @@
-require 'multi_mail/mandrill/message'
-
 module MultiMail
   module Sender
     # Mandrill's outgoing mail sender.
@@ -14,13 +12,22 @@ module MultiMail
       #
       # @param [Hash] options required and optional arguments
       # @option options [String] :api_key a Mandrill API key
+      # @option options [Boolean] :async whether to enable a background sending
+      #   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 [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
         @ip_pool = settings.delete(:ip_pool)
         @send_at = settings.delete(:send_at)
+        unless @send_at.nil? or String === @send_at
+          @send_at = @send_at.utc.strftime('%Y-%m-%d %T')
+        end
       end
 
       # Returns the additional parameters for the API call.

data/lib/multi_mail/message/base.rb

@@ -22,6 +22,20 @@ module MultiMail
         end
       end
 
+      def tags
+        if self['tag']
+          if self['tag'].respond_to?(:map)
+            self['tag'].map do |field|
+              field.value
+            end
+          else
+            [self['tag'].value]
+          end
+        else
+          []
+        end
+      end
+
     private
 
       def normalize(hash)

data/lib/multi_mail/postmark/message.rb

@@ -0,0 +1,74 @@
+module MultiMail
+  module Message
+    # @see http://developer.postmarkapp.com/developer-build.html#message-format
+    class Postmark < MultiMail::Message::Base
+      # Returns the message headers in Postmark format.
+      #
+      # @return [Multimap] the message headers in Postmark format
+      def postmark_headers
+        array = []
+        header_fields.each do |field|
+          key = field.name.downcase
+          # @see https://github.com/wildbit/postmark-gem/blob/master/lib/postmark/message_extensions/mail.rb#L74
+          # @see https://github.com/wildbit/postmark-gem/pull/36#issuecomment-22298955
+          unless %w(from to cc bcc reply-to subject tag content-type date).include?(key) || (Array === field.value && field.value.size > 1)
+            array << {'Name' => field.name, 'Value' => field.value}
+          end
+        end
+        array
+      end
+
+      # Returns the message's attachments in Postmark format.
+      #
+      # @return [Multimap] the attachments in Postmark format
+      # @see http://developer.postmarkapp.com/developer-build.html#attachments
+      def postmark_attachments
+        attachments.map do |attachment|
+          hash = {
+            'ContentType' => attachment.content_type,
+            'Name'        => attachment.filename,
+            'Content'     => Base64.encode64(attachment.body.decoded)
+          }
+          if attachment.content_type.start_with?('image/')
+            hash['ContentID'] = attachment.filename
+          end
+          hash
+        end
+      end
+
+      # Returns the message as parameters to POST to Postmark.
+      #
+      # @return [Hash] the message as parameters to POST to Postmark
+      def to_postmark_hash
+        hash = {}
+
+        %w(from subject).each do |field|
+          if self[field]
+            hash[postmark_key(field)] = self[field].value
+          end
+        end
+
+        %w(to cc bcc reply_to).each do |field|
+          if self[field]
+            value = self[field].value
+            hash[postmark_key(field)] = value.respond_to?(:join) ? value.join(', ') : value
+          end
+        end
+
+        hash['TextBody']    = body_text
+        hash['HtmlBody']    = body_html
+        hash['Headers']     = postmark_headers
+        hash['Attachments'] = postmark_attachments
+        hash['Tag']         = tags.first
+
+        normalize(hash)
+      end
+
+      private
+
+      def postmark_key(string)
+        string.downcase.split(/[_-]/).map(&:capitalize).join
+      end
+    end
+  end
+end

data/lib/multi_mail/postmark/receiver.rb

@@ -16,7 +16,8 @@ module MultiMail
         cc   = params['CcFull'].map{|hash| transform_address(hash)}
 
         message = Mail.new do
-          headers headers
+          headers    headers
+          message_id params['MessageID']
 
           from      from
           to        to

data/lib/multi_mail/postmark/sender.rb

@@ -1,42 +1,72 @@
-begin
-  require 'postmark'
-rescue LoadError
-  raise 'The postmark gem is not available. In order to use the Postmark sender, you must: gem install postmark'
-end
-
 module MultiMail
   module Sender
     # Postmark's outgoing mail sender.
     class Postmark
       include MultiMail::Sender::Base
 
-      # @see https://github.com/wildbit/postmark-gem#communicating-with-the-api
       requires :api_key
 
+      attr_reader :api_key
+
+      # Initializes a Postmark outgoing email sender.
+      #
+      # @param [Hash] options required and optional arguments
+      # @option options [String] :api_key a Postmark API key
+      # @see http://developer.postmarkapp.com/developer-build.html#authentication-headers
+      def initialize(options = {})
+        super
+        @api_key = settings.delete(:api_key)
+      end
+
       # Delivers a message via the Postmark API.
       #
       # @param [Mail::Message] mail a message
-      # @see https://github.com/wildbit/postmark-gem#using-postmark-with-the-mail-library
+      # @see http://developer.postmarkapp.com/developer-build.html
+      # @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)
-        mail.delivery_method Mail::Postmark, settings
+        parameters = settings.dup
+        parameters.delete(:return_response)
+        message = MultiMail::Message::Postmark.new(mail).to_postmark_hash.merge(parameters)
 
-        if settings[:return_response]
-          mail.deliver!
-        else
-          mail.deliver
+        response = Faraday.post do |request|
+          request.url 'https://api.postmarkapp.com/email'
+          request.headers['Accept'] = 'application/json'
+          request.headers['Content-Type'] = 'application/json'
+          request.headers['X-Postmark-Server-Token'] = @api_key
+          request.body = JSON.dump(message)
+        end
+
+        body = JSON.load(response.body)
+
+        unless response.status == 200
+          case body['ErrorCode']
+          when 0
+            raise InvalidAPIKey, body['Message']
+          when 300
+            case body['Message']
+            when "Header 'Content-Type' not allowed."
+              raise InvalidHeader, body['Message']
+            when "Header 'Date' not allowed."
+              raise InvalidHeader, body['Message']
+            when "Invalid 'From' value."
+              raise MissingSender, body['Message']
+            when 'Zero recipients specified'
+              raise MissingRecipients, body['Message']
+            when 'Provide either email TextBody or HtmlBody or both.'
+              raise MissingBody, body['Message']
+            else
+              raise InvalidMessage, body['Message']
+            end
+          else
+            raise InvalidRequest, body['Message']
+          end
         end
-      rescue ::Postmark::InvalidApiKeyError => e
-        raise InvalidAPIKey, e.message
-      rescue ::Postmark::InvalidMessageError => e
-        case e.message
-        when "Invalid 'From' value."
-          raise MissingSender, e.message
-        when 'Zero recipients specified'
-          raise MissingRecipients, e.message
-        when 'Provide either email TextBody or HtmlBody or both.'
-          raise MissingBody, e.message
+
+        if settings[:return_response]
+          body
         else
-          raise InvalidMessage, e.message
+          self
         end
       end
     end

data/lib/multi_mail/sendgrid/message.rb

@@ -6,15 +6,15 @@ module MultiMail
       #
       # @return [Hash] the message headers in SendGrid format
       def sendgrid_headers
-        headers = {}
+        hash = {}
         header_fields.each do |field|
           key = field.name.downcase
-          unless %w(to subject from bcc reply-to date message-id).include?(key)
+          unless %w(to subject from bcc reply-to date).include?(key)
             # The JSON must not contain integers.
-            headers[field.name] = field.value.to_s
+            hash[field.name] = field.value.to_s
           end
         end
-        headers
+        hash
       end
 
       # Returns the message's attachments in SendGrid format.

data/lib/multi_mail/sendgrid/sender.rb

@@ -1,5 +1,3 @@
-require 'multi_mail/sendgrid/message'
-
 module MultiMail
   module Sender
     # SendGrid's outgoing mail sender.
@@ -14,6 +12,8 @@ module MultiMail
       # @param [Hash] options required and optional arguments
       # @option options [String] :api_user a SendGrid API user
       # @option options [String] :api_key a SendGrid API key
+      # @option options [Hash,String] the X-SMTPAPI SendGrid header
+      # @see http://sendgrid.com/docs/API_Reference/SMTP_API/index.html
       def initialize(options = {})
         super
         if Hash === settings[:'x-smtpapi']

data/lib/multi_mail/simple/receiver.rb

@@ -1,8 +1,33 @@
 module MultiMail
   module Receiver
+    # A simple incoming email receiver.
     class Simple
       include MultiMail::Receiver::Base
 
+      recognizes :secret
+
+      # Initializes a simple incoming email receiver.
+      #
+      # @param [Hash] options required and optional arguments
+      # @option options [String] :secret a secret key
+      def initialize(options = {})
+        super
+        @secret = options[:secret]
+      end
+
+      # Returns whether a request is authentic.
+      #
+      # @param [Hash] params the content of the webhook
+      # @return [Boolean] whether the request is authentic
+      # @raise [IndexError] if the request is missing parameters
+      def valid?(params)
+        if @secret
+          params.fetch('signature') == signature(params)
+        else
+          super
+        end
+      end
+
       # Expects a raw email message parsable by the Mail gem.
       #
       # @param [Hash] params the content of the webhook
@@ -10,6 +35,11 @@ module MultiMail
       def transform(params)
         [Mail.new(params)]
       end
+
+      def signature(params)
+        data = "#{params.fetch('timestamp')}#{params.fetch('token')}"
+        OpenSSL::HMAC.hexdigest('sha256', @secret, data)
+      end
     end
   end
-end
+end

data/lib/multi_mail/version.rb

@@ -1,3 +1,3 @@
 module MultiMail
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/multi_mail.gemspec

@@ -9,6 +9,7 @@ Gem::Specification.new do |s|
   s.email       = ["info@opennorth.ca"]
   s.homepage    = "http://github.com/opennorth/multi_mail"
   s.summary     = %q{Easily switch between email APIs}
+  s.license     = 'MIT'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -25,7 +26,7 @@ Gem::Specification.new do |s|
   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.0'
+  s.add_development_dependency 'vcr', '~> 2.4.0'
 
   # For Rake tasks
   s.add_development_dependency 'mandrill-api', '~> 1.0.35'

data/spec/cloudmailin/receiver_spec.rb

@@ -2,108 +2,113 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 require 'multi_mail/cloudmailin/receiver'
 
 describe MultiMail::Receiver::Cloudmailin do
-  context 'after initialization' do
-    context 'with invalid HTTP POST format' do
-      let :service do
-        MultiMail::Receiver.new({
-          :provider => :cloudmailin,
-          :http_post_format => 'invalid',
-        })
-      end
+  context 'with invalid HTTP POST format' do
+    let :service do
+      MultiMail::Receiver.new({
+        :provider => :cloudmailin,
+        :http_post_format => 'invalid',
+      })
+    end
 
-      describe '#transform' do
-        it 'should raise an error if :http_post_format is invalid' do
-          expect{ service.transform({}) }.to raise_error(ArgumentError)
-        end
+    describe '#transform' do
+      it 'should raise an error if :http_post_format is invalid' do
+        expect{ service.transform({}) }.to raise_error(ArgumentError)
       end
     end
+  end
 
-    [false, true].each do |action_dispatch|
-      let :action_dispatch do
-        action_dispatch
-      end
+  [false, true].each do |action_dispatch|
+    let :action_dispatch do
+      action_dispatch
+    end
 
-      ['raw', 'json', 'multipart', '', nil].each do |http_post_format|
-        context "with #{http_post_format.inspect} format and #{action_dispatch ? 'ActionDispatch' : 'Rack'}" do
-          let :http_post_format do
-            http_post_format
-          end
+    ['raw', 'json', 'multipart', '', nil].each do |http_post_format|
+      context "with #{http_post_format.inspect} format and #{action_dispatch ? 'ActionDispatch' : 'Rack'}" do
+        let :actual_http_post_format do
+          http_post_format.to_s.empty? ? 'raw' : http_post_format
+        end
 
-          let :actual_http_post_format do
-            http_post_format.to_s.empty? ? 'raw' : http_post_format
+        let :service do
+          MultiMail::Receiver.new({
+            :provider => :cloudmailin,
+            :http_post_format => http_post_format,
+          })
+        end
+
+        def params(fixture)
+          MultiMail::Receiver::Cloudmailin.parse(response("cloudmailin/#{actual_http_post_format}", fixture, action_dispatch))
+        end
+
+        describe '#transform' do
+          it 'should return a mail message' do
+            helper(service.transform(params('valid')))
           end
 
-          let :service do
-            MultiMail::Receiver.new({
+          it 'should return a mail message with URL attachments' do
+            helper(MultiMail::Receiver.new({
               :provider => :cloudmailin,
               :http_post_format => http_post_format,
-            })
+              :attachment_store => true,
+            }).transform(params('attachment_store')), true)
           end
 
-          def params(fixture)
-            MultiMail::Receiver::Cloudmailin.parse(response("cloudmailin/#{actual_http_post_format}", fixture, action_dispatch))
-          end
+          def helper(messages, attachment_store = false)
+            messages.size.should == 1
+            message = messages[0]
+
+            # Headers
+            message.date.should    == DateTime.parse('Mon, 15 Apr 2013 20:20:12 -04:00')
+            message.from.should    == ['james@opennorth.ca']
+            message.to.should      == ['5dae6f85cd65d30d384a@cloudmailin.net']
+            message.subject.should == 'Test'
 
-          describe '#transform' do
-            it 'should return a mail message' do
-              messages = service.transform(params('valid'))
-              messages.size.should == 1
-              message = messages[0]
-
-              # Headers
-              message.date.should    == DateTime.parse('Mon, 15 Apr 2013 20:20:12 -04:00')
-              message.from.should    == ['james@opennorth.ca']
-              message.to.should      == ['5dae6f85cd65d30d384a@cloudmailin.net']
-              message.subject.should == 'Test'
-
-              # Body
-              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"
-
-              # @note Due to a Cloudmailin bug, the HTML part is missing content
-              #   unless you use the "raw" HTTP POST format.
-              if actual_http_post_format == 'raw'
-                html_part.body.decoded.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><html><body style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space; "><head></head><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><body style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space; "><br><div><b></b></div><div><b><span class="Apple-style-span" style="font-weight: normal; "><br></span></b></div><div><b><span class="Apple-style-span" style="font-weight: normal; "><i>some italic text</i></span></b></div><div><b><span class="Apple-style-span" style="font-weight: normal; "><br></span></b></div><div><blockquote type="cite">multiline</blockquote><blockquote type="cite">quoted</blockquote><blockquote type="cite">text</blockquote></div><div><br></div><div>--</div><div>Signature block</div></body></html>)
-              else
-                html_part.body.decoded.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>)
-              end
-
-              # Attachments
-              attachment0 = message.attachments.find{|attachment| attachment.filename == 'foo.txt'}
-              attachment1 = message.attachments.find{|attachment| attachment.filename == 'bar.txt'}
-              # @note Cloudmailin removes the newline at the end of the file,
-              #   unless you use the "raw" HTTP POST format.
-              if actual_http_post_format == 'raw'
-                attachment0.read.should == "Lorem ipsum dolor sit amet, consectetur adipiscing elit.\n"
-                attachment1.read.should == "Nam accumsan euismod eros et rhoncus.\n"
-              else
-                attachment0.read.should == "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
-                attachment1.read.should == "Nam accumsan euismod eros et rhoncus."
-              end
-
-              # Extra Cloudmailin parameters
-              if actual_http_post_format == 'raw'
-                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"
-              end
-              message['spf-result'].value.should == 'pass'
+            # Body
+            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"
+
+            # @note Due to a Cloudmailin bug, the HTML part is missing content
+            #   unless you use the "raw" HTTP POST format or URL attachments.
+            if actual_http_post_format == 'raw' || attachment_store
+              html_part.body.decoded.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><html><body style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space; "><head></head><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><body style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space; "><br><div><b></b></div><div><b><span class="Apple-style-span" style="font-weight: normal; "><br></span></b></div><div><b><span class="Apple-style-span" style="font-weight: normal; "><i>some italic text</i></span></b></div><div><b><span class="Apple-style-span" style="font-weight: normal; "><br></span></b></div><div><blockquote type="cite">multiline</blockquote><blockquote type="cite">quoted</blockquote><blockquote type="cite">text</blockquote></div><div><br></div><div>--</div><div>Signature block</div></body></html>)
+            else
+              html_part.body.decoded.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>)
             end
-          end
 
-          describe '#spam?' do
-            it 'should return true if the response is spam' do
-              message = service.transform(params('spam'))[0]
-              service.spam?(message).should == true
+            # Attachments
+            attachment0 = message.attachments.find{|attachment| attachment.filename == 'foo.txt'}
+            attachment1 = message.attachments.find{|attachment| attachment.filename == 'bar.txt'}
+            # @note Cloudmailin removes the newline at the end of the file,
+            #   unless you use the "raw" HTTP POST format or URL attachments.
+            if actual_http_post_format == 'raw' || attachment_store
+              attachment0.read.should == "Lorem ipsum dolor sit amet, consectetur adipiscing elit.\n"
+              attachment1.read.should == "Nam accumsan euismod eros et rhoncus.\n"
+            else
+              attachment0.read.should == "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
+              attachment1.read.should == "Nam accumsan euismod eros et rhoncus."
             end
 
-            it 'should return false if the response is ham' do
-              message = service.transform(params('valid'))[0]
-              service.spam?(message).should == false
+            # Extra Cloudmailin parameters
+            if actual_http_post_format == 'raw'
+              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"
             end
+            message['spf-result'].value.should == 'pass'
+          end
+        end
+
+        describe '#spam?' do
+          it 'should return true if the response is spam' do
+            message = service.transform(params('spam'))[0]
+            service.spam?(message).should == true
+          end
+
+          it 'should return false if the response is ham' do
+            message = service.transform(params('valid'))[0]
+            service.spam?(message).should == false
           end
         end
       end