griddler 0.1.0

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2012 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,119 @@
+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) that hands
+off a built email object to a class implemented by you.
+
+Installation
+------------
+
+Add griddler to your application's Gemfile and run `bundle install`:
+
+```ruby
+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 may
+add the route to the desired position in routes.rb with the following:
+
+```ruby
+match '/email_processor' => 'griddler/emails#create', via: :post
+```
+
+Defaults
+--------
+
+By default Griddler will look for a class to be created in your application
+called EmailProcessor with a class method implemented named process, taking in
+one argument (presumably `email`). For example, in `./lib/email_processor.rb`:
+
+```ruby
+class EmailProcessor
+  def self.process(email)
+    # all of your application-specific code here - creating models, processing
+    # reports, etc
+  end
+end
+```
+
+The contents of the `email` object passed into your process method is a hash
+containing:
+
+* `:to`
+* `:from`
+* `:subject`
+* `:body`
+
+Each of those has some sensible defaults.
+
+`:from` and `:subject` will contain the obvious values found in the email, the
+raw from and subject values.
+
+`: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
+case `:body` will contain everything before that line.
+
+`:to` will contain all of the text before the email's "@" character. We've found
+that this is the most often use portion of the email address and consider it to
+be the token we'll key off of for interaction with our application.
+
+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`:
+
+```ruby
+Griddler.configure do |config|
+  config.handler_class = EmailProcessor # MyEmailProcessor
+  config.handler_method = :process # :go
+  config.raw_body = false # true
+  config.to = :token # :raw, :email, :hash
+  # :raw    => 'AppName <s13.6b2d13dc6a1d33db7644@mail.myapp.com>'
+  # :email  => 's13.6b2d13dc6a1d33db7644@mail.myapp.com'
+  # :token  => 's13.6b2d13dc6a1d33db7644'
+  # :hash   => { raw: '', email: '', token: '', host: '' }
+  config.reply_delimeter = '-- REPLY ABOVE THIS LINE --'
+end
+```
+
+* `config.handler_class` change the class Griddler will use to handle your
+  incoming emails.
+* `config.handler_method` change the class method called on
+  `config.handler_class`.
+* `config.reply_delimeter` change the string searched for that will split your
+  body.
+* `config.raw_body` use the full email body whether or not
+  `config.reply_delimeter` is set.
+* `config.to` change the format of the returned value for the `:to` key in the
+  email object. `:hash` will return all options within a (surprise!) - hash.
+
+More Information
+----------------
+
+* [Sendgrid](http://www.sendgrid.com)
+* [Sendgrid Parse API](www.sendgrid.com/docs/API Reference/Webhooks/parse.html)
+
+Credits
+-------
+
+Griddler was written by Caleb Thompson and Joel Oliveira.
+
+Large portions of the codebase were extracted from thoughtbot's
+[Trajectory](http://www.apptrajectory.com).
+
+![thoughtbot](http://thoughtbot.com/images/tm/logo.png)
+
+The names and logos for thoughtbot are trademarks of thoughtbot, inc.
+
+License
+-------
+
+Griddler is Copyright © 2012 Caleb Thompson, Joel Oliveira and thoughtbot. It is
+free software, and may be redistributed under the terms specified in the LICENSE
+file.

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/app/controllers/griddler/emails_controller.rb

@@ -0,0 +1,6 @@
+class Griddler::EmailsController < ActionController::Base
+  def create
+    Griddler::Email.new(params)
+    head :ok
+  end
+end

data/config/initializers/griddler.rb

@@ -0,0 +1 @@
+require 'griddler'

data/config/routes.rb

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

data/lib/griddler/configuration.rb

@@ -0,0 +1,43 @@
+module Griddler
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration = Configuration.new
+
+    if block_given?
+      yield configuration
+    end
+
+    self.configuration
+  end
+
+  def self.configuration
+    @configuration || self.configure
+  end
+
+  class Configuration
+    attr_accessor :handler_class, :handler_method, :raw_body, :reply_delimiter, :to
+
+    def to
+      @to ||= :token
+    end
+
+    def handler_class
+      @handler_class ||= EmailProcessor
+    end
+
+    def handler_method
+      @handler_method ||= :process
+    end
+
+    def raw_body
+      @raw_body ||= false
+    end
+
+    def reply_delimiter
+      @reply_delimiter ||= 'Reply ABOVE THIS LINE'
+    end
+  end
+end

data/lib/griddler/email.rb

@@ -0,0 +1,45 @@
+require 'iconv'
+
+class Griddler::Email
+  attr_accessor :to, :from, :body, :subject
+
+  def initialize(params)
+    @to = extract_address(params[:to], config.to)
+    @from = extract_address(params[:from], :email)
+    @subject = params[:subject]
+
+    if config.raw_body
+      @body = params[:text]
+    else
+      @body = extract_body(params[:text], params[:charsets])
+    end
+
+    handler_class = config.handler_class
+    handler_method = config.handler_method
+    handler_class.send(handler_method, self)
+  end
+
+  private
+
+  def extract_address(address, type)
+    parsed = EmailParser.parse_address(address)
+    if type == :hash
+      parsed
+    else
+      parsed[type]
+    end
+  end
+
+  def extract_body(body_text, charsets)
+    if charsets.present?
+      charsets = ActiveSupport::JSON.decode(charsets)
+      body_text = Iconv.new('utf-8', charsets['text']).iconv(body_text)
+    end
+
+    EmailParser.extract_reply_body(body_text)
+  end
+
+  def config
+    Griddler.configuration
+  end
+end

data/lib/griddler/email_format.rb

@@ -0,0 +1,6 @@
+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

data/lib/griddler/email_parser.rb

@@ -0,0 +1,49 @@
+# Parse emails from their full format into a hash containing full email, host,
+# local token, and the raw argument.
+#
+# Some Body <somebody@example.com>
+# # => {
+#   token: 'somebody',
+#   host: 'example.com',
+#   email: 'somebody@example.com',
+#   full: 'Some Body <somebody@example.com>',
+# }
+module EmailParser
+  def self.parse_address(full_address)
+    email_address = extract_email_address(full_address)
+    token, host = split_address(email_address)
+    {
+      token: token,
+      host: host,
+      email: email_address,
+      full: full_address,
+    }
+  end
+
+  def self.extract_reply_body(body)
+    if body
+      delimeter = Griddler.configuration.reply_delimiter
+      body.split(delimeter).first.
+        split(/^\s*[-]+\s*Original Message\s*[-]+\s*$/).first.
+        split(/^\s*--\s*$/).first.
+        split(/[\r]*\n/).reject do |line|
+          line =~ /^\s*>/ ||
+            line =~ /^\s*On.*wrote:$/ ||
+            line =~ /^\s*Sent from my /
+        end.
+        join("\n").
+        gsub(/^\s*On.*\r?\n?\s*.*\s*wrote:$/,'').
+        strip
+    end
+  end
+
+  private
+
+  def self.extract_email_address(full_address)
+    full_address.split('<').last.delete('>').strip
+  end
+
+  def self.split_address(email_address)
+    email_address.try :split, '@'
+  end
+end

data/lib/griddler/engine.rb

@@ -0,0 +1,4 @@
+module Griddler
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/griddler/version.rb

@@ -0,0 +1,3 @@
+module Griddler
+  VERSION = "0.1.0"
+end

data/lib/griddler.rb

@@ -0,0 +1,8 @@
+require 'griddler/engine'
+require 'griddler/email'
+require 'griddler/email_format'
+require 'griddler/email_parser'
+require 'griddler/configuration'
+
+module Griddler
+end

data/lib/tasks/griddler_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :griddler do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: griddler
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Caleb Thompson
+- Joel Oliveira
+- thoughtbot
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-06 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: 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: 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'
+description: 
+email:
+- cjaysson@gmail.com
+- joel@thoughtbot.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/controllers/griddler/emails_controller.rb
+- config/initializers/griddler.rb
+- config/routes.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/version.rb
+- lib/griddler.rb
+- lib/tasks/griddler_tasks.rake
+- LICENSE
+- Rakefile
+- README.md
+homepage: http://thoughtbot.com
+licenses: []
+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: -1174056135577180289
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1174056135577180289
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: SendGrid Parse API client Rails Engine
+test_files: []