sanitize_email 1.0.0.rc1 → 1.0.0.rc3

data/.gitignore

@@ -0,0 +1,7 @@
+*.sw?
+.DS_Store
+coverage
+pkg
+.idea
+spec/tmp
+*.gem

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - jruby-19mode
+  - rbx-19mode
+  - ruby-head
+  - jruby-head

data/CHANGELOG

@@ -1,3 +1,17 @@
+Version 1.0.0.rc3 - AUG.08.2012
+- Forgot to switch from jeweler to gem-release, so making appropriate changes and bumping again
+- Aligning closer to bundler gem defaults
+- Removing Rails dependency - Should work with Sinatra, or any Mail-like interface
+- Added facets dependency to get cattr functionality (and hopefully other cool stuff)
+- Gem dependencies in gemspec
+
+
+Version 1.0.0.rc2 - AUG.08.2012 - botched
+- Bug: loading the gem in a rails app broke mailer specs in the app - Fixed
+  - https://github.com/pboling/sanitize_email/issues/4
+- Moved MIT-LICENSE to LICENSE, updated years
+- Added Travis-CI for... CI.
+
 Version 1.0.0.rc1
 - Added a good_list and a bad_list (whitelist and blacklist)
 - Added Deprecation library

data/Gemfile

@@ -1,15 +1,4 @@
 source "http://rubygems.org"
 
-gem 'rails', '> 3'
-gem 'actionmailer', '> 3'
-
-group :development, :test do
-  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
+# Specify your gem's dependencies in mygem.gemspec
+gemspec

data/Gemfile.lock

@@ -1,31 +1,37 @@
+PATH
+  remote: .
+  specs:
+    sanitize_email (1.0.0.rc2)
+      facets (> 0)
+
 GEM
   remote: http://rubygems.org/
   specs:
-    actionmailer (3.2.6)
-      actionpack (= 3.2.6)
+    actionmailer (3.2.7)
+      actionpack (= 3.2.7)
       mail (~> 2.4.4)
-    actionpack (3.2.6)
-      activemodel (= 3.2.6)
-      activesupport (= 3.2.6)
+    actionpack (3.2.7)
+      activemodel (= 3.2.7)
+      activesupport (= 3.2.7)
       builder (~> 3.0.0)
       erubis (~> 2.7.0)
-      journey (~> 1.0.1)
+      journey (~> 1.0.4)
       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)
+    activemodel (3.2.7)
+      activesupport (= 3.2.7)
       builder (~> 3.0.0)
-    activerecord (3.2.6)
-      activemodel (= 3.2.6)
-      activesupport (= 3.2.6)
+    activerecord (3.2.7)
+      activemodel (= 3.2.7)
+      activesupport (= 3.2.7)
       arel (~> 3.0.2)
       tzinfo (~> 0.3.29)
-    activeresource (3.2.6)
-      activemodel (= 3.2.6)
-      activesupport (= 3.2.6)
-    activesupport (3.2.6)
+    activeresource (3.2.7)
+      activemodel (= 3.2.7)
+      activesupport (= 3.2.7)
+    activesupport (3.2.7)
       i18n (~> 0.6)
       multi_json (~> 1.0)
     addressable (2.2.8)
@@ -33,6 +39,7 @@ GEM
     builder (3.0.0)
     diff-lcs (1.1.3)
     erubis (2.7.0)
+    facets (2.9.3)
     git (1.2.5)
     hike (1.2.1)
     i18n (0.6.0)
@@ -61,17 +68,17 @@ GEM
       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)
+    rails (3.2.7)
+      actionmailer (= 3.2.7)
+      actionpack (= 3.2.7)
+      activerecord (= 3.2.7)
+      activeresource (= 3.2.7)
+      activesupport (= 3.2.7)
       bundler (~> 1.0)
-      railties (= 3.2.6)
-    railties (3.2.6)
-      actionpack (= 3.2.6)
-      activesupport (= 3.2.6)
+      railties (= 3.2.7)
+    railties (3.2.7)
+      actionpack (= 3.2.7)
+      activesupport (= 3.2.7)
       rack-ssl (~> 1.3.2)
       rake (>= 0.8.7)
       rdoc (~> 3.4)
@@ -106,7 +113,7 @@ GEM
       hike (~> 1.2)
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
-    thor (0.15.3)
+    thor (0.15.4)
     tilt (1.3.3)
     treetop (1.4.10)
       polyglot
@@ -127,3 +134,4 @@ DEPENDENCIES
   reek (>= 1.2.8)
   roodi (>= 2.1.0)
   rspec
+  sanitize_email!

data/{MIT-LICENSE → LICENSE}

@@ -1,4 +1,6 @@
-Copyright (c) 2008 Peter H. Boling of 9thBit LLC
+Copyright (c) 2008-2012 Peter H. Boling of 9thBit LLC
+
+MIT License
 
 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,10 +1,10 @@
