sendgrid_events_pbxx 0.1.4

data/script/rails

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/sendgrid_events/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/sendgrid_events.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/sendgrid_events/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jon Phenow", "Russen Guggemos"]
+  gem.email         = ["jon.phenow@tstmedia.com","russen@promoboxx.com"]
+  gem.description   = %q{}
+  gem.summary       = %q{}
+  gem.homepage      = ""
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "sendgrid_events_pbxx"
+  gem.version       = SendgridEvents::VERSION
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'awesome_print'
+  gem.add_development_dependency 'rspec-rails', '~> 2'
+  gem.add_development_dependency 'capybara'
+  gem.add_development_dependency 'rails', '~> 3.2'
+  gem.add_development_dependency 'factory_girl_rails', '~> 1.7'
+  gem.add_development_dependency 'sqlite3'
+
+  gem.add_dependency 'rails', '~> 3.2'
+  gem.add_dependency 'sendgrid-rails', '~> 2.0'
+  gem.add_dependency 'enumerated_field'
+end

data/spec/sendgrid_events/action_mailer_override_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+class TestMailer < ActionMailer::Base
+  def test_mail
+    sendgrid_email_record_attributes user_id: 42
+    mail(to: "to@example.com", from: "from@example.com", subject: "Test Mail")
+  end
+end
+
+module SendgridEvents
+  describe ActionMailerOverride do
+    let(:recorded_email) { SendgridEvents::SendgridEmailRecord.last }
+
+
+    describe "records the sent email" do
+      before { @mail = TestMailer.test_mail }
+      specify { recorded_email.to.should      == "to@example.com"   }
+      specify { recorded_email.from.should    == "from@example.com" }
+      specify { recorded_email.subject.should == "Test Mail"        }
+      specify { recorded_email.status.should  == 'processing'       }
+    end
+
+    describe "stores new event record's id in the uniq args" do
+      before                { @mail = TestMailer.test_mail }
+      let(:sendgrid_header) { @mail.instance_variable_get(:@sendgrid_header) }
+
+      specify { sendgrid_header.data[:unique_args].should == { sendgrid_events_id: recorded_email.id} }
+    end
+
+    describe "passes additional attributes to SendgridEmailRecord" do
+      let(:email_record) { stub.as_null_object }
+
+      specify do
+        SendgridEmailRecord.should_receive(:create_from_headers!).with do |_, additional_attributes|
+          additional_attributes.should == { user_id: 42 }
+        end.and_return(email_record)
+
+        TestMailer.test_mail
+      end
+    end
+  end
+end

data/spec/sendgrid_events/handlers/base_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+module SendgridEvents
+  module Handlers
+    describe Base do
+      subject { Base }
+      it { should respond_to(:handle) }
+      it { should_not respond_to(:handlee) }
+      it { should respond_to(:registered_handlers) }
+      it { should respond_to(:selected_handlers) }
+      it { should respond_to(:choose_and_handle) }
+      it { should respond_to(:register_as_handler_for) }
+      let(:event) { {
+        :email => "foo@bar.com",
+        :timestamp => 1322000095,
+        :sendgrid_events_id => '7',
+        :event => "delivered"
+      } }
+
+      it "returns the list of handlers" do
+        subject.registered_handlers.keys.sort.should == Dispatch.acceptable_handlers.keys.sort
+      end
+
+      it "chose a handler if handler is registered" do
+        subject.stub(:selected_handlers).and_return({ "delivered" => true })
+        Delivered.should_receive(:handle).with(event)
+        subject.choose_and_handle(event)
+      end
+
+      it "doesn't handle a non-selected handler" do
+        subject.stub(:selected_handlers).and_return({})
+        Delivered.should_not_receive(:handle).with(event)
+        subject.choose_and_handle(event)
+      end
+
+      it "doesn't handle a non-registered handler" do
+        subject.stub(:selected_handlers).and_return({ "delivered" => true })
+        subject.stub(:registered_handlers).and_return({})
+        Delivered.should_not_receive(:handle).with(event)
+        subject.choose_and_handle(event)
+      end
+
+      it "doesn't regitser a new handle with unacceptable handle" do
+        expect { subject.register_as_handler_for(:winning) }.to raise_error(ArgumentError)
+      end
+    end
+  end
+end

