catch_all 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+.DS_Store
+.tmproj

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+gemspec
+
+gem 'actionmailer'
+
+group :development do
+  gem 'rspec', '>= 2.3.0'
+  gem 'ZenTest', "~> 4.4.2"
+end

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    catch_all (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ZenTest (4.4.2)
+    actionmailer (3.2.11)
+      actionpack (= 3.2.11)
+      mail (~> 2.4.4)
+    actionpack (3.2.11)
+      activemodel (= 3.2.11)
+      activesupport (= 3.2.11)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.11)
+      activesupport (= 3.2.11)
+      builder (~> 3.0.0)
+    activesupport (3.2.11)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    builder (3.0.4)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    hike (1.2.1)
+    i18n (0.6.1)
+    journey (1.0.4)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.19)
+    multi_json (1.5.0)
+    polyglot (0.3.3)
+    rack (1.4.3)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.0)
+    rspec-expectations (2.12.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.0)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    tilt (1.3.3)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ZenTest (~> 4.4.2)
+  actionmailer
+  catch_all!
+  rspec (>= 2.3.0)

data/README.md

@@ -0,0 +1,17 @@
+# ActionMailer::CatchAll
+
+ActionMailer::CatchAll is a simple module to define a white-list of email addresses, used for staging environments.
+
+## Usage
+
+  Gemfile:
+
+    gem 'catch_all'
+
+  config/initializers/email_catch_all.rb:
+
+    if Rails.env.staging?
+      ActionMailer::CatchAll.enable('scott@railsnewbie.com')
+    end
+
+

