multi_mail 0.0.2 → 0.1.0

data/lib/multi_mail/mailgun/receiver.rb

@@ -1,11 +1,10 @@
 module MultiMail
   module Receiver
     # Mailgun's incoming email receiver.
-    class Mailgun < MultiMail::Service
+    class Mailgun
       include MultiMail::Receiver::Base
 
-      requires :mailgun_api_key
-      recognizes :http_post_format
+      recognizes :mailgun_api_key, :http_post_format
 
       # Initializes a Mailgun incoming email receiver.
       #
@@ -25,9 +24,11 @@ module MultiMail
       # @raise [IndexError] if the request is missing parameters
       # @see http://documentation.mailgun.net/user_manual.html#securing-webhooks
       def valid?(params)
-        params.fetch('signature') == OpenSSL::HMAC.hexdigest(
-          OpenSSL::Digest::Digest.new('sha256'), @mailgun_api_key,
-          '%s%s' % [params.fetch('timestamp'), params.fetch('token')])
+        if @mailgun_api_key
+          params.fetch('signature') == signature(params)
+        else
+          super
+        end
       end
 
       # Transforms the content of Mailgun's webhook into a list of messages.
@@ -39,12 +40,10 @@ module MultiMail
       def transform(params)
         case @http_post_format
         when 'parsed', '', nil
-          headers = Multimap.new
-          JSON.parse(params['message-headers']).each do |key,value|
-            headers[key] = value
-          end
-
+          # Mail changes `self`.
+          headers = self.class.multimap(JSON.load(params['message-headers']))
           this = self
+
           message = Mail.new do
             headers headers
 
@@ -71,7 +70,7 @@ module MultiMail
             end
 
             if params.key?('attachment-count')
-              1.upto(params['attachment-count'].to_i).each do |n|
+              1.upto(params['attachment-count'].to_i) do |n|
                 attachment = params["attachment-#{n}"]
                 add_file(this.class.add_file_arguments(attachment))
               end
@@ -99,7 +98,8 @@ module MultiMail
 
           [message]
         when 'raw'
-          [Mail.new(params['body-mime'])]
+          message = self.class.condense(Mail.new(params['body-mime']))
+          [message]
         else
           raise ArgumentError, "Can't handle Mailgun #{@http_post_format} HTTP POST format"
         end
@@ -117,6 +117,13 @@ module MultiMail
       def spam?(message)
         message['X-Mailgun-Sflag'] && message['X-Mailgun-Sflag'].value == 'Yes'
       end
+
+    private
+
+      def signature(params)
+        data = "#{params.fetch('timestamp')}#{params.fetch('token')}"
+        OpenSSL::HMAC.hexdigest('sha256', @mailgun_api_key, data)
+      end
     end
   end
 end

data/lib/multi_mail/mailgun/sender.rb

@@ -1,13 +1,90 @@
+require 'multi_mail/mailgun/message'
+
 module MultiMail
   module Sender
-    class Mailgun < MultiMail::Service
+    # Mailgun's outgoing mail sender.
+    class Mailgun
       include MultiMail::Sender::Base
 
-      #requires :
+      requires :api_key, :domain
+
+      attr_reader :api_key, :domain
 
+      # Initializes a Mailgun outgoing email sender.
+      #
       # @param [Hash] options required and optional arguments
+      # @option options [String] :api_key a Mailgun API key
       def initialize(options = {})
         super
+        @api_key = settings.delete(:api_key)
+        @domain  = settings.delete(:domain)
+      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)
+
+        [:opens, :clicks].each do |sym|
+          if tracking.key?(sym)
+            parameter = :"o:tracking-#{sym}"
+            case tracking[sym]
+            when 'yes', 'no', 'htmlonly'
+              parameters[parameter] = tracking[sym]
+            when true
+              parameters[parameter] = 'yes'
+            when false
+              parameters[parameter] = 'no'
+            end # ignore nil
+          end
+        end
+
+        parameters
+      end
+
+      # Delivers a message via the Mailgun API.
+      #
+      # @param [Mail::Message] mail a message
+      def deliver!(mail)
+        message = MultiMail::Message::Mailgun.new(mail).to_mailgun_hash.merge(parameters)
+
+        connection = Faraday.new do |conn|
+          conn.basic_auth 'api', api_key
+          conn.request :multipart
+          conn.request :url_encoded
+          conn.adapter Faraday.default_adapter
+        end
+
+        response = connection.post("https://api.mailgun.net/v2/#{domain}/messages", message)
+
+        case response.status
+        when 401
+          raise InvalidAPIKey, response.body
+        when 400
+          body = JSON.load(response.body)
+          case body['message']
+          when "'from' parameter is missing"
+            raise MissingSender, body['message']
+          when "'to' parameter is missing"
+            raise MissingRecipients, body['message']
+          when "Need at least one of 'text' or 'html' parameters specified"
+            raise MissingBody, body['message']
+          else
+            raise InvalidMessage, body['message']
+          end
+        when 200
+          body = JSON.load(response.body)
+        else
+          raise response.body
+        end
+
+        if settings[:return_response]
+          body
+        else
+          self
+        end
       end
     end
   end

