special-delivery 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4768d6c31c2e94ba4eb4f37a4a62bb5f7f94da1f
+  data.tar.gz: 4b32439c6ff8ffaf4d852e070fa5fa5f2d7b0c6d
+SHA512:
+  metadata.gz: 7b64162f3a7aa0efa1cd687984c7fd591099eecbb475ef215ca43b9a4be8fc2e00e65fdd576a7d2f91466787a25d90556ad957983e81f0a833c2cd78cc105ea1
+  data.tar.gz: b1ff851ceea36294cd22efc969019b4b3eef2c97f26f97306a5dec9ce24a17ed62f166f81309245dbb69b7beadce46798a86026cf5e703e7aa975966cd782b18

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 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.rdoc

@@ -0,0 +1,3 @@
+= SpecialDelivery
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,23 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SpecialDelivery'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/assets/javascripts/special_delivery/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/javascripts/special_delivery/events.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/special_delivery/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/assets/stylesheets/special_delivery/events.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/special_delivery/application_controller.rb

@@ -0,0 +1,4 @@
+module SpecialDelivery
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/special_delivery/events_controller.rb

@@ -0,0 +1,35 @@
+require_dependency "special_delivery/application_controller"
+
+module SpecialDelivery
+  class EventsController < ApplicationController
+    skip_before_filter :verify_authenticity_token
+
+    before_filter :ensure_authenticity
+
+    rescue_from ActiveRecord::RecordNotFound,
+                :with => :issue_accepted_response
+
+    def create
+      event.issue_callback
+      render_nothing(:ok)
+    end
+
+    private
+
+    def issue_accepted_response
+      render_nothing(:accepted)
+    end
+
+    def render_nothing(http_status)
+      render nothing: true, status: http_status
+    end
+
+    def ensure_authenticity
+      Authenticator.new(params).authentic? || render_nothing(:unauthorized)
+    end
+
+    def event
+      @event ||= EventFactory.new_event(params)
+    end
+  end
+end

data/app/models/special_delivery/delivery.rb

@@ -0,0 +1,18 @@
+module SpecialDelivery
+  class Delivery < ActiveRecord::Base
+    belongs_to :deliverable, polymorphic: true
+
+    validates :callback_class_name, :message_id, :presence => true
+
+    def callback(event_type)
+      callback_class.send(event_type, deliverable) if callback_class
+    end
+
+    private
+
+    def callback_class
+      callback_class_name.constantize
+    rescue NameError
+    end
+  end
+end

data/app/views/layouts/special_delivery/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>SpecialDelivery</title>
+  <%= stylesheet_link_tag    "special_delivery/application", media: "all" %>
+  <%= javascript_include_tag "special_delivery/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,3 @@
+SpecialDelivery::Engine.routes.draw do
+  post "/" => "events#create", :as => "root"
+end

data/db/migrate/20131111152047_create_special_delivery_deliveries.rb

@@ -0,0 +1,12 @@
+class CreateSpecialDeliveryDeliveries < ActiveRecord::Migration
+  def change
+    create_table :special_delivery_deliveries do |t|
+      t.string :callback_class_name
+      t.integer :deliverable_id
+      t.string :deliverable_type
+      t.string :message_id
+
+      t.timestamps
+    end
+  end
+end

data/lib/special_delivery/authenticator.rb

@@ -0,0 +1,37 @@
+module SpecialDelivery
+  class Authenticator
+    def initialize(event_params)
+      @event_params = event_params.to_hash
+    end
+
+    def authentic?
+      actual_signature == expected_signature
+    rescue
+      false
+    end
+
+    private
+
+    attr_reader :event_params
+
+    def expected_signature
+      OpenSSL::HMAC.hexdigest(OpenSSL::Digest::Digest.new('sha256'), api_key,"#{timestamp}#{token}")
+    end
+
+    def api_key
+      MAILGUN_CONFIG[:api_key]
+    end
+
+    def timestamp
+      event_params.fetch('timestamp')
+    end
+
+    def token
+      event_params.fetch('token')
+    end
+
+    def actual_signature
+      event_params.fetch('signature')
+    end
+  end
+end

data/lib/special_delivery/base_event.rb

@@ -0,0 +1,23 @@
+module SpecialDelivery
+  class BaseEvent
+    attr_reader :params
+
+    def initialize(params)
+      @params = params || {}
+    end
+
+    def issue_callback
+      delivery.callback(callback_method)
+    end
+
+    private
+
+    def callback_method
+      raise NotImplementedError, 'Event subclasses must implement #callback_method'
+    end
+
+    def delivery
+      @delivery ||= Delivery.find_by_message_id!(params.fetch('Message-Id'))
+    end
+  end
+end

data/lib/special_delivery/bounce_event.rb

@@ -0,0 +1,10 @@
+module SpecialDelivery
+  class BounceEvent < BaseEvent
+
+    private
+
+    def callback_method
+      :bounced
+    end
+  end
+end

data/lib/special_delivery/callback.rb

@@ -0,0 +1,40 @@
+module SpecialDelivery
+  class Callback
+    def bounced(*args); end
+    def clicked(*args); end
+    def complained(*args); end
+    def delivered(*args); end
+    def dropped(*args); end
+    def opened(*args); end
+    def unsubscribed(*args); end
+
+    def evaluate
+      if callback_argument.nil?
+        send(callback_method)
+      else
+        send(callback_method, callback_argument)
+      end
+    end
+
+    def self.respond_to?(method, include_private = false)
+      super || public_instance_methods(true).include?(method)
+    end
+
+    def self.method_missing(method_name, *args)
+      if respond_to?(method_name)
+        new(method_name, *args).evaluate
+      else
+        super
+      end
+    end
+
+    private
+
+    attr_reader :callback_argument, :callback_method
+
+    def initialize(callback_method, *args)
+      @callback_method = callback_method
+      @callback_argument = args[0].presence
+    end
+  end
+end

