mail_interceptor 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 691b985934a4d8d914973c060939febba013f974
-  data.tar.gz: ce02faa6ca1925dba811e607ceb5b015e7ce10da
+  metadata.gz: 00ca7563318bdfe6a5a029d688a30a11389c6241
+  data.tar.gz: 822c440a035866a071146d0c18ea8ae4cf0ca2f6
 SHA512:
-  metadata.gz: 1d47f4ab350a5a78dbc0628edb983ad02a867aefd72893284012efe6e62284596120c1e7dcf7ead1022bd64bff723de6fcbb93830dd1217cbe2180566e22da70
-  data.tar.gz: fe81f686a1df5e724f94380cf7ed94375e573df5a310f5c7900f0485d8331fdeb4f73043532e4e2b9263eb070628a202c38e6d8ccefe99439e2b7c8d6589f25b
+  metadata.gz: f9996e2846789d53d5e7bff41c2a1141b9655ad935450fab2e05fb88967633f6569632b7f3236a7f22b3f98d9391b449f2eb0dbd9236f9186591bdcc1e9a51c2
+  data.tar.gz: d5a63b1210264f18dbae927675dbf0cf7a8e7b66033f0f7a326c68ae55ef2e072de486c6b5feccc4646c3dff0e9a950bf84c905c30ff85efeef606ae28e9048d

data/README.md

@@ -3,19 +3,17 @@
 [![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
+a non-production environment. It also allows 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'
+# There is no need to include this gem for production or for test environment
+gem 'mail_interceptor', group: [:development, :staging]
 ```
 
 ## Usage
@@ -24,11 +22,11 @@ gem 'mail_interceptor'
 # config/initializer/mail_interceptor.rb
 
 options = { forward_emails_to: 'intercepted_emails@domain.com',
-            deliver_emails_to: ["@wheel.com"],
-            subject_prefix: 'WHEEL' }
+            deliver_emails_to: ["@wheel.com"] }
 
 interceptor = MailInterceptor::Interceptor.new(options)
-unless Rails.env.test?
+
+unless (Rails.env.test? || Rails.env.production?)
   ActionMailer::Base.register_interceptor(interceptor)
 end
 ```
@@ -64,22 +62,11 @@ 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__ is optional. If it is supplied then it is added to
-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
 
 This is a required field.
 
-It takes a single email as string.
+It can take a single email or an array of emails.
 
 ```ruby
 MailInterceptor::Interceptor.new({ forward_emails_to: 'intercepted_emails@bigbinary.com' })
@@ -94,15 +81,24 @@ MailInterceptor::Interceptor.new({ forward_emails_to: ['intercepted_emails@bigbi
 
 ### 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.
+By default all emails sent in non production environment are
+intercepted. However you can control this behavior by passing `env` as
+the key. It accepts any ruby objects which responds to `intercept?`
+method. If the result of that method is `true` then emails are
+intercepted otherwise emails are not intercepted.
+
+Below is an example of how to pass a custom ruby object as value for
+`env` key.
+
+Besides method `intercept?` method `name` is needed if you have provided
+`subject_prefix`. This name will be appended to the `subject_prefix` to
+produce something like `[WHEEL STAGING] Forgot password`. In this case
+`STAGING` came form `name`.
 
 ```ruby
 class MyEnv
   def name
-    ENV["INSTANCE_NAME"]
+    ENV["ENVIRONMENT_NAME"]
   end
 
   def intercept?

data/lib/mail_interceptor.rb

@@ -4,20 +4,17 @@ require "mail_interceptor/version"
 
 module MailInterceptor
   class Interceptor
-    attr_accessor :deliver_emails_to, :forward_emails_to, :subject_prefix, :env
+    attr_accessor :deliver_emails_to, :forward_emails_to, :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
     end
 
     def delivering_email message
-      add_subject_prefix message
       message.to = normalize_recipients(message.to).flatten.uniq
     end
 
@@ -37,12 +34,6 @@ module MailInterceptor
       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
 
@@ -51,13 +42,6 @@ module MailInterceptor
       end
     end
 
-    def add_env_info_to_subject_prefix
-      return if subject_prefix.blank?
-
-      _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

data/lib/mail_interceptor/version.rb

@@ -1,3 +1,3 @@
 module MailInterceptor
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/test/mail_interceptor_test.rb

@@ -36,63 +36,26 @@ class MailInterceptorTest < Minitest::Test
     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 env: env,
-                                                     forward_emails_to: 'test@example.com',
-                                                     subject_prefix: nil
-    @message.subject = 'Forgot password'
-
-    interceptor.delivering_email @message
-    assert_equal "Forgot password", @message.subject
-  end
-
-  def test_subject_prefix_in_test
-    interceptor = ::MailInterceptor::Interceptor.new env: env,
-                                                     forward_emails_to: 'test@example.com',
-                                                     subject_prefix: 'wheel'
-    @message.subject = 'Forgot password'
-
-    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
-    interceptor = ::MailInterceptor::Interceptor.new env: env('production'),
-                                                     forward_emails_to: 'test@example.com',
-                                                     subject_prefix: 'wheel'
-    @message.subject = 'Forgot password'
-
-    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 env: env,
-                                         forward_emails_to: '',
-                                         subject_prefix: 'wheel'
+                                         forward_emails_to: ''
     end
 
     assert_equal message, exception.message
 
     exception =  assert_raises(RuntimeError) do
       ::MailInterceptor::Interceptor.new env: env,
-                                         forward_emails_to: [],
-                                         subject_prefix: 'wheel'
+                                         forward_emails_to: []
     end
 
     assert_equal message, exception.message
 
     exception =  assert_raises(RuntimeError) do
       ::MailInterceptor::Interceptor.new env: env,
-                                         forward_emails_to: [''],
-                                         subject_prefix: 'wheel'
+                                         forward_emails_to: ['']
     end
 
     assert_equal message, exception.message

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mail_interceptor
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Neeraj Singh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-22 00:00:00.000000000 Z
+date: 2015-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -116,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Intercepts and forwards emails in non production environment