data/spec/sendgrid_events/handlers/bounced_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+module SendgridEvents
+  module Handlers
+    describe Bounced do
+      subject { Bounced }
+      it { should respond_to(:handle) }
+      its(:handlee) { should == 'bounced' }
+      let(:event) { {
+        :email => "foo@bar.com",
+        :timestamp => 1322000095,
+        :sendgrid_events_id => '7',
+        :event => "bounce"
+      } }
+
+      it "updates event, but doesn't call handler without one set" do
+        subject.should_receive(:find_and_update_event).with(event).once
+        subject.should_receive(:handler).never
+        subject.handle(event)
+      end
+
+      it "updates event, but doesn't call handler without one set" do
+        subject.handler do
+          true
+        end
+        subject.stub(:find_and_update_event => true)
+        subject.should_receive(:handler).once
+        subject.handle(event)
+      end
+    end
+  end
+end

data/spec/sendgrid_events/handlers/clicked_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+module SendgridEvents
+  module Handlers
+    describe Clicked do
+      subject { Clicked }
+      it { should respond_to(:handle) }
+      its(:handlee) { should == 'clicked' }
+      let(:event) { {
+        :email => "foo@bar.com",
+        :timestamp => 1322000095,
+        :sendgrid_events_id => '7',
+        :event => "click"
+      } }
+
+      it "updates event, but doesn't call handler without one set" do
+        subject.should_receive(:find_and_update_event).with(event).once
+        subject.should_receive(:handler).never
+        subject.handle(event)
+      end
+
+      it "updates event, but doesn't call handler without one set" do
+        subject.handler do
+          true
+        end
+        subject.stub(:find_and_update_event => true)
+        subject.should_receive(:handler).once
+        subject.handle(event)
+      end
+    end
+  end
+end

data/spec/sendgrid_events/handlers/deferred_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+module SendgridEvents
+  module Handlers
+    describe Deferred do
+      subject { Deferred }
+      it { should respond_to(:handle) }
+      its(:handlee) { should == 'deferred' }
+      let(:event) { {
+        :email => "foo@bar.com",
+        :timestamp => 1322000095,
+        :sendgrid_events_id => '7',
+        :event => "deferred"
+      } }
+
+      it "updates event, but doesn't call handler without one set" do
+        subject.should_receive(:find_and_update_event).with(event).once
+        subject.should_receive(:handler).never
+        subject.handle(event)
+      end
+
+      it "updates event, but doesn't call handler without one set" do
+        subject.handler do
+          true
+        end
+        subject.stub(:find_and_update_event => true)
+        subject.should_receive(:handler).once
+        subject.handle(event)
+      end
+    end
+  end
+end

data/spec/sendgrid_events/handlers/delivered_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+module SendgridEvents
+  module Handlers
+    describe Delivered do
+      subject { Delivered }
+      it { should respond_to(:handle) }
+      its(:handlee) { should == 'delivered' }
+      let(:event) { {
+        :email => "foo@bar.com",
+        :timestamp => 1322000095,
+        :sendgrid_events_id => '7',
+        :event => "delivered"
+      } }
+
+      it "updates event, but doesn't call handler without one set" do
+        subject.should_receive(:find_and_update_event).with(event).once
+        subject.should_receive(:handler).never
+        subject.handle(event)
+      end
+
+      it "updates event, but doesn't call handler without one set" do
+        subject.handler do
+          true
+        end
+        subject.stub(:find_and_update_event => true)
+        subject.should_receive(:handler).once
+        subject.handle(event)
+      end
+    end
+  end
+end

data/spec/sendgrid_events/handlers/dispatch_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+module SendgridEvents
+  module Handlers
+    describe Dispatch do
+      subject { Dispatch }
+    end
+  end
+end

data/spec/sendgrid_events/handlers/dropped_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+module SendgridEvents
+  module Handlers
+    describe Dropped do
+      subject { Dropped }
+      it { should respond_to(:handle) }
+      its(:handlee) { should == 'dropped' }
+      let(:event) { {
+        :email => "foo@bar.com",
+        :timestamp => 1322000095,
+        :sendgrid_events_id => '7',
+        :event => "dropped"
+      } }
+
+      it "updates event, but doesn't call handler without one set" do
+        subject.should_receive(:find_and_update_event).with(event).once
+        subject.should_receive(:handler).never
+        subject.handle(event)
+      end
+
+      it "updates event, but doesn't call handler without one set" do
+        subject.handler do
+          true
+        end
+        subject.stub(:find_and_update_event => true)
+        subject.should_receive(:handler).once
+        subject.handle(event)
+      end
+    end
+  end
+end

data/spec/sendgrid_events/handlers/opened_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+module SendgridEvents
+  module Handlers
+    describe Opened do
+      subject { Opened }
+      it { should respond_to(:handle) }
+      its(:handlee) { should == 'opened' }
+      let(:event) { {
+        :email => "foo@bar.com",
+        :timestamp => 1322000095,
+        :sendgrid_events_id => '7',
+        :event => "open"
+      } }
+
+      it "updates event, but doesn't call handler without one set" do
+        subject.should_receive(:find_and_update_event).with(event).once
+        subject.should_receive(:handler).never
+        subject.handle(event)
+      end
+
+      it "updates event, but doesn't call handler without one set" do
+        subject.handler do
+          true
+        end
+        subject.stub(:find_and_update_event => true)
+        subject.should_receive(:handler).once
+        subject.handle(event)
+      end
+    end
+  end
+end

