griddler 0.5.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3573025fb9bfe09cc1746e637a3992d7349d58e5
-  data.tar.gz: 1c818804c1f63e95613531fc79afba41c5964213
+  metadata.gz: 01c15f81e30fcd63ca2c9cb4bc9e2e8678264c5f
+  data.tar.gz: 37a8b24a5ce5b94ef4e7f7d907298abfb3517cd2
 SHA512:
-  metadata.gz: c3c628a41d84ee8f0319b0d4016916c60f50b42e97b0358a5772bd79301d67b132b8712525f18aca403b1e6b9636fe28aef1f2d629a1f7c3da969b2ce1e1d19d
-  data.tar.gz: 951ecc70b7cf18c8b8ef81b303098ff5139a64f15c7fa0c8b70d0d631a44f86b59478c031881b6e1b957ab8e44b07114840a3687a470c14666051f6e0b9470d2
+  metadata.gz: 44c21089a2ede6e88242b9e6b24fc38bda03bc0a0dbcbf92e74e0a4a792d000cc374bcbb1da8e99bc922e934dbf8fa4506c164034293ebb482c62c80c1a8ece0
+  data.tar.gz: 82704ef5699bc9c2b5c8fa1f274a21f37bb63993f6da44d74f273414d4464c2fea834464afe1f77919c1bd9a88abeb46ea7adeeb4676feaa8aa19562cf2d8a15

data/README.md

@@ -31,15 +31,25 @@ 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:
+In `config/routes.rb` you may either use the provided method `mount_griddler`
+or set the route manually. Examples:
 
 ```ruby
+# mount using default path
+mount_griddler
+
+# mount using a custom path
+mount_griddler('/email/incoming')
+
+# the "get off my lawn", DIY approach:
 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
 --------
 
@@ -72,16 +82,31 @@ that responds to:
 
 Each of those has some sensible defaults.
 
-`.from`, `.raw_body`, `.raw_headers`, and `.subject` will contain the obvious
+`.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
 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 used portion of the email address and consider it to
-be the token we'll key off of for interaction with our application.
+`.to` will contain an array of hashes. Each hash will have the following
+information of each recipient:
+
+  * `token`: All the text before the email's "@". 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.
+
+  * `host`: All the text after the email's "@". This is important to filter
+  the recipients sent to the application vs emails to other domains. More
+  info below on the Upgrading to 0.5.0 section.
+
+  * `email`: The email address of the recipient.
+
+  * `full`: The whole recipient field. E.g, `Some User <hello@example.com>`
+  * `name`: The name of the recipient. E.g, `Some User`
+
+`.from` will default to the `email` value of a hash like `.to`, and can be
+configured to return the full hash.
 
 `.attachments` will contain an array of attachments as multipart/form-data files
 which can be passed off to attachment libraries like Carrierwave or Paperclip.
@@ -98,23 +123,25 @@ are shown below with sample overrides following. In `config/initializer/griddler
 ```ruby
 Griddler.configure do |config|
   config.processor_class = EmailProcessor # MyEmailProcessor
-  config.to = :token # :full, :email, :hash
+  config.to = :hash # :full, :email, :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: '' }
+  # :hash   => { raw: [...], email: [...], token: [...], host: [...],
+name: [...] }
   config.reply_delimiter = '-- REPLY ABOVE THIS LINE --'
-  config.email_service = :sendgrid
+  config.email_service = :sendgrid # :cloudmailin, :postmark, :mandrill
 end
 ```
 
 * `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), `:postmark` and `:mandrill`.
+* `config.to` 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`
+  (expects multipart format), `:postmark` and `:mandrill`.
 
 Testing In Your App
 -------------------
@@ -126,7 +153,7 @@ following sample factory.
 ```ruby
 factory :email, class: OpenStruct do
   # Assumes Griddler.configure.to is :hash (default)
-  to [{ raw: 'to_user@email.com', email: 'to_user@email.com', token: 'to_user', host: 'email.com' }]
+  to [{ full: 'to_user@email.com', email: 'to_user@email.com', token: 'to_user', host: 'email.com', name: nil }]
   from 'user@email.com'
   subject 'email subject'
   body 'Hello!'

data/lib/griddler.rb

@@ -5,6 +5,7 @@ require 'griddler/engine'
 require 'griddler/email'
 require 'griddler/email_parser'
 require 'griddler/configuration'
+require 'griddler/route_extensions'
 require 'griddler/adapters/sendgrid_adapter'
 require 'griddler/adapters/cloudmailin_adapter'
 require 'griddler/adapters/postmark_adapter'

data/lib/griddler/adapters/postmark_adapter.rb

