mail_interceptor 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 519692ac3fb68840234a78cc4868c0305c129bf0
-  data.tar.gz: 28be53d6876eae2aa09301022ee1162a1c036a88
+  metadata.gz: 01f80432a77850310f4d4ae32027ead3bdc951b5
+  data.tar.gz: 50e4552dd58951fbae975339350e75d31e0d13fc
 SHA512:
-  metadata.gz: 898f3f4f3240815ab68ae7e28d126f4280516fca853acf00107fd112a8ca6aded5eeaf09a06e4811f61895fba3b7b0b47aff2e8cc38063bdf3f742bd2e86b672
-  data.tar.gz: 24afd80b88edccd7fc1becca837c5248bdd2cf919794f5d51ce897ffe274416ccb4fd49c84ad7e94d15603ba60c5fd69e0609749fdbdedcacce52a3c6c61a942
+  metadata.gz: 606b17ea4496526fe9b9cf0f1f17710a5184218083749770cdc8f1e588995ca0edd03404c4453b8438d95c5a228c2ae3a5fa224fd6cf6144e31d2f9eaf65af84
+  data.tar.gz: 461fb9d049dd049ffb7492a643063e9fa1d4a7ead07fe39f72f4eb036c9aa99d29d61054977eea39cd92c7f6acd342c1b43b69632c725164f03d7ae22e9e49ab

data/README.md

