dalbaqui-sanitize_email 0.1.3

data/README.rdoc

@@ -0,0 +1,112 @@
+= sanitize_email
+
+This gem allows you to globally override your mail delivery settings.  It's particularly helpful when you want to omit the delivery of email (e.g. in development/test environments) or alter the to/cc/bcc (e.g. in staging or demo environments) of all email generated from your application.
+
+It is a "configure it and forget it" type gem that requires very little setup.  It includes some very innocuous monkey patching of ActionMailer::Base to work its magic.
+
+Peter Boling wrote the plugin that this gem is derived from.  It currently solves three common problems in ruby web applications that use ActionMailer:
+
+=== Working Locally with Production Data
+
+Peter described this common problem in his original plugin implementation as such:
+
+* I have a production site with live data.
+* I dump the live data and securely transfer it to another machine (rync -e ssh), and import it using scripts that I will soon open source to.
+* On this separate machine (staging, or development) I run tests, and test various features.
+* I usually want the emails to get sent from these non-production environments so I can verify what they look like when sent, but I don't ever want to risk them getting sent to addresses that are not mine.
+
+=== Re-routing Email on a Staging or QA Server
+
+Another very important use case for me is to transparently re-route email generated from a staging or QA server to an appropriate person.  For example, it's common for us to set up a staging server for a client to use to view our progress and test out new features.  It's important for any email that is generated from our web application be delivered to the client's inbox so that they can review the content and ensure that it's acceptable.  Similarly, we set up QA instances for our own QA team and we use {rails-caddy}[http://github.com/jtrupiano/rails-caddy] to allow each QA person to configure it specifically for them.
+
+=== Testing Email from a Hot Production Server
+
+If you install this gem on a production server (which I don't always do), you can load up script/console and override the to/cc/bcc on all emails for the duration of your console session.  This allows you to poke and prod a live production instance, and route all email to your own inbox for inspection.  The best part is that this can all be accomplished without changing a single line of your application code.
+
+== Install
+
+    gem sources -a http://gems.github.com/
+    gem install jtrupiano-sanitize_email
+
+== Setup
+
+It only requires a few lines of configuration:
+
+* Rails 1.x: Add to bottom of environment.rb
+		
+* Rails 2.x: Use an initializer, stick it in any initializer file, or create a new one for sanitize_email
+		
+Add this bit and customize for your app:
+
+    # Settings for sanitize_email gem.  These can be overridden in individual config/%env%/environment.rb files.
+
+    require 'sanitize_email'
+    ActionMailer::Base.sanitized_recipients = "jtrupiano@gmail.com"
+    ActionMailer::Base.sanitized_bcc = nil
+    ActionMailer::Base.sanitized_cc = nil
+
+    # These are the environments whose outgoing email BCC, CC and recipients fields will be overridden!  
+    # All environments not listed will be treated as normal.
+    ActionMailer::Base.local_environments = %w( development test staging )
+
+Keep in mind, this is ruby (and possibly rails), so you can add conditionals or utilize different environment.rb files to customize these settings on a per-environment basis.
+
+But wait there's more:
+
+Let's say you have a method in your model that you can call to test the signup email.
+You want to be able to test sending it to any user at any time... but you don't want
+the user to ACTUALLY get the email, even in production. A dilemma, yes?  Not anymore!
+
+All your mailers get a force_sanitize class method which takes precedence over the environment override.
+
+When force_sanitize is nil it will not be used by sanitize_email to determine if it should override the recipients, bcc, and cc.
+
+
+== Example
+
+So here's how you can use force_sanitize to override the override.
+
+Even if you set:
+
+  ActionMailer::Base.local_environments = %w( development )
+
+and are in the development environment, you can override the override anywhere in your code.
+
+    class User < ActiveRecord::Base
+      def test_signup_email_me_only
+        UserMailer.force_sanitize = true
+        UserMailer.deliver_signup_notification(self)
+        UserMailer.force_sanitize = nil
+      end
+
+      def test_signup_email_user_only
+        UserMailer.force_sanitize = false
+        UserMailer.deliver_signup_notification(self)
+        UserMailer.force_sanitize = nil
+      end
+
+      # this third method would conditionally use the overridden recipients based on current Rails environment
+      def test_signup_email_environment
+        UserMailer.deliver_signup_notification(self)
+      end
+    end
+
+Load the console with ruby script/console and regardless of what environment you are in:
+
+	  > User.find(4).test_signup_email_me_only
+	
+and the email will have it's recipients, bcc, and cc overridden to be whatever you set the sanitized values to be.
+Then if you want to send it to the actual user, instead of yourself
+
+	  > User.find(4).test_signup_email_user_only
+
+== References
+* {RDoc}[http://johntrupiano.rubyforge.org/sanitize_email]
+* {Source Code}[http://github.com/jtrupiano/sanitize_email]
+* {Gem Release Announcement}[http://blog.smartlogicsolutions.com/2009/04/25/reintroducing-sanitize_email-work-with-production-email-without-fear/]
+* {Peter's Original Writeup}[http://galtzo.blogspot.com/2008/11/sanitize-email-never-worry-about.html]
+* {Using sanitize_email to Preview HTML Emails Locally}[http://blog.smartlogicsolutions.com/2009/04/30/using-sanitize-email-to-preview-html-emails-locally/]
+
+Copyright (c) 2009 {John Trupiano}[http://smartlogicsolutions.com/wiki/John_Trupiano] of {SmartLogic Solutions, LLC}[http://www.smartlogicsolutions.com]
+Copyright (c) 2008 {Peter H. Boling}[http://www.peterboling.com/about.html] of {9thBit LLC}[http://www.peterboling.com/]
+Released under the MIT license

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 1
+:patch: 1

data/lib/sanitize_email.rb

@@ -0,0 +1,5 @@
+require File.join(File.dirname(__FILE__), "sanitize_email", "sanitize_email")
+require File.join(File.dirname(__FILE__), "sanitize_email", "custom_environments")
+
+ActionMailer::Base.send :include, NinthBit::CustomEnvironments
+ActionMailer::Base.send :include, NinthBit::SanitizeEmail

data/lib/sanitize_email/custom_environments.rb

@@ -0,0 +1,23 @@
+#Copyright (c) 2008 Peter H. Boling of 9thBit LLC
+#Released under the MIT license
+
+module NinthBit
+  module CustomEnvironments
+    
+    def self.included(base)
+      base.extend(ClassMethods)
+  
+      base.cattr_accessor :local_environments
+      base.local_environments = %w( development test )
+
+    end
+
+    module ClassMethods
+      def consider_local?
+        local_environments.include?(RAILS_ENV)
+      end
+
+    end
+    
+  end
+end

data/lib/sanitize_email/sanitize_email.rb

@@ -0,0 +1,64 @@
+#Copyright (c) 2008 Peter H. Boling of 9thBit LLC
+#Released under the MIT license
+
+module NinthBit
+  module SanitizeEmail
+
+    def self.included(base)
+  
+      # Adds the following class attributes to the classes that include NinthBit::SanitizeEmail
+      base.cattr_accessor :force_sanitize
+      base.force_sanitize = nil
+      
+      # Specify the BCC addresses for the messages that go out in 'local' environments
+      base.cattr_accessor :sanitized_bcc
+      base.sanitized_bcc = nil
+     
+      # Specify the CC addresses for the messages that go out in 'local' environments
+      base.cattr_accessor :sanitized_cc
+      base.sanitized_cc = nil
+    
+      # The recipient addresses for the messages, either as a string (for a single
+      # address) or an array (for multiple addresses) that go out in 'local' environments
+      base.cattr_accessor :sanitized_recipients
+      base.sanitized_recipients = nil
+      
+      base.class_eval do
+        #We need to alias these methods so that our new methods get used instead
+        alias :real_bcc :bcc
+        alias :real_cc :cc
+        alias :real_recipients :recipients
+        alias :real_subject :subject
+
+        def localish?
+          #consider_local is a method in sanitize_email/lib/custom_environments.rb
+          # it is included in ActionMailer in sanitize_email/init.rb
+          !self.class.force_sanitize.nil? ? self.class.force_sanitize : self.class.consider_local?
+        end
+
+        def subject(*lines)
+          real_subject *lines
+          localish? ? "(#{real_recipients}) #{real_subject}" : real_subject unless real_recipients.nil?
+        end
+
+        def recipients(*addresses)
+          real_recipients *addresses
+          puts "sanitize_email error: sanitized_recipients is not set" if self.class.sanitized_recipients.nil?
+          localish? ? self.class.sanitized_recipients : real_recipients
+        end
+
+        def bcc(*addresses)
+          real_bcc *addresses
+          localish? ? self.class.sanitized_bcc : real_bcc
+        end
+
+        def cc(*addresses)
+          real_cc *addresses
+          localish? ? self.class.sanitized_cc : real_cc
+        end
+      
+      end
+
+    end
+  end # end Module SanitizeEmail
+end # end Module NinthBit

data/test/sample_mailer.rb

@@ -0,0 +1,24 @@
+
+require 'rubygems'
+require 'action_mailer'
+
+# configure ActionMailer
+ActionMailer::Base.template_root = "."
+
+require File.join(File.dirname(__FILE__), "..", "lib", 'sanitize_email')
+
+
+class SampleMailer < ActionMailer::Base
+  
+  def gmail_override
+    # set them all to send to gmail
+    @recipients = "jtrupiano@gmail.com"
+    @cc         = "jtrupiano@gmail.com"
+    @bcc        = "jtrupiano@gmail.com"
+
+    @subject = "Hello there"
+    
+    part :content_type => "text/html", :body => "Hello there"
+  end
+
+end

data/test/sanitize_email_test.rb

@@ -0,0 +1,21 @@
+require 'test/unit'
+require 'test/sample_mailer'
+
+class SanitizeEmailTest < Test::Unit::TestCase
+
+  def test_send_can_override_recips_cc_bcc_all_independently
+    # configure SanitizeEmail
+    ActionMailer::Base.sanitized_recipients = "john@smartlogicsolutions.com"
+    ActionMailer::Base.sanitized_bcc = nil
+    ActionMailer::Base.sanitized_cc = "john@smartlogicsolutions.com"
+    ActionMailer::Base.local_environments = %w( test )
+    ENV['RAILS_ENV'] = 'test'
+    
+    # the mailer sets all 3 of these values to "jtrupiano@gmail.com".  We override them independently
+    tmail = SampleMailer.create_gmail_override
+    assert_equal ["john@smartlogicsolutions.com"], tmail.to
+    assert_equal ["john@smartlogicsolutions.com"], tmail.cc
+    assert_equal nil, tmail.bcc
+  end
+
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: dalbaqui-sanitize_email
+version: !ruby/object:Gem::Version 
+  version: 0.1.3
+platform: ruby
+authors: 
+- John Trupiano
+- Peter Boling
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-25 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: allows you to play with your application's email abilities without worrying that emails will get sent to actual live addresses
+email: jtrupiano@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- VERSION.yml
+- lib/sanitize_email
+- lib/sanitize_email/custom_environments.rb
+- lib/sanitize_email/sanitize_email.rb
+- lib/sanitize_email.rb
+- test/sample_mailer.rb
+- test/sanitize_email_test.rb
+has_rdoc: true
+homepage: http://github.com/jtrupiano/sanitize_email
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: johntrupiano
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Tool to aid in development, testing, qa, and production troubleshooting of email issues without worrying that emails will get sent to actual live addresses.
+test_files: []
+