data/lib/multi_mail/mandrill/message.rb

@@ -0,0 +1,74 @@
+module MultiMail
+  module Message
+    # @see https://mandrillapp.com/api/docs/messages.ruby.html#method-send
+    class Mandrill < MultiMail::Message::Base
+      # Returns the To header in Mandrill format.
+      #
+      # @return [Array<Hash>] the To header in Mandrill format
+      def mandrill_to
+        if to
+          to.each_with_index.map do |value,index|
+            {
+              'email' => value,
+              'name'  => self[:to].display_names[index]
+            }
+          end
+        else
+          []
+        end
+      end
+
+      # Returns the message headers in Mandrill format.
+      #
+      # @return [Hash] the message headers in Mandrill format
+      def mandrill_headers
+        headers = {}
+        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
+          end
+        end
+        headers
+      end
+
+      # Returns the message's attachments in Mandrill format.
+      #
+      # @return [Array<Faraday::UploadIO>] the attachments in Mandrill format
+      def mandrill_attachments
+        attachments.map do |attachment|
+          {
+            'type'    => attachment.content_type,
+            'name'    => attachment.filename,
+            'content' => Base64.encode64(attachment.body.decoded)
+          }
+        end
+      end
+
+      # Returns the message as parameters to POST to Mandrill.
+      #
+      # @return [Hash] the message as parameters to POST to Mandrill
+      def to_mandrill_hash
+        images, attachments = mandrill_attachments.partition do |attachment|
+          attachment['type'].start_with?('image/')
+        end
+
+        hash = {
+          'html'        => body_html,
+          'text'        => body_text,
+          'subject'     => subject,
+          'from_email'  => from && from.first,
+          'from_name'   => from && self[:from].display_names.first,
+          'to'          => mandrill_to,
+          'headers'     => mandrill_headers,
+          'attachments' => attachments,
+          'images'      => images,
+        }
+
+        normalize(hash)
+      end
+    end
+  end
+end

data/lib/multi_mail/mandrill/receiver.rb

@@ -5,10 +5,10 @@ module MultiMail
     # Mandrill uses an HTTP header to ensure a request originates from Mandrill.
     #
     # @see http://help.mandrill.com/entries/23704122-Authenticating-webhook-requests
-    class Mandrill < MultiMail::Service
+    class Mandrill
       include MultiMail::Receiver::Base
 
-      recognizes :spamassassin_threshold
+      recognizes :spamassassin_threshold, :mandrill_webhook_key, :mandrill_webhook_url
 
       # Initializes a Mandrill incoming email receiver.
       #
@@ -18,6 +18,22 @@ module MultiMail
       def initialize(options = {})
         super
         @spamassassin_threshold = options[:spamassassin_threshold] || 5
+        @mandrill_webhook_key = options[:mandrill_webhook_key]
+        @mandrill_webhook_url = options[:mandrill_webhook_url]
+      end
+
+      # Returns whether a request originates from Mandrill.
+      #
+      # @param [Hash] params the content of Mandrill's webhook
+      # @return [Boolean] whether the request originates from Mailgun
+      # @raise [IndexError] if the request is missing parameters
+      # @see http://help.mandrill.com/entries/23704122-Authenticating-webhook-requests
+      def valid?(params)
+        if @mandrill_webhook_url && @mandrill_webhook_key
+          params.fetch('env').fetch('HTTP_X_MANDRILL_SIGNATURE') == signature(params)
+        else
+          super
+        end
       end
 
       # Transforms the content of Mandrill's webhook into a list of messages.
