mail_interceptor 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e81465681066b3e3e2392f09413dab4e069c3d43
-  data.tar.gz: 4062ddaa9e71fd5d12e09809a6dd9863ba101056
+  metadata.gz: 519692ac3fb68840234a78cc4868c0305c129bf0
+  data.tar.gz: 28be53d6876eae2aa09301022ee1162a1c036a88
 SHA512:
-  metadata.gz: 7db16cb58488d073b8aad0599e031b36dbbbbd8e0d1652514897140362111633d646ec86e7cde290d6a955b4b7f4edc8596bf3ebeff2bb5f613ebbe9561e1a2b
-  data.tar.gz: 29248224aab6fb1a991ab5c21bcd74c1cd89cc77eacee2e55cb6c1b55d7edc36bb0542a946d8a1537735f0fac94806a41cdf890b6d4ab6251c37c2e55c1f7d30
+  metadata.gz: 898f3f4f3240815ab68ae7e28d126f4280516fca853acf00107fd112a8ca6aded5eeaf09a06e4811f61895fba3b7b0b47aff2e8cc38063bdf3f742bd2e86b672
+  data.tar.gz: 24afd80b88edccd7fc1becca837c5248bdd2cf919794f5d51ce897ffe274416ccb4fd49c84ad7e94d15603ba60c5fd69e0609749fdbdedcacce52a3c6c61a942

data/README.md

@@ -1,62 +1,92 @@
 # MailInterceptor
 
-Intercepts and forwards emails in non production environment.
+[![Circle CI](https://circleci.com/gh/bigbinary/mail_interceptor.svg?style=svg)](https://circleci.com/gh/bigbinary/mail_interceptor)
+
+This gem intercepts and forwards email to a forwarding address in
+non-production environment. However it also provides ability to not
+intercept certain emails so that testing of emails is easier in
+development/staging environment.
+
+If `subject_prefix` is supplied then that is added to every single email
+in both production and non-production environment.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-```
+```ruby
 gem 'mail_interceptor'
 ```
 
 ## Usage
 
-```
+```ruby
 # config/initializer/mail_interceptor.rb
 
-interceptor = MailInterceptor::Interceptor.new({ forward_emails_to: 'forward@domain.com',
-                                                 deliver_emails_to: ["@wheel.com"],
-                                                 subject_prefix: 'WHEEL' })
+options = { forward_emails_to: 'intercepted_emails@domain.com',
+            deliver_emails_to: ["@wheel.com"],
+            subject_prefix: 'WHEEL' }
+
+interceptor = MailInterceptor::Interceptor.new(options)
 ActionMailer::Base.register_interceptor(interceptor)
 ```
 
-#### deliver_emails_to
+### deliver_emails_to
 
 Passing __deliver_emails_to__ is optional. If no "deliver_emails_to"
-is passed then all emails will be forwarded.
+is passed then all emails will be intercepted and forwarded in
+non-production environment.
 
 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.
+"@BigBinary.com". Here is how it can be accomplished.
 
+```ruby
+MailInterceptor::Interceptor.new({ forward_emails_to: 'intercepted_emails@domain.com',
+                                   deliver_emails_to: ["@bigbinary.com"] })
 ```
-deliver_emails_to: ["@BigBinary.com"]
+
+If you want the emails to be delivered only if the email address is
+`qa@bigbinary.com` then that can be done too.
+
+```ruby
+MailInterceptor::Interceptor.new({ forward_emails_to: 'intercepted_emails@domain.com',
+                                   deliver_emails_to: ["qa@bigbinary.com"] })
 ```
 
+Now only `qa@bigbinary.com` will get its emails delivered and all other emails
+will be intercepted and forwarded.
+
 The regular expression is matched without case sensitive. So you can mix lowercase
 and uppercase and it won't matter.
 
-#### subject_prefix
+### subject_prefix
 
 __subject_prefix__ is optional. If it is supplied then it is added to
-the front of the subject in non-production environment.
+the front of the subject. In non-production environment the environment
+name is also added.
 
 ```
 [WHEEL] Forgot password
 [WHEEL STAGING] Forgot password
 ```
 
-#### forward_emails_to
+### 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.
+It takes a single email as string.
 
+```ruby
+MailInterceptor::Interceptor.new({ forward_emails_to: 'intercepted_emails@bigbinary.com' })
+```
 
-#### Brought to you by
+It can also take an array of emails in which case emails are forwarded to each of those emails in the array.
 
+```ruby
+MailInterceptor::Interceptor.new({ forward_emails_to: ['intercepted_emails@bigbinary.com',
+                                                       'qa@bigbinary.com' })
+```
+
+#### Brought to you by
 
-![BigBinary](http://bigbinary.com/assets/common/logo.png)
+[![BigBinary logo](http://bigbinary.com/assets/common/logo.png)](http://BigBinary.com)

data/lib/mail_interceptor.rb

@@ -1,3 +1,5 @@
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/array'
 require "mail_interceptor/version"
 
 module MailInterceptor
@@ -9,11 +11,11 @@ module MailInterceptor
       @subject_prefix    = options[:subject_prefix] || ''
       @forward_emails_to = options.fetch :forward_emails_to
 
+      add_env_info_to_subject_prefix
       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

data/lib/mail_interceptor/version.rb

@@ -1,3 +1,3 @@
 module MailInterceptor
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/mail_interceptor.gemspec

@@ -17,9 +17,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency "activesupport"
   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"
+  spec.add_development_dependency "rake"
 end

data/test/mail_interceptor_test.rb

@@ -1,7 +1,6 @@
 require 'rubygems'
 require 'bundler/setup'
 require 'minitest/autorun'
-require 'active_support/all'
 require 'ostruct'
 require 'mocha/mini_test'
 require_relative './../lib/mail_interceptor'
@@ -10,6 +9,7 @@ class MailInterceptorTest < Minitest::Test
 
   def setup
     @message = OpenStruct.new
+    stub_env_methods('test')
   end
 
   def test_normalized_deliver_emails_to
@@ -37,7 +37,6 @@ class MailInterceptorTest < Minitest::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
@@ -47,17 +46,20 @@ class MailInterceptorTest < Minitest::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
+
+    @message.subject = 'Another Forgot password'
+    interceptor.delivering_email @message
+    assert_equal "[wheel TEST] Another Forgot password", @message.subject
   end
 
   def test_subject_prefix_in_production
+    stub_env_methods('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
@@ -90,8 +92,8 @@ class MailInterceptorTest < Minitest::Test
 
   private
 
-  def stub_env_methods(interceptor, env)
-    interceptor.stubs(:env).returns(env)
-    interceptor.stubs(:production?).returns(env == 'production')
+  def stub_env_methods(env)
+    ::MailInterceptor::Interceptor.any_instance.stubs(:env).returns(env)
+    ::MailInterceptor::Interceptor.any_instance.stubs(:production?).returns(env == 'production')
   end
 end

metadata

@@ -1,23 +1,23 @@
 --- !ruby/object:Gem::Specification
 name: mail_interceptor
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Neeraj Singh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-22 00:00:00.000000000 Z
+date: 2015-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="