griddler 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25118b339d00976897148f6999e07b31a7b430e5
-  data.tar.gz: 10c89b94dd65253620018490b1b84290885ee9b1
+  metadata.gz: 3573025fb9bfe09cc1746e637a3992d7349d58e5
+  data.tar.gz: 1c818804c1f63e95613531fc79afba41c5964213
 SHA512:
-  metadata.gz: d33d3fac3fdad15c1ee4b1aa957fa667f52d5aad4c17f5aa7572b0199c33598a283689837192f9373faff4dd32b1ac951e8fceda4db7de27ed530d5da946806c
-  data.tar.gz: dd09ef830ab90a1e6cebbef4cefc744cb0ae94a1a21cf644ad6a93b3052a667b05683045202a607a8117caa7cb94a3b2efd6b43a7e06b8b194d6c082237b1188
+  metadata.gz: c3c628a41d84ee8f0319b0d4016916c60f50b42e97b0358a5772bd79301d67b132b8712525f18aca403b1e6b9636fe28aef1f2d629a1f7c3da969b2ce1e1d19d
+  data.tar.gz: 951ecc70b7cf18c8b8ef81b303098ff5139a64f15c7fa0c8b70d0d631a44f86b59478c031881b6e1b957ab8e44b07114840a3687a470c14666051f6e0b9470d2

data/README.md

