mail_interceptor 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1038b93a850773fa998a6d17a784b0c9d2c6a49b
+  data.tar.gz: 42edb3a479327add4a8b4f7242567f813263a6c2
+SHA512:
+  metadata.gz: 0f72941dc324c3e7c4f2a0a3e22146843e7ae33be4a5926933871d47aa14a98da88f1bc2ab7bc15c167494c2c4d005b681d0806dfa38faa057405d8f59567b20
+  data.tar.gz: 669c21d19894c6c1b6a541389b6853c39e791a111157041c01ab466e58d94287cd31ed1407ea85ab483fe924c35310c41ba652524611c9600978594c1e513285

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Neeraj Singh
+
+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,62 @@
+# MailInterceptor
+
+Intercepts and forwards emails in non production environment.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+gem 'mail_interceptor'
+```
+
+## Usage
+
+```
+# config/initializer/mail_interceptor.rb
+
+interceptor = MailInterceptor::Interceptor.new({ forward_emails_to: 'forward@domain.com',
+                                                 deliver_emails_to: ["@wheel.com"],
+                                                 subject_prefix: 'WHEEL' })
+ActionMailer::Base.register_interceptor(interceptor)
+```
+
+#### deliver_emails_to
+
+Passing __deliver_emails_to__ is optional. If no "deliver_emails_to"
+is passed then all emails will be forwarded.
+
+Let's say that you want to actually deliver all emails having the pattern
+"@BigBinary.com" then pass a regular expression like this. Now emails
+like `john@BigBinary.com` will not be intercepted and John will actually
+get an email in non-production environment.
+
+```
+deliver_emails_to: ["@BigBinary.com"]
+```
+
+The regular expression is matched without case sensitive. So you can mix lowercase
+and uppercase and it won't matter.
+
+#### subject_prefix
+
+__subject_prefix__ is optional. If it is supplied then it is added to
+the front of the subject in non-production environment.
+
+```
+[WHEEL] Forgot password
+[WHEEL STAGING] Forogt password
+```
+
+#### forward_emails_to
+
+This is a required field.
+
+It can take a single email as string or it can take an array of emails
+in which case emails are forwarded to each of those emails in the array.
+
+
+#### Brought to you by
+
+
+![BigBinary](http://bigbinary.com/assets/common/logo.png)

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+require 'rubygems/package_task'
+
+task :default => :test
+
+Rake::TestTask.new('test') do |t|
+  t.pattern = 'test/**/*_test.rb'
+  t.warning = true
+  t.verbose = true
+end

data/lib/mail_interceptor.rb

@@ -0,0 +1,66 @@
+require "mail_interceptor/version"
+
+module MailInterceptor
+  class Interceptor
+    attr_accessor :deliver_emails_to, :forward_emails_to, :subject_prefix
+
+    def initialize options = {}
+      @deliver_emails_to = Array.wrap options[:deliver_emails_to]
+      @subject_prefix    = options[:subject_prefix] || ''
+      @forward_emails_to = options.fetch :forward_emails_to
+
+      sanitize_forward_emails_to
+    end
+
+    def delivering_email message
+      add_env_info_to_subject_prefix
+      add_subject_prefix message
+      message.to = normalize_recipients(message.to).flatten.uniq
+    end
+
+    private
+
+    def normalize_recipients recipients
+      return forward_emails_to if deliver_emails_to.empty?
+
+      recipients.map do |recipient|
+        if deliver_emails_to.find { |regex| Regexp.new(regex, Regexp::IGNORECASE).match(recipient) }
+          recipient
+        else
+          forward_emails_to
+        end
+      end
+    end
+
+    def add_subject_prefix message
+      return if subject_prefix.blank?
+
+      message.subject = "#{subject_prefix} #{message.subject}"
+    end
+
+    def sanitize_forward_emails_to
+      self.forward_emails_to = Array.wrap forward_emails_to
+
+      raise "forward_emails_to should not be empty" if forward_emails_to_empty?
+    end
+
+    def add_env_info_to_subject_prefix
+      return if subject_prefix.blank?
+
+      _prefix = production? ? subject_prefix : "#{subject_prefix} #{env.upcase}"
+      self.subject_prefix = "[#{_prefix}]"
+    end
+
+    def forward_emails_to_empty?
+      Array.wrap(forward_emails_to).reject(&:blank?).empty?
+    end
+
+    def production?
+      env.production?
+    end
+
+    def env
+      Rails.env
+    end
+  end
+end

data/lib/mail_interceptor/version.rb

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

data/mail_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 'mail_interceptor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mail_interceptor"
+  spec.version       = MailInterceptor::VERSION
+  spec.authors       = ["Neeraj Singh"]
+  spec.email         = ["neeraj@BigBinary.com"]
+  spec.summary       = %q{Intercepts and forwards emails in non production environment}
+  spec.homepage      = "http://github.com/bigbinary/mail_interceptor"
+  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_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "activesupport"
+  spec.add_development_dependency "mocha"
+end

data/test/mail_interceptor_test.rb

@@ -0,0 +1,97 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'minitest/autorun'
+require 'active_support/all'
+require 'ostruct'
+require 'mocha/mini_test'
+require_relative './../lib/mail_interceptor'
+
+class MailInterceptorTest < Minitest::Test
+
+  def setup
+    @message = OpenStruct.new
+  end
+
+  def test_normalized_deliver_emails_to
+    @interceptor = ::MailInterceptor::Interceptor.new forward_emails_to: 'test@example.com'
+    assert_equal [], @interceptor.deliver_emails_to
+
+    @interceptor = ::MailInterceptor::Interceptor.new forward_emails_to: 'test@example.com',
+                                                       deliver_emails_to: '@wheel.com'
+    assert_equal ["@wheel.com"], @interceptor.deliver_emails_to
+
+    @interceptor = ::MailInterceptor::Interceptor.new  forward_emails_to: 'test@example.com',
+                                                        deliver_emails_to: ['@wheel.com', '@pump.com']
+    assert_equal ["@wheel.com", "@pump.com"], @interceptor.deliver_emails_to
+  end
+
+  def test_invocation_of_regular_expression
+    interceptor = ::MailInterceptor::Interceptor.new forward_emails_to: 'test@example.com',
+                                                      deliver_emails_to: ['@wheel.com', '@pump.com', 'john@gmail.com']
+    @message.to = [ 'a@wheel.com', 'b@wheel.com', 'c@pump.com', 'd@club.com', 'e@gmail.com', 'john@gmail.com', 'sam@gmail.com']
+    interceptor.delivering_email @message
+    assert_equal ["a@wheel.com", "b@wheel.com", "c@pump.com", "test@example.com", "john@gmail.com"], @message.to
+  end
+
+  def test_no_subject_prefix_in_test
+    interceptor = ::MailInterceptor::Interceptor.new forward_emails_to: 'test@example.com',
+                                                       subject_prefix: nil
+    @message.subject = 'Forgot password'
+    stub_env_methods(interceptor, 'test')
+
+    interceptor.delivering_email @message
+    assert_equal "Forgot password", @message.subject
+  end
+
+  def test_subject_prefix_in_test
+    interceptor = ::MailInterceptor::Interceptor.new forward_emails_to: 'test@example.com',
+                                                       subject_prefix: 'wheel'
+    @message.subject = 'Forgot password'
+    stub_env_methods(interceptor, 'test')
+
+    interceptor.delivering_email @message
+    assert_equal "[wheel TEST] Forgot password", @message.subject
+  end
+
+  def test_subject_prefix_in_production
+    interceptor = ::MailInterceptor::Interceptor.new forward_emails_to: 'test@example.com',
+                                                       subject_prefix: 'wheel'
+    @message.subject = 'Forgot password'
+    stub_env_methods(interceptor, 'production')
+
+    interceptor.delivering_email @message
+    assert_equal "[wheel] Forgot password", @message.subject
+  end
+
+  def test_error_if_forward_emails_to_is_empty
+    message = "forward_emails_to should not be empty"
+
+    exception = assert_raises(RuntimeError) do
+      ::MailInterceptor::Interceptor.new forward_emails_to: '',
+                                          subject_prefix: 'wheel'
+    end
+
+    assert_equal message, exception.message
+
+    exception =  assert_raises(RuntimeError) do
+      ::MailInterceptor::Interceptor.new forward_emails_to: [],
+                                          subject_prefix: 'wheel'
+    end
+
+    assert_equal message, exception.message
+
+    exception =  assert_raises(RuntimeError) do
+      ::MailInterceptor::Interceptor.new forward_emails_to: [''],
+                                          subject_prefix: 'wheel'
+    end
+
+    assert_equal message, exception.message
+  end
+
+  private
+
+  def stub_env_methods(interceptor, env)
+    interceptor.stubs(:env).returns(env)
+    interceptor.stubs(:production?).returns(env == 'production')
+  end
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: mail_interceptor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Neeraj Singh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: minitest
+  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: activesupport
+  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: mocha
+  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: 
+email:
+- neeraj@BigBinary.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mail_interceptor.rb
+- lib/mail_interceptor/version.rb
+- mail_interceptor.gemspec
+- test/mail_interceptor_test.rb
+homepage: http://github.com/bigbinary/mail_interceptor
+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: Intercepts and forwards emails in non production environment
+test_files:
+- test/mail_interceptor_test.rb