mail_magnet 0.1.0

data/README.rdoc

@@ -0,0 +1,24 @@
+= Mail Magnet
+
+Mail Magnet allows you to override e-mail recipients in ActionMailer, e.g. for testing purposes.
+
+http://gem-session.com/2010/06/overriding-e-mail-recipients-in-actionmailer
+
+== Installation
+
+Install the gem with
+    sudo gem install mail_magnet
+
+....
+
+== Rails 3 compatibility
+
+We cannot guarantee Rails 3 compatibility at this point, but we will upgrade the gem when Rails 3 is released.
+
+=== Credits
+
+Arne Hartherz
+
+{makandra.com}[http://makandra.com/]
+
+{gem-session.com}[http://gem-session.com/]

data/lib/mail_magnet/action_mailer_ext.rb

@@ -0,0 +1,14 @@
+ActionMailer::Base.class_eval do
+
+  @@override_recipients = nil
+  cattr_accessor :override_recipients
+
+  def deliver_with_override!(mail = @mail)
+    if override_recipients.present?
+      mail.override_recipients! override_recipients
+    end
+    deliver_without_override! mail
+  end
+  alias_method_chain :deliver!, :override
+
+end

data/lib/mail_magnet/tmail_ext.rb

@@ -0,0 +1,27 @@
+TMail::Mail.class_eval do
+
+  def override_recipients!(recipients)
+    recipients = Array(recipients)
+
+    original_addresses = {
+      :to => override(:to, recipients),
+      :cc => override(:cc, recipients),
+      :bcc => override(:bcc, recipients)
+    }
+
+    parts = [ "--- Original recipients ---" ]
+    [ :to, :cc, :bcc ].each do |target|
+      parts << target.to_s.capitalize + ": " + (original_addresses[target] ? original_addresses[target].join(', ') : '(none)')
+    end
+    parts << "---------------------------"
+
+    self.body = parts.join("\n") + "\n\n" + self.body
+  end
+
+  def override(method, recipients)
+    original_recipients = send("#{method}")
+    self.send "#{method}=", recipients if original_recipients
+    original_recipients
+  end
+
+end

data/spec/app_root/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/spec/app_root/app/models/mailer.rb

@@ -0,0 +1,10 @@
+class Mailer < ActionMailer::Base
+
+  def letter
+    recipients 'original.to@example.com'
+    cc 'original.cc@example.com'
+    bcc 'original.bcc@example.com'
+    subject 'Hello Universe!'
+  end
+
+end

data/spec/app_root/app/views/mailer/letter.erb

@@ -0,0 +1 @@
+Hello!

data/spec/app_root/config/boot.rb

@@ -0,0 +1,114 @@
+# Allow customization of the rails framework path
+RAILS_FRAMEWORK_ROOT = (ENV['RAILS_FRAMEWORK_ROOT'] || "#{File.dirname(__FILE__)}/../../../../../../vendor/rails") unless defined?(RAILS_FRAMEWORK_ROOT) 
+
+# Don't change this file!
+# Configure your app in config/environment.rb and config/environments/*.rb
+
+RAILS_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?(RAILS_ROOT)
+
+module Rails
+  class << self
+    def boot!
+      unless booted?
+        preinitialize
+        pick_boot.run
+      end
+    end
+
+    def booted?
+      defined? Rails::Initializer
+    end
+
+    def pick_boot
+      (vendor_rails? ? VendorBoot : GemBoot).new
+    end
+
+    def vendor_rails?
+      File.exist?(RAILS_FRAMEWORK_ROOT)
+    end
+
+    def preinitialize
+      load(preinitializer_path) if File.exist?(preinitializer_path)
+    end
+
+    def preinitializer_path
+      "#{RAILS_ROOT}/config/preinitializer.rb"
+    end
+  end
+
+  class Boot
+    def run
+      load_initializer
+      Rails::Initializer.run(:set_load_path)
+    end
+  end
+
+  class VendorBoot < Boot
+    def load_initializer
+      require "#{RAILS_FRAMEWORK_ROOT}/railties/lib/initializer"
+      Rails::Initializer.run(:install_gem_spec_stubs)
+    end
+  end
+
+  class GemBoot < Boot
+    def load_initializer
+      self.class.load_rubygems
+      load_rails_gem
+      require 'initializer'
+    end
+
+    def load_rails_gem
+      if version = self.class.gem_version
+        gem 'rails', version
+      else
+        gem 'rails'
+      end
+    rescue Gem::LoadError => load_error
+      $stderr.puts %(Missing the Rails #{version} gem. Please `gem install -v=#{version} rails`, update your RAILS_GEM_VERSION setting in config/environment.rb for the Rails version you do have installed, or comment out RAILS_GEM_VERSION to use the latest version installed.)
+      exit 1
+    end
+
+    class << self
+      def rubygems_version
+        Gem::RubyGemsVersion rescue nil
+      end
+
+      def gem_version
+        if defined? RAILS_GEM_VERSION
+          RAILS_GEM_VERSION
+        elsif ENV.include?('RAILS_GEM_VERSION')
+          ENV['RAILS_GEM_VERSION']
+        else
+          parse_gem_version(read_environment_rb)
+        end
+      end
+
+      def load_rubygems
+        require 'rubygems'
+        min_version = '1.1.1'
+        unless rubygems_version >= min_version
+          $stderr.puts %Q(Rails requires RubyGems >= #{min_version} (you have #{rubygems_version}). Please `gem update --system` and try again.)
+          exit 1
+        end
+ 
+      rescue LoadError
+        $stderr.puts %Q(Rails requires RubyGems >= #{min_version}. Please install RubyGems and try again: http://rubygems.rubyforge.org)
+        exit 1
+      end
+
+      def parse_gem_version(text)
+        $1 if text =~ /^[^#]*RAILS_GEM_VERSION\s*=\s*["']([!~<>=]*\s*[\d.]+)["']/
+      end
+
+      private
+        def read_environment_rb
+          environment_rb = "#{RAILS_ROOT}/config/environment.rb"
+          environment_rb = "#{HELPER_RAILS_ROOT}/config/environment.rb" unless File.exists?(environment_rb)
+          File.read(environment_rb)
+        end
+    end
+  end
+end
+
+# All that for this:
+Rails.boot!

data/spec/app_root/config/environment.rb

@@ -0,0 +1,14 @@
+require File.join(File.dirname(__FILE__), 'boot')
+
+Rails::Initializer.run do |config|
+  config.cache_classes = false
+  config.whiny_nils = true
+  config.action_controller.session = { :key => "_myapp_session", :secret => "gwirofjweroijger8924rt2zfwehfuiwehb1378rifowenfoqwphf23" }
+  config.plugin_locators.unshift(
+    Class.new(Rails::Plugin::Locator) do
+      def plugins
+        [Rails::Plugin.new(File.expand_path('.'))]
+      end
+    end
+  ) unless defined?(PluginTestHelper::PluginLocator)
+end

data/spec/app_root/config/routes.rb

@@ -0,0 +1,4 @@
+ActionController::Routing::Routes.draw do |map|
+  map.connect ':controller/:action/:id'
+  map.connect ':controller/:action/:id.:format'
+end

data/spec/app_root/lib/console_with_fixtures.rb

@@ -0,0 +1,4 @@
+# Loads fixtures into the database when running the test app via the console
+(ENV['FIXTURES'] ? ENV['FIXTURES'].split(/,/) : Dir.glob(File.join(Rails.root, '../fixtures/*.{yml,csv}'))).each do |fixture_file|
+  Fixtures.create_fixtures(File.join(Rails.root, '../fixtures'), File.basename(fixture_file, '.*'))
+end

data/spec/mail_magnet_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe 'mail_magnet' do
+
+  before :each do
+    ActionMailer::Base.delivery_method = :test
+    ActionMailer::Base.override_recipients = nil
+  end
+
+  it 'should allow to override recipients, cc and bcc for all mailers' do
+    ActionMailer::Base.override_recipients = 'overridden.to@example.com'
+    Mailer.deliver_letter
+    ActionMailer::Base.deliveries.last.to.should == ['overridden.to@example.com']
+    ActionMailer::Base.deliveries.last.cc.should == ['overridden.to@example.com']
+    ActionMailer::Base.deliveries.last.bcc.should == ['overridden.to@example.com']
+  end
+
+  it 'should allow to override recipients, cc, and bcc with multiple recipients' do
+    overrides = %w[ overridden.to@example.com other.overridden.to@example.com ]
+    ActionMailer::Base.override_recipients = overrides
+    Mailer.deliver_letter
+    ActionMailer::Base.deliveries.last.to.should == overrides
+    ActionMailer::Base.deliveries.last.cc.should == overrides
+    ActionMailer::Base.deliveries.last.bcc.should == overrides
+  end
+
+  it 'should put the original recipients, cc and bcc into the mail body' do
+    ActionMailer::Base.override_recipients = 'overridden.to@example.com'
+    Mailer.deliver_letter
+    ActionMailer::Base.deliveries.last.body.should include('To: original.to@example.com')
+    ActionMailer::Base.deliveries.last.body.should include('Cc: original.cc@example.com')
+    ActionMailer::Base.deliveries.last.body.should include('Bcc: original.bcc@example.com')
+  end
+
+  it 'should leave original recipients untouched if it is not activated' do
+    Mailer.deliver_letter
+    ActionMailer::Base.deliveries.last.to.should == ['original.to@example.com']
+    ActionMailer::Base.deliveries.last.cc.should == ['original.cc@example.com']
+    ActionMailer::Base.deliveries.last.bcc.should == ['original.bcc@example.com']
+  end
+
+  it 'should not touch the subject' do
+    ActionMailer::Base.override_recipients = 'overridden.to@example.com'
+    Mailer.deliver_letter
+    ActionMailer::Base.deliveries.last.subject.should == 'Hello Universe!'
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+$: << File.join(File.dirname(__FILE__), "/../lib" )
+
+# Set the default environment to sqlite3's in_memory database
+ENV['RAILS_ENV'] ||= 'in_memory'
+
+# Load the Rails environment and testing framework
+require "#{File.dirname(__FILE__)}/app_root/config/environment"
+require "#{File.dirname(__FILE__)}/../lib/mail_magnet"
+require 'spec/rails'
+
+# Undo changes to RAILS_ENV
+silence_warnings {RAILS_ENV = ENV['RAILS_ENV']}
+
+# Run the migrations
+ActiveRecord::Migrator.migrate("#{Rails.root}/db/migrate")
+
+Spec::Runner.configure do |config|
+  config.use_transactional_fixtures = true
+  config.use_instantiated_fixtures  = false
+end
+

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: mail_magnet
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Arne Hartherz
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-23 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Override ActionMailer recipients so all mails go to a given address
+email: github@makandra.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- lib/mail_magnet/action_mailer_ext.rb
+- lib/mail_magnet/tmail_ext.rb
+- spec/app_root/app/views/mailer/letter.erb
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/makandra/mail_magnet
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Override ActionMailer recipients so all mails go to a given address
+test_files: 
+- spec/app_root/config/boot.rb
+- spec/app_root/config/environment.rb
+- spec/app_root/config/routes.rb
+- spec/app_root/config/environments/in_memory.rb
+- spec/app_root/config/environments/mysql.rb
+- spec/app_root/config/environments/postgresql.rb
+- spec/app_root/config/environments/sqlite.rb
+- spec/app_root/config/environments/sqlite3.rb
+- spec/app_root/lib/console_with_fixtures.rb
+- spec/app_root/app/controllers/application_controller.rb
+- spec/app_root/app/models/mailer.rb
+- spec/spec_helper.rb
+- spec/mail_magnet_spec.rb