gridhook 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd1b5b0d7fdd8ee2aabe014129eb68735f7e2559
-  data.tar.gz: aff3bde4721b9444ef3e1d33963438a40e5fdd8b
+  metadata.gz: 839428d1167c2c442e70a17e9bc6bdecd3a4cd9a
+  data.tar.gz: a75f9a9e050b1abf48d96349a402d3ba2f298e3f
 SHA512:
-  metadata.gz: be176c7e538cd9edd0d87681aee4b95176f594ff1e05db89da37d1abf47aa49a7567e8c7521d2fa576e4dce7ac1fd308987b9bd6271fa1e998aa26c6cf93b314
-  data.tar.gz: 48cec9955b1ac5884010856e1dd38729bec8d2111173d0b15d23a124aeb74388c1557969756d10523dc834a6bde2c4d92a99d9b9e417e23e0dc84d6c678ce38d
+  metadata.gz: e500c033309351375601d64a73797e8937e3f28010ac88bf763785bee0b33819a703b739869499e94a9f7aed61b068f69af5af29cff7331d4a689072c01ba81e
+  data.tar.gz: 1e5584c7006688438f7813f418cdb9ea2d06ffd774e96465d05e206817d53e26d08c005c4c6e4ebb6bb67aae3b63f1ab4eef442e5b149a288c42ffcad4b76b4e

data/README.md

@@ -1,7 +1,13 @@
 # Gridhook
 
-A Rails engine providing an endpoint for handling incoming SendGrid
-webhook events.
+Gridhook is a Rails engine providing an endpoint for handling incoming
+SendGrid webhook events.
+
+This engine supports both batched and non-batched events from SendGrid.
+
+Looking to handle incoming email from the SendGrid Parse API? Gridhook
+will eventually support that, until then, you should check out
+[Griddler](https://github.com/thoughtbot/griddler). It's awesome.
 
 ## Installation
 
@@ -49,5 +55,6 @@ end
 
 ## More Information
 
+* [Gridhook API Documentation](http://injekt.github.com/rdoc/gridhook/)
 * [SendGrid Webhooks](http://sendgrid.com/docs/API_Reference/Webhooks/index.html)
 * [SendGrid Webhooks/Event](http://sendgrid.com/docs/API_Reference/Webhooks/event.html)

data/lib/gridhook.rb

@@ -1,6 +1,8 @@
 require 'rails/engine'
 require 'yajl'
+require 'yajl/json_gem'
 require 'action_view'
+require 'action_dispatch'
 
 require 'gridhook/engine'
 require 'gridhook/config'

data/lib/gridhook/config.rb

@@ -1,18 +1,17 @@
 module Gridhook
 
+  # Returns a new Config instance.
   def self.config
     @config ||= Config.new
   end
 
+  # A helper method for providing a configure block.
   def self.configure
     yield config
   end
 
+  # This class handles storing Gridhooks configuration variables.
   class Config < Struct.new(:event_processor, :event_receive_path)
-    def initialize(*)
-      self.event_receive_path = '/sendgrid/event'
-      super
-    end
   end
 
 end

data/lib/gridhook/engine.rb

@@ -2,6 +2,8 @@ require 'gridhook/unfortunate_sendgrid_fix'
 
 module Gridhook
   class Engine < ::Rails::Engine
-    config.app_middleware.insert_before ActionDispatch::ParamsParser, 'UnfortunateSendgridFix'
+    # Insert our SendGrid JSON fix middleware before ParamsParser
+    # attempts to encode the JSON.
+    config.app_middleware.insert_before ActionDispatch::ParamsParser, 'Gridhook::UnfortunateSendgridFix'
   end
 end

data/lib/gridhook/errors.rb

@@ -2,6 +2,7 @@ module Gridhook
   class Error < StandardError
   end
 
+  # Raised if Gridhook.config.event_processor does not respond to #call.
   class InvalidEventProcessor < Error
   end
 end

data/lib/gridhook/event.rb

@@ -1,6 +1,12 @@
 module Gridhook
   class Event
 
+    # Process a String or stream of JSON and execute our
+    # event processor.
+    #
+    # body - A String or stream for Yajl to parse
+    #
+    # Returns nothing.
     def self.process(body)
       parser = Yajl::Parser.new
       parser.on_parse_complete = proc do |event|
@@ -13,20 +19,32 @@ module Gridhook
       parser.parse(body)
     end
 
+    # The original Hash of attributes received from SendGrid.
     attr_reader :attributes
 
     def initialize(attributes)
       @attributes = attributes.with_indifferent_access
     end
 
+    # An alias for returning the type of this event, ie:
+    # sent, delivered, bounced, etc
     def name
       attributes[:event]
     end
 
+    # Returns a new Time object from the event timestamp.
     def timestamp
       Time.at (attributes[:timestamp] || Time.now).to_i
     end
 
+    # A helper for accessing the original values sent from
+    # SendGrid, ie
+    #
+    # Example:
+    #
+    #   event = Event.new(event: 'sent', email: 'lee@example.com')
+    #   event[:event]  #=> 'sent'
+    #   event['email'] #=> 'lee@example.com' # indifferent access
     def [](key)
       attributes[key]
     end

data/lib/gridhook/unfortunate_sendgrid_fix.rb

@@ -1,12 +1,14 @@
-class UnfortunateSendgridFix
-  def initialize(app)
-    @app = app
-  end
+module Gridhook
+  class UnfortunateSendgridFix
+    def initialize(app)
+      @app = app
+    end
 
-  def call(env)
-    if env['PATH_INFO'] == Gridhook.config.event_receive_path
-      env['CONTENT_TYPE'] = 'text/plain'
+    def call(env)
+      if env['PATH_INFO'] == Gridhook.config.event_receive_path
+        env['CONTENT_TYPE'] = 'text/plain'
+      end
+      @app.call(env)
     end
-    @app.call(env)
   end
 end

data/lib/gridhook/version.rb

@@ -1,3 +1,3 @@
 module Gridhook
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/test/helper.rb

@@ -1,5 +1,5 @@
 ENV['RAILS_ENV'] ||= 'test'
-require File.expand_path '../dummy/config/environment', __FILE__
+# require File.expand_path '../dummy/config/environment', __FILE__
 
 require 'minitest/autorun'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gridhook
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Lee Jarvis