data/lib/special_delivery/click_event.rb

@@ -0,0 +1,10 @@
+module SpecialDelivery
+  class ClickEvent < BaseEvent
+
+    private
+
+    def callback_method
+      :clicked
+    end
+  end
+end

data/lib/special_delivery/complaint_event.rb

@@ -0,0 +1,10 @@
+module SpecialDelivery
+  class ComplaintEvent < BaseEvent
+
+    private
+
+    def callback_method
+      :complained
+    end
+  end
+end

data/lib/special_delivery/delivery_event.rb

@@ -0,0 +1,10 @@
+module SpecialDelivery
+  class DeliveryEvent < BaseEvent
+
+    private
+
+    def callback_method
+      :delivered
+    end
+  end
+end

data/lib/special_delivery/drop_event.rb

@@ -0,0 +1,10 @@
+module SpecialDelivery
+  class DropEvent < BaseEvent
+
+    private
+
+    def callback_method
+      :dropped
+    end
+  end
+end

data/lib/special_delivery/engine.rb

@@ -0,0 +1,7 @@
+module SpecialDelivery
+  class Engine < ::Rails::Engine
+    isolate_namespace SpecialDelivery
+
+    config.autoload_paths += Dir["#{config.root}/lib/**/"]
+  end
+end

data/lib/special_delivery/event_factory.rb

@@ -0,0 +1,19 @@
+module SpecialDelivery
+  class EventFactory
+    EVENT_TYPE_CLASSES = {
+        'opened'       => OpenEvent,
+        'unsubscribed' => UnsubscribeEvent,
+        'complained'   => ComplaintEvent,
+        'bounced'      => BounceEvent,
+        'clicked'      => ClickEvent,
+        'dropped'      => DropEvent,
+        'delivered'    => DeliveryEvent
+      }
+
+    def self.new_event(event_params)
+      event_type = event_params.fetch(:event)
+
+      EVENT_TYPE_CLASSES.fetch(event_type).new(event_params)
+    end
+  end
+end

data/lib/special_delivery/mailer.rb

@@ -0,0 +1,27 @@
+module SpecialDelivery
+  module Mailer
+    def special_delivery(params = {})
+      callback_class = params[:callback_class]
+
+      yield.tap do |mail|
+        if mail && callback_class
+          Delivery.new.tap do |delivery|
+            delivery.callback_class_name = callback_class.to_s
+            delivery.deliverable = params[:callback_record] if params[:callback_record]
+            delivery.message_id = message_id_for(mail)
+          end.save
+        end
+      end
+    end
+
+    private
+
+    def message_id_for(mail)
+      if mail.message_id.blank?
+        mail.message_id = SecureRandom.uuid
+      end
+
+      "<#{mail.message_id}>"
+    end
+  end
+end

data/lib/special_delivery/open_event.rb

@@ -0,0 +1,10 @@
+module SpecialDelivery
+  class OpenEvent < BaseEvent
+
+    private
+
+    def callback_method
+      :opened
+    end
+  end
+end

data/lib/special_delivery/unsubscribe_event.rb

@@ -0,0 +1,10 @@
+module SpecialDelivery
+  class UnsubscribeEvent < BaseEvent
+
+    private
+
+    def callback_method
+      :unsubscribed
+    end
+  end
+end

data/lib/special_delivery/version.rb

@@ -0,0 +1,3 @@
+module SpecialDelivery
+  VERSION = "0.1.0"
+end

data/lib/special_delivery.rb

@@ -0,0 +1,4 @@
+require "special_delivery/engine"
+
+module SpecialDelivery
+end

data/lib/tasks/special_delivery_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :special_delivery do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: special-delivery
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lawson Kurtz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Special Delivery is a Rails engine that enables powerful and easy-to-use
+  callbacks in response to Mailgun events POSTed via webhook.
+email:
+- lawson.kurtz@viget.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/assets/javascripts/special_delivery/application.js
+- app/assets/javascripts/special_delivery/events.js
+- app/assets/stylesheets/special_delivery/application.css
+- app/assets/stylesheets/special_delivery/events.css
+- app/controllers/special_delivery/application_controller.rb
+- app/controllers/special_delivery/events_controller.rb
+- app/models/special_delivery/delivery.rb
+- app/views/layouts/special_delivery/application.html.erb
+- config/routes.rb
+- db/migrate/20131111152047_create_special_delivery_deliveries.rb
+- lib/special_delivery/authenticator.rb
+- lib/special_delivery/base_event.rb
+- lib/special_delivery/bounce_event.rb
+- lib/special_delivery/callback.rb
+- lib/special_delivery/click_event.rb
+- lib/special_delivery/complaint_event.rb
+- lib/special_delivery/delivery_event.rb
+- lib/special_delivery/drop_event.rb
+- lib/special_delivery/engine.rb
+- lib/special_delivery/event_factory.rb
+- lib/special_delivery/mailer.rb
+- lib/special_delivery/open_event.rb
+- lib/special_delivery/unsubscribe_event.rb
+- lib/special_delivery/version.rb
+- lib/special_delivery.rb
+- lib/tasks/special_delivery_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+homepage: https://github.com/vigetlabs/special-delivery
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: A Mailgun Webhook Event Manager
+test_files: []
+has_rdoc: