griddler 0.6.1 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01c15f81e30fcd63ca2c9cb4bc9e2e8678264c5f
-  data.tar.gz: 37a8b24a5ce5b94ef4e7f7d907298abfb3517cd2
+  metadata.gz: c93ac0eaccf2bf366151a3d202d31fb80c955e3a
+  data.tar.gz: 7966242ad3ac5d8566b8ed991b3b1118f266d88d
 SHA512:
-  metadata.gz: 44c21089a2ede6e88242b9e6b24fc38bda03bc0a0dbcbf92e74e0a4a792d000cc374bcbb1da8e99bc922e934dbf8fa4506c164034293ebb482c62c80c1a8ece0
-  data.tar.gz: 82704ef5699bc9c2b5c8fa1f274a21f37bb63993f6da44d74f273414d4464c2fea834464afe1f77919c1bd9a88abeb46ea7adeeb4676feaa8aa19562cf2d8a15
+  metadata.gz: 42e335e21700230465f2f60b9148cb0bd7188c5b99c86421d8bb06d3e34f8c4658a0b871c1248d5620a1edf4b1cb59e200bc961b0df5571c0698eda403894fc6
+  data.tar.gz: 40fdce0ad4cdd2e3644b40a253bf427e1b724c70831c36ae02ddd07b4efc07b835fda1e48537d7cca073f2d5d08a105d7a4c23144e870fb5e33ad10f5ce32af0

data/README.md

@@ -11,6 +11,7 @@ Griddler is a Rails engine (full plugin) that provides an endpoint for the
 [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)