-= sanitize_email
+= sanitize_email {<img src="https://codeclimate.com/badge.png" />}[https://codeclimate.com/github/pboling/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.
 
-It currently solves five (3!) common problems in ruby web applications that use ActionMailer:
+It currently solves five (3!) common problems in ruby web applications that use ActionMailer, or the Mail gem, or anything that follows Mailer's register_interceptor pattern:
 
 === Working Locally with Production Data
 
@@ -35,7 +35,7 @@ Customize and add to an initializer:
     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[:local_environment_proc] =   Proc.new { %w(development test).include?(Rails.env) }
     config[:use_actual_email_prepended_to_subject] = true   # or false
     config[:use_actual_email_as_sanitized_user_name] = true # or false
   end

data/Rakefile

@@ -1,30 +1,8 @@
 # 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
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
 require 'rake'
 
-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|

data/lib/sanitize_email.rb

@@ -1,7 +1,5 @@
 #Copyright (c) 2008-12 Peter H. Boling of 9thBit LLC
 #Released under the MIT license
-require 'rails'
-require 'action_mailer'
 
 module SanitizeEmail
   require 'sanitize_email/version'
@@ -10,14 +8,16 @@ module SanitizeEmail
   require 'sanitize_email/deprecation'
 
   # Allow non-rails implementations to use this gem
-  if @rails = defined?(Rails) && ::Rails::VERSION::MAJOR >= 3
+  if defined?(Rails) && ::Rails::VERSION::MAJOR >= 3
     if ::Rails::VERSION::MINOR >= 1
       require 'sanitize_email/engine'
     elsif ::Rails::VERSION::MINOR == 0
       require 'sanitize_email/railtie'
     end
-  elsif @rails = defined?(Rails)
+  elsif defined?(Rails)
     raise "Please use the 0.X.X versions of sanitize_email for Rails 2.X and below."
+  elsif defined?(Mailer) && Mailer.respond_to?(:register_interceptor)
+    Mailer.register_interceptor(SanitizeEmail::Bleach.new)
   end
 
   def self.[](key)

data/lib/sanitize_email/config.rb

@@ -1,6 +1,11 @@
+require 'facets/module/mattr' # gives cattr
+
 module SanitizeEmail
   class Config
-    cattr_accessor :config
+
+    cattr_reader :config
+    cattr_writer :config
+
     self.config ||= {
       # Adds the following class attributes to the classes that include NinthBit::SanitizeEmail
       :force_sanitize => nil,
@@ -31,7 +36,6 @@ module SanitizeEmail
 
       :local_environment_proc => Proc.new { true }
     }
-
     def self.configure &block
       yield self.config
 

data/lib/sanitize_email/engine.rb

@@ -5,7 +5,7 @@ module SanitizeEmail
   class Engine < ::Rails::Engine
 
     config.to_prepare do
-      ActionMailer::Base.register_interceptor(SanitizeEmail::Bleach)
+      ActionMailer::Base.register_interceptor(SanitizeEmail::Bleach.new)
     end
 
   end

data/lib/sanitize_email/railtie.rb

@@ -5,7 +5,7 @@ module SanitizeEmail
   class Railtie < ::Rails::Railtie
 
     config.before_configuration do
-      ActionMailer::Base.register_interceptor(SanitizeEmail::Bleach)
+      ActionMailer::Base.register_interceptor(SanitizeEmail::Bleach.new)
     end
 
   end

data/lib/sanitize_email/version.rb

@@ -1,5 +1,5 @@
 #Copyright (c) 2008-12 Peter H. Boling of 9thBit LLC
 #Released under the MIT license
 module SanitizeEmail
-  VERSION = '1.0.0.rc1'
+  VERSION = '1.0.0.rc3'
 end

data/sanitize_email.gemspec

@@ -1,53 +1,35 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+require File.expand_path('../lib/sanitize_email/version', __FILE__)
 
 Gem::Specification.new do |s|
   s.name = "sanitize_email"
-  s.version = "1.0.0.rc1"
+  s.version = SanitizeEmail::VERSION
 
   s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
   s.authors = ["Peter Boling", "John Trupiano", "George Anderson"]
-  s.date = "2012-08-04"
-  s.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."
+  s.date = "2012-08-08"
+  s.summary = "In Rails, Sinatra, or any framework using a Mail-like API: Test an application's email abilities without ever sending a message to actual live addresses"
+  s.description = "In Rails, Sinatra, or any framework using a Mail-like API: Aids in development, testing, qa, and production troubleshooting of email issues without worrying that emails will get sent to actual live addresses."
   s.email = ["peter.boling@gmail.com", "jtrupiano@gmail.com", "george@benevolentcode.com"]
   s.extra_rdoc_files = [
+    "LICENSE",
     "README.rdoc"
   ]
-  s.files = [
-    ".rspec",
-    "CHANGELOG",
-    "Gemfile",
-    "Gemfile.lock",
-    "MIT-LICENSE",
-    "README.rdoc",
-    "Rakefile",
-    "VERSION.yml",
-    "init.rb",
-    "lib/sanitize_email.rb",
-    "lib/sanitize_email/bleach.rb",
-    "lib/sanitize_email/config.rb",
-    "lib/sanitize_email/deprecation.rb",
-    "lib/sanitize_email/engine.rb",
-    "lib/sanitize_email/railtie.rb",
-    "lib/sanitize_email/version.rb",
-    "sanitize_email.gemspec",
-    "spec/sanitize_email_spec.rb",
-    "spec/spec_helper.rb"
-  ]
+  s.files         = `git ls-files`.split($\)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.homepage = "http://github.com/pboling/sanitize_email"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
   s.rubygems_version = "1.8.24"
-  s.summary = "Test an application's email abilities without ever sending a message to actual live addresses"
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<rails>, ["> 3"])
-      s.add_runtime_dependency(%q<actionmailer>, ["> 3"])
+      s.add_runtime_dependency(%q<facets>, ["> 0"]) # to replace the cattr_accessor method we lost when removing rails
+      s.add_development_dependency(%q<rails>, ["> 3"])
+      s.add_development_dependency(%q<actionmailer>, ["> 3"])
       s.add_development_dependency(%q<jeweler>, [">= 0"])
       s.add_development_dependency(%q<letter_opener>, [">= 0"])
       s.add_development_dependency(%q<launchy>, [">= 0"])
@@ -57,6 +39,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<reek>, [">= 1.2.8"])
       s.add_development_dependency(%q<roodi>, [">= 2.1.0"])
     else
+      s.add_dependency(%q<facets>, ["> 0"]) # to replace the cattr_accessor method we lost when removing rails
       s.add_dependency(%q<rails>, ["> 3"])
       s.add_dependency(%q<actionmailer>, ["> 3"])
       s.add_dependency(%q<jeweler>, [">= 0"])
@@ -69,6 +52,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<roodi>, [">= 2.1.0"])
     end
   else
+    s.add_dependency(%q<facets>, ["> 0"]) # to replace the cattr_accessor method we lost when removing rails
     s.add_dependency(%q<rails>, ["> 3"])
     s.add_dependency(%q<actionmailer>, ["> 3"])
     s.add_dependency(%q<jeweler>, [">= 0"])

data/spec/sanitize_email_spec.rb

@@ -25,18 +25,20 @@ describe SanitizeEmail do
     Mail.defaults do
       delivery_method LetterOpener::DeliveryMethod, :location => location
     end
+
     Rails.stub(:env).and_return(rails_env)
     @location = location
   end
 
   def configure_sanitize_email(sanitize_hash = {})
-    sanitize_hash.reverse_merge!({
+    defaults = {
       :sanitized_to =>  'to@sanitize_email.org',
       :sanitized_cc =>  'cc@sanitize_email.org',
       :sanitized_bcc => 'bcc@sanitize_email.org',
       :use_actual_email_prepended_to_subject => true,
       :use_actual_email_as_sanitized_user_name => true
-    })
+    }
+    sanitize_hash = defaults.merge(sanitize_hash)
     SanitizeEmail::Config.configure do |config|
       config[:sanitized_to] =         sanitize_hash[:sanitized_to]
       config[:sanitized_cc] =         sanitize_hash[:sanitized_cc]
@@ -50,9 +52,12 @@ describe SanitizeEmail do
     Mail.register_interceptor(SanitizeEmail::Bleach.new)
   end
 
-  def sanitized_mail_delivery(sanitization_switch = false)
+  def sanitized_mail_delivery(options = {})
+    unless options.has_key?(:force_sanitize)
+      options[:force_sanitize] = false
+    end
     # Ensure that localish? will return sanitization_switch if true or false, and use proc when nil
-    SanitizeEmail::Config.config[:force_sanitize] = sanitization_switch
+    SanitizeEmail::Config.config[:force_sanitize] = options[:force_sanitize]
     Launchy.should_receive(:open)
     @mail_message = Mail.deliver do
       from      'from@example.org'
@@ -75,7 +80,7 @@ describe SanitizeEmail do
 
     context "false" do
       it "alters nothing" do
-        sanitized_mail_delivery(false)
+        sanitized_mail_delivery(:force_sanitize => false)
         @email_file.should have_from("from@example.org")
         @email_file.should have_to("to@example.org")
         @mail_message.header.fields[3].value.should_not have_to("to at example.org")
@@ -87,7 +92,7 @@ describe SanitizeEmail do
 
     context "true" do
       it "should override" do
