jtrupiano-sanitize_email 0.0.2

data/README.textile

@@ -0,0 +1,107 @@
+h1. sanitize_email
+
+This gem allows you to quickly globally override your mail delivery settings in depending on the environment.  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.
+
+This is the problem I have with site after site:
+
+1) I have a production site with live data.
+2) 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.
+3) On this separate machine (staging, or development) I run tests, and test various features.
+4) I usually want the emails to get sent from these non-production evnironments 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.
+	
+So Peter Boling wrote a plugin!  And I've taken it and turned into a gem!
+
+It is an "configure it and forget it" type gem that requires very little setup.  It includes some very innocuous monkey patching of ActiveRecord::Base to work its magic.
+
+
+h2. Install
+
+gem sources -a http://gems.github.com/
+gem install jtrupiano-sanitize_email
+
+
+h2. 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:
+
+<ruby>
+  # 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 )
+</ruby>
+
+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.
+
+
+h2. Example
+
+So here's how you can use force_sanitize to override the override.
+
+Even if you set:
+<ruby>
+        ActionMailer::Base.local_environments = %w( development )
+</ruby>
+
+and are in the development environment, you can override the override anywhere in your code.
+
+<ruby>	
+    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
+</ruby>
+
+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
+
+That's it!  Enjoy!
+
+Copyright (c) 2008 Peter H. Boling of 9thBit LLC
+Released under the MIT license

data/VERSION.yml

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

data/lib/sanitize_email/custom_environments.rb

@@ -0,0 +1,27 @@
+#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 )
+      
+      base.cattr_accessor :deployed_environments
+      base.deployed_environments = %w( production staging )
+    end
+
+    module ClassMethods
+      def consider_local?
+        local_environments.include?(ENV['RAILS_ENV'])
+      end
+      def consider_deployed?
+        deployed_environments.include?(ENV['RAILS_ENV'])
+      end
+    end
+    
+  end
+end

data/lib/sanitize_email/sanitize_email.rb

@@ -0,0 +1,58 @@
+#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
+
+        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 recipients(*addresses)
+          real_recipients *addresses
+          puts "santize_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/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/test/sanitize_email_test.rb

@@ -0,0 +1,8 @@
+require 'test/unit'
+
+class SanitizeEmailTest < Test::Unit::TestCase
+  # Replace this with your real tests.
+  def test_this_plugin
+    flunk
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: jtrupiano-sanitize_email
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- John Trupiano
+- Peter Boling
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-02 00:00:00 -08: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: []
+
+files: 
+- README.textile
+- VERSION.yml
+- lib/sanitize_email
+- lib/sanitize_email/custom_environments.rb
+- lib/sanitize_email/sanitize_email.rb
+- lib/sanitize_email.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: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: "Gemified fork of pboling's sanitize_email plugin: allows you to play with your application's email abilities without worrying that emails will get sent to actual live addresses."
+test_files: []
+