data/catch_all.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'catch_all/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "catch_all"
+  gem.version       = ActionMailer::CatchAll::VERSION
+  gem.authors       = ["Scott Taylor"]
+  gem.email         = ["scott@railsnewbie.com"]
+  gem.description   = %q{Define a white-list only set of emails for ActionMailer}
+  gem.summary       = %q{Define a white-list only set of emails for ActionMailer.  Used in staging environments.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/catch_all/version.rb

@@ -0,0 +1,5 @@
+module ActionMailer
+  module CatchAll
+    VERSION = '0.0.1'
+  end
+end

data/lib/catch_all.rb

@@ -0,0 +1,52 @@
+require 'action_mailer'
+require File.dirname(__FILE__) + "/catch_all/version"
+
+module ActionMailer
+  module CatchAll
+    class << self
+      def enabled?
+        ActionMailer::Base.instance_methods.include?(:mail_aliased_from_action_mailer_staging)
+      end
+
+      def enable(*to_addresses)
+        to_addresses = to_addresses.flatten
+
+        ActionMailer::Base.class_eval do
+          if instance_methods.include?(:mail_aliased_from_action_mailer_staging)
+            ActionMailerStaging.disable
+          end
+
+          alias_method :mail_aliased_from_action_mailer_staging, :mail
+
+          define_method :mail do |*args, &block|
+            mailer = mail_aliased_from_action_mailer_staging(*args, &block)
+
+            to_values = Array(mailer[:to]).map do |field|
+              field.value
+            end
+
+            # save the original to header
+            mailer['X-Action-Mailer-Staging-Original-Email-To'] = to_values.inspect
+            selected_to_addresses = to_values.select { |to| to_addresses.include?(to) }
+            if selected_to_addresses.any?
+              mailer[:to] = selected_to_addresses
+            else
+              mailer[:to] = to_addresses
+            end
+
+            mailer
+          end
+        end
+      end
+
+      def disable
+        if enabled?
+          ActionMailer::Base.class_eval do
+            alias_method :mail, :mail_aliased_from_action_mailer_staging
+            remove_method :mail_aliased_from_action_mailer_staging
+          end
+        end
+      end
+    end
+  end
+end

data/spec/catch_all_spec.rb

@@ -0,0 +1,96 @@
+require File.dirname(__FILE__) + '/../lib/catch_all'
+
+class Notifier < ActionMailer::Base
+  def notify
+    mail(:to => "scott@learnup.me")
+  end
+
+  def notify_multiple
+    mail(:to => ["scott@learnup.me", "kenny@learnup.me"])
+  end
+
+  def notify_with_name
+    mail(:to => "Scott Taylor <scott@learnup.me>")
+  end
+
+  def notify_no_address
+    mail()
+  end
+end
+
+describe ActionMailer::CatchAll do
+  before :each do
+    ActionMailer::CatchAll.disable
+  end
+
+  after :all do
+    ActionMailer::CatchAll.disable
+  end
+
+  it "should disable properly" do
+    ActionMailer::CatchAll.disable
+    ActionMailer::CatchAll.disable
+  end
+
+  it "should override the to address when enabled" do
+    ActionMailer::CatchAll.enable("scott@railsnewbie.com")
+    mailer = Notifier.notify
+    mailer.to.should == ["scott@railsnewbie.com"]
+  end
+
+  it "should use the correct email" do
+    ActionMailer::CatchAll.enable("foo@railsnewbie.com")
+    mailer = Notifier.notify
+    mailer.to.should == ["foo@railsnewbie.com"]
+  end
+
+  it "should allow a list of emails" do
+    ActionMailer::CatchAll.enable(["foo@railsnewbie.com", "bar@railsnewbie.com"])
+    mailer = Notifier.notify
+    mailer.to.should == ["foo@railsnewbie.com", "bar@railsnewbie.com"]
+  end
+
+  it "should allow a list of emails in splatted format" do
+    ActionMailer::CatchAll.enable("foo@railsnewbie.com", "bar@railsnewbie.com")
+    mailer = Notifier.notify
+    mailer.to.should == ["foo@railsnewbie.com", "bar@railsnewbie.com"]
+  end
+
+  it "should send an email to the intended recipient if on the list (and only to the intended recipient)" do
+    ActionMailer::CatchAll.enable("scott@learnup.me", "bar@railsnewbie.com")
+    mailer = Notifier.notify
+    mailer.to.should == ["scott@learnup.me"]
+  end
+
+  it "should only email the intersection of the lists" do
+    ActionMailer::CatchAll.enable("scott@learnup.me", "scott@railsnewbie.com")
+    mailer = Notifier.notify
+    mailer.to.should == ["scott@learnup.me"]
+  end
+
+  it "should allow for <> in the email format" do
+    ActionMailer::CatchAll.enable("scott@learnup.me")
+    mailer = Notifier.notify
+    mailer.to.should == ["scott@learnup.me"]
+  end
+
+  it "should email even if no :to address is specified" do
+    ActionMailer::CatchAll.enable('scott@railsnewbie.com')
+    mailer = Notifier.notify_no_address
+    mailer.to.should == ["scott@railsnewbie.com"]
+  end
+
+  it "should set a header with the original to address" do
+    ActionMailer::CatchAll.enable('scott@railsnewbie.com')
+    mailer = Notifier.notify
+    mailer['X-Action-Mailer-Staging-Original-Email-To'].value.should == "[\"scott@learnup.me\"]"
+  end
+
+  it "should report as enabled when enabled" do
+    ActionMailer::CatchAll.enable("scott@railsnewbie.com")
+    ActionMailer::CatchAll.should be_enabled
+
+    ActionMailer::CatchAll.disable
+    ActionMailer::CatchAll.should_not be_enabled
+  end
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: catch_all
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Scott Taylor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-06 00:00:00.000000000 Z
+dependencies: []
+description: Define a white-list only set of emails for ActionMailer
+email:
+- scott@railsnewbie.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- README.md
+- catch_all.gemspec
+- lib/catch_all.rb
+- lib/catch_all/version.rb
+- spec/catch_all_spec.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Define a white-list only set of emails for ActionMailer.  Used in staging
+  environments.
+test_files:
+- spec/catch_all_spec.rb