sanitize_email 0.3.9 → 1.0.0.alpha2

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/CHANGELOG

@@ -0,0 +1,23 @@
+Version 1.0.0.alpha1
+- Implementing initial support for Rails >= 3.0 (new ActionMailer API)
+  - Support for Rails <= 2.X remains in version 0.X.X releases.
+
+XXXXXXXXXXXXXXXXXXXXXXX Rail 3.0+ Only Form here on up! XXXXXXXXXXXXXXXXXXXXXXX
+
+Version 0.3.8
+- Update specs, note requirement of Rails 2.3 or below to run spec quite.
+- Support use_actual_email_prepended_to_subject
+- Fix environment check for old versions of Rails
+- Improved Readme
+
+Version 0.3.7
+- Improved Installation instructions
+- Fixed so tests run from inside a rails app (previously only ran standalone)
+
+Version 0.3.6
+- Fixed Installation instructions
+- Improved README
+
+Old version?
+- Fixed require paths
+- added about.yml and this CHANGELOG

data/Gemfile

@@ -1,15 +1,15 @@
-source 'https://rubygems.org'
+source "http://rubygems.org"
 
-# Specify your gem's dependencies in sanitize_email.gemspec
-gemspec
+gem 'rails', '> 3'
+gem 'actionmailer', '> 3'
 
-# Development dependencies (everything needed to run rake, tests, features, etc.)
 group :development, :test do
-# To use debugger
-# gem 'ruby-debug19', :require => 'ruby-debug'
-
-  gem "rdoc", ">= 3.12"
-  gem "bundler", ">= 1.0.24"
-  gem "reek", ">= 1.2.8"
-  gem "roodi", ">= 2.1.0"
+  gem 'jeweler'
+  gem 'letter_opener'
+  gem 'launchy'
+  gem 'rspec'
+  gem 'mail'
+  gem 'rdoc', '>= 3.12'
+  gem 'reek', '>= 1.2.8'
+  gem 'roodi', '>= 2.1.0'
 end

data/Gemfile.lock

@@ -0,0 +1,129 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.6)
+      actionpack (= 3.2.6)
+      mail (~> 2.4.4)
+    actionpack (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.1)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.3)
+    activemodel (3.2.6)
+      activesupport (= 3.2.6)
+      builder (~> 3.0.0)
+    activerecord (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+    activesupport (3.2.6)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    addressable (2.2.8)
+    arel (3.0.2)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    git (1.2.5)
+    hike (1.2.1)
+    i18n (0.6.0)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    journey (1.0.4)
+    json (1.7.3)
+    launchy (2.1.0)
+      addressable (~> 2.2.6)
+    letter_opener (0.0.2)
+      launchy
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.19)
+    multi_json (1.3.6)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.2.6)
+      actionmailer (= 3.2.6)
+      actionpack (= 3.2.6)
+      activerecord (= 3.2.6)
+      activeresource (= 3.2.6)
+      activesupport (= 3.2.6)
+      bundler (~> 1.0)
+      railties (= 3.2.6)
+    railties (3.2.6)
+      actionpack (= 3.2.6)
+      activesupport (= 3.2.6)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    reek (1.2.12)
+      ripper_ruby_parser (~> 0.0.7)
+      ruby2ruby (~> 1.2.5)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    ripper_ruby_parser (0.0.7)
+      sexp_processor (~> 3.0)
+    roodi (2.1.0)
+      ruby_parser
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.1)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+    ruby2ruby (1.2.5)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    ruby_parser (2.3.1)
+      sexp_processor (~> 3.0)
+    sexp_processor (3.2.0)
+    sprockets (2.1.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.15.3)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionmailer (> 3)
+  jeweler
+  launchy
+  letter_opener
+  mail
+  rails (> 3)
+  rdoc (>= 3.12)
+  reek (>= 1.2.8)
+  roodi (>= 2.1.0)
+  rspec

data/{LICENSE.txt → MIT-LICENSE}

@@ -1,6 +1,4 @@
-Copyright (c) 2008-2014 Peter Boling
-
-MIT License
+Copyright (c) 2008 Peter H. Boling of 9thBit LLC
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,7 +1,5 @@
 = sanitize_email
 
