mandrill_event 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 357fad87e433403ede41ebe47e29dea49ac64e27
+  data.tar.gz: f7c5bc7a8a2b84e18ae9ae10ac5e01afb73205d2
+SHA512:
+  metadata.gz: ac53717af144185c834bc2b90d54928eb0d59f31e7d9c0f9b842bee1ab1a4b7aa8528c6147d2cc28965f6c826f541914931915c6fd6719ff1050e6e58b2d862f
+  data.tar.gz: a99ce98a1a482f642c646e5db5a2690e72cb83de4b70e3c9d24791dd38100234659b4069637ac63d63444885315162e94f0b206e2b217d928da9bfe2d8bed445

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+spec/dummy/log
+/.ruby-version
+/.ruby-gemset
+

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format d
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mandrill_event.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,62 @@
+
+## Uncomment to clear the screen before every task
+# clearing :on
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "ostruct"
+
+  # Generic Ruby apps
+  rspec = OpenStruct.new
+  rspec.spec = ->(m) { "spec/#{m}_spec.rb" }
+  rspec.spec_dir = "spec"
+  rspec.spec_helper = "spec/spec_helper.rb"
+
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| rspec.spec.("lib/#{m[1]}") }
+  watch(rspec.spec_helper)      { rspec.spec_dir }
+
+  # Rails example
+  rails = OpenStruct.new
+  # rails.app = %r{^app/(.+)\.rb$}
+  # rails.views_n_layouts = %r{^app/(.*)(\.erb|\.haml|\.slim)$}
+  rails.controllers = %r{^app/controllers/(.+)_controller\.rb$}
+  # rails.routes = "config/routes.rb"
+  # rails.app_controller = "app/controllers/application_controller.rb"
+  # rails.spec_helper = "spec/rails_helper.rb"
+  # rails.spec_support = %r{^spec/support/(.+)\.rb$}
+  # rails.views = %r{^app/views/(.+)/.*\.(erb|haml|slim)$}
+
+  # watch(rails.app) { |m| rspec.spec.(m[1]) }
+  # watch(rails.views_n_layouts) { |m| rspec.spec.("#{m[1]}#{m[2]}") }
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.("routing/#{m[1]}_routing"),
+      rspec.spec.("controllers/#{m[1]}_controller"),
+      rspec.spec.("acceptance/#{m[1]}")
+    ]
+  end
+
+  # watch(rails.spec_support)    { rspec.spec_dir }
+  # watch(rails.spec_helper)     { rspec.spec_dir }
+  # watch(rails.routes)          { "spec/routing" }
+  # watch(rails.app_controller)  { "spec/controllers" }
+
+  # # Capybara features specs
+  # watch(rails.views)     { |m| rspec.spec.("features/#{m[1]}") }
+
+  # # Turnip features and steps
+  # watch(%r{^spec/acceptance/(.+)\.feature$})
+  # watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+  #   Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  # end
+
+end

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Netsign Communications Inc.
+
+MIT License
+
+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,68 @@
+# MandrillEvent
+
+MandrillEvent is built on the ActiveSupport::Notifications API. Define subscribers to handle specific event types. Subscribers can be a block or an object that responds to #call.
+
+
+## Installation
+
+### Add it to your Gemfile
+
+```ruby
+# Gemfile
+gem 'mandrill_event', github: 'netsign/mandrill_event'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+### Mount the engine in your routes
+
+```ruby
+# config/routes.rb
+  mount MandrillEvent::Engine => '/mandrill'
+```
+
+### Setup the initializer
+
+```ruby
+# config/initializers/mandrill_event.rb
+MandrillEvent.configure do |events|
+  events.subscribe 'reject', RejectHandler.new
+end
+```
+
+### Create subscriber objects that respond to #call
+
+```ruby
+# app/mandrill_handlers/reject_handler.rb
+class RejectHandler
+  def call(event)
+    # your code here
+  end
+end
+```
+
+## Thanks
+
+MandrillEvent ~~takes inspiration from~~ is a direct rip-off of the [stripe_event](https://github.com/integrallis/stripe_event) gem, which takes it's inspiration from [Webmachine](https://github.com/seancribbs/webmachine-ruby/blob/6edaecea1ceab7c2c54fc5e83446317524f6bb8b/lib/webmachine/events.rb), which is inspired by Erlang. It's turtles all the way down.
+
+
+## TODO:
+
+* More test coverage
+* Incoming webhook requests are authenticated
+* Get it on Coveralls
+* Get it on Travis
+* Get it on Code Climate
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/mandrill_event/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/controllers/mandrill_event/events_controller.rb

@@ -0,0 +1,15 @@
+module MandrillEvent
+  class EventsController < ActionController::Base
+
+    def index
+      head :ok
+    end
+
+    def create
+      MandrillEvent.process(params)
+      head :ok
+    # rescue MandrillEvent::UnauthorizedError
+    #   head :unauthorized
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+MandrillEvent::Engine.routes.draw do
+  resources :events, only: [:index, :create]
+end

data/lib/mandrill_event/engine.rb

@@ -0,0 +1,5 @@
+module MandrillEvent
+  class Engine < ::Rails::Engine
+    isolate_namespace MandrillEvent
+  end
+end

data/lib/mandrill_event/version.rb

@@ -0,0 +1,3 @@
+module MandrillEvent
+  VERSION = '0.0.1'
+end

data/lib/mandrill_event.rb

@@ -0,0 +1,60 @@
+require 'active_support/notifications'
+require 'mandrill_event/version'
+require 'mandrill_event/engine' if defined?(Rails)
+require 'json'
+
+module MandrillEvent
+
+  class << self
+    attr_accessor :adapter, :backend, :namespace
+
+    def configure(&block)
+      raise ArgumentError, 'must provide a block' unless block_given?
+      block.arity.zero? ? instance_eval(&block) : yield(self)
+    end
+
+    def process(params)
+      JSON.parse(params['mandrill_events'] || '[]').each do |event_params|
+        instrument(event_params)
+      end
+    end
+
+    def instrument(params)
+      backend.instrument namespace.call(params['event']), params
+    end
+
+    def subscribe(name, callable = Proc.new)
+      backend.subscribe namespace.to_regexp(name), adapter.call(callable)
+    end
+
+  end
+
+  class Namespace < Struct.new(:value, :delimiter)
+    def call(name = nil)
+      "#{value}#{delimiter}#{name}"
+    end
+
+    def to_regexp(name = nil)
+      %r{^#{Regexp.escape call(name)}}
+    end
+  end
+
+  class NotificationAdapter < Struct.new(:subscriber)
+    def self.call(callable)
+      new(callable)
+    end
+
+    def call(*args)
+      payload = args.last
+      subscriber.call(payload)
+    end
+  end
+
+  class Error < StandardError; end
+  class UnauthorizedError < Error; end
+
+  self.adapter = NotificationAdapter
+  self.backend = ActiveSupport::Notifications
+  self.namespace = Namespace.new('mandrill_event', '.')
+
+end

data/mandrill_event.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mandrill_event/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mandrill_event'
+  spec.version       = MandrillEvent::VERSION
+  spec.authors       = ['Weston Triemstra']
+  spec.email         = ['weston@netsign.com']
+  spec.summary       = %q{Mandrill webhook integration for Rails.}
+  # spec.description   = %q{TODO: Write a longer description. Optional.}
+  spec.homepage      = 'https://github.com/netsign/mandrill_event'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '>= 3.1'
+
+  spec.add_development_dependency 'rails', '>= 4.1'
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-rails', '~> 3.0'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-remote'
+  spec.add_development_dependency 'pry-nav'
+
+end

data/spec/controllers/events_controller_spec.rb

@@ -0,0 +1,44 @@
+require 'rails_helper'
+require 'spec_helper'
+
+describe MandrillEvent::EventsController, :type => :controller do
+
+  def webhook(params)
+    post :create, params.merge(use_route: :mandrill)
+  end
+
+  context 'mandrill checks for working endpoint' do
+
+    describe 'HEAD index' do
+
+      it 'returns status 200' do
+        head :index, use_route: :mandrill
+        expect(response.code).to eq('200')
+      end
+
+    end
+
+  end
+
+  context 'with valid event params' do
+
+    describe 'POST create' do
+
+      let(:params) { {mandrill_events: webhook_example_events('rejects')} }
+
+      it 'returns status 200' do
+        webhook params
+        expect(response.code).to eq('200')
+      end
+
+      it 'calls MandrillEvent.process' do
+        allow(MandrillEvent).to receive(:process).and_return(true)
+        expect(MandrillEvent).to receive(:process)
+        webhook params
+      end
+
+    end
+
+  end
+
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/config/application.rb

@@ -0,0 +1,31 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+# require "active_record/railtie"
+require "action_controller/railtie"
+# require "action_mailer/railtie"
+# require "action_view/railtie"
+# require "sprockets/railtie"
+# require "rails/test_unit/railtie"
+
+# Bundler.require(*Rails.groups)
+require 'mandrill_event'
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    config.eager_load_paths += %W(#{config.root}/../../app/controllers)
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,85 @@
+# PostgreSQL. Versions 8.2 and up are supported.
+#
+# Install the pg driver:
+#   gem install pg
+# On OS X with Homebrew:
+#   gem install pg -- --with-pg-config=/usr/local/bin/pg_config
+# On OS X with MacPorts:
+#   gem install pg -- --with-pg-config=/opt/local/lib/postgresql84/bin/pg_config
+# On Windows:
+#   gem install pg
+#       Choose the win32 build.
+#       Install PostgreSQL and put its /bin directory on your path.
+#
+# Configure Using Gemfile
+# gem 'pg'
+#
+default: &default
+  adapter: postgresql
+  encoding: unicode
+  # For details on connection pooling, see rails configuration guide
+  # http://guides.rubyonrails.org/configuring.html#database-pooling
+  pool: 5
+
+development:
+  <<: *default
+  database: dummy_development
+
+  # The specified database role being used to connect to postgres.
+  # To create additional roles in postgres see `$ createuser --help`.
+  # When left blank, postgres will use the default role. This is
+  # the same name as the operating system user that initialized the database.
+  #username: dummy
+
+  # The password associated with the postgres role (username).
+  #password:
+
+  # Connect on a TCP socket. Omitted by default since the client uses a
+  # domain socket that doesn't need configuration. Windows does not have
+  # domain sockets, so uncomment these lines.
+  #host: localhost
+
+  # The TCP port the server listens on. Defaults to 5432.
+  # If your server runs on a different port number, change accordingly.
+  #port: 5432
+
+  # Schema search path. The server defaults to $user,public
+  #schema_search_path: myapp,sharedapp,public
+
+  # Minimum log levels, in increasing order:
+  #   debug5, debug4, debug3, debug2, debug1,
+  #   log, notice, warning, error, fatal, and panic
+  # Defaults to warning.
+  #min_messages: notice
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: dummy_test
+
+# As with config/secrets.yml, you never want to store sensitive information,
+# like your database password, in your source code. If your source code is
+# ever seen by anyone, they now have access to your database.
+#
+# Instead, provide the password as a unix environment variable when you boot
+# the app. Read http://guides.rubyonrails.org/configuring.html#configuring-a-database
+# for a full rundown on how to provide these environment variables in a
+# production deployment.
+#
+# On Heroku and other platform providers, you may have a full connection URL
+# available as an environment variable. For example:
+#
+#   DATABASE_URL="postgres://myuser:mypass@localhost/somedatabase"
+#
+# You can use this database configuration with:
+#
+#   production:
+#     url: <%= ENV['DATABASE_URL'] %>
+#
+production:
+  <<: *default
+  database: dummy_production
+  username: dummy
+  password: <%= ENV['DUMMY_DATABASE_PASSWORD'] %>

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,37 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  # config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  # config.assets.debug = true
+
+  # Adds additional error checking when serving assets at runtime.
+  # Checks for improperly declared sprockets dependencies.
+  # Raises helpful error messages.
+  # config.assets.raise_runtime_errors = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end