recoil 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87e82d8f7f24b7d3335c5bd3e7291f1ff80493c9
-  data.tar.gz: dc33eaacc67cd5ce873b4ce15a4d64727a03eda4
+  metadata.gz: 3269c4c5c6231717a8a492750c188db9e1350bff
+  data.tar.gz: a9d986089b643cb8919e37f8bd1c1b4ba9ea2701
 SHA512:
-  metadata.gz: 5d4757afa6e0e1923eb3de8f1a191d22b69283bf0cee1c0c1b78680195db9fd8300fc9c8d7f649cbdccee7dfe23e4c7caa203a8d6971106eb12910662feb3c1b
-  data.tar.gz: d5e023713d948071fd7b0abe3119b88e1673e0033e6f2e4b0199e080712ab3754e4fc4d058335ab931211e3cb159372f06f1dd17fba7595c5387fbb626cbb976
+  metadata.gz: 82262082b4d30016229756467c6677ee1c9ec871afab8ebb7160f033e1d1b624d757e30e9b2bca1acb1c801ca54ca9cb83a310abfb983ac043fdd0a7b924f25d
+  data.tar.gz: a160355df3843dc90698bb8aadea7ea41bad0f713e0e1614e07705b9d3cc0b233a9c25bc4d8d2c7a6ca96a4c52f8c90126a29febd48ac6f7f938867da503d12c

data/.travis.yml

@@ -4,7 +4,7 @@ rvm:
   - 2.1.6
   - 2.2.2
 env:
-  - COVERAGE=true
+  - CODECLIMATE_REPO_TOKEN=8320e6374064729f72e516cbad8c8103ba96ceed1f37b00137c8b81f7cc83e5e
 script:
   - ./bin/rubocop
   - ./bin/brakeman

data/README.md

