email_interceptor 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3e335c082ec97b10d48fdfcfac1da05eef48b874
+  data.tar.gz: aea7158992b7728e53d1377619eb132463c49c2d
+SHA512:
+  metadata.gz: 78d4bc47ba53ce612fdc37203b6c0414e9e79f4ddbe7600631ef2e7e0beddc10a846bcc614fb00d042f4006416ebc119e0cf7980dfa4d20b8772d7188b203a2e
+  data.tar.gz: 616fc4bc6491f358de34f6a75dc3b0434632be11ff737bae101681e5cb7ad9efef54be21210cb7912d8327e546788f735736cdc0e9cb87d147685af026bfa984

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+/coverage

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format=nested
+--require spec_helper

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    email_interceptor (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    docile (1.1.3)
+    multi_json (1.8.4)
+    rake (10.1.1)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.5)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  email_interceptor!
+  rake
+  rspec
+  simplecov

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Your
+
+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,46 @@
+# EmailInterceptor
+
+This is a very simple gem that works as an ActiveMailer email
+interceptor.  It allows you to selectively send some emails (called
+:internal) while re-writing all other emails with a test account or
+other email address.
+
+The intention of this is to prevent real users from being emailed from
+non-production environments, such as staging.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'email_interceptor'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install email_interceptor
+
+## Usage
+
+To use this in Rails, one can pass it to
+`ActionMailer.register_interceptor` in an initializer, i.e.
+
+```ruby
+email_interceptor = EmailInterceptor.new(:internal_only, {
+  :fake_email_address => 'testdummy@example.com',
+  :internal_recipient_matcher => /@this.can.be.a.regex.com$/,
+  :logger_file => Rails.root.join('/log/mailer.log')
+})
+
+ActionMailer::Base.register_interceptor(email_interceptor)
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => [:spec]
+
+Rake::TaskManager.record_task_metadata = true

data/email_interceptor.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'email_interceptor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "email_interceptor"
+  spec.version       = EmailInterceptor::VERSION
+  spec.authors       = ["Renewable Funding"]
+  spec.email         = ["dave.miller@renewfund.com", "maher@renewfund.com", "laurie@renewfund.com", "ravi@renewfund.com"]
+  spec.description   = %q{A small utility for shunting email to a an email address, depending on settings}
+  spec.summary       = %q{Using this, you can rewrite recipient lists to a test email account for all or only external users}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+end

data/lib/email_interceptor.rb

@@ -0,0 +1,40 @@
+require 'socket'
+require 'email_interceptor/version'
+
+class EmailInterceptor
+  def initialize(strategy, opts={})
+    strategies = [:live, :internal_only, :fake]
+    @strategy = strategies.include?(strategy) ? strategy : :fake
+    @fake_email_address = opts[:fake_email_address] || 'fake@example.com'
+    @internal_recipient_matcher = opts[:internal_recipient_matcher]
+    @logger_file = opts[:logger_file]
+  end
+
+  def delivering_email(message)
+    override_mail_to(message)
+    log_delivery(message)
+  end
+
+  def override_mail_to(message)
+    unless @strategy == :live
+      message.to = message.to.map { |t| override_single_recipient(t) }
+    end
+  end
+
+  def log_delivery(message)
+    return unless @logger_file
+    File.open(@logger_file, 'a') do |f|
+      f.puts "#{Time.now}\n#{message}"
+    end
+  end
+
+private
+  def override_single_recipient(recipient)
+    case @strategy
+    when :internal_only
+      recipient =~ @internal_recipient_matcher ? recipient : @fake_email_address
+    else
+      @fake_email_address
+    end
+  end
+end

data/lib/email_interceptor/version.rb

@@ -0,0 +1,3 @@
+class EmailInterceptor
+  VERSION = "0.0.1"
+end

data/spec/lib/email_interceptor_spec.rb

@@ -0,0 +1,56 @@
+require 'stringio'
+require 'ostruct'
+require 'spec_helper'
+
+describe EmailInterceptor do
+  let(:opts) { {:fake_email_address => 'foo@bar.com', :internal_recipient_matcher => /@renewfund.com$/, :logger_file => '/foo/bar/mail.log' } }
+  subject(:fake_interceptor) { described_class.new(:fake, opts) }
+  subject(:live_interceptor) { described_class.new(:live, opts) }
+  subject(:internal_interceptor) { described_class.new(:internal_only, opts) }
+  subject(:bogus_interceptor) { described_class.new(:bogus, opts) }
+
+  describe '#delivering_email' do
+    it 'overrides mail to and logs delivery' do
+      subject.should_receive(:override_mail_to).with(:message)
+      subject.should_receive(:log_delivery).with(:message)
+      subject.delivering_email(:message)
+    end
+  end
+
+  describe '#override_mail_to' do
+    it 'always fake mail recipients when strategy is fake' do
+      message = OpenStruct.new(:to => ['real@email.address', 'real@renewfund.com'])
+      fake_interceptor.override_mail_to(message)
+      expect(message.to).to eq ['foo@bar.com', 'foo@bar.com']
+    end
+
+    it 'only fakes external mail recipients when strategy is internal_only' do
+      message = OpenStruct.new(:to => ['real@email.address', 'real@renewfund.com'])
+      internal_interceptor.override_mail_to(message)
+      expect(message.to).to eq ['foo@bar.com', 'real@renewfund.com']
+    end
+
+    it 'does not modify mail to address if strategy is live' do
+      message = OpenStruct.new(:to => ['real@email.address', 'real@renewfund.com'])
+      live_interceptor.override_mail_to(message)
+      expect(message.to).to eq ['real@email.address', 'real@renewfund.com']
+    end
+
+    it 'fakes the recipient if the strategy is not live, internal_only, or fake' do
+      message = OpenStruct.new(:to => ['real@email.address', 'real@renewfund.com'])
+      bogus_interceptor.override_mail_to(message)
+      expect(message.to).to eq ['foo@bar.com', 'foo@bar.com']
+    end
+  end
+
+  describe '#log_delivery' do
+    it 'adds the message to the mailer log' do
+      io = StringIO.new(dummy_file = '')
+      File.stub(:open).with('/foo/bar/mail.log', 'a').and_yield(io)
+      Time.stub(:now => 'alabaster')
+      subject.log_delivery('nergo nergo')
+      dummy_file.split("\n").should == ["alabaster", "nergo nergo"]
+      Time.unstub(:now)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'simplecov'
+SimpleCov.start
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+require './lib/email_interceptor'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: email_interceptor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Renewable Funding
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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
+  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: A small utility for shunting email to a an email address, depending on
+  settings
+email:
+- dave.miller@renewfund.com
+- maher@renewfund.com
+- laurie@renewfund.com
+- ravi@renewfund.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- email_interceptor.gemspec
+- lib/email_interceptor.rb
+- lib/email_interceptor/configuration.rb
+- lib/email_interceptor/version.rb
+- spec/lib/email_interceptor_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Using this, you can rewrite recipient lists to a test email account for all
+  or only external users
+test_files:
+- spec/lib/email_interceptor_spec.rb
+- spec/spec_helper.rb