@@ -13,7 +13,7 @@ module Griddler
       def normalize_params
         {
           to: extract_recipients,
-          from: params[:FromFull][:Email],
+          from: full_email(params[:FromFull]),
           subject: params[:Subject],
           text: params[:TextBody],
           html: params[:HtmlBody],

data/lib/griddler/configuration.rb

@@ -16,7 +16,7 @@ module Griddler
   end
 
   class Configuration
-    attr_accessor :processor_class, :reply_delimiter
+    attr_accessor :processor_class, :reply_delimiter, :from
 
     def to
       @to ||= :hash
@@ -33,6 +33,10 @@ module Griddler
       @to = type
     end
 
+    def from
+      @from ||= :email
+    end
+
     def processor_class
       @processor_class ||= EmailProcessor
     end
@@ -46,6 +50,10 @@ module Griddler
     end
 
     def email_service=(new_email_service)
+      if new_email_service == :default
+        new_email_service = :sendgrid
+      end
+
       @email_service_adapter = adapter_class.fetch(new_email_service) { raise Griddler::Errors::EmailServiceAdapterNotFound }
     end
 

data/lib/griddler/email.rb

@@ -10,7 +10,7 @@ module Griddler
       @params = params
 
       @to = recipients
-      @from = extract_address(params[:from], :email)
+      @from = extract_address(params[:from], config.from)
       @subject = params[:subject]
 
       @body = extract_body
@@ -64,8 +64,6 @@ module Griddler
         clean_text(params[:text])
       elsif params.key? :html
         clean_html(params[:html])
-      else
-        raise Errors::EmailBodyNotFound
       end
     end
 

data/lib/griddler/email_parser.rb

@@ -13,12 +13,14 @@ require 'mail'
 module Griddler::EmailParser
   def self.parse_address(full_address)
     email_address = extract_email_address(full_address)
+    name = extract_name(full_address)
     token, host = split_address(email_address)
     {
       token: token,
       host: host,
       email: email_address,
       full: full_address,
+      name: name,
     }
   end
 
@@ -26,17 +28,13 @@ module Griddler::EmailParser
     if body.blank?
       ""
     else
-      delimeter = Griddler.configuration.reply_delimiter
-      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*>/ ||
+      remove_reply_portion(body)
+        .split(/[\r]*\n/)
+        .reject do |line|
+          line =~ /^\s+>/ ||
             line =~ /^\s*Sent from my /
         end.
         join("\n").
-        gsub(/^\s*On.*\r?\n?\s*.*\s*wrote:$/,'').
         strip
     end
   end
@@ -52,11 +50,40 @@ module Griddler::EmailParser
 
   private
 
+  def self.reply_delimeter_regex
+    delimiter = Array(Griddler.configuration.reply_delimiter).join('|')
+    %r{#{delimiter}}
+  end
+
   def self.extract_email_address(full_address)
     full_address.split('<').last.delete('>').strip
   end
 
+  def self.extract_name(full_address)
+    full_address = full_address.strip
+    name = full_address.split('<').first.strip
+    if name.present? && name != full_address
+      name
+    end
+  end
+
   def self.split_address(email_address)
     email_address.try :split, '@'
   end
+
+  def self.regex_split_points
+    [
+      reply_delimeter_regex,
+      /^\s*[-]+\s*Original Message\s*[-]+\s*$/,
+      /^\s*--\s*$/,
+      /On.*wrote:/,
+      /^\s*On.*\r?\n?\s*.*\s*wrote:$/
+    ]
+  end
+
+  def self.remove_reply_portion(body)
+    regex_split_points.inject(body) do |result, split_point|
+      result.split(split_point).first || ""
+    end
+  end
 end

data/lib/griddler/engine.rb

@@ -1,4 +1,9 @@
 module Griddler
   class Engine < ::Rails::Engine
+    initializer 'griddler.routes',
+      after: 'action_dispatch.prepare_dispatcher' do |app|
+
+      ActionDispatch::Routing::Mapper.send :include, Griddler::RouteExtensions
+    end
   end
 end

data/lib/griddler/errors.rb

@@ -3,9 +3,6 @@ module Griddler
   end
 
   module Errors
-    class EmailBodyNotFound < Griddler::Error
-    end
-
     class EmailServiceAdapterNotFound < Griddler::Error
     end
   end

data/lib/griddler/route_extensions.rb

@@ -0,0 +1,7 @@
+module Griddler
+  module RouteExtensions
+    def mount_griddler(path='/email_processor')
+      post path => 'griddler/emails#create', as: :email_processor
+    end
+  end
+end

data/lib/griddler/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: griddler
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Caleb Thompson
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-21 00:00:00.000000000 Z
+date: 2013-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -104,6 +104,7 @@ files:
 - lib/griddler/email_parser.rb
 - lib/griddler/engine.rb
 - lib/griddler/errors.rb
+- lib/griddler/route_extensions.rb
 - lib/griddler/version.rb
 - lib/griddler.rb
 - lib/tasks/griddler_tasks.rake
@@ -133,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.0.5
 signing_key: 
 specification_version: 4
 summary: SendGrid Parse API client Rails Engine