recoil 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b7681cd36e4fde7955fd8f33c5679f1fb212419f
+  data.tar.gz: 94f28e1bd854a05f8a91aca5c0d40b4ebd368a94
+SHA512:
+  metadata.gz: 8f508b60ed8ceccc4684b2a83fef3c26c6ae18a70b7756cd1df3d1a37d7cfd938fd94645b4f6fba436294d7ed58d52f23cc9d6040477166c4c0597fa731f1239
+  data.tar.gz: 784668189d77b52da0971695b2ae8c36123e048847839c167ef4eb4a03dc9259dd8b99ebf6c2361e355a013ec8611c966d041e344e5b76dde374b708cc064aea

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Brightin
+
+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,40 @@
+# Recoil
+![Recoil](http://nowthatsgangsta.com/wp-content/uploads/Sniper-Rrifle-Recoil.gif)
+
+Rails delivery method. Send via Amazon SES, but with local blacklist.
+
+Warning: This is an early version of the gem. If you're sending an email to multiple receivers this gem might break in unexpected ways.
+
+## Installation
+
+Add this line to your application's Gemfile and run `bundle install`:
+
+```ruby
+gem 'recoil'
+```
+
+Copy migrations and run
+```ruby
+rake recoil:install:migrations
+rake db:migrate
+```
+
+Change the action mailer delivery method:
+```ruby
+config.action_mailer.delivery_method = :recoil
+```
+
+Add endpoint to routes:
+```ruby
+mount Recoil::Engine => '/ses'
+```
+
+Subscribe to SES notifications... and profit!
+
+## Contributing
+
+1. Fork it ( https://github.com/brightin/recoil/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,29 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/controllers/recoil/notifications_controller.rb

@@ -0,0 +1,8 @@
+module Recoil
+  class NotificationsController < ActionController::Base
+    def index
+      Message.for(params).process!
+      head :no_content
+    end
+  end
+end

data/app/models/recoil/bounce.rb

@@ -0,0 +1,4 @@
+module Recoil
+  class Bounce < ActiveRecord::Base
+  end
+end

data/bin/rails

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 4 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/recoil/engine', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/config/routes.rb

@@ -0,0 +1,3 @@
+Recoil::Engine.routes.draw do
+  post '/' => 'notifications#index'
+end

data/db/migrate/20150305152728_add_emails_table.rb

@@ -0,0 +1,10 @@
+class AddEmailsTable < ActiveRecord::Migration
+  def change
+    create_table :recoil_bounces do |t|
+      t.string :email
+      t.string :bounce_type
+
+      t.timestamps
+    end
+  end
+end

data/lib/recoil/delivery_method.rb

@@ -0,0 +1,16 @@
+require 'aws-sdk'
+
+module Recoil
+  class DeliveryMethod
+    attr_accessor :settings
+
+    def initialize(options = {})
+      @settings = options
+    end
+
+    def deliver!(email)
+      return if Email.blacklisted?(email['to'])
+      AWS::SimpleEmailService.new.send_raw_email(email)
+    end
+  end
+end

data/lib/recoil/email.rb

@@ -0,0 +1,11 @@
+module Recoil
+  Email = Struct.new(:bounces) do
+    def self.blacklisted?(email)
+      new(Bounce.where(email: email).count).blacklisted?
+    end
+
+    def blacklisted?
+      Recoil.blacklist_threshold.call(self)
+    end
+  end
+end

data/lib/recoil/engine.rb

@@ -0,0 +1,11 @@
+module Recoil
+  class Engine < ::Rails::Engine
+    isolate_namespace Recoil
+
+    initializer "Add delivery method" do
+      ActiveSupport.on_load :action_mailer do
+        ActionMailer::Base.add_delivery_method :recoil, DeliveryMethod, {}
+      end
+    end
+  end
+end

data/lib/recoil/message/abstract.rb

@@ -0,0 +1,15 @@
+module Recoil
+  module Message
+    class Abstract
+      attr_reader :message
+
+      def initialize(message)
+        @message = message
+      end
+
+      def process!
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/recoil/message/notification.rb

@@ -0,0 +1,18 @@
+require 'recoil/message/abstract'
+require 'json'
+
+module Recoil
+  module Message
+    class Notification < Abstract
+      def process!
+        body = JSON.parse(message['Message'])
+        body['bounce']['bouncedRecipients'].each do |bounce|
+          Bounce.create!(
+            email: bounce['emailAddress'],
+            bounce_type: body['bounce']['bounceType']
+          )
+        end
+      end
+    end
+  end
+end

data/lib/recoil/message/subscription_confirmation.rb

@@ -0,0 +1,17 @@
+require 'recoil/message/abstract'
+
+module Recoil
+  module Message
+    class SubscriptionConfirmation < Abstract
+      def process!
+        Net::HTTP.get(subscribe_url)
+      end
+
+      private
+
+      def subscribe_url
+        URI(message['SubscribeURL'])
+      end
+    end
+  end
+end

data/lib/recoil/message/unsubscribe_confirmation.rb

@@ -0,0 +1,11 @@
+require 'recoil/message/abstract'
+
+module Recoil
+  module Message
+    class UnsubscribeConfirmation < Abstract
+      def process!
+        # NOOP
+      end
+    end
+  end
+end

data/lib/recoil/message.rb

@@ -0,0 +1,16 @@
+require 'active_support/inflector'
+require 'recoil/message/notification'
+require 'recoil/message/subscription_confirmation'
+require 'recoil/message/unsubscribe_confirmation'
+
+module Recoil
+  module Message
+    TypeUnknown = Class.new(StandardError)
+
+    def self.for(params)
+      "Recoil::Message::#{params['Type']}".constantize.new(params)
+    rescue NameError
+      raise TypeUnknown, "Unknown type #{params['Type']}"
+    end
+  end
+end

data/lib/recoil/version.rb

@@ -0,0 +1,3 @@
+module Recoil
+  VERSION = "0.0.1"
+end

data/lib/recoil.rb

@@ -0,0 +1,13 @@
+require 'recoil/engine'
+require 'recoil/delivery_method'
+require 'recoil/message'
+require 'recoil/email'
+
+module Recoil
+  mattr_accessor :blacklist_threshold
+  @@blacklist_threshold = ->(record) { record.bounces > 3 }
+
+  def self.setup
+    yield self
+  end
+end

data/recoil.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'recoil/version'
+
+Gem::Specification.new do |s|
+  s.name          = "recoil"
+  s.version       = Recoil::VERSION
+  s.authors       = ["Brightin"]
+  s.email         = ["developers@brightin.nl"]
+  s.summary       = 'Send emails with Amazon SES with automatic blacklisting'
+  s.description   = 'Send emails with Amazon SES with automatic blacklisting'
+  s.homepage      = "http://www.brightin.nl"
+  s.license       = "MIT"
+
+  s.files         = `git ls-files -z`.split("\x0")
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'rails', '>= 4.0'
+  s.add_dependency 'aws-sdk', '~> 1.60'
+  s.add_development_dependency "rspec", "~> 3.2.0"
+  s.add_development_dependency "rspec-rails"
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "vcr", "~> 2.9.0"
+  s.add_development_dependency "webmock", "~> 1.20.0"
+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/assets/javascripts/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 any plugin's vendor/assets/javascripts directory 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/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * 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 any plugin's vendor/assets/stylesheets directory 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 bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

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/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/spec/dummy/config/application.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "recoil"
+
+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.
+
+    # 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
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+  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,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# 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: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

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,41 @@
+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
+
+  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
+  # yet still be able to expire them through the digest params.
+  config.assets.digest = 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