@@ -87,6 +87,29 @@ MailInterceptor::Interceptor.new({ forward_emails_to: ['intercepted_emails@bigbi
                                                        'qa@bigbinary.com' })
 ```
 
+### Custom environment
+
+If your staging environment is using the same Rails environment as
+production, you can pass in an object with the name of the environment
+and whether to intercept mail as an option. The default is to use
+`Rails.env` and intercept mail in all environments except production.
+
+```ruby
+class MyEnv
+  def name
+    ENV["INSTANCE_NAME"]
+  end
+
+  def intercept?
+    ENV["INTERCEPT_MAIL"] == '1'
+  end
+end
+
+MailInterceptor::Interceptor.new({ env: MyEnv.new,
+                                   forward_emails_to: ['intercepted_emails@bigbinary.com',
+                                   'qa@bigbinary.com' })
+```
+
 #### Brought to you by
 
 [![BigBinary logo](http://bigbinary.com/assets/common/logo.png)](http://BigBinary.com)

data/lib/mail_interceptor.rb

@@ -4,12 +4,13 @@ require "mail_interceptor/version"
 
 module MailInterceptor
   class Interceptor
-    attr_accessor :deliver_emails_to, :forward_emails_to, :subject_prefix
+    attr_accessor :deliver_emails_to, :forward_emails_to, :subject_prefix, :env
 
     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
+      @env               = options.fetch :env, InterceptorEnv.new
 
       add_env_info_to_subject_prefix
       sanitize_forward_emails_to
@@ -23,7 +24,7 @@ module MailInterceptor
     private
 
     def normalize_recipients recipients
-      return Array.wrap(recipients) if production?
+      return Array.wrap(recipients) unless env.intercept?
 
       return forward_emails_to if deliver_emails_to.empty?
 
@@ -38,6 +39,7 @@ module MailInterceptor
 
     def add_subject_prefix message
       return if subject_prefix.blank?
+      return if !env.intercept?
 
       message.subject = "#{subject_prefix} #{message.subject}"
     end
@@ -45,7 +47,7 @@ module MailInterceptor
     def sanitize_forward_emails_to
       self.forward_emails_to = Array.wrap forward_emails_to
 
-      if forward_emails_to_empty? && !production?
+      if forward_emails_to_empty? && env.intercept?
         raise "forward_emails_to should not be empty"
       end
     end
@@ -53,20 +55,24 @@ module MailInterceptor
     def add_env_info_to_subject_prefix
       return if subject_prefix.blank?
 
-      _prefix = production? ? subject_prefix : "#{subject_prefix} #{env.upcase}"
+      _prefix = env.intercept? ? "#{subject_prefix} #{env.name}" : subject_prefix
       self.subject_prefix = "[#{_prefix}]"
     end
 
     def forward_emails_to_empty?
       Array.wrap(forward_emails_to).reject(&:blank?).empty?
     end
+  end
 
-    def production?
-      env.production?
+  class InterceptorEnv
+    def name
+      Rails.env.upcase
     end
 
-    def env
-      Rails.env
+    def intercept?
+      return false if Rails.env.test?
+
+      !Rails.env.production?
     end
   end
 end

data/lib/mail_interceptor/version.rb

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

data/test/mail_interceptor_test.rb

@@ -9,33 +9,37 @@ class MailInterceptorTest < Minitest::Test
 
   def setup
     @message = OpenStruct.new
-    stub_env_methods('test')
   end
 
   def test_normalized_deliver_emails_to
-    @interceptor = ::MailInterceptor::Interceptor.new forward_emails_to: 'test@example.com'
+    @interceptor = ::MailInterceptor::Interceptor.new env: env,
+                                                      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'
+    @interceptor = ::MailInterceptor::Interceptor.new env: env,
+                                                      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']
+    @interceptor = ::MailInterceptor::Interceptor.new  env: env,
+                                                       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']
+    interceptor = ::MailInterceptor::Interceptor.new env: env,
+                                                     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
+    interceptor = ::MailInterceptor::Interceptor.new env: env,
+                                                     forward_emails_to: 'test@example.com',
+                                                     subject_prefix: nil
     @message.subject = 'Forgot password'
 
     interceptor.delivering_email @message
@@ -43,8 +47,9 @@ class MailInterceptorTest < Minitest::Test
   end
 
   def test_subject_prefix_in_test
-    interceptor = ::MailInterceptor::Interceptor.new forward_emails_to: 'test@example.com',
-                                                       subject_prefix: 'wheel'
+    interceptor = ::MailInterceptor::Interceptor.new env: env,
+                                                     forward_emails_to: 'test@example.com',
+                                                     subject_prefix: 'wheel'
     @message.subject = 'Forgot password'
 
     interceptor.delivering_email @message
@@ -56,9 +61,9 @@ class MailInterceptorTest < Minitest::Test
   end
 
   def test_subject_prefix_in_production
-    stub_env_methods('production')
-    interceptor = ::MailInterceptor::Interceptor.new forward_emails_to: 'test@example.com',
-                                                       subject_prefix: 'wheel'
+    interceptor = ::MailInterceptor::Interceptor.new env: env('production'),
+                                                     forward_emails_to: 'test@example.com',
+                                                     subject_prefix: 'wheel'
     @message.subject = 'Forgot password'
 
     interceptor.delivering_email @message
@@ -69,22 +74,25 @@ class MailInterceptorTest < Minitest::Test
     message = "forward_emails_to should not be empty"
 
     exception = assert_raises(RuntimeError) do
-      ::MailInterceptor::Interceptor.new forward_emails_to: '',
-                                          subject_prefix: 'wheel'
+      ::MailInterceptor::Interceptor.new env: env,
+                                         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'
+      ::MailInterceptor::Interceptor.new env: env,
+                                         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'
+      ::MailInterceptor::Interceptor.new env: env,
+                                         forward_emails_to: [''],
+                                         subject_prefix: 'wheel'
     end
 
     assert_equal message, exception.message
@@ -92,8 +100,8 @@ class MailInterceptorTest < Minitest::Test
 
   private
 
-  def stub_env_methods(env)
-    ::MailInterceptor::Interceptor.any_instance.stubs(:env).returns(env)
-    ::MailInterceptor::Interceptor.any_instance.stubs(:production?).returns(env == 'production')
+  def env(environment = 'test')
+    OpenStruct.new :name => environment.upcase,
+                   :intercept? => environment != 'production'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mail_interceptor
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Neeraj Singh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-26 00:00:00.000000000 Z
+date: 2015-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport