mail_gate 1.0.1 → 1.1.0

data/README.md

@@ -59,6 +59,28 @@ CNN::Application.configure do
 end
 ```
 
+When the email is sent, any emails that end up being extracted because they don't match the whitelist will be appended to the email's body so you know the intended recipients. So if you had a whitelist only for CNN.com, and you sent an email out to nytimes.com, it'd look something like:
+
+```
+Thanks for reading our interesting article!
+
+Extracted Recipients: user@nytimes.com
+```
+
+If you dislike that behavior, you can easily turn it off by setting `append_emails` to `false` in the settings.
+
+
+```ruby
+# config/environments/staging.rb
+CNN::Application.configure do
+  config.action_mailer.delivery_method = :mail_gate
+  config.action_mailer.mail_gate_settings = {
+    :whitelist     => /cnn.com/,
+    :append_emails => false
+  }
+end
+```
+
 By default the emails send will have the same subject that they normally would. If you'd like to customize the subject to inform the reader where it was sent from you can do that with the `:subject_prefix` option:
 
 ```ruby

data/lib/mail_gate/filter.rb

@@ -39,10 +39,21 @@ module MailGate
     #
     # Returns instance of Mail::Message.
     def deliver!(mail)
+      unless settings[:append_emails] == false
+        original_emails = email_list(mail)
+      end
+
       %w{ to cc bcc }.each do |field|
         mail.send(:"#{field}=", filter_emails(mail.send(field)))
       end
 
+      unless settings[:append_emails] == false
+        new_emails = original_emails - email_list(mail)
+        if !new_emails.empty?
+          mail.body = "#{mail.body}\n\nExtracted Recipients: #{new_emails.join(', ')}"
+        end
+      end
+
       if settings[:subject_prefix]
         mail.subject = settings[:subject_prefix] + mail.subject
       end
@@ -82,5 +93,14 @@ module MailGate
 
       email_list.length > 1 ? email_list : email_list.shift
     end
+
+    # Private: Get all unique emails across all headers that the email may contain.
+    #
+    # mail - Mail object
+    #
+    # Return Array of email addresses.
+    def email_list(mail)
+      [mail.to, mail.bcc, mail.cc].flatten.uniq.compact
+    end
   end
 end

data/lib/mail_gate/version.rb

@@ -1,3 +1,3 @@
 module MailGate
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

data/test/test_helper.rb

@@ -29,7 +29,8 @@ class Test::Unit::TestCase
   def with_whitelist(options={})
     filter = MailGate::Filter.new \
       :whitelist => options.delete(:whitelist),
-      :subject_prefix => options.delete(:subject_prefix)
+      :subject_prefix => options.delete(:subject_prefix),
+      :append_emails => options.delete(:append_emails)
 
     mail = Mail.new options.merge(:from => 'test@mail_gate.com')
 

data/test/unit/mail_gate/filter_test.rb

@@ -75,4 +75,25 @@ class TestFilter < Test::Unit::TestCase
 
     assert_equal '[staging] Welcome to the site!', mail.subject
   end
+
+  def test_append_emails_is_included
+    mail = with_whitelist \
+      :to => %w{ garrett@site.com matt@site.com luke@skywalker.com luke@copy.com },
+      :bcc => 'garrett@example.com',
+      :body => 'Test',
+      :whitelist => /site.com|copy.com/
+
+    assert_match /luke@skywalker.com\, garrett@example.com$/, mail.body.to_s
+  end
+
+  def test_appended_emails_not_included
+    mail = with_whitelist \
+      :to => %w{ garrett@site.com matt@site.com luke@skywalker.com luke@copy.com },
+      :bcc => 'garrett@example.com',
+      :body => 'Test',
+      :whitelist => /site.com|copy.com/,
+      :append_emails => false
+
+    assert_no_match /Extracted Recipients/, mail.body.to_s
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mail_gate
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-04 00:00:00.000000000 Z
+date: 2012-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
-  requirement: &70265078879640 !ruby/object:Gem::Requirement
+  requirement: &70139081871840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,7 +21,7 @@ dependencies:
         version: 2.4.1
   type: :runtime
   prerelease: false
-  version_requirements: *70265078879640
+  version_requirements: *70139081871840
 description: MailGate is an additional delivery method for the Mail gem that lets
   you restrict the delivery of mail to only whitelisted emails.
 email:
@@ -57,7 +57,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4083294560587255025
+      hash: 2893690760553553373
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -66,7 +66,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4083294560587255025
+      hash: 2893690760553553373
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.17