-NOTE ABOUT THIS VERSION: Sanitize email versions < 1 (i.e. major version 0) are to be kept compatible with Rails versions 3.1 and under.  They will be built and released from the rails_3_1_and_below branch.
-
 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.
@@ -25,51 +23,34 @@ Another very important use case for me is to transparently re-route email genera
 
 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 as a RubyGem
-
-Releases on the rails_3_1_and_below branch will remain within major version 0 and support Rails 2:
-
-  [sudo] gem install sanitize_email -v 0.3.9
-
-The master branch (*which is not this one*) has moved on to support Rails 3 and 4, and the API is somewhat different.
-
-== Setup
-
-It only requires a few lines of configuration:
+== Install Like a Boss
 
-* Rails 1.x: Add to bottom of environment.rb
+  [sudo] gem install sanitize_email
 
-* Rails 2.x: Use an initializer, stick it in any initializer file, or create a new one for sanitize_email
+== Setup With An Axe
 
-Add this bit and customize for your app:
+Customize and add to an initializer:
 
-    # 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
-
-    # optionally, you can configure sanitize_email to to include the "real" email address as the 'user name' of the
-    # "sanitized" email (e.g. "real@address.com <sanitized@email.com>")
-    ActionMailer::Base.use_actual_email_as_sanitized_user_name = true # defaults to false
-
-    # 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 )
+  SanitizeEmail::Config.configure do |config|
+    config[:sanitized_recipients] = 'to@sanitize_email.org'
+    config[:sanitized_bcc] =        'bcc@sanitize_email.org'
+    config[:sanitized_cc] =         'cc@sanitize_email.org'
+    config[:local_environments] =   %w(development test
+    config[:use_actual_email_prepended_to_subject] = true   # or false
+    config[:use_actual_email_as_sanitized_user_name] = true # or false
+  end
 
 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!
+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.
+To override the environment based switch use force_sanitize, which is nil, and ignored by default. When set to true or false it will turn sanitization on or off:
 
+  SanitizeEmail::Config.configure do |config|
+    config[:force_sanitize] = true
+  end
 
 == Example
 
@@ -83,18 +64,22 @@ and are in the development environment, you can override the override anywhere i
 
     class User < ActiveRecord::Base
       def test_signup_email_me_only
-        UserMailer.force_sanitize = true
+        SanitizeEmail::Config.configure do |config|
+          config[:force_sanitize] = true
+        end
         UserMailer.deliver_signup_notification(self)
         UserMailer.force_sanitize = nil
       end
 
       def test_signup_email_user_only
-        UserMailer.force_sanitize = false
+        SanitizeEmail::Config.configure do |config|
+          config[:force_sanitize] = false
+        end
         UserMailer.deliver_signup_notification(self)
         UserMailer.force_sanitize = nil
       end
 
-      # this third method would conditionally use the overridden recipients based on current Rails environment
+      # this third method would conditionally use the overridden recipients based on inclusion of current Rails environment in the local_environments configuration option.
       def test_signup_email_environment
         UserMailer.deliver_signup_notification(self)
       end
@@ -109,27 +94,6 @@ Then if you want to send it to the actual user, instead of yourself
 
     > User.find(4).test_signup_email_user_only
 
-== Alternate Installation Methods
-
-Some of these are Rails version dependent.
-
-Source Install:
-
-  mkdir -p ~/src
-  cd ~/src
-  git clone git://github.com/pboling/sanitize_email.git
-  cd sanitize_email
-  gem build sanitize_email.gemspec
-  sudo gem install sanitize_email-X.X.X.gem # (whatever version gets built)
-
-Then in your environment.rb (if you are just going to use it from the console, you can require it as needed there, and skip the config.gem):
-
-  config.gem 'sanitize_email'
-
-Then cd to your rails app to optionally freeze the gem into your app (if you roll this way):
-
-  rake gems:freeze GEM=sanitize_email
-
 == Install as a Plugin
 
 Plugin using Git:
@@ -141,17 +105,10 @@ Plugin using Git:
 
   git submodule add git://github.com/pboling/sanitize_email.git vendor/plugins/sanitize_email
 
-== Run the Test Suite
-
-The test suite must be run against Rails 2.3.X or below as it is coded to expect the Tmail objects under the hood.
-
-  rake test
-
 == Authors
 
-Peter Boling is the original author of the code.
-John Trupiano gemified and improved the code.
-John kindly returned gem ownership to Peter, who currently maintains it.
+Peter Boling is the original author of the code, and current maintainer of both the rails 2 and rails 3 development tracks.
+John Trupiano did the initial gemification and some refactoring.
 
 == Contributors
 
@@ -163,6 +120,6 @@ George Anderson's work / improvements have been pulled in, along with several ot
 * {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) 2008-2014 {Peter H. Boling}[http://railsbling.com]
+Copyright (c) 2008-2012 {Peter H. Boling}[http://www.peterboling.com/about.html] of {9thBit LLC}[http://www.peterboling.com/]
 Copyright (c) 2009 {John Trupiano}[http://smartlogicsolutions.com/wiki/John_Trupiano] of {SmartLogic Solutions, LLC}[http://www.smartlogicsolutions.com]
-Released under the MIT license, see LICENSE.txt in this directory
+Released under the MIT license

data/Rakefile

@@ -1,14 +1,59 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
 require 'rake'
-require 'rake/testtask'
 
-desc 'Default: run unit tests.'
-task :default => :test
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "sanitize_email"
+  gem.homepage = "http://github.com/pboling/sanitize_email"
+  gem.license = "MIT"
+  gem.summary = %q{Test an application's email abilities without ever sending a message to actual live addresses}
+  gem.description = "Tool to aid in development, testing, qa, and production troubleshooting of email issues without worrying that emails will get sent to actual live addresses."
+  gem.email = ['peter.boling@gmail.com', 'jtrupiano@gmail.com', 'george@benevolentcode.com']
+  gem.authors = ["Peter Boling", "John Trupiano", "George Anderson"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+require 'reek/rake/task'
+Reek::Rake::Task.new do |t|
+  t.fail_on_error = true
+  t.verbose = false
+  t.source_files = 'lib/**/*.rb'
+end
+
+require 'roodi'
+require 'roodi_task'
+RoodiTask.new do |t|
+  t.verbose = false
+end
+
+task :default => :spec
 
-desc 'Test the sanitize_email plugin.'
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = true
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = "SanitizeEmail #{version}"
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-require "bundler/gem_tasks"
+Bundler::GemHelper.install_tasks

data/VERSION.yml

@@ -1,5 +1,5 @@
 ---
-:major: 0
-:minor: 3
-:patch: 8
-:build: 
+:major: 1
+:minor: 0
+:patch: 0
+:build: alpha2

data/lib/sanitize_email.rb

@@ -1,12 +1,31 @@
-# Versions of sanitize_email > 1 no longer require actionmailer, and can be used sans-rails.
-require 'actionmailer'
-
-require "sanitize_email/version"
-require 'sanitize_email/sanitize_email'
-require 'sanitize_email/custom_environments'
+#Copyright (c) 2008-12 Peter H. Boling of 9thBit LLC
+#Released under the MIT license
+require 'rails'
+require 'action_mailer'
 
 module SanitizeEmail
-end
+  if defined?(Rails) && ::Rails::VERSION::MAJOR >= 3
+    require 'sanitize_email/version'
+    require 'sanitize_email/config'
+    require 'sanitize_email/sanitizer'
+    require 'sanitize_email/hook'
+
+    if ::Rails::VERSION::MINOR >= 1
+      require 'sanitize_email/engine'
+    elsif ::Rails::VERSION::MINOR == 0
+      require 'sanitize_email/railtie'
+    end
+  else
+    raise "Please use the 0.X.X versions of sanitize_email for Rails 2.X and below."
+  end
 
-ActionMailer::Base.send :include, NinthBit::CustomEnvironments
-ActionMailer::Base.send :include, NinthBit::SanitizeEmail
+  def self.[](key)
+    return nil unless key.respond_to?(:to_sym)
+    SanitizeEmail::Config.config[key.to_sym]
+  end
+
+  def self.method_missing(name, *args)
+    SanitizeEmail[name]
+  end
+
+end