griddler 1.0.0.pre.beta.1 → 1.0.0.pre.beta.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5db84495ea1dd75d93ad77af6b7b345471658418
-  data.tar.gz: ab4522dd7709770a8fa825c1328a034fc42abe8a
+  metadata.gz: fdb714b3a8525e8794d87ddb0fdd8925ac1ae39e
+  data.tar.gz: 8bcf701f4e310616683dea33d61305b991557e2d
 SHA512:
-  metadata.gz: c3a1251948e7b861c2fea3ba5e526a90c14dbe352ab9b00d64dacb18fb9cd0a3e3dd77f3a910ed0f709eb9802ef81a031dbe624d4392902d1bb6877df04ca6d3
-  data.tar.gz: 3df07fd60447f539702466ea27e5d6890e2e68d25266b0a9e3cc98d6b134b15125d2cea2cd4dfe835b0501bbfd9f8aecf29b3ada57064af1eb1ac79f32702932
+  metadata.gz: 76986506c6ff012f225b22f67942551795867728dff8e6f34fd3cbe221352bf04ecba58c7344386edde56a99c9226712a47c9b377d6301073354356d40e497a9
+  data.tar.gz: 5d74b1583264d8d4f9a24cc50ba68cf39d5b95e4e6da5638271e636b2c3afded4a79e3e23546ab588175f2d6149b5c6c11eab5b1c1661018ac2466cde7fa70eb

data/README.md

@@ -6,13 +6,9 @@ Griddler
 
 ### Receive emails in your Rails app
 
-Griddler is a Rails engine that provides an endpoint for the
-[SendGrid](http://sendgrid.com/docs/API%20Reference/Webhooks/parse.html),
-[Cloudmailin](http://cloudmailin.com),
-[Postmark](http://developer.postmarkapp.com/developer-inbound-parse.html),
-[Mandrill](http://help.mandrill.com/entries/21699367-Inbound-Email-Processing-Overview), or
-[Mailgun](http://documentation.mailgun.com/user\_manual.html#receiving-messages-via-http-through-a-forward-action)
-parse APIs that hands off a built email object to a class implemented by you.
+Griddler is a Rails engine that provides an endpoint for services that convert
+incoming emails to HTTP POST requests. It parses these POSTs and hands off a
+built email object to a class implemented by you.
 
 Tutorials
 ---------
@@ -58,13 +54,6 @@ Defaults are shown below with sample overrides following. In
 Griddler.configure do |config|
   config.processor_class = EmailProcessor # CommentViaEmail
   config.processor_method = :process # :create_comment (A method on CommentViaEmail)
-  config.to = :hash # :full, :email, :token
-  config.cc = :email # :full, :hash, :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: [...], name: [...] }
   config.reply_delimiter = '-- REPLY ABOVE THIS LINE --'
   config.email_service = :sendgrid # :cloudmailin, :postmark, :mandrill, :mailgun
 end
@@ -76,15 +65,18 @@ end
 | `processor_method` | The method Griddler will call on the processor class when handling your incoming emails.
 | `reply_delimiter`  | The string searched for that will split your body.
 | `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`. You will also need to have an appropriate [adapter] gem included in your Gemfile.
-| `to`, `config.cc` and `config.from` | The format of the returned value for that address in the email object. `:hash` will return all options within a -- (surprise!) -- hash.
 
-By default Griddler will look for a class named `EmailProcessor` with a class
-method named `process`, taking in one argument, a `Griddler::Email` instance
+By default Griddler will look for a class named `EmailProcessor` with a method
+named `process`, taking in one argument, a `Griddler::Email` instance
 representing the incoming email.  For example, in `./lib/email_processor.rb`:
 
 ```ruby
 class EmailProcessor
-  def self.process(email)
+  def initialize(email)
+    @email = email
+  end
+
+  def process
     # all of your application-specific code here - creating models,
     # processing reports, etc
   end
@@ -167,10 +159,12 @@ adapter gem in addition to `griddler`.
 | sendgrid    | [griddler-sendgrid]
 | mandrill    | [griddler-mandrill]
 | mailgun     | [griddler-mailgun]
+| postmark    | [griddler-postmark]
 
 [griddler-sendgrid]: https://github.com/thoughtbot/griddler-sendgrid
 [griddler-mandrill]: https://github.com/wingrunr21/griddler-mandrill
 [griddler-mailgun]: https://github.com/bradpauly/griddler-mailgun
+[griddler-postmark]: https://github.com/r38y/griddler-postmark
 
 Writing an Adapter
 ------------------
@@ -199,28 +193,11 @@ Adapters should be provided as gems. If you write an adapter, let us know and we
 will add it to this README. See [griddler-sendgrid] for an example
 implementation.
 
-More Information
-----------------
-
-* [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/)
-* [Mandrill](http://mandrill.com)
-* [Mandrill Docs](http://help.mandrill.com/forums/21092258-Inbound-Email-Processing)
-* [Mailgun](http://mailgun.com)
-* [Mailgun Docs](http://documentation.mailgun.com/user\_manual.html#receiving-forwarding-and-storing-messages)
-
 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).
-
 Thanks to our [contributors](https://github.com/thoughtbot/griddler/contributors)!
 
 ![thoughtbot](http://thoughtbot.com/images/tm/logo.png)

data/lib/griddler/testing.rb

@@ -44,14 +44,14 @@ shared_examples_for 'Griddler adapter' do |adapter, service_params|
     Array.wrap(normalized_params).each do |params|
       email = Griddler::Email.new(params)
 
-      email.to.should eq([{
+      expect(email.to).to eq([{
         token: 'hi',
         host: 'example.com',
         full: 'Hello World <hi@example.com>',
         email: 'hi@example.com',
         name: 'Hello World',
       }])
-      email.cc.should eq [{
+      expect(email.cc).to eq [{
         token: 'emily',
         host: 'example.com',
         email: 'emily@example.com',
@@ -81,8 +81,8 @@ RSpec::Matchers.define :be_normalized_to do |expected|
   match do |actual|
     expected.each do |k, v|
       case v
-      when Regexp then actual[k].should =~ v
-      else actual[k].should === v
+      when Regexp then expect(actual[k]).to =~ v
+      else expect(actual[k]).to === v
       end
     end
   end

data/lib/griddler/version.rb

@@ -1,3 +1,3 @@
 module Griddler
-  VERSION = "1.0.0-beta.1"
+  VERSION = "1.0.0-beta.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: griddler
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.beta.1
+  version: 1.0.0.pre.beta.2
 platform: ruby
 authors:
 - Caleb Thompson