@@ -8,8 +8,9 @@ Griddler
 
 Griddler is a Rails engine (full plugin) that provides an endpoint for the
 [SendGrid parse api](http://sendgrid.com/docs/API%20Reference/Webhooks/parse.html),
-[Cloudmailin parse api](http://cloudmailin.com) or
-[Postmark parse api](http://developer.postmarkapp.com/developer-inbound-parse.html)
+[Cloudmailin parse api](http://cloudmailin.com),
+[Postmark parse api](http://developer.postmarkapp.com/developer-inbound-parse.html) or
+[Mandrill parse api](http://help.mandrill.com/entries/21699367-Inbound-Email-Processing-Overview)
 that hands off a built email object to a class implemented by you.
 
 Tutorials
@@ -62,6 +63,8 @@ that responds to:
 * `.from`
 * `.subject`
 * `.body`
+* `.raw_text`
+* `.raw_html`
 * `.raw_body`
 * `.attachments`
 * `.headers`
@@ -95,7 +98,7 @@ are shown below with sample overrides following. In `config/initializer/griddler
 ```ruby
 Griddler.configure do |config|
   config.processor_class = EmailProcessor # MyEmailProcessor
-  config.to = :token # :raw, :email, :hash
+  config.to = :token # :full, :email, :hash
   # :raw    => 'AppName <s13.6b2d13dc6a1d33db7644@mail.myapp.com>'
   # :email  => 's13.6b2d13dc6a1d33db7644@mail.myapp.com'
   # :token  => 's13.6b2d13dc6a1d33db7644'
@@ -111,18 +114,19 @@ end
 the email object. `:hash` will return all options within a -- (surprise!) -- hash.
 * `config.email_service` tells Griddler which email service you are using. The supported
 email service options are `:sendgrid` (the default), `:cloudmailin` (expects
-multipart format) and `:postmark`.
+multipart format), `:postmark` and `:mandrill`.
 
 Testing In Your App
 -------------------
 
 You may want to create a factory for when testing the integration of Griddler into
-your application. If you're using factory_girl this can be accomplished with the
+your application. If you're using factory\_girl this can be accomplished with the
 following sample factory.
 
 ```ruby
 factory :email, class: OpenStruct do
-  to 'email-token'
+  # Assumes Griddler.configure.to is :hash (default)
+  to [{ raw: 'to_user@email.com', email: 'to_user@email.com', token: 'to_user', host: 'email.com' }]
   from 'user@email.com'
   subject 'email subject'
   body 'Hello!'
@@ -164,6 +168,57 @@ of your adapter returns a hash with these keys:
 * `:charsets` (optional) A JSON string containing the character sets of the
   fields extracted from the message
 
+Upgrading to Griddler 0.5.0
+---------------------------
+
+Because of an issue with the way Griddler handled recipients in the `To` header,
+a breaking change was introduced in Griddler 0.5.0 that requires a minor change
+to `EmailProcessor` or `processor_class`.
+
+Previously, a single address was returned from `Griddler::Email#to`. Moving
+forward, this field will always be an array. Generally speaking, you will want
+to do something like this to handle the change:
+
+```ruby
+# before
+def initialize(email)
+  @to = email.to
+  @from = email.from
+  @body = email.body
+end
+
+# after
+def initialize(email)
+  @to = pick_meaningful_recipient(email.to)
+  @from = email.from
+  @body = email.body
+end
+
+private
+
+def pick_meaningful_recipient(recipients)
+  recipients.find { |address| address =~ /@mydomain.com$/ }
+end
+```
+
+Using Griddler with Mandrill
+----------------------------
+
+When adding a webhook in their administration panel, Mandrill will issue a HEAD
+request to check if the webhook is valid (see
+[Adding Routes](http://help.mandrill.com/entries/21699367-Inbound-Email-Processing-Overview)).
+If the HEAD request fails, Mandrill will not allow you to add the webhook.
+Since Griddler is only configured to handle POST requests, you will not be able
+to add the webhook as-is. To solve this, add a temporary route to your
+application that can handle the HEAD request:
+
+```ruby
+# routes.rb
+get '/email_processor', :to => proc { [200, {}, ["OK"]] }
+```
+
+Once you have correctly configured Mandrill, you can go ahead and delete this code.
+
 More Information
 ----------------
 
@@ -173,6 +228,8 @@ More Information
 * [Cloudmailin Docs](http://docs.cloudmailin.com/)
 * [Postmark](http://postmarkapp.com)
 * [Postmark Docs](http://developer.postmarkapp.com/)
+* [Mandrill](http://mandrill.com)
+* [Mandrill Docs](http://help.mandrill.com/forums/21092258-Inbound-Email-Processing)
 
 Credits
 -------

data/Rakefile

@@ -1,6 +1,7 @@
 #!/usr/bin/env rake
 begin
   require 'bundler/setup'
+  require 'bundler/gem_tasks'
 rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end

data/app/controllers/griddler/emails_controller.rb

@@ -1,12 +1,14 @@
 class Griddler::EmailsController < ActionController::Base
   def create
-    Griddler::Email.new(normalized_params).process
+    normalized_params.each do |p|
+      Griddler::Email.new(p).process
+    end
     head :ok
   end
 
   private
 
   def normalized_params
-    Griddler.configuration.email_service.normalize_params(params)
+    Array.wrap(Griddler.configuration.email_service.normalize_params(params))
   end
 end

data/lib/griddler.rb

@@ -8,6 +8,7 @@ require 'griddler/configuration'
 require 'griddler/adapters/sendgrid_adapter'
 require 'griddler/adapters/cloudmailin_adapter'
 require 'griddler/adapters/postmark_adapter'
+require 'griddler/adapters/mandrill_adapter'
 
 module Griddler
 end

data/lib/griddler/adapters/cloudmailin_adapter.rb

@@ -12,7 +12,7 @@ module Griddler
 
       def normalize_params
         {
-          to: params[:envelope][:to],
+          to: params[:envelope][:to].split(','),
           from: params[:envelope][:from],
           subject: params[:headers][:Subject],
           text: params[:plain],

data/lib/griddler/adapters/mandrill_adapter.rb

@@ -0,0 +1,70 @@
+module Griddler
+  module Adapters
+    class MandrillAdapter
+      def initialize(params)
+        @params = params
+      end
+
+      def self.normalize_params(params)
+        adapter = new(params)
+        adapter.normalize_params
+      end
+
+      def normalize_params
+        events.map do |event|
+          {
+            to: recipients(event),
+            from: event[:from_email],
+            subject: event[:subject],
+            text: event[:text],
+            html: event[:html],
+            raw_body: event[:raw_msg],
+            attachments: attachment_files(event)
+          }
+        end
+      end
+
+      private
+
+      attr_reader :params
+
+      def events
+        @events ||= ActiveSupport::JSON.decode(params[:mandrill_events]).map do |event|
+          event['msg'].with_indifferent_access
+        end
+      end
+
+      def recipients(event)
+        event[:to].map { |recipient| full_email(recipient) }
+      end
+
+      def full_email(contact_info)
+        email = contact_info[0]
+        if contact_info[1]
+          "#{contact_info[1]} <#{email}>"
+        else
+          email
+        end
+      end
+
+      def attachment_files(event)
+        attachments = event[:attachments] || Array.new
+        attachments.map do |key, attachment|
+          ActionDispatch::Http::UploadedFile.new({
+            filename: attachment[:name],
+            type: attachment[:type],
+            tempfile: create_tempfile(attachment)
+          })
+        end
+      end
+
+      def create_tempfile(attachment)
+        filename = attachment[:name]
+        tempfile = Tempfile.new(filename, Dir::tmpdir, encoding: 'ascii-8bit')
+        tempfile.write(Base64.decode64(attachment[:content]))
+        tempfile.rewind
+        tempfile
+      end
+    end
+  end
+end

data/lib/griddler/adapters/postmark_adapter.rb

@@ -12,7 +12,7 @@ module Griddler
 
       def normalize_params
         {
-          to: full_email(params[:ToFull].first),
+          to: extract_recipients,
           from: params[:FromFull][:Email],
           subject: params[:Subject],
           text: params[:TextBody],
@@ -25,6 +25,10 @@ module Griddler
 
       attr_reader :params
 
+      def extract_recipients
+        params[:ToFull].map { |recipient| full_email(recipient) }
+      end
+
       def full_email(contact_info)
         email = contact_info[:Email]
         if contact_info[:Name].present?

data/lib/griddler/adapters/sendgrid_adapter.rb

@@ -11,14 +11,20 @@ module Griddler
       end
 
       def normalize_params
-        params[:attachments] = attachment_files
-        params
+        params.merge(
+          to: recipients,
+          attachments: attachment_files,
+        )
       end
 
       private
 
       attr_reader :params
 
+      def recipients
+        params[:to].split(',')
+      end
+
       def attachment_files
         params.delete('attachment-info')
         attachment_count = params[:attachments].to_i

data/lib/griddler/configuration.rb

@@ -16,10 +16,21 @@ module Griddler
   end
 
   class Configuration
-    attr_accessor :processor_class, :reply_delimiter, :to
+    attr_accessor :processor_class, :reply_delimiter
 
     def to
-      @to ||= :token
+      @to ||= :hash
+    end
+
+    def to=(type)
+      if type == :token
+        Kernel.warn <<-WARN.strip_heredoc
+          [Deprecation] the :token option is deprecated and will be removed in v0.6.
+          For tokens use :hash and retrieve the token from email.to[:token] or choose any of [:email, :full, :hash]
+        WARN
+      end
+
+      @to = type
     end
 
     def processor_class
@@ -45,6 +56,7 @@ module Griddler
         sendgrid: Griddler::Adapters::SendgridAdapter,
         cloudmailin: Griddler::Adapters::CloudmailinAdapter,
         postmark: Griddler::Adapters::PostmarkAdapter,
+        mandrill: Griddler::Adapters::MandrillAdapter,
       }
     end
   end

data/lib/griddler/email.rb

@@ -3,18 +3,20 @@ require 'htmlentities'
 module Griddler
   class Email
     include ActionView::Helpers::SanitizeHelper
-    attr_reader :to, :from, :subject, :body, :raw_body,
+    attr_reader :to, :from, :subject, :body, :raw_body, :raw_text, :raw_html,
       :headers, :raw_headers, :attachments
 
     def initialize(params)
       @params = params
 
-      @to = extract_address(params[:to], config.to)
+      @to = recipients
       @from = extract_address(params[:from], :email)
       @subject = params[:subject]
 
       @body = extract_body
-      @raw_body = params[:text] || params[:html]
+      @raw_text = params[:text]
+      @raw_html = params[:html]
+      @raw_body = @raw_text || @raw_html
 
       @headers = extract_headers
       @raw_headers = params[:headers]
@@ -35,6 +37,10 @@ module Griddler
       Griddler.configuration
     end
 
+    def recipients
+      params[:to].map { |recipient| extract_address(recipient, config.to) }
+    end
+
     def extract_address(address, type)
       parsed = EmailParser.parse_address(address)
 

data/lib/griddler/version.rb

@@ -1,3 +1,3 @@
 module Griddler
-  VERSION = "0.4.1"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: griddler
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Caleb Thompson
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-26 00:00:00.000000000 Z
+date: 2013-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -96,6 +96,7 @@ files:
 - config/initializers/griddler.rb
 - config/routes.rb
 - lib/griddler/adapters/cloudmailin_adapter.rb
+- lib/griddler/adapters/mandrill_adapter.rb
 - lib/griddler/adapters/postmark_adapter.rb
 - lib/griddler/adapters/sendgrid_adapter.rb
 - lib/griddler/configuration.rb
@@ -112,7 +113,10 @@ files:
 homepage: http://thoughtbot.com
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message: |
+  When upgrading from a Griddler version previous to 0.5.0, it is important that
+  you view https://github.com/thoughtbot/griddler/#upgrading-to-griddler-050 for
+  upgrade information.
 rdoc_options: []
 require_paths:
 - app