Griddler is a Rails engine (full plugin) that provides an endpoint for the SendGrid parse api that hands off a built email object to a class implemented by you.
- SendGrid has done a great tutorial on integrating Griddler with your application.
- And of course, view our own blog post on the subject over at Giant Robots.
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:
post '/email_processor' => 'griddler/emails#create'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:
class EmailProcessor
def self.process(email)
# all of your application-specific code here - creating models,
# processing reports, etc
end
endThe contents of the email object passed into your process method is an object
that responds to:
.to.from.subject.body.raw_body
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.
.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.
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:
Griddler.configure do |config|
config.processor_class = EmailProcessor # MyEmailProcessor
config.to = :token # :raw, :email, :hash
# :raw => 'AppName <[email protected]>'
# :email => '[email protected]'
# :token => 's13.6b2d13dc6a1d33db7644'
# :hash => { raw: '', email: '', token: '', host: '' }
config.reply_delimiter = '-- REPLY ABOVE THIS LINE --'
endconfig.processor_classis the class Griddler will use to handle your incoming emails.config.reply_delimiteris the string searched for that will split your body.config.tois the format of the returned value for the:tokey in the email object.:hashwill return all options within a -- (surprise!) -- hash.
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.
factory :email, class: OpenStruct do
to 'email-token'
from '[email protected]'
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
endBear 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)
- SendGrid
- [SendGrid Parse API](http://www.sendgrid.com/docs/API Reference/Webhooks/parse.html)
Griddler was written by Caleb Thompson and Joel Oliveira.
Large portions of the codebase were extracted from thoughtbot's Trajectory.
The names and logos for thoughtbot are trademarks of thoughtbot, inc.
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.