-        sanitized_mail_delivery(true)
+        sanitized_mail_delivery(:force_sanitize => true)
         @email_file.should have_from("from@example.org")
         #puts "@mail_message.header.fields[3]: #{@mail_message.header.fields[3]}"
         #@mail_message.header.fields[3].value.should have_to("to at example.org")
@@ -104,7 +109,7 @@ describe SanitizeEmail do
         sanitize_spec_dryer('test')
         configure_sanitize_email({:local_environments => ['test']})
         SanitizeEmail[:local_environment_proc].call.should == true
-        sanitized_mail_delivery(nil)
+        sanitized_mail_delivery(:force_sanitize => nil)
         @email_file.should have_to("to@sanitize_email.org")
         @email_file.should have_subject("(to at example.org) original subject")
       end
@@ -112,7 +117,7 @@ describe SanitizeEmail do
         sanitize_spec_dryer('production')
         configure_sanitize_email({:local_environments => ['development']}) # Won't match!
         SanitizeEmail[:local_environment_proc].call.should == false
-        sanitized_mail_delivery(nil)
+        sanitized_mail_delivery(:force_sanitize => nil)
         @mail_message.should_not have_subject("to at example.org")
       end
     end
@@ -123,7 +128,7 @@ describe SanitizeEmail do
         configure_sanitize_email({:sanitized_recipients => 'barney@sanitize_email.org'})
       end
       it "used as sanitized_to" do
-        sanitized_mail_delivery(true)
+        sanitized_mail_delivery(:force_sanitize => true)
         @email_file.should have_from("from@example.org")
         @mail_message.should have_to("to@sanitize_email.org")
         @email_file.should have_subject("(to at example.org) original subject")

data/spec/spec_helper.rb

@@ -17,7 +17,18 @@ module EmailMatcherHelpers
   # Sweet, nourishing recursion
   def email_matching(matcher, part, mail_or_part)
     if mail_or_part.respond_to?(part)
-      email_matching(matcher, part, mail_or_part.send(part))
+      # within rspec objects sometimes respond_to all sorts of odd methods they don't really have,
+      # raising an argument error when called
+      # Need to write a failing spec for rspec I think to figure out where this is stemming from
+      begin
+        email_matching(matcher, part, mail_or_part.send(part))
+      rescue ArgumentError
+        if mail_or_part.respond_to?(:=~)
+          mail_or_part =~ Regexp.new(Regexp.escape(matcher))
+        else
+          raise UnexpectedMailType, "Cannot match #{matcher} for #{part}"
+        end
+      end
     elsif mail_or_part.respond_to?(:join)
       email_matching(matcher, part, mail_or_part.join(', '))
     elsif mail_or_part.respond_to?(:=~) # Can we match a regex against it?
@@ -32,6 +43,7 @@ end
 RSpec::Matchers.define :have_from do |from|
   include EmailMatcherHelpers
   match do |container|
+    #puts "container: #{container}"
     email_matching(from, :from, container)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sanitize_email
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc1
+  version: 1.0.0.rc3
   prerelease: 6
 platform: ruby
 authors:
@@ -11,8 +11,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-04 00:00:00.000000000 Z
+date: 2012-08-08 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: facets
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -21,7 +37,7 @@ dependencies:
     - - ! '>'
       - !ruby/object:Gem::Version
         version: '3'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -37,7 +53,7 @@ dependencies:
     - - ! '>'
       - !ruby/object:Gem::Version
         version: '3'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -173,8 +189,9 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.1.0
-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.
+description: ! 'In Rails, Sinatra, or any framework using a Mail-like API: Aids in
+  development, testing, qa, and production troubleshooting of email issues without
+  worrying that emails will get sent to actual live addresses.'
 email:
 - peter.boling@gmail.com
 - jtrupiano@gmail.com
@@ -182,16 +199,18 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files:
+- LICENSE
 - README.rdoc
 files:
+- .gitignore
 - .rspec
+- .travis.yml
 - CHANGELOG
 - Gemfile
 - Gemfile.lock
-- MIT-LICENSE
+- LICENSE
 - README.rdoc
 - Rakefile
-- VERSION.yml
 - init.rb
 - lib/sanitize_email.rb
 - lib/sanitize_email/bleach.rb
@@ -216,9 +235,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2863798588423167662
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -230,6 +246,8 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Test an application's email abilities without ever sending a message to actual
-  live addresses
-test_files: []
+summary: ! 'In Rails, Sinatra, or any framework using a Mail-like API: Test an application''s
+  email abilities without ever sending a message to actual live addresses'
+test_files:
+- spec/sanitize_email_spec.rb
+- spec/spec_helper.rb

data/VERSION.yml

@@ -1,5 +0,0 @@
----
-:major: 1
-:minor: 0
-:patch: 0
-:build: rc1