griddler 0.3.1 → 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fb74f34f6940e9e3287bfb7a543d4eed144ca554
+  data.tar.gz: 38c69abc85aed6e97d8d7e75d47456b476964b27
+SHA512:
+  metadata.gz: 2cd9c1d15de8639995f8c02f085da8c88846d3226a136756c022cdfb9b9125a0bb1da7d9b4b2aea10274f9d58ee6792d8675ced712f75f9470f6791b1931d40b
+  data.tar.gz: 7d6bce5cd7c9bff557cc6611a7c5129091d104d4e90e1bd031d26d9f7e8f8cb79e28eb12ab162e4c52e4fcf0e015eb5dea3a3c9974daf75d61aeff6d8c8c0b2d

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Caleb Thompson, Joel Oliveira and thoughtbot, inc.
+Copyright (c) 2013 Caleb Thompson, Joel Oliveira and thoughtbot, inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,13 +1,26 @@
-
 Griddler
 ========
 
+[![Build Status](https://travis-ci.org/thoughtbot/griddler.png?branch=master)](https://travis-ci.org/thoughtbot/griddler)
+[![Code Climate](https://codeclimate.com/github/thoughtbot/griddler.png)](https://codeclimate.com/github/thoughtbot/griddler)
+
 ### Receive emails in your Rails app
 
 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)
+[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)
 that hands off a built email object to a class implemented by you.
 
+Tutorials
+---------
+
+* SendGrid has done a
+  [great tutorial](http://blog.sendgrid.com/receiving-email-in-your-rails-app-with-griddler/)
+  on integrating Griddler with your application.
+* And of course, view our own blog post on the subject over at
+  [Giant Robots](http://robots.thoughtbot.com/post/42286882447/handle-incoming-email-with-griddler).
+
 Installation
 ------------
 
@@ -19,11 +32,11 @@ gem 'griddler'
 
 Griddler comes with a default endpoint that will be displayed at the bottom
 of the output of `rake routes`. If there is a previously defined route that
-matches `/email_processor`–or you would like to rename the matched path–you
+matches `/email_processor` -- or you would like to rename the matched path -- you
 may add the route to the desired position in routes.rb with the following:
 
 ```ruby
-match '/email_processor' => 'griddler/emails#create', via: :post
+post '/email_processor' => 'griddler/emails#create'
 ```
 
 Defaults
@@ -50,10 +63,14 @@ that responds to:
 * `.subject`
 * `.body`
 * `.raw_body`
+* `.attachments`
+* `.headers`
+* `.raw_headers`
 
 Each of those has some sensible defaults.
 
-`.from`, `.raw_body` and `.subject` will contain the obvious values found in the email, the raw values from those fields.
+`.from`, `.raw_body`, `.raw_headers`, and `.subject` will contain the obvious
+values found in the email, the raw values from those fields.
 
 `.body` will contain the full contents of the email body **unless** there is a
 line in the email containing the string `-- Reply ABOVE THIS LINE --`. In that
@@ -63,6 +80,12 @@ case `.body` will contain everything before that line.
 that this is the most often used portion of the email address and consider it to
 be the token we'll key off of for interaction with our application.
 
+`.attachments` will contain an array of attachments as multipart/form-data files
+which can be passed off to attachment libraries like Carrierwave or Paperclip.
+
+`.headers` will contain a hash of header names and values as parsed by the Mail
+gem. Headers will only be parsed if the adapter supports a headers option.
+
 Configuration Options
 ---------------------
 
@@ -78,13 +101,17 @@ Griddler.configure do |config|
   # :token  => 's13.6b2d13dc6a1d33db7644'
   # :hash   => { raw: '', email: '', token: '', host: '' }
   config.reply_delimiter = '-- REPLY ABOVE THIS LINE --'
+  config.email_service = :sendgrid
 end
 ```
 
-* `config.processor_class` change the class Griddler will use to handle your incoming emails.
-* `config.reply_delimiter` change the string searched for that will split your body.
-* `config.to` change the format of the returned value for the `:to` key in
+* `config.processor_class` is the class Griddler will use to handle your incoming emails.
+* `config.reply_delimiter` is the string searched for that will split your body.
+* `config.to` is the format of the returned value for the `:to` key 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 (expects
+multipart format) and :postmark
 
 Testing In Your App
 -------------------
@@ -113,18 +140,39 @@ factory :email, class: OpenStruct do
 end
 ```
 
-Bear in mind, if you plan on using the :with_attachment trait, that this
-example assumes your factories are in spec/factories.rb and you have
-an image file in spec/fixtures/
+Bear in mind, if you plan on using the `:with_attachment` trait, that this
+example assumes your factories are in `spec/factories.rb` and you have
+an image file in `spec/fixtures/`.
 
 To use it in your test(s) just build with `email = build(:email)`
-or `email = build(:email, :with_attachment)`
+or `email = build(:email, :with_attachment)`.
+
+Adapters
+--------
+
+`Griddler::Email` expects certain parameters to be in place for proper parsing
+to occur. When writing an adapter, ensure that the `normalized_params` method
+of your adapter returns a hash with these keys:
+
+* `:to` The recipient field
+* `:from` The sender field
+* `:subject` Email subject
+* `:text` The text body of the email
+* `:html` The html body of the email, nil or empty string if not present
+* `:attachments` (can be an empty array) Array of attachments to the email
+* `:headers` (optional) The raw headers of the email
+* `:charsets` (optional) A JSON string containing the character sets of the
+  fields extracted from the message
 
 More Information
 ----------------
 
-* [Sendgrid](http://www.sendgrid.com)
-* [Sendgrid Parse API](www.sendgrid.com/docs/API Reference/Webhooks/parse.html)
+* [SendGrid](http://www.sendgrid.com)
+* [SendGrid Parse API](http://www.sendgrid.com/docs/API Reference/Webhooks/parse.html)
+* [Cloudmailin](http://cloudmailin.com)
+* [Cloudmailin Docs](http://docs.cloudmailin.com/)
+* [Postmark](http://postmarkapp.com)
+* [Postmark Docs](http://developer.postmarkapp.com/)
 
 Credits
 -------
@@ -141,6 +189,6 @@ The names and logos for thoughtbot are trademarks of thoughtbot, inc.
 License
 -------
 
-Griddler is Copyright © 2012 Caleb Thompson, Joel Oliveira and thoughtbot. It is
+Griddler is Copyright © 2013 Caleb Thompson, Joel Oliveira and thoughtbot. It is
 free software, and may be redistributed under the terms specified in the LICENSE
 file.

data/app/controllers/griddler/emails_controller.rb

@@ -1,6 +1,12 @@
 class Griddler::EmailsController < ActionController::Base
   def create
-    Griddler::Email.new(params)
+    Griddler::Email.new(normalized_params).process
     head :ok
   end
+
+  private
+
+  def normalized_params
+    Griddler.configuration.email_service.normalize_params(params)
+  end
 end

data/config/routes.rb

@@ -1,3 +1,3 @@
 Rails.application.routes.draw do
-  match '/email_processor' => 'griddler/emails#create', via: :post, as: :email_processor
+  post '/email_processor' => 'griddler/emails#create', as: :email_processor
 end

data/lib/griddler.rb

@@ -1,9 +1,13 @@
+require 'rails/engine'
+require 'action_view'
 require 'griddler/errors'
 require 'griddler/engine'
 require 'griddler/email'
-require 'griddler/email_format'
 require 'griddler/email_parser'
 require 'griddler/configuration'
+require 'griddler/adapters/sendgrid_adapter'
+require 'griddler/adapters/cloudmailin_adapter'
+require 'griddler/adapters/postmark_adapter'
 
 module Griddler
 end

data/lib/griddler/adapters/cloudmailin_adapter.rb

@@ -0,0 +1,29 @@
+module Griddler
+  module Adapters
+    class CloudmailinAdapter
+      def initialize(params)
+        @params = params
+      end
+
+      def self.normalize_params(params)
+        adapter = new(params)
+        adapter.normalize_params
+      end
+
+      def normalize_params
+        {
+          to: params[:envelope][:to],
+          from: params[:envelope][:from],
+          subject: params[:headers][:Subject],
+          text: params[:plain],
+          attachments: params.fetch(:attachments) { [] },
+        }
+      end
+
+      private
+
+      attr_reader :params
+
+    end
+  end
+end

data/lib/griddler/adapters/postmark_adapter.rb

@@ -0,0 +1,49 @@
+module Griddler
+  module Adapters
+    class PostmarkAdapter
+      def initialize(params)
+        @params = params
+      end
+
+      def self.normalize_params(params)
+        adapter = new(params)
+        adapter.normalize_params
+      end
+
+      def normalize_params
+        {
+          to: params[:ToFull][:Email],
+          from: params[:FromFull][:Email],
+          subject: params[:Subject],
+          text: params[:TextBody],
+          html: params[:HtmlBody],
+          attachments: attachment_files,
+        }
+      end
+
+      private
+
+      attr_reader :params
+
+      def attachment_files
+        attachments = Array(params[:Attachments])
+
+        attachments.map do |attachment|
+          ActionDispatch::Http::UploadedFile.new({
+            filename: attachment[:Name],
+            type: attachment[:ContentType],
+            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/sendgrid_adapter.rb

@@ -0,0 +1,32 @@
+module Griddler
+  module Adapters
+    class SendgridAdapter
+      def initialize(params)
+        @params = params
+      end
+
+      def self.normalize_params(params)
+        adapter = new(params)
+        adapter.normalize_params
+      end
+
+      def normalize_params
+        params[:attachments] = attachment_files
+        params
+      end
+
+      private
+
+      attr_reader :params
+
+      def attachment_files
+        params.delete('attachment-info')
+        attachment_count = params[:attachments].to_i
+
+        attachment_count.times.map do |index|
+          params.delete("attachment#{index + 1}".to_sym)
+        end
+      end
+    end
+  end
+end

data/lib/griddler/configuration.rb

@@ -1,20 +1,18 @@
 module Griddler
-  class << self
-    attr_accessor :configuration
-  end
+  @@configuration = nil
 
   def self.configure
-    self.configuration = Configuration.new
+    @@configuration = Configuration.new
 
     if block_given?
       yield configuration
     end
 
-    self.configuration
+    configuration
   end
 
   def self.configuration
-    @configuration || self.configure
+    @@configuration || configure
   end
 
   class Configuration
@@ -31,5 +29,22 @@ module Griddler
     def reply_delimiter
       @reply_delimiter ||= 'Reply ABOVE THIS LINE'
     end
+
+    def email_service
+      @email_service_adapter ||= adapter_class[:sendgrid]
+    end
+
+    def email_service=(new_email_service)
+      @email_service_adapter = adapter_class.fetch(new_email_service) { raise Griddler::Errors::EmailServiceAdapterNotFound }
+    end
+
+    private
+
+    def adapter_class
+      {
+        sendgrid: Griddler::Adapters::SendgridAdapter,
+        cloudmailin: Griddler::Adapters::CloudmailinAdapter,
+      }
+    end
   end
 end

data/lib/griddler/email.rb

@@ -1,96 +1,96 @@
 require 'htmlentities'
 
-class Griddler::Email
-  include ActionView::Helpers::SanitizeHelper
-  attr_accessor :to, :from, :body, :raw_body, :subject, :attachments
-
-  def initialize(params)
-    @params = params
-    @to = extract_address(params[:to], config.to)
-    @from = extract_address(params[:from], :email)
-    @subject = params[:subject]
-    @body = extract_body
-    @raw_body = params[:text] || params[:html]
-    @attachments = extract_attachments
-
-    processor_class = config.processor_class
-    processor_class.process(self)
-  end
+module Griddler
+  class Email
+    include ActionView::Helpers::SanitizeHelper
+    attr_reader :to, :from, :subject, :body, :raw_body,
+      :headers, :raw_headers, :attachments
 
-  private
+    def initialize(params)
+      @params = params
 
-  attr_reader :params
+      @to = extract_address(params[:to], config.to)
+      @from = extract_address(params[:from], :email)
+      @subject = params[:subject]
 
-  def config
-    Griddler.configuration
-  end
+      @body = extract_body
+      @raw_body = params[:text] || params[:html]
 
-  def extract_address(address, type)
-    parsed = EmailParser.parse_address(address)
+      @headers = extract_headers
+      @raw_headers = params[:headers]
 
-    if type == :hash
-      parsed
-    else
-      parsed[type]
+      @attachments = params[:attachments]
     end
-  end
 
-  def extract_attachments
-    attachment_count = params[:attachments].to_i
-    attachment_files = []
+    def process
+      processor_class = config.processor_class
+      processor_class.process(self)
+    end
 
-    attachment_count.times do |index|
-      attachment_files << params["attachment#{index + 1}".to_sym]
+    private
+
+    attr_reader :params
+
+    def config
+      Griddler.configuration
     end
 
-    attachment_files
-  end
+    def extract_address(address, type)
+      parsed = EmailParser.parse_address(address)
 
-  def extract_body
-    body_text = text_or_sanitized_html
-    charsets = params[:charsets]
+      if type == :hash
+        parsed
+      else
+        parsed[type]
+      end
+    end
 
-    if charsets.present?
-      charsets = ActiveSupport::JSON.decode(charsets)
-      body_text = body_text.encode(
-        'UTF-8',
-        invalid: :replace,
-        undef: :replace,
-        replace: ''
-      ).force_encoding('UTF-8')
+    def extract_body
+      EmailParser.extract_reply_body(text_or_sanitized_html)
     end
 
-    EmailParser.extract_reply_body(body_text)
-  end
+    def extract_headers
+      EmailParser.extract_headers(params[:headers])
+    end
 
-  def text_or_sanitized_html
-    if params.key? :text
-      clean_text(params[:text])
-    elsif params.key? :html
-      clean_html(params[:html])
-    else
-      raise Griddler::Errors::EmailBodyNotFound
+    def text_or_sanitized_html
+      if params.key? :text
+        clean_text(params[:text])
+      elsif params.key? :html
+        clean_html(params[:html])
+      else
+        raise Errors::EmailBodyNotFound
+      end
     end
-  end
 
-  def clean_text(text)
-    clean_invalid_utf8_bytes(text)
-  end
+    def clean_text(text)
+      clean_invalid_utf8_bytes(text, 'text')
+    end
 
-  def clean_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_html(html)
+      cleaned_html = clean_invalid_utf8_bytes(html, 'html')
+      cleaned_html = strip_tags(cleaned_html)
+      cleaned_html = HTMLEntities.new.decode(cleaned_html)
+      cleaned_html
+    end
 
-  def clean_invalid_utf8_bytes(text)
-    text.encode(
-      'UTF-8',
-      'binary',
-      invalid: :replace,
-      undef: :replace,
-      replace: ''
-    )
+    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'
+      end
+    end
   end
 end

data/lib/griddler/email_parser.rb

@@ -8,7 +8,9 @@
 #   email: 'somebody@example.com',
 #   full: 'Some Body <somebody@example.com>',
 # }
-module EmailParser
+require 'mail'
+
+module Griddler::EmailParser
   def self.parse_address(full_address)
     email_address = extract_email_address(full_address)
     token, host = split_address(email_address)
@@ -21,7 +23,9 @@ module EmailParser
   end
 
   def self.extract_reply_body(body)
-    if body
+    if body.blank?
+      ""
+    else
       delimeter = Griddler.configuration.reply_delimiter
       body.split(delimeter).first.
         split(/^\s*[-]+\s*Original Message\s*[-]+\s*$/).first.
@@ -37,6 +41,15 @@ module EmailParser
     end
   end
 
+  def self.extract_headers(raw_headers)
+    header_fields = Mail::Header.new(raw_headers).fields
+
+    header_fields.inject({}) do |header_hash, header_field|
+      header_hash[header_field.name.to_s] = header_field.value.to_s
+      header_hash
+    end
+  end
+
   private
 
   def self.extract_email_address(full_address)

data/lib/griddler/errors.rb

@@ -5,5 +5,8 @@ module Griddler
   module Errors
     class EmailBodyNotFound < Griddler::Error
     end
+
+    class EmailServiceAdapterNotFound < Griddler::Error
+    end
   end
 end

data/lib/griddler/version.rb

@@ -1,3 +1,3 @@
 module Griddler
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,86 +1,93 @@
 --- !ruby/object:Gem::Specification
 name: griddler
 version: !ruby/object:Gem::Version
-  version: 0.3.1
-  prerelease: 
+  version: 0.4.0
 platform: ruby
 authors:
 - Caleb Thompson
 - Joel Oliveira
 - thoughtbot
+- Swift
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-04 00:00:00.000000000 Z
+date: 2013-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: htmlentities
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: 
 email:
 - cjaysson@gmail.com
 - joel@thoughtbot.com
+- theycallmeswift@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -88,9 +95,11 @@ files:
 - app/controllers/griddler/emails_controller.rb
 - config/initializers/griddler.rb
 - config/routes.rb
+- lib/griddler/adapters/cloudmailin_adapter.rb
+- lib/griddler/adapters/postmark_adapter.rb
+- lib/griddler/adapters/sendgrid_adapter.rb
 - lib/griddler/configuration.rb
 - lib/griddler/email.rb
-- lib/griddler/email_format.rb
 - lib/griddler/email_parser.rb
 - lib/griddler/engine.rb
 - lib/griddler/errors.rb
@@ -102,33 +111,26 @@ files:
 - README.md
 homepage: http://thoughtbot.com
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - app
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: 4165747324942510967
+      version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 4165747324942510967
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: SendGrid Parse API client Rails Engine
 test_files: []

data/lib/griddler/email_format.rb

@@ -1,6 +0,0 @@
-module Griddler::EmailFormat
-  LocalPartSpecialChars = Regexp.escape('!#$%&\'*-/=?+-^_`{|}~')
-  LocalPartUnquoted = '(([[:alnum:]' + LocalPartSpecialChars + ']+[\.\+]+))*[[:alnum:]' + LocalPartSpecialChars + '+]+'
-  LocalPartQuoted = '\"(([[:alnum:]' + LocalPartSpecialChars + '\.\+]*|(\\\\[\u0001-\uFFFF]))*)\"'
-  Regex = Regexp.new('((' + LocalPartUnquoted + ')|(' + LocalPartQuoted + ')+)@(((\w+\-+)|(\w+\.))*\w{1,63}\.[a-z]{2,6})', Regexp::EXTENDED | Regexp::IGNORECASE)
-end