data/spec/sendgrid_events/handlers/processed_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+module SendgridEvents
+  module Handlers
+    describe Processed do
+      subject { Processed }
+      it { should respond_to(:handle) }
+      its(:handlee) { should == 'processed' }
+      let(:event) { {
+        :email => "foo@bar.com",
+        :timestamp => 1322000095,
+        :sendgrid_events_id => '7',
+        :event => "processed"
+      } }
+
+      it "updates event, but doesn't call handler without one set" do
+        subject.should_receive(:find_and_update_event).with(event).once
+        subject.should_receive(:handler).never
+        subject.handle(event)
+      end
+
+      it "updates event, but doesn't call handler without one set" do
+        subject.handler do
+          true
+        end
+        subject.stub(:find_and_update_event => true)
+        subject.should_receive(:handler).once
+        subject.handle(event)
+      end
+    end
+  end
+end

data/spec/sendgrid_events/handlers/spam_reported_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+module SendgridEvents
+  module Handlers
+    describe SpamReported do
+      subject { SpamReported }
+      it { should respond_to(:handle) }
+      its(:handlee) { should == 'spamreported' }
+      let(:event) { {
+        :email => "foo@bar.com",
+        :timestamp => 1322000095,
+        :sendgrid_events_id => '7',
+        :event => "spamreport"
+      } }
+
+      it "updates event, but doesn't call handler without one set" do
+        subject.should_receive(:find_and_update_event).with(event).once
+        subject.should_receive(:handler).never
+        subject.handle(event)
+      end
+
+      it "updates event, but doesn't call handler without one set" do
+        subject.handler do
+          true
+        end
+        subject.stub(:find_and_update_event => true)
+        subject.should_receive(:handler).once
+        subject.handle(event)
+      end
+    end
+  end
+end

data/spec/sendgrid_events/handlers/unsubscribed_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+module SendgridEvents
+  module Handlers
+    describe Unsubscribed do
+      subject { Unsubscribed }
+      it { should respond_to(:handle) }
+      its(:handlee) { should == 'unsubscribed' }
+      let(:event) { {
+        :email => "foo@bar.com",
+        :timestamp => 1322000095,
+        :sendgrid_events_id => '7',
+        :event => "unsubscribe"
+      } }
+
+      it "updates event, but doesn't call handler without one set" do
+        subject.should_receive(:find_and_update_event).with(event).once
+        subject.should_receive(:handler).never
+        subject.handle(event)
+      end
+
+      it "updates event, but doesn't call handler without one set" do
+        subject.handler do
+          true
+        end
+        subject.stub(:find_and_update_event => true)
+        subject.should_receive(:handler).once
+        subject.handle(event)
+      end
+    end
+  end
+end

data/spec/sendgrid_events/receiver_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+module SendgridEvents
+  describe Receiver do
+    before do
+      Configure.config do
+        foreign_key 'sendgrid_events_id'
+      end
+    end
+    subject { Receiver }
+    it { should respond_to(:receive) }
+
+    let(:params) {
+      { "_json" => [
+        {"email" => "foo@bar.com", "timestamp" => 1322000095,"sendgrid_events_id" => "7", "event" => "delivered"},
+        {"email" => "foo@bar.com", "timestamp" => 1322000096, "sendgrid_events_id" => "4", "event" => "delivered"}
+      ] }
+    }
+
+    it "sends the poorly composed params to be cleaned then handles" do
+      Handlers::Base.should_receive(:choose_and_handle).exactly(2).times
+      subject.receive params
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,42 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'action_mailer'
+require 'rails'
+require 'sqlite3'
+require 'active_record'
+require 'enumerated_field'
+
+ActiveRecord::Base.establish_connection :adapter => 'sqlite3', :database => ':memory:'
+ActiveRecord::Schema.define do
+  create_table :sendgrid_email_records, :force => true do |t|
+    t.string :status
+    t.string :to
+    t.string :from
+    t.string :subject
+
+    t.timestamps
+  end
+end
+
+Dir.glob(File.expand_path('../../app/models/**/*.rb', __FILE__)).each { |file| require file }
+require 'sendgrid_events'
+
+ActionMailer::Base.delivery_method = :test
+ActionMailer::Base.register_interceptor(SendGrid::MailInterceptor)
+
+RSpec.configure do |config|
+
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end