recoil 0.0.6 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb64222977c91bad7d4104e48d59e385679612d5
-  data.tar.gz: 8f70210112b5093ac1b9c82250dc7eca893db8f8
+  metadata.gz: 87e82d8f7f24b7d3335c5bd3e7291f1ff80493c9
+  data.tar.gz: dc33eaacc67cd5ce873b4ce15a4d64727a03eda4
 SHA512:
-  metadata.gz: ab057346614e471fc209c2904dfe68ea2ad5c05c309f187a31398660f3a4126590b409877c84fe2dfda9efea0c5673ec3ab2b27db5dea83556768adf629f00eb
-  data.tar.gz: 4196182ae4f044f63e865394a6d1606d6449b9ab08ccf393805743201c72fc7e4baa81ef3f58fd84b2b20425d0c4dd1a961ad0c9387833ed04b9ca763d637227
+  metadata.gz: 5d4757afa6e0e1923eb3de8f1a191d22b69283bf0cee1c0c1b78680195db9fd8300fc9c8d7f649cbdccee7dfe23e4c7caa203a8d6971106eb12910662feb3c1b
+  data.tar.gz: d5e023713d948071fd7b0abe3119b88e1673e0033e6f2e4b0199e080712ab3754e4fc4d058335ab931211e3cb159372f06f1dd17fba7595c5387fbb626cbb976

data/.rubocop.yml

@@ -0,0 +1,99 @@
+require: rubocop-rspec
+
+AllCops:
+  Exclude:
+    - bin/**/*
+    - spec/dummy/**/*
+  RunRailsCops: true
+
+Style/CollectionMethods:
+  Enabled: true
+  PreferredMethods:
+    collect: 'map'
+    collect!: 'map!'
+    inject: 'inject'
+    detect: 'find'
+    find_all: 'select'
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  MaxLineLength: 50
+
+Style/PredicateName:
+  Enabled: false
+
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/TrivialAccessors:
+  IgnoreClassMethods: true
+
+Lint/UselessAssignment:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 403
+
+Style/ClassVars:
+  Enabled: false
+
+# Avoid chaining a method call on a do...end block.
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+
+# Use %i or %I for arrays of symbols
+Style/SymbolArray:
+  Enabled: true
+
+# Consider `method *args` ambiguous and require `method(*args)`. The former is
+# fine so disable this rule by default.
+Lint/AmbiguousOperator:
+  Enabled: false
+
+# We are all responsible adults. We know when we mean to write `if a = 5` and when
+# we mean to write `if a == 5`.
+Lint/AssignmentInCondition:
+  Enabled: false
+
+# Prefer alias_method over alias. Disable because alias is fine.
+Style/Alias:
+  Enabled: false
+
+# Disallow the case equality operator (===). Disable because this is a useful and
+# perfectly acceptable practice.
+Style/CaseEquality:
+  Enabled: false
+
+# Ensure multi-line blocks use `do/end` and single-line blocks use `{/}` as
+# delimiters. This is fine rule, except in case of RSpec tests, where the
+# `expect { ... }.to` is idiomatically written across multiple lines. Disable
+# only in specs.
+Style/BlockDelimiters:
+  Exclude:
+    - spec/**/*_spec.rb
+
+# Ensure short conditionals are written on a single line. The only exception
+# here is Rails initializers, which sometimes have entire blocks of code with a
+# `if defined?` modifier, which is acceptable.
+Style/IfUnlessModifier:
+  Exclude:
+    - 'config/initializers/*'
+
+# The top-level `describe` call should reference a class or module that is
+# under test. This is not the case in some kinds of integration tests that are
+# not tied to a particular class or module. Disable this cop in those cases.
+RSpec/DescribeClass:
+  Exclude:
+    - spec/requests/**/*
+    - spec/features/**/*

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.6
+  - 2.2.2
+env:
+  - COVERAGE=true
+script:
+  - ./bin/rubocop
+  - ./bin/brakeman
+  - ./bin/rspec

data/README.md

@@ -1,5 +1,6 @@
 # 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)
 
 Rails delivery method. Send via Amazon SES, but with local blacklist.
 

data/Rakefile

@@ -6,14 +6,11 @@ end
 
 require 'rdoc/task'
 
-APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+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'
@@ -25,5 +22,4 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = false
 end
 
-
 task default: :test

data/bin/brakeman

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'brakeman' 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('brakeman', 'brakeman')

data/bin/rubocop

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' 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('rubocop', 'rubocop')

data/bin/setup

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+end

data/lib/recoil.rb

@@ -5,7 +5,7 @@ require 'recoil/message'
 
 module Recoil
   mattr_accessor :blacklist_threshold
-  @@blacklist_threshold = ->(record) { record.bounces > 3 }
+  @@blacklist_threshold = ->(scope) { scope.where('created_at > ?', 2.weeks.ago).count > 10 }
 
   def self.setup
     yield self

data/lib/recoil/email.rb

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

data/lib/recoil/interceptor.rb

@@ -1,7 +1,7 @@
 module Recoil
   class Interceptor
     def self.delivering_email(message)