@@ -27,23 +43,15 @@ module MultiMail
       # @see http://help.mandrill.com/entries/22092308-What-is-the-format-of-inbound-email-webhooks-
       def transform(params)
         # JSON is necessarily UTF-8.
-        JSON.parse(params['mandrill_events']).select do |event|
+        JSON.load(params['mandrill_events']).select do |event|
           event.fetch('event') == 'inbound'
         end.map do |event|
           msg = event['msg']
 
-          headers = Multimap.new
-          msg['headers'].each do |key,value|
-            if Array === value
-              value.each do |v|
-                headers[key] = v
-              end
-            else
-              headers[key] = value
-            end
-          end
-
+          # Mail changes `self`.
+          headers = self.class.multimap(msg['headers'])
           this = self
+
           message = Mail.new do
             headers headers
 
@@ -88,8 +96,8 @@ module MultiMail
 
           # Extra Mandrill parameters. Discard `sender` and `tags`, which are
           # null according to the docs, `matched_rules` within `spam_report`,
-          # `detail` within `spf`, which is just a human-readable version of
-          # `result`, and `raw_msg`.
+          # 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
@@ -108,6 +116,18 @@ module MultiMail
       def spam?(message)
         message['spam_report-score'] && message['spam_report-score'].value.to_f > @spamassassin_threshold
       end
+
+    private
+
+      def signature(params)
+        data = @mandrill_webhook_url
+        params.sort.each do |key,value|
+          unless key == 'env'
+            data += "#{key}#{value}"
+          end
+        end
+        Base64.encode64(OpenSSL::HMAC.digest('sha1', @mandrill_webhook_key, data)).strip
+      end
     end
   end
 end

data/lib/multi_mail/mandrill/sender.rb

@@ -1,13 +1,88 @@
+require 'multi_mail/mandrill/message'
+
 module MultiMail
   module Sender
-    class Mandrill < MultiMail::Service
+    # Mandrill's outgoing mail sender.
+    class Mandrill
       include MultiMail::Sender::Base
 
-      #requires :
+      requires :api_key
+
+      attr_reader :api_key, :async, :ip_pool, :send_at
 
+      # Initializes a Mandrill outgoing email sender.
+      #
       # @param [Hash] options required and optional arguments
+      # @option options [String] :api_key a Mandrill API key
+      # @see https://mandrillapp.com/api/docs/index.ruby.html
       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)
+      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)
+
+        [:opens, :clicks].each do |sym|
+          if tracking.key?(sym)
+            parameter = :"track_#{sym}"
+            case tracking[sym]
+            when true, false, nil
+              parameters[parameter] = tracking[sym]
+            when 'yes'
+              parameters[parameter] = true
+            when 'no'
+              parameters[parameter] = false
+            end # ignore "htmlonly"
+          end
+        end
+
+        parameters
+      end
+
+      # Delivers a message via the Mandrill API.
+      #
+      # @param [Mail::Message] mail a message
+      # @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)
+        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({
+          :key     => api_key,
+          :message => message,
+          :async   => async,
+          :ip_pool => ip_pool,
+          :send_at => send_at,
+        }))
+
+        body = JSON.load(response.body)
+
+        unless response.status == 200
+          if body['status'] == 'error'
+            case body['name']
+            when 'Invalid_Key'
+              raise InvalidAPIKey, body['message']
+            else
+              raise body['message']
+            end
+          else
+            raise body['message']
+          end
+        end
+
+        if settings[:return_response]
+          body
+        else
+          self
+        end
       end
     end
   end

data/lib/multi_mail/message/base.rb

@@ -0,0 +1,40 @@
+module MultiMail
+  module Message
+    class Base < Mail::Message
+      # @see https://github.com/wildbit/postmark-gem/blob/master/lib/postmark/message_extensions/mail.rb
+      def html?
+        !!content_type && content_type.include?('text/html')
+      end
+
+      def body_html
+        if html_part
+          html_part.body.decoded
+        elsif html?
+          body.decoded
+        end
+      end
+
+      def body_text
+        if text_part
+          text_part.body.decoded
+        elsif !html?
+          body.decoded
+        end
+      end
+
+    private
+
+      def normalize(hash)
+        hash.delete_if do |_,value|
+          value.nil? || value.empty? || Array === value && value.all?{|v| v.nil?}
+        end
+
+        hash.keys.each do |key| # based on Hash#symbolize_keys! from Rails
+          hash[(key.to_sym rescue key) || key] = hash.delete(key)
+        end
+
+        hash
+      end
+    end
+  end
+end