@@ -1,36 +1,56 @@
 # Recoil
 [![Gem Version](https://badge.fury.io/rb/recoil.svg)](http://badge.fury.io/rb/recoil)
 [![Build Status](https://travis-ci.org/brightin/recoil.svg?branch=master)](https://travis-ci.org/brightin/recoil)
+[![Code Climate](https://codeclimate.com/github/brightin/recoil/badges/gpa.svg)](https://codeclimate.com/github/brightin/recoil)
+[![Test Coverage](https://codeclimate.com/github/brightin/recoil/badges/coverage.svg)](https://codeclimate.com/github/brightin/recoil/coverage)
 
-Rails delivery method. Send via Amazon SES, but with local blacklist.
+Recoil makes sure you're Amazon SES reputation is preserved by blacklisting emails with a bad reputation. Recoil does this with two simple tools:
 
-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.
+1. A HTTP-endpoint to receive bounce notifications and saves them in the database.
+2. A ActionMailer interceptor which is able to filter emails with high-bounce rates.
 
-## Installation
+## Getting started
 
-Add this line to your application's Gemfile and run `bundle install`:
+Recoil works with Rails 4.0 onward. You can add it to you Gemfile with:
 
 ```ruby
 gem 'recoil'
 ```
 
-Copy migrations and run
+Run the bundle command to install it. After you've installed Recoil you need to copy the migrations and migrate the database:
+
 ```ruby
 rake recoil:install:migrations
 rake db:migrate
 ```
 
-Add an initializer: `config/initializers/recoil.rb` with the following content:
+Add the endpoint to your `routes.rb`:
+```ruby
+mount Recoil::Engine => '/ses'
+```
+
+Add an initializer: `config/initializers/recoil.rb` to initialize the interceptor:
 ```ruby
 ActionMailer::Base.register_interceptor(Recoil::Interceptor)
 ```
 
-Add endpoint to routes:
+You're now ready to subscribe to SNS-notifications. Go to the SES-dashboard > Topics > Create new topic, give it a name and save it. Create a new http/https subscription for this topic with the Recoil-URL as endpoint. Make sure Recoil is mounted to this URL because SNS wil send a verification request as soon as you add the subscription. Lastly, when the subscription is added and verified, you're able to let SES send notifications to the SNS topic. This is configurable in the SES-dashboard.
+
+## Configuration
+
+There is just a single configuration option for recoil: `blacklist_threshold`. This is a lamdba with an ActiveRecord-scope as argument. The default configuration is do blacklist all email with 10+ bounces in the last two weeks. This is a very loose policy, but it's easy to change:
+
 ```ruby
-mount Recoil::Engine => '/ses'
+# config/initializers/recoil.rb
+  Recoil.blacklist_threshold = ->(scope) { scope.where('created_at > ?', 1.week.ago).count > 10 }
 ```
 
-Subscribe to SES notifications... and profit!
+##RDocs
+
+You can view the Recoil documentation in RDoc format here:
+
+http://rubydoc.info/github/brightin/recoil
+
 
 ## Contributing
 

data/lib/recoil.rb

@@ -6,8 +6,4 @@ require 'recoil/message'
 module Recoil
   mattr_accessor :blacklist_threshold
   @@blacklist_threshold = ->(scope) { scope.where('created_at > ?', 2.weeks.ago).count > 10 }
-
-  def self.setup
-    yield self
-  end
 end

data/lib/recoil/interceptor.rb

@@ -1,9 +1,8 @@
 module Recoil
   class Interceptor
     def self.delivering_email(message)
-      if message.to.any? { |email| Email.new(email).blacklisted? }
-        message.perform_deliveries = false
-      end
+      # cannot use reject! because .to is not a plain ruby-array.
+      message.to = message.to.reject { |email| Email.new(email).blacklisted? }
     end
   end
 end

data/lib/recoil/version.rb

@@ -1,3 +1,3 @@
 module Recoil
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/recoil.gemspec

@@ -21,11 +21,11 @@ Gem::Specification.new do |s|
   s.add_dependency 'aws-sdk', '< 2'
 
   s.add_development_dependency 'brakeman'
+  s.add_development_dependency 'codeclimate-test-reporter'
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'rspec-rails'
   s.add_development_dependency 'rubocop'
   s.add_development_dependency 'rubocop-rspec'
-  s.add_development_dependency 'simplecov'
   s.add_development_dependency 'sqlite3'
   s.add_development_dependency 'vcr', '~> 2.9.0'
   s.add_development_dependency 'webmock', '~> 1.20.0'

data/spec/recoil/interceptor_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+module Recoil
+  RSpec.describe Interceptor do
+    FakeMessage = Struct.new(:to)
+
+    describe '.delivering_email' do
+      it 'does send all email' do
+        message = FakeMessage.new(['example@example.com', 'example2@example.com'])
+        Interceptor.delivering_email(message)
+        expect(message.to).to eq ['example@example.com', 'example2@example.com']
+      end
+
+      it 'does not send email which are blacklisted' do
+        message = FakeMessage.new(['example@example.com', 'example2@example.com'])
+
+        email_instance = double(:email, blacklisted?: true)
+        email_instance2 = double(:email, blacklisted?: false)
+
+        allow(Email).to receive(:new).with('example@example.com') { email_instance }
+        allow(Email).to receive(:new).with('example2@example.com') { email_instance2 }
+
+        Interceptor.delivering_email(message)
+
+        expect(message.to).to eq ['example2@example.com']
+      end
+    end
+  end
+end

data/spec/recoil/message/abstract_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+require 'recoil/message/abstract'
+
+RSpec.describe Recoil::Message::Abstract do
+  it 'performs a http get on the url' do
+    expect {
+      described_class.new({}).process!
+    }.to raise_error(NotImplementedError)
+  end
+end

data/spec/spec_helper.rb

@@ -1,12 +1,9 @@
 ENV['RAILS_ENV'] = 'test'
 ENGINE_RAILS_ROOT = File.join(File.dirname(__FILE__), '../')
 
-if ENV['COVERAGE']
-  require 'simplecov'
-  SimpleCov.start do
-    minimum_coverage 90
-    add_filter '/spec/'
-  end
+if ENV['CODECLIMATE_REPO_TOKEN']
+  require 'codeclimate-test-reporter'
+  CodeClimate::TestReporter.start
 end
 
 require File.expand_path('../dummy/config/environment.rb',  __FILE__)
@@ -41,4 +38,5 @@ VCR.configure do |c|
   c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
   c.hook_into :webmock
   c.configure_rspec_metadata!
+  c.ignore_hosts 'codeclimate.com'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: recoil
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Brightin
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -242,6 +242,8 @@ files:
 - spec/dummy/public/favicon.ico
 - spec/fixtures/vcr_cassettes/Recoil_Message_SubscriptionConfirmation/performs_a_http_get_on_the_url.yml
 - spec/recoil/email_spec.rb
+- spec/recoil/interceptor_spec.rb
+- spec/recoil/message/abstract_spec.rb
 - spec/recoil/message/notification_spec.rb
 - spec/recoil/message/subscription_confirmation_spec.rb
 - spec/recoil/message_spec.rb
@@ -316,6 +318,8 @@ test_files:
 - spec/dummy/public/favicon.ico
 - spec/fixtures/vcr_cassettes/Recoil_Message_SubscriptionConfirmation/performs_a_http_get_on_the_url.yml
 - spec/recoil/email_spec.rb
+- spec/recoil/interceptor_spec.rb
+- spec/recoil/message/abstract_spec.rb
 - spec/recoil/message/notification_spec.rb
 - spec/recoil/message/subscription_confirmation_spec.rb
 - spec/recoil/message_spec.rb