-      if message.to.any? { |email| Email.blacklisted?(email) }
+      if message.to.any? { |email| Email.new(email).blacklisted? }
         message.perform_deliveries = false
       end
     end

data/lib/recoil/version.rb

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

data/recoil.gemspec

@@ -4,24 +4,29 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'recoil/version'
 
 Gem::Specification.new do |s|
-  s.name          = "recoil"
+  s.name          = 'recoil'
   s.version       = Recoil::VERSION
-  s.authors       = ["Brightin"]
-  s.email         = ["developers@brightin.nl"]
+  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.homepage      = 'http://www.brightin.nl'
+  s.license       = 'MIT'
 
   s.files         = `git ls-files -z`.split("\x0")
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
-  s.require_paths = ["lib"]
+  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"
+  s.add_dependency 'aws-sdk', '< 2'
+
+  s.add_development_dependency 'brakeman'
+  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'
 end

data/spec/recoil/email_spec.rb

@@ -2,26 +2,33 @@ require 'spec_helper'
 
 module Recoil
   RSpec.describe Email do
-    describe "#blacklisted?" do
-      it 'is blackisted depending on the threshold' do
-        original_threshold = Recoil.blacklist_threshold
+    subject(:email) { Email.new('example@example.com') }
+
+    def create_bounce(created_at = nil)
+      Bounce.create!(email: email.to_s, created_at: created_at)
+    end
+
+    describe '.blacklisted?' do
+      it 'defaults to a blacklist emails with more than 10 bounces in the last two weeks' do
+        10.times { create_bounce }
+        expect(email).not_to be_blacklisted
 
-        Recoil.setup do |c|
-          c.blacklist_threshold = ->(r) { r.bounces > 3 }
-        end
+        create_bounce(3.weeks.ago)
+        create_bounce(3.weeks.ago)
 
-        expect(Email.new(2)).not_to be_blacklisted
-        expect(Email.new(4)).to be_blacklisted
+        expect(email).not_to be_blacklisted
+
+        create_bounce
+        expect(email).to be_blacklisted
+      end
+
+      it 'is configurable via the recoil config' do
+        original_threshold = Recoil.blacklist_threshold
 
-        Recoil.setup do |c|
-          c.blacklist_threshold = ->(r) { true }
-        end
-        expect(Email.new(2)).to be_blacklisted
-        expect(Email.new(4)).to be_blacklisted
+        Recoil.blacklist_threshold = ->(_scope) { true }
+        expect(email).to be_blacklisted
 
-        Recoil.setup do |c|
-          c.blacklist_threshold = original_threshold
-        end
+        Recoil.blacklist_threshold = original_threshold
       end
     end
   end

data/spec/recoil/message/notification_spec.rb