+[Mailgun routes](http://documentation.mailgun.com/user_manual.html#receiving-messages-via-http-through-a-forward-action)
 that hands off a built email object to a class implemented by you.
 
 Tutorials
@@ -30,9 +31,18 @@ Add griddler to your application's Gemfile and run `bundle install`:
 ```ruby
 gem 'griddler'
 ```
+A route is needed for the endpoint which receives `POST` messages. Currently,
+the route is automatically appended to the route table like so:
 
-In `config/routes.rb` you may either use the provided method `mount_griddler`
-or set the route manually. Examples:
+```ruby
+email_processor POST /email_processor(.:format)   griddler/emails#create
+```
+
+**NOTE: This behavior is deprecated and will be removed by version 0.7.0 in favor
+of manually adding the route.**
+
+To manually add the route, in `config/routes.rb` you may either use the provided
+routing method `mount_griddler` or set the route explicitly. Examples:
 
 ```ruby
 # mount using default path
@@ -45,11 +55,6 @@ mount_griddler('/email/incoming')
 post '/email_processor' => 'griddler/emails#create'
 ```
 
-**NOTE:** Currently the default route is added to the bottom of your route table.
-By version 0.7.0 it will be removed and you will be required to add the route
-with one of the three above methods.
-
-
 Defaults
 --------
 
@@ -71,6 +76,7 @@ that responds to:
 
 * `.to`
 * `.from`
+* `.cc`
 * `.subject`
 * `.body`
 * `.raw_text`
@@ -108,6 +114,9 @@ information of each recipient:
 `.from` will default to the `email` value of a hash like `.to`, and can be
 configured to return the full hash.
 
+`.cc` behaves and can be configured like `.to`. If the adapter does not
+pass along a `cc` key then the headers will be parsed.
+
 `.attachments` will contain an array of attachments as multipart/form-data files
 which can be passed off to attachment libraries like Carrierwave or Paperclip.
 
@@ -118,26 +127,28 @@ Configuration Options
 ---------------------
 
 An initializer can be created to control some of the options in Griddler. Defaults
-are shown below with sample overrides following. In `config/initializer/griddler.rb`:
+are shown below with sample overrides following. In `config/initializers/griddler.rb`:
 
 ```ruby
 Griddler.configure do |config|
   config.processor_class = EmailProcessor # MyEmailProcessor
+  config.processor_method = :process # :custom_method
   config.to = :hash # :full, :email, :token
+  config.cc = :email # :full, :hash, :token
   config.from = :email # :full, :token, :hash
   # :raw    => 'AppName <s13.6b2d13dc6a1d33db7644@mail.myapp.com>'
   # :email  => 's13.6b2d13dc6a1d33db7644@mail.myapp.com'
   # :token  => 's13.6b2d13dc6a1d33db7644'
-  # :hash   => { raw: [...], email: [...], token: [...], host: [...],
-name: [...] }
+  # :hash   => { raw: [...], email: [...], token: [...], host: [...], name: [...] }
   config.reply_delimiter = '-- REPLY ABOVE THIS LINE --'
-  config.email_service = :sendgrid # :cloudmailin, :postmark, :mandrill
+  config.email_service = :sendgrid # :cloudmailin, :postmark, :mandrill, :mailgun
 end
 ```
 
 * `config.processor_class` is the class Griddler will use to handle your incoming emails.
+* `config.processor_method` is the method Griddler will call on the processor class when handling your incoming emails.
 * `config.reply_delimiter` is the string searched for that will split your body.
-* `config.to` and `config.from` are the format of the returned value for that
+* `config.to`, `config.cc` and `config.from` are the format of the returned value for that
   address in 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`
@@ -241,7 +252,7 @@ application that can handle the HEAD request:
 
 ```ruby
 # routes.rb
-get '/email_processor', :to => proc { [200, {}, ["OK"]] }
+get "/email_processor", to: proc { [200, {}, ["OK"]] }, as: "mandrill_head_test_request"
 ```
 
 Once you have correctly configured Mandrill, you can go ahead and delete this code.
@@ -257,6 +268,8 @@ More Information
 * [Postmark Docs](http://developer.postmarkapp.com/)
 * [Mandrill](http://mandrill.com)
 * [Mandrill Docs](http://help.mandrill.com/forums/21092258-Inbound-Email-Processing)
+* [Mailgun](http://mailgun.com)
+* [Mailgun Docs](http://documentation.mailgun.com/user_manual.html#receiving-forwarding-and-storing-messages)
 
 Credits
 -------

data/lib/griddler.rb

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

data/lib/griddler/adapters/cloudmailin_adapter.rb

@@ -13,6 +13,7 @@ module Griddler
       def normalize_params
         {
           to: params[:envelope][:to].split(','),
+          cc: ccs,
           from: params[:envelope][:from],
           subject: params[:headers][:Subject],
           text: params[:plain],
@@ -24,6 +25,10 @@ module Griddler
 
       attr_reader :params
 
+      def ccs
+        params[:headers][:Cc].to_s.split(',').map(&:strip)
+      end
+
     end
   end
 end

data/lib/griddler/adapters/mailgun_adapter.rb

@@ -0,0 +1,57 @@
+module Griddler
+  module Adapters
+    class MailgunAdapter
+      def initialize(params)
+        @params = params
+      end
+
+      def self.normalize_params(params)
+        adapter = new(params)
+        adapter.normalize_params
+      end
+
+      def normalize_params
+        params.merge(
+          to: recipients,
+          cc: ccs,
+          text: params['body-plain'],
+          html: params['body-html'],
+          headers: params['message-headers'],
+          attachments: attachment_files
+        )
+      end
+
+      private
+
+      attr_reader :params
+
+      def recipients
+        params[:recipient].split(',')
+      end
+
+      def ccs
+        cc = if params[:Cc].present?
+          params[:Cc]
+        else
+          extract_header_cc
+        end
+        cc.split(',').map(&:strip)
+      end
+
+      def extract_header_cc
+        header = params['message-headers'].select{|h|
+          h.first == 'Cc'
+        }.first
+        header.to_a.last
+      end
+
+      def attachment_files
+        attachment_count = params['attachment-count'].to_i
+
+        attachment_count.times.map do |index|
+          params.delete("attachment-#{index+1}")
+        end
+      end
+    end
+  end
+end

data/lib/griddler/adapters/mandrill_adapter.rb

@@ -14,7 +14,8 @@ module Griddler
         events.map do |event|
           {
             to: recipients(event),
-            from: event[:from_email],
+            cc: ccs(event),
+            from: full_email([ event[:from_email], event[:from_name] ]),
             subject: event[:subject],
             text: event[:text],
             html: event[:html],
@@ -38,6 +39,11 @@ module Griddler
         event[:to].map { |recipient| full_email(recipient) }
       end
 
+      def ccs(event)
+        found = event[:headers].select { |header| header.first == 'Cc' }.first
+        Array(found).last.to_s.split(',').map(&:strip)
+      end
+
       def full_email(contact_info)
         email = contact_info[0]
         if contact_info[1]

data/lib/griddler/adapters/postmark_adapter.rb

@@ -12,7 +12,8 @@ module Griddler
 
       def normalize_params
         {
-          to: extract_recipients,
+          to: extract_recipients(:ToFull),
+          cc: extract_recipients(:CcFull),
           from: full_email(params[:FromFull]),
           subject: params[:Subject],
           text: params[:TextBody],
@@ -25,8 +26,8 @@ module Griddler
 
       attr_reader :params
 
-      def extract_recipients
-        params[:ToFull].map { |recipient| full_email(recipient) }
+      def extract_recipients(key)
+        params[key].to_a.map { |recipient| full_email(recipient) }
       end
 
       def full_email(contact_info)

data/lib/griddler/adapters/sendgrid_adapter.rb

@@ -12,7 +12,8 @@ module Griddler
 
       def normalize_params
         params.merge(
-          to: recipients,
+          to: recipients(:to),
+          cc: recipients(:cc),
           attachments: attachment_files,
         )
       end
@@ -21,8 +22,8 @@ module Griddler
 
       attr_reader :params
 
-      def recipients
-        params[:to].split(',')
+      def recipients(key)
+        ( params[key] || '' ).split(',')
       end
 
       def attachment_files

data/lib/griddler/configuration.rb

@@ -16,7 +16,7 @@ module Griddler
   end
 
   class Configuration
-    attr_accessor :processor_class, :reply_delimiter, :from
+    attr_accessor :processor_class, :processor_method, :reply_delimiter, :cc, :from
 
     def to
       @to ||= :hash
@@ -33,6 +33,10 @@ module Griddler
       @to = type
     end
 
+    def cc
+      @cc ||= :email
+    end
+
     def from
       @from ||= :email
     end
@@ -41,6 +45,10 @@ module Griddler
       @processor_class ||= EmailProcessor
     end
 
+    def processor_method
+      @processor_method ||= :process
+    end
+
     def reply_delimiter
       @reply_delimiter ||= 'Reply ABOVE THIS LINE'
     end
@@ -65,6 +73,7 @@ module Griddler
         cloudmailin: Griddler::Adapters::CloudmailinAdapter,
         postmark: Griddler::Adapters::PostmarkAdapter,
         mandrill: Griddler::Adapters::MandrillAdapter,
+        mailgun: Griddler::Adapters::MailgunAdapter
       }
     end
   end

data/lib/griddler/email.rb

@@ -3,13 +3,13 @@ require 'htmlentities'
 module Griddler
   class Email
     include ActionView::Helpers::SanitizeHelper
-    attr_reader :to, :from, :subject, :body, :raw_body, :raw_text, :raw_html,
+    attr_reader :to, :from, :cc, :subject, :body, :raw_body, :raw_text, :raw_html,
       :headers, :raw_headers, :attachments
 
     def initialize(params)
       @params = params
 
-      @to = recipients
+      @to = recipients(:to)
       @from = extract_address(params[:from], config.from)
       @subject = params[:subject]
 
@@ -19,14 +19,18 @@ module Griddler
       @raw_body = @raw_text || @raw_html
 
       @headers = extract_headers
+
+      @cc = recipients(:cc)
+
       @raw_headers = params[:headers]
 
       @attachments = params[:attachments]
     end
 
     def process
-      processor_class = config.processor_class
-      processor_class.process(self)
+      processor_class  = config.processor_class
+      processor_method = config.processor_method
+      processor_class.public_send(processor_method, self)
     end
 
     private
@@ -34,11 +38,11 @@ module Griddler
     attr_reader :params
 
     def config
-      Griddler.configuration
+      @config ||= Griddler.configuration
     end
 
-    def recipients
-      params[:to].map { |recipient| extract_address(recipient, config.to) }
+    def recipients(type=:to)
+      params[type].to_a.map { |recipient| extract_address(recipient, config.send(type)) }
     end
 
     def extract_address(address, type)
@@ -59,6 +63,10 @@ module Griddler
       EmailParser.extract_headers(params[:headers])
     end
 
+    def extract_cc_from_headers(headers)
+      EmailParser.extract_cc(headers)
+    end
+
     def text_or_sanitized_html
       if params.key? :text
         clean_text(params[:text])
@@ -68,33 +76,24 @@ module Griddler
     end
 
     def clean_text(text)
-      clean_invalid_utf8_bytes(text, 'text')
+      clean_invalid_utf8_bytes(text)
     end
 
     def clean_html(html)
-      cleaned_html = clean_invalid_utf8_bytes(html, 'html')
+      cleaned_html = clean_invalid_utf8_bytes(html)
       cleaned_html = strip_tags(cleaned_html)
       cleaned_html = HTMLEntities.new.decode(cleaned_html)
       cleaned_html
     end
 
-    def clean_invalid_utf8_bytes(text, email_part)
-      text.encode(
-        'UTF-8',
-        src_encoding(email_part),
-        invalid: :replace,
-        undef: :replace,
-        replace: ''
-      )
-    end
-
-    def src_encoding(email_part)
-      if params[:charsets]
-        charsets = ActiveSupport::JSON.decode(params[:charsets])
-        charsets[email_part]
-      else
-        'binary'
+    def clean_invalid_utf8_bytes(text)
+      if !text.valid_encoding?
+        text = text
+          .force_encoding('ISO-8859-1')
+          .encode('UTF-8')
       end
+
+      text
     end
   end
 end

data/lib/griddler/email_parser.rb

@@ -74,10 +74,12 @@ module Griddler::EmailParser
   def self.regex_split_points
     [
       reply_delimeter_regex,
-      /^\s*[-]+\s*Original Message\s*[-]+\s*$/,
+      /^\s*[-]+\s*Original Message\s*[-]+\s*$/i,
       /^\s*--\s*$/,
+      /^\s*\>?\s*On.*\r?\n?\s*.*\s*wrote:$/,
       /On.*wrote:/,
-      /^\s*On.*\r?\n?\s*.*\s*wrote:$/
+      /From:.*$/i,
+      /^\s*\d{4}\/\d{1,2}\/\d{1,2}\s.*\s<.*>?$/i
     ]
   end
 

data/lib/griddler/version.rb

@@ -1,3 +1,3 @@
 module Griddler
-  VERSION = "0.6.1"
+  VERSION = "0.6.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: griddler
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.3
 platform: ruby
 authors:
 - Caleb Thompson
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-04 00:00:00.000000000 Z
+date: 2014-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -92,10 +92,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
+- Rakefile
 - app/controllers/griddler/emails_controller.rb
 - config/initializers/griddler.rb
 - config/routes.rb
+- lib/griddler.rb
 - lib/griddler/adapters/cloudmailin_adapter.rb
+- lib/griddler/adapters/mailgun_adapter.rb
 - lib/griddler/adapters/mandrill_adapter.rb
 - lib/griddler/adapters/postmark_adapter.rb
 - lib/griddler/adapters/sendgrid_adapter.rb
@@ -106,11 +111,7 @@ files:
 - lib/griddler/errors.rb
 - lib/griddler/route_extensions.rb
 - lib/griddler/version.rb
-- lib/griddler.rb
 - lib/tasks/griddler_tasks.rake
-- LICENSE
-- Rakefile
-- README.md
 homepage: http://thoughtbot.com
 licenses: []
 metadata: {}
@@ -134,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.5
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: SendGrid Parse API client Rails Engine