sendgrid_events 0.0.1

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/.rvmrc

@@ -0,0 +1,5 @@
+rvm --create ruby-1.9.3-p125@sendgrid_events
+# Ensure that Bundler is installed, install it if it is not.
+if ! command -v bundle > /dev/null; then
+  gem install bundler
+fi

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,141 @@
+PATH
+  remote: .
+  specs:
+    sendgrid_events (0.0.1)
+      enumerated_field
+      rails (~> 3.0.15)
+      sendgrid
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.15)
+      actionpack (= 3.0.15)
+      mail (~> 2.2.19)
+    actionpack (3.0.15)
+      activemodel (= 3.0.15)
+      activesupport (= 3.0.15)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.5.0)
+      rack (~> 1.2.5)
+      rack-mount (~> 0.6.14)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.15)
+      activesupport (= 3.0.15)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.15)
+      activemodel (= 3.0.15)
+      activesupport (= 3.0.15)
+      arel (~> 2.0.10)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.15)
+      activemodel (= 3.0.15)
+      activesupport (= 3.0.15)
+    activesupport (3.0.15)
+    addressable (2.2.8)
+    arel (2.0.10)
+    awesome_print (1.0.2)
+    builder (2.1.2)
+    capybara (1.1.2)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (~> 2.0)
+      xpath (~> 0.1.4)
+    childprocess (0.3.3)
+      ffi (~> 1.0.6)
+    diff-lcs (1.1.3)
+    enumerated_field (0.3.8)
+      activemodel (~> 3.0.0)
+      activesupport (~> 3.0.0)
+    erubis (2.6.6)
+      abstract (>= 1.0.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.0.11)
+    i18n (0.5.0)
+    json (1.7.3)
+    libwebsocket (0.1.4)
+      addressable
+    mail (2.2.19)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.19)
+    multi_json (1.3.6)
+    nokogiri (1.5.5)
+    polyglot (0.3.3)
+    rack (1.2.5)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.15)
+      actionmailer (= 3.0.15)
+      actionpack (= 3.0.15)
+      activerecord (= 3.0.15)
+      activeresource (= 3.0.15)
+      activesupport (= 3.0.15)
+      bundler (~> 1.0)
+      railties (= 3.0.15)
+    railties (3.0.15)
+      actionpack (= 3.0.15)
+      activesupport (= 3.0.15)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.4)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.0)
+    rspec-expectations (2.11.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.1)
+    rspec-rails (2.11.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec (~> 2.11.0)
+    rubyzip (0.9.9)
+    selenium-webdriver (2.24.0)
+      childprocess (>= 0.2.5)
+      libwebsocket (~> 0.1.3)
+      multi_json (~> 1.0)
+      rubyzip
+    sendgrid (1.0.1)
+      json
+      json
+    sqlite3 (1.3.6)
+    thor (0.14.6)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.33)
+    xpath (0.1.4)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  capybara
+  factory_girl_rails (~> 1.7)
+  rails (~> 3.0.15)
+  rake
+  rspec-rails (~> 2.6)
+  sendgrid_events!
+  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,33 @@
+# SendgridEvents
+
+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 < ApplicationController
+    def receiver
+      Receiver.receive params
+      render :nothing => true
+    end
+  end
+end

data/app/models/sendgrid_events/sendgrid_email_record.rb

@@ -0,0 +1,14 @@
+module SendgridEvents
+  class SendgridEmailRecord < ActiveRecord::Base
+    #belongs_to :sender, :polymorphic => true # What models can we use here?
+    # Message
+    include EnumeratedField
+    enum_field :status, [
+      %w[processing processing],
+      %w[dropped dropped],
+      %w[deferred deferred],
+      %w[bounced bounced],
+      %w[delivered delivered]
+    ]
+  end
+end

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

@@ -0,0 +1,5 @@
+SendgridEvents::Configure.config do
+  handle %w[processed deferred delivered open click bounce dropped spamreport unsubscribe]
+  receive = true
+  mount_at = "/sendgrid_events/"
+end

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

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

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

@@ -0,0 +1,16 @@
+class CreateSendGridEmailRecordTable < 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_generator.rb

@@ -0,0 +1,34 @@
+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
+        puts "Copying Sengrid Events migrations..."
+        migration_template "sendgrid_events_table.rb", "db/migrate/sendgrid_events_table.rb"
+      end
+
+      def install_initializer
+        puts "Copying initializer..."
+        copy_file "initializer.rb", "config/initializers/sendgrid_events.rb"
+      end
+
+      def add_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
+    end
+  end
+end

data/lib/sendgrid_events.rb

@@ -0,0 +1,8 @@
+require 'active_support/core_ext/string'
+require 'sendgrid'
+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'

data/lib/sendgrid_events/action_mailer_override.rb

@@ -0,0 +1,23 @@
+module SendgridEvents
+  module ActionMailerOverride
+    extend ActiveSupport::Concern
+    included do
+      alias_method_chain :sendgrid_unique_args, :merge_args
+    end
+
+    def sendgrid_unique_args_with_merge_args(args={})
+      @sg_unique_args ||= {}
+      @sg_unique_args.merge! args
+    end
+
+    def mail(headers={}, &block)
+        id = SendgridEmailRecord.create!(:to => headers[:to],
+                                         :from => headers[:from],
+                                         :subject => headers[:subject],
+                                         :status => 'processing').id
+        sendgrid_unique_args :sendgrid_events_id => id
+      super headers, &block
+    end
+  end
+end
+SendGrid.send :include, SendgridEvents::ActionMailerOverride

data/lib/sendgrid_events/configure.rb

@@ -0,0 +1,23 @@
+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
+  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.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/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
+            handlee
+          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