sendgrid_events_pbxx 0.1.4

data/.gitignore

@@ -0,0 +1,6 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem 'enumerated_field'
+gem 'jeweler'

data/Gemfile.lock

@@ -0,0 +1,154 @@
+PATH
+  remote: .
+  specs:
+    sendgrid_events_pbxx (0.1.4)
+      enumerated_field
+      rails (~> 3.2)
+      sendgrid-rails (~> 2.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.13)
+      actionpack (= 3.2.13)
+      mail (~> 2.5.3)
+    actionpack (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+    activerecord (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    awesome_print (1.1.0)
+    builder (3.0.4)
+    capybara (2.0.3)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (~> 2.0)
+      xpath (~> 1.0.0)
+    childprocess (0.3.9)
+      ffi (~> 1.0, >= 1.0.11)
+    diff-lcs (1.2.2)
+    enumerated_field (0.3.0)
+      activemodel
+      activesupport
+    erubis (2.7.0)
+    factory_girl (2.6.4)
+      activesupport (>= 2.3.9)
+    factory_girl_rails (1.7.0)
+      factory_girl (~> 2.6.0)
+      railties (>= 3.0.0)
+    ffi (1.6.0)
+    git (1.2.5)
+    hike (1.2.1)
+    i18n (0.6.1)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    journey (1.0.4)
+    json (1.7.7)
+    mail (2.5.3)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.22)
+    multi_json (1.7.2)
+    nokogiri (1.5.9)
+    polyglot (0.3.3)
+    rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.3)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.13)
+      actionmailer (= 3.2.13)
+      actionpack (= 3.2.13)
+      activerecord (= 3.2.13)
+      activeresource (= 3.2.13)
+      activesupport (= 3.2.13)
+      bundler (~> 1.0)
+      railties (= 3.2.13)
+    railties (3.2.13)
+      actionpack (= 3.2.13)
+      activesupport (= 3.2.13)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.0.4)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
+    rspec-rails (2.13.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rubyzip (0.9.9)
+    selenium-webdriver (2.31.0)
+      childprocess (>= 0.2.5)
+      multi_json (~> 1.0)
+      rubyzip
+      websocket (~> 1.0.4)
+    sendgrid-rails (2.0.3)
+      actionmailer (>= 3.0.0)
+      activesupport (>= 2.1.0)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.7)
+    thor (0.18.1)
+    tilt (1.3.6)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.37)
+    websocket (1.0.7)
+    xpath (1.0.0)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  capybara
+  enumerated_field
+  factory_girl_rails (~> 1.7)
+  jeweler
+  rails (~> 3.2)
+  rake
+  rspec-rails (~> 2)
+  sendgrid_events_pbxx!
+  sqlite3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# SendgridEvents
+
+[![TravisCI](https://secure.travis-ci.org/jphenow/sendgrid_events.png "TravisCI")](http://travis-ci.org/jphenow/sendgrid_events "Travis-CI SendgridEvents")
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/jphenow/sendgrid_events)
+[Ruby Gems](https://rubygems.org/gems/sendgrid_events)
+
+SendgridEvents is a gem designed to give your application [Sendgrid postbacks](http://docs.sendgrid.com/documentation/api/event-api/).
+With these postbacks you are more able to track the status of your emails programatically.
+
+This gem creates a `SendgridEmailRecord` table for this tracking and you can attach handlers to specific
+events.
+
+# Installation
+
+add
+
+```ruby
+gem 'sendgrid_events'
+```
+
+to your Gemfile and run
+
+```
+bundle install
+```
+
+After that you'll want to run:
+
+```
+rails g sendgrid_events:install
+rake db:migrate
+```
+
+Finally, you'll want to edit your `config/initializers/sendgrid_events.rb`. Currently
+you just have the option to include or disclude certain event handlers.
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,13 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+namespace :spec do
+  RSpec::Core::RakeTask.new(:docs) do |t|
+    t.rspec_opts = ["--format doc"]
+  end
+end
+
+task :default => :spec

data/app/controllers/sendgrid_events/sendgrid_events_controller.rb

@@ -0,0 +1,8 @@
+module SendgridEvents
+  class SendgridEventsController < ActionController::Base
+    def create
+      Receiver.receive params
+      render :nothing => true
+    end
+  end
+end

data/app/models/sendgrid_events/sendgrid_email_record.rb

@@ -0,0 +1,26 @@
+module SendgridEvents
+  class SendgridEmailRecord < ActiveRecord::Base
+    #belongs_to :sender, :polymorphic => true # What models can we use here?
+    # Message
+    include ::EnumeratedField
+    enum_field :status, [
+      %w[bounced bounced],
+      %w[clicked clicked],
+      %w[deferred deferred],
+      %w[delivered delivered],
+      %w[dropped dropped],
+      %w[opened opened],
+      %w[processed processed],
+      %w[processing processing],
+      %w[spamreported spamreported],
+      %w[unsubscribed unsubscribed],
+    ]
+
+    def self.create_from_headers!(headers, additional_attributes)
+      create!(:to      => headers[:to],
+              :from    => headers[:from],
+              :subject => headers[:subject],
+              :status  => 'processing')
+    end
+  end
+end

data/lib/generators/sendgrid_events/install/templates/create_sendgrid_email_records.rb

@@ -0,0 +1,16 @@
+class CreateSendGridEmailRecords < ActiveRecord::Migration
+  def self.up
+    create_table :sendgrid_email_records do |t|
+      t.string :status
+      t.string :to
+      t.string :from
+      t.string :subject
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :sendgrid_email_records
+  end
+end

data/lib/generators/sendgrid_events/install/templates/initializer.rb

@@ -0,0 +1,8 @@
+SendgridEvents::Configure.config do
+  handle %w[processed deferred delivered open click bounce dropped spamreport unsubscribe]
+  receive true
+  foreign_key 'sengrid_events_id'
+  mount_at "/sendgrid_events/receiver"
+end
+
+# ActionMailer::Base.send :include, SendgridEvents::ActionMailerOverride

data/lib/generators/sendgrid_events/install/templates/routes.rb

@@ -0,0 +1,2 @@
+
+  match SendgridEvents::Configure.mount_at => "sendgrid_events/sendgrid_events#receiver", :via => :post

data/lib/generators/sendgrid_events/install_generator.rb

@@ -0,0 +1,55 @@
+require 'rails/generators'
+module SendgridEvents
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path "../install/templates", __FILE__
+
+      def self.next_migration_number(path)
+        unless @prev_migration_nr
+          @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+        else
+          @prev_migration_nr += 1
+        end
+        @prev_migration_nr.to_s
+      end
+
+      def install
+        migrations
+        initializer
+        routes
+        middleware
+      end
+
+      private
+
+      def migrations
+        puts "Copying Sengrid Events migrations..."
+        begin
+          migration_template "create_sendgrid_email_records.rb", "db/migrate/create_sendgrid_email_records.rb"
+        rescue
+          puts "Already have that migration"
+        end
+      end
+
+      def initializer
+        puts "Copying initializer..."
+        copy_file "initializer.rb", "config/initializers/sendgrid_events.rb"
+      end
+
+      def routes
+        puts "Copying routes..."
+        insert_into_file Rails.root.join('config', 'routes.rb'),
+          File.open(File.join(File.expand_path("../install/templates", __FILE__), 'routes.rb')).read,
+          :after => /Application\.routes\.draw do$/
+      end
+
+      def middleware
+        puts "Copying config..."
+        insert_into_file Rails.root.join('config', 'application.rb'), :after => /class Application.*$/ do
+          "\n    config.middleware.insert_before ActiveRecord::ParamsParser, SendgridEvents::Middleware"
+        end
+      end
+    end
+  end
+end

data/lib/sendgrid_events/action_mailer_override.rb

@@ -0,0 +1,29 @@
+module SendgridEvents
+  module ActionMailerOverride
+    extend ActiveSupport::Concern
+    included do
+      alias_method_chain :uniq_args, :merge_args
+      alias_method_chain :mail, :record_email
+    end
+
+    attr_accessor :sendgrid_email_record_attributes
+    def sendgrid_email_record_attributes(attrs = nil)
+      @sendgrid_email_record_attributes ||= {}
+      return @sendgrid_email_record_attributes if attrs.nil?
+      self.sendgrid_email_record_attributes = attrs
+    end
+
+    def uniq_args_with_merge_args(args)
+      set_args = send_grid_header.data[:unique_args] ||= {}
+      uniq_args_without_merge_args set_args.merge(args)
+    end
+
+    def mail_with_record_email(headers={}, &block)
+      id = SendgridEmailRecord.create_from_headers!(headers, sendgrid_email_record_attributes).id
+      uniq_args :sendgrid_events_id => id
+      mail_without_record_email headers, &block
+    end
+  end
+end
+
+ActionMailer::Base.send :include, SendgridEvents::ActionMailerOverride

data/lib/sendgrid_events/configure.rb

@@ -0,0 +1,27 @@
+module SendgridEvents
+  class Configure
+    def self.mount_at(val = nil)
+      @mount_at ||= val
+    end
+
+    def self.config(&block)
+      class_eval &block
+    end
+
+    def self.handle(list)
+      Handlers::Dispatch.selected_handlers = list
+    end
+
+    def self.receive(boolean)
+      @receive = boolean
+    end
+
+    def self.receive?
+      @receive.nil? ? true : @receive
+    end
+
+    def self.foreign_key(name = nil)
+      @foreign_key ||= name
+    end
+  end
+end

data/lib/sendgrid_events/engine.rb

@@ -0,0 +1,12 @@
+module ::SendgridEvents
+  class Engine < Rails::Engine
+    config.mount_at = '/sendgrid_events/' #TODO Config file
+    class << self
+      attr_accessor :root
+    end
+
+    def self.root
+      @root ||= Pathname.new(File.expand_path('../../', __FILE__))
+    end
+  end
+end

data/lib/sendgrid_events/handlers/base.rb

@@ -0,0 +1,50 @@
+module SendgridEvents
+  module Handlers
+    class Base
+      def self.registered_handlers
+        Dispatch.registered_handlers
+      end
+
+      def self.selected_handlers
+        Dispatch.selected_handlers
+      end
+
+      def self.acceptable_handlers
+        Dispatch.acceptable_handlers
+      end
+
+      def self.choose_and_handle(event)
+        if registered_handlers[event[:event]] and selected_handlers[event[:event]]
+          registered_handlers[event[:event]].handle(event)
+        end
+      end
+
+      def self.register_as_handler_for(handlee)
+        if acceptable_handlers[handlee]
+          handlee = handlee.to_s
+          registered_handlers[handlee] = self.name.constantize
+          self.name.constantize.send :define_singleton_method, :handlee do
+            self.name.demodulize.downcase
+          end
+        else
+          raise ArgumentError, "#{handlee.to_s.titleize} is not in the Dispatch's list of acceptable handlers"
+        end
+      end
+
+      def self.handler(&block)
+        block_given? ? @handler = block : @handler
+      end
+
+      def self.handle(event)
+        found_event = find_and_update_event(event)
+        handler.call(found_event) unless found_event.nil? or handler.nil?
+      end
+
+      def self.find_and_update_event(event)
+        SendgridEmailRecord.find_by_id(event[:sendgrid_events_id]).tap do |record|
+          record.update_attributes(:status => handlee) unless record.nil?
+        end
+      end
+    end
+  end
+end

data/lib/sendgrid_events/handlers/bounced.rb

@@ -0,0 +1,7 @@
+module SendgridEvents
+  module Handlers
+    class Bounced < Base
+      register_as_handler_for :bounce
+    end
+  end
+end

data/lib/sendgrid_events/handlers/clicked.rb

@@ -0,0 +1,7 @@
+module SendgridEvents
+  module Handlers
+    class Clicked < Base
+      register_as_handler_for :click
+    end
+  end
+end

data/lib/sendgrid_events/handlers/deferred.rb

@@ -0,0 +1,7 @@
+module SendgridEvents
+  module Handlers
+    class Deferred < Base
+      register_as_handler_for :deferred
+    end
+  end
+end

data/lib/sendgrid_events/handlers/delivered.rb

@@ -0,0 +1,10 @@
+module SendgridEvents
+  module Handlers
+    class Delivered < Base
+      # Delivered
+      # event     | email             | response              | category
+      # delivered | Message recipient | Full reponse from MTA | The category you assigned
+      register_as_handler_for :delivered
+    end
+  end
+end

data/lib/sendgrid_events/handlers/dispatch.rb

@@ -0,0 +1,34 @@
+module SendgridEvents
+  module Handlers
+    class Dispatch
+      class << self
+        attr_accessor :registered_handlers, :selected_handlers
+      end
+
+      def self.registered_handlers
+        @registered_handlers ||= {}.with_indifferent_access
+      end
+
+      def self.acceptable_handlers
+        @acceptable_handlers ||= begin
+                                   array = %w[processed
+                                              deferred
+                                              delivered
+                                              open
+                                              click
+                                              bounce
+                                              dropped
+                                              spamreport
+                                              unsubscribe
+                                            ]
+                                   Hash[array.zip([true] * array.size)].with_indifferent_access
+                                 end
+      end
+
+      def self.selected_handlers=(handler_list)
+        raise ArgumentError, "Found an unaccetable handler" unless handler_list.all? { |x| acceptable_handlers[x.to_sym] }
+        @selected_handlers = Hash[handler_list.zip([true] * handler_list.size)].with_indifferent_access
+      end
+    end
+  end
+end

data/lib/sendgrid_events/handlers/dropped.rb

@@ -0,0 +1,7 @@
+module SendgridEvents
+  module Handlers
+    class Dropped < Base
+      register_as_handler_for :dropped
+    end
+  end
+end

data/lib/sendgrid_events/handlers/opened.rb

@@ -0,0 +1,7 @@
+module SendgridEvents
+  module Handlers
+    class Opened < Base
+      register_as_handler_for :open
+    end
+  end
+end

data/lib/sendgrid_events/handlers/processed.rb

@@ -0,0 +1,7 @@
+module SendgridEvents
+  module Handlers
+    class Processed < Base
+      register_as_handler_for :processed
+    end
+  end
+end

data/lib/sendgrid_events/handlers/spam_reported.rb

@@ -0,0 +1,7 @@
+module SendgridEvents
+  module Handlers
+    class SpamReported < Base
+      register_as_handler_for :spamreport
+    end
+  end
+end

data/lib/sendgrid_events/handlers/unsubscribed.rb

@@ -0,0 +1,7 @@
+module SendgridEvents
+  module Handlers
+    class Unsubscribed < Base
+      register_as_handler_for :unsubscribe
+    end
+  end
+end

data/lib/sendgrid_events/handlers.rb

@@ -0,0 +1,3 @@
+require 'sendgrid_events/handlers/dispatch'
+require 'sendgrid_events/handlers/base'
+Dir.glob(File.expand_path('../handlers/**/*.rb', __FILE__)).each { |file| require file }

data/lib/sendgrid_events/middleware.rb

@@ -0,0 +1,22 @@
+module SendgridEvents
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      scrub(env) if env and env["REQUEST_URI"] and env["REQUEST_URI"].include? Configure.mount_at
+      @app.call(env)
+    end
+
+    private
+    def scrub(env)
+      rack_input = env["rack.input"].read
+      rack_input ="[#{rack_input.split("\r\n").join(",")}]"
+      env["rack.input"] = StringIO.new(rack_input)
+    rescue
+    ensure
+      env["rack.input"].rewind
+    end
+  end
+end

data/lib/sendgrid_events/receiver.rb

@@ -0,0 +1,18 @@
+module SendgridEvents
+  class Receiver
+    def self.receive(params)      
+      if Configure.receive? and params['_json'] and params['_json'].is_a? Array
+
+        SendgridEmailRecord.transaction do
+          params['_json'].each do |event|
+            if event.is_a? Hash and event.has_key? Configure.foreign_key
+              event = event.with_indifferent_access
+              Handlers::Base.choose_and_handle(event)
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/sendgrid_events/version.rb

@@ -0,0 +1,3 @@
+module SendgridEvents
+  VERSION = "0.1.4"
+end

data/lib/sendgrid_events.rb

@@ -0,0 +1,9 @@
+require 'active_support/core_ext/string'
+require 'sendgrid-rails'
+require 'sendgrid_events/version'
+require 'sendgrid_events/engine'
+require 'sendgrid_events/handlers'
+require 'sendgrid_events/receiver'
+require 'sendgrid_events/action_mailer_override'
+require 'sendgrid_events/configure'
+require 'sendgrid_events/middleware'