data/lib/multi_mail/postmark/receiver.rb

@@ -1,7 +1,7 @@
 module MultiMail
   module Receiver
     # Postmark's incoming email receiver.
-    class Postmark < MultiMail::Service
+    class Postmark
       include MultiMail::Receiver::Base
 
       def transform(params)

data/lib/multi_mail/postmark/sender.rb

@@ -1,13 +1,43 @@
+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
-    class Postmark < MultiMail::Service
+    # Postmark's outgoing mail sender.
+    class Postmark
       include MultiMail::Sender::Base
 
-      #requires :
+      # @see https://github.com/wildbit/postmark-gem#communicating-with-the-api
+      requires :api_key
+
+      # 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
+      def deliver!(mail)
+        mail.delivery_method Mail::Postmark, settings
 
-      # @param [Hash] options required and optional arguments
-      def initialize(options = {})
-        super
+        if settings[:return_response]
+          mail.deliver!
+        else
+          mail.deliver
+        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
+        else
+          raise InvalidMessage, e.message
+        end
       end
     end
   end

data/lib/multi_mail/receiver/base.rb

@@ -7,10 +7,18 @@ module MultiMail
     module Base
       def self.included(subclass)
         subclass.class_eval do
+          extend MultiMail::Service
           extend MultiMail::Receiver::Base::ClassMethods
         end
       end
 
+      # Initializes an incoming email receiver.
+      #
+      # @param [Hash] options required and optional arguments
+      def initialize(options = {})
+        self.class.validate_options(options)
+      end
+
       # Ensures a request is authentic, parses it into a params hash, and
       # transforms it into a list of messages.
       #
@@ -66,6 +74,24 @@ module MultiMail
           end
         end
 
+        # Converts a hash or array to a multimap.
+        #
+        # @param [Hash,Array] object a hash or array
+        # @return [Multimap] a multimap
+        def multimap(object)
+          multimap = Multimap.new
+          object.each do |key,value|
+            if Array === value
+              value.each do |v|
+                multimap[key] = v
+              end
+            else
+              multimap[key] = value
+            end
+          end
+          multimap
+        end
+
         # Parses raw POST data into a params hash.
         #
         # @param [String,Hash] raw raw POST data or a params hash
@@ -74,7 +100,7 @@ module MultiMail
           case raw
           when String
             begin
-              JSON.parse(raw)
+              JSON.load(raw)
             rescue JSON::ParserError
               params = CGI.parse(raw)
 
@@ -107,7 +133,10 @@ module MultiMail
 
             params
           when Rack::Request
-            raw.params
+            env = raw.env.dup
+            env.delete('rack.input')
+            env.delete('rack.errors')
+            {'env' => env}.merge(raw.params)
           when Hash
             raw
           else

data/lib/multi_mail/receiver.rb

@@ -14,7 +14,7 @@ module MultiMail
     #
     # @param [Hash] attributes required arguments
     # @option attributes [String,Symbol] :provider a provider
-    # @return [MultiMail::Service] an incoming email receiver
+    # @return an incoming email receiver
     # @raise [ArgumentError] if the provider does not exist
     # @see Fog::Storage::new
     def self.new(attributes)
@@ -38,9 +38,6 @@ module MultiMail
       when :simple
         require 'multi_mail/simple/receiver'
         MultiMail::Receiver::Simple.new(attributes)
-      when :mock
-        # for testing
-        MultiMail::Receiver::Mock.new(attributes)
       else
         raise ArgumentError.new("#{provider} is not a recognized provider")
       end

data/lib/multi_mail/sender/base.rb

@@ -1,7 +1,29 @@
 module MultiMail
   module Sender
-    # Abstract class for outgoing email services.
+    # Abstract class for outgoing email senders.
     module Base
+      def self.included(subclass)
+        subclass.class_eval do
+          extend MultiMail::Service
+        end
+      end
+
+      attr_reader :settings, :tracking
+
+      # Initializes an outgoing email sender.
+      #
+      # @param [Hash] options required and optional arguments
+      def initialize(options = {})
+        @settings = {}
+
+        options.keys.each do |key| # based on Hash#symbolize_keys! from Rails
+          settings[(key.to_sym rescue key) || key] = options[key]
+        end
+
+        self.class.validate_options(settings, false)
+
+        @tracking = settings.delete(:track) || {}
+      end
     end
   end
 end