@@ -4,15 +4,15 @@ require 'recoil/message/notification'
 RSpec.describe Recoil::Message::Notification do
   it 'performs a http get on the url' do
     message = {
-      "Type" => "Notification",
-      "MessageId" => "id",
-      "TopicArn" => "arn:aws:sns:",
-      "Message" => "{\"notificationType\":\"Bounce\",\"bounce\":{\"bounceSubType\":\"Undetermined\",\"bounceType\":\"Undetermined\",\"bouncedRecipients\":[{\"emailAddress\":\"example@example.com\"}],\"timestamp\":\"2015-03-05T13:36:37.000Z\",\"feedbackId\":\"ID\"},\"mail\":{\"timestamp\":\"2015-03-05T13:36:34.000Z\",\"destination\":[\"example@example.com\"],\"messageId\":\"ID\",\"source\":\"SES\"}}",
-      "Timestamp" => "2015-03-05T13:36:39.002Z",
-      "SignatureVersion" => "1",
-      "Signature" => "Sig",
-      "SigningCertURL" => "https",
-      "UnsubscribeURL" => "https"
+      'Type' => 'Notification',
+      'MessageId' => 'id',
+      'TopicArn' => 'arn:aws:sns:',
+      'Message' => "{\"notificationType\":\"Bounce\",\"bounce\":{\"bounceSubType\":\"Undetermined\",\"bounceType\":\"Undetermined\",\"bouncedRecipients\":[{\"emailAddress\":\"example@example.com\"}],\"timestamp\":\"2015-03-05T13:36:37.000Z\",\"feedbackId\":\"ID\"},\"mail\":{\"timestamp\":\"2015-03-05T13:36:34.000Z\",\"destination\":[\"example@example.com\"],\"messageId\":\"ID\",\"source\":\"SES\"}}",
+      'Timestamp' => '2015-03-05T13:36:39.002Z',
+      'SignatureVersion' => '1',
+      'Signature' => 'Sig',
+      'SigningCertURL' => 'https',
+      'UnsubscribeURL' => 'https'
     }
     expect(Recoil::Bounce).to receive(:create!).with(
       email: 'example@example.com',

data/spec/requests/receive_notification_spec.rb

@@ -2,20 +2,20 @@ require 'spec_helper'
 
 RSpec.describe 'Receive notification', type: :request do
   it 'adds notifications to the database' do
-     body = {
-      "Type" => "Notification",
-      "MessageId" => "id",
-      "TopicArn" => "arn:aws:sns:",
-      "Message" => "{\"notificationType\":\"Bounce\",\"bounce\":{\"bounceSubType\":\"Undetermined\",\"bounceType\":\"Undetermined\",\"bouncedRecipients\":[{\"emailAddress\":\"example@example.com\"}],\"timestamp\":\"2015-03-05T13:36:37.000Z\",\"feedbackId\":\"ID\"},\"mail\":{\"timestamp\":\"2015-03-05T13:36:34.000Z\",\"destination\":[\"example@example.com\"],\"messageId\":\"ID\",\"source\":\"SES\"}}",
-      "Timestamp" => "2015-03-05T13:36:39.002Z",
-      "SignatureVersion" => "1",
-      "Signature" => "Sig",
-      "SigningCertURL" => "https",
-      "UnsubscribeURL" => "https"
+    body = {
+      'Type' => 'Notification',
+      'MessageId' => 'id',
+      'TopicArn' => 'arn:aws:sns:',
+      'Message' => "{\"notificationType\":\"Bounce\",\"bounce\":{\"bounceSubType\":\"Undetermined\",\"bounceType\":\"Undetermined\",\"bouncedRecipients\":[{\"emailAddress\":\"example@example.com\"}],\"timestamp\":\"2015-03-05T13:36:37.000Z\",\"feedbackId\":\"ID\"},\"mail\":{\"timestamp\":\"2015-03-05T13:36:34.000Z\",\"destination\":[\"example@example.com\"],\"messageId\":\"ID\",\"source\":\"SES\"}}",
+      'Timestamp' => '2015-03-05T13:36:39.002Z',
+      'SignatureVersion' => '1',
+      'Signature' => 'Sig',
+      'SigningCertURL' => 'https',
+      'UnsubscribeURL' => 'https'
     }
 
     expect {
-     post '/ses', body
+      post '/ses', body.to_json
     }.to change(Recoil::Bounce, :count).by(1)
 
     expect(Recoil::Bounce.last.email).to eq 'example@example.com'

data/spec/spec_helper.rb

@@ -1,17 +1,28 @@
-ENV["RAILS_ENV"] = "test"
+ENV['RAILS_ENV'] = 'test'
 ENGINE_RAILS_ROOT = File.join(File.dirname(__FILE__), '../')
 
-require File.expand_path("../dummy/config/environment.rb",  __FILE__)
-ActiveRecord::Migrator.migrations_paths = [File.expand_path("../../test/dummy/db/migrate", __FILE__)]
+if ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.start do
+    minimum_coverage 90
+    add_filter '/spec/'
+  end
+end
+
+require File.expand_path('../dummy/config/environment.rb',  __FILE__)
+ActiveRecord::Migrator.migrations_paths = [File.expand_path('../../test/dummy/db/migrate', __FILE__)]
 ActiveRecord::Migrator.migrations_paths << File.expand_path('../../db/migrate', __FILE__)
 require 'vcr'
 require 'rspec/rails'
 
+ActiveRecord::Migration.maintain_test_schema!
+
 RSpec.configure do |c|
   c.expect_with :rspec do |expectations|
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true
   end
 
+  c.use_transactional_fixtures = true
   c.filter_run :focus
   c.run_all_when_everything_filtered = true
 
@@ -19,9 +30,7 @@ RSpec.configure do |c|
 
   c.warnings = true
 
-  if c.files_to_run.one?
-    c.default_formatter = 'doc'
-  end
+  c.default_formatter = 'doc' if c.files_to_run.one?
 
   c.order = :random
 
@@ -29,7 +38,7 @@ RSpec.configure do |c|
 end
 
 VCR.configure do |c|
-  c.cassette_library_dir = "spec/fixtures/vcr_cassettes"
+  c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
   c.hook_into :webmock
   c.configure_rspec_metadata!
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recoil
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors:
 - Brightin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-01 00:00:00.000000000 Z
+date: 2015-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -28,30 +28,44 @@ dependencies:
   name: aws-sdk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.60'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: brakeman
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.60'
+        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
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: rubocop-rspec
+  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'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -117,14 +173,19 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - app/controllers/recoil/notifications_controller.rb
 - app/models/recoil/bounce.rb
+- bin/brakeman
 - bin/rails
 - bin/rspec
+- bin/rubocop
+- bin/setup
 - config/routes.rb
 - db/migrate/20150305152728_add_emails_table.rb
 - lib/recoil.rb
@@ -173,7 +234,6 @@ files:
 - spec/dummy/config/locales/en.yml
 - spec/dummy/config/routes.rb
 - spec/dummy/config/secrets.yml
-- spec/dummy/db/development.sqlite3
 - spec/dummy/db/schema.rb
 - spec/dummy/lib/assets/.keep
 - spec/dummy/public/404.html
@@ -248,7 +308,6 @@ test_files:
 - spec/dummy/config/locales/en.yml
 - spec/dummy/config/routes.rb
 - spec/dummy/config/secrets.yml
-- spec/dummy/db/development.sqlite3
 - spec/dummy/db/schema.rb
 - spec/dummy/lib/assets/.keep
 - spec/dummy/public/404.html