griddler 0.2.0 → 0.3.0

data/README.md

@@ -1,10 +1,12 @@
+
 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) that hands
-off a built email object to a class implemented by you.
+[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
 ------------
@@ -15,10 +17,10 @@ Add griddler to your application's Gemfile and run `bundle install`:
 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:
+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
@@ -28,70 +30,95 @@ 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`:
+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
+    # 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:
+The contents of the `email` object passed into your process method is an object
+that responds to:
 
-* `:to`
-* `:from`
-* `:subject`
-* `:body`
+* `.to`
+* `.from`
+* `.subject`
+* `.body`
+* `.raw_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.
+`.from`, `.raw_body` 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
+`.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.
+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
+`.to` will contain all of the text before the email's "@" character. We've found
+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.
 
 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`:
+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.processor_class = EmailProcessor # MyEmailProcessor
   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 --'
+  config.reply_delimiter = '-- 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.
+* `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
+the email object. `:hash` will return all options within a -- (surprise!) -- hash.
+
+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
+following sample factory.
+
+```ruby
+factory :email, class: OpenStruct do
+  to 'email-token'
+  from 'user@email.com'
+  subject 'email subject'
+  body 'Hello!'
+  attachments {[]}
+
+  trait :with_attachment do
+    attachments {[
+      ActionDispatch::Http::UploadedFile.new({
+        filename: 'img.png',
+        type: 'image/png',
+        tempfile: File.new("#{File.expand_path File.dirname(__FILE__)}/fixtures/img.png")
+      })
+    ]}
+  end
+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/
+
+To use it in your test(s) just build with `email = build(:email)`
+or `email = build(:email, :with_attachment)`
 
 More Information
 ----------------

data/lib/griddler.rb

@@ -1,3 +1,4 @@
+require 'griddler/errors'
 require 'griddler/engine'
 require 'griddler/email'
 require 'griddler/email_format'

data/lib/griddler/configuration.rb

@@ -18,22 +18,14 @@ module Griddler
   end
 
   class Configuration
-    attr_accessor :handler_class, :handler_method, :raw_body, :reply_delimiter, :to
+    attr_accessor :processor_class, :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
+    def processor_class
+      @processor_class ||= EmailProcessor
     end
 
     def reply_delimiter

data/lib/griddler/email.rb

@@ -1,18 +1,19 @@
-require 'iconv'
+require 'htmlentities'
 
 class Griddler::Email
-  attr_accessor :to, :from, :body, :subject, :attachments
+  include ActionView::Helpers::SanitizeHelper
+  attr_accessor :to, :from, :body, :raw_body, :subject, :attachments
 
   def initialize(params)
     @to = extract_address(params[:to], config.to)
     @from = extract_address(params[:from], :email)
     @subject = params[:subject]
-    @body = raw_or_extracted_body(params)
+    @body = extract_body(params)
+    @raw_body = params[:text] || params[:html]
     @attachments = extract_attachments(params)
 
-    handler_class = config.handler_class
-    handler_method = config.handler_method
-    handler_class.send(handler_method, self)
+    processor_class = config.processor_class
+    processor_class.process(self)
   end
 
   private
@@ -41,20 +42,26 @@ class Griddler::Email
     attachment_files
   end
 
-  def extract_body(body_text, charsets)
+  def extract_body(params)
+    body_text = text_or_sanitized_html(params)
+    charsets = params[:charsets]
+
     if charsets.present?
       charsets = ActiveSupport::JSON.decode(charsets)
-      body_text = Iconv.new('utf-8', charsets['text']).iconv(body_text)
+      body_text = body_text.encode('UTF-8', invalid: :replace,
+        undef: :replace, replace: '').force_encoding('UTF-8')
     end
 
     EmailParser.extract_reply_body(body_text)
   end
 
-  def raw_or_extracted_body(params)
-    if config.raw_body
-      @body = params[:text]
+  def text_or_sanitized_html(params)
+    if params.key? :text
+      params[:text]
+    elsif params.key? :html
+      HTMLEntities.new.decode(strip_tags(params[:html]))
     else
-      @body = extract_body(params[:text], params[:charsets])
+      raise Griddler::Errors::EmailBodyNotFound
     end
   end
 end

data/lib/griddler/email_parser.rb

@@ -26,9 +26,9 @@ module EmailParser
       body.split(delimeter).first.
         split(/^\s*[-]+\s*Original Message\s*[-]+\s*$/).first.
         split(/^\s*--\s*$/).first.
+        gsub(/On.*wrote:/, '').
         split(/[\r]*\n/).reject do |line|
           line =~ /^\s*>/ ||
-            line =~ /^\s*On.*wrote:$/ ||
             line =~ /^\s*Sent from my /
         end.
         join("\n").

data/lib/griddler/errors.rb

@@ -0,0 +1,9 @@
+module Griddler
+  class Error < StandardError
+  end
+
+  module Errors
+    class EmailBodyNotFound < Griddler::Error
+    end
+  end
+end

data/lib/griddler/version.rb

@@ -1,3 +1,3 @@
 module Griddler
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: griddler
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-10 00:00:00.000000000 Z
+date: 2013-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -30,14 +30,14 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.2.0
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: htmlentities
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -61,6 +61,22 @@ dependencies:
     - - ! '>='
       - !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'
 description: 
 email:
 - cjaysson@gmail.com
@@ -77,6 +93,7 @@ files:
 - lib/griddler/email_format.rb
 - lib/griddler/email_parser.rb
 - lib/griddler/engine.rb
+- lib/griddler/errors.rb
 - lib/griddler/version.rb
 - lib/griddler.rb
 - lib/tasks/griddler_tasks.rake
@@ -96,12 +113,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3729493469419997719
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3729493469419997719
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24