sanitize_email 0.3.9 → 1.0.0.alpha2

data/lib/sanitize_email/config.rb

@@ -0,0 +1,34 @@
+module SanitizeEmail
+  class Config
+    cattr_accessor :config
+    self.config ||= {
+      # Adds the following class attributes to the classes that include NinthBit::SanitizeEmail
+      :force_sanitize => nil,
+
+      # Specify the BCC addresses for the messages that go out in 'local' environments
+      :sanitized_bcc => nil,
+
+      # Specify the CC addresses for the messages that go out in 'local' environments
+      :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
+      :sanitized_recipients => nil,
+
+      # Use the 'real' email address as the username for the sanitized email address
+      # e.g. "real@example.com <sanitized@example.com>"
+      :use_actual_email_as_sanitized_user_name => false,
+
+      # Prepend the 'real' email address onto the Subject line of the message
+      # e.g. "real@example.com rest of subject"
+      :use_actual_email_prepended_to_subject => false,
+
+      :local_environments => %w( development test )
+    }
+
+    def self.configure &block
+      yield self.config
+    end
+
+  end
+end

data/lib/sanitize_email/engine.rb

@@ -0,0 +1,12 @@
+#Copyright (c) 2008-12 Peter H. Boling of 9thBit LLC
+#Released under the MIT license
+# For Rails >= 3.1
+module SanitizeEmail
+  class Engine < ::Rails::Engine
+
+    config.to_prepare do
+      ActionMailer::Base.register_interceptor(SanitizeEmail::Hook)
+    end
+
+  end
+end

data/lib/sanitize_email/hook.rb

@@ -0,0 +1,30 @@
+#Copyright (c) 2008-12 Peter H. Boling of 9thBit LLC
+#Released under the MIT license
+
+module SanitizeEmail
+  class Hook
+
+    include SanitizeEmail::Sanitizer
+
+    def self.delivering_email(message)
+      if self.localish?
+        message.subject = self.subject_override(message.subject, message.to)
+        message.to = self.recipients_override(message.to)
+        message.cc = self.cc_override(message.cc)
+        message.bcc = self.bcc_override(message.bcc)
+      end
+    end
+
+    def self.consider_local?
+      SanitizeEmail.local_environments.include?(Rails.env) if defined?(Rails)
+    end
+
+    # This method will be called by the Hook to determine if an override should occur
+    def self.localish?
+      !SanitizeEmail.force_sanitize.nil? ? SanitizeEmail.force_sanitize : self.consider_local?
+    end
+
+  end # end Class Hook
+end # end Module SanitizeEmail
+
+

data/lib/sanitize_email/railtie.rb

@@ -0,0 +1,12 @@
+#Copyright (c) 2008-12 Peter H. Boling of 9thBit LLC
+#Released under the MIT license
+# For Rails 3.0, which didn't yet support Engines'
+module SanitizeEmail
+  class Railtie < ::Rails::Railtie
+
+    config.before_configuration do
+      ActionMailer::Base.register_interceptor(SanitizeEmail::Hook)
+    end
+
+  end
+end

data/lib/sanitize_email/sanitizer.rb

@@ -0,0 +1,73 @@
+#Copyright (c) 2008-12 Peter H. Boling of 9thBit LLC
+#Released under the MIT license
+module SanitizeEmail
+  module Sanitizer
+    def self.included(base)
+      base.extend SanitizeEmail::Sanitizer::ClassMethods
+    end
+
+    module ClassMethods
+
+      def subject_override(real_subject, actual_addresses)
+        if actual_addresses.nil? || !SanitizeEmail.use_actual_email_prepended_to_subject
+          real_subject
+        else
+          "(#{actual_addresses.join(',').gsub(/@/,' at ').gsub(/[<>]/,'~')}) #{real_subject}"
+        end
+      end
+
+      def recipients_override(actual_addresses)
+        override_email(:recipients, actual_addresses)
+      end
+
+      def cc_override(actual_addresses)
+        override_email(:cc, actual_addresses)
+      end
+
+      def bcc_override(actual_addresses)
+        override_email(:bcc, actual_addresses)
+      end
+
+      #######
+      private
+      #######
+
+      def override_email(type, actual_addresses)
+        real_addresses, sanitized_addresses = case type
+          when :recipients
+            [actual_addresses, SanitizeEmail.sanitized_recipients]
+          when :cc
+            [actual_addresses, SanitizeEmail.sanitized_cc]
+          when :bcc
+            [actual_addresses, SanitizeEmail.sanitized_bcc]
+          else raise "sanitize_email error: unknown email override"
+        end
+        # Normalize to an array
+        real_addresses = [real_addresses] unless real_addresses.is_a?(Array)
+        # Normalize to an array
+        sanitized_addresses = [sanitized_addresses] unless sanitized_addresses.is_a?(Array)
+
+        # If there were no original recipients, then we DO NOT override the nil with the sanitized recipients
+        return nil if real_addresses.blank?
+        # If there are no sanitized addresses we can't override!
+        return nil if sanitized_addresses.blank?
+        # If we don't want to inject the actual email in the 'user name' section of the sanitized recipients,
+        # then just return the default sanitized recipients
+        return sanitized_addresses unless SanitizeEmail.use_actual_email_as_sanitized_user_name
+
+        out = real_addresses.inject([]) do |result, real_recipient|
+          if real_recipient.nil?
+            new_recipient = sanitized_addresses
+          else
+            new_recipient = sanitized_addresses.map{|sanitized| "#{real_recipient.gsub(/@/,' at ').gsub(/[<>]/,'~')} <#{sanitized}>"}
+          end
+          result << new_recipient
+          result
+        end.flatten
+        return out
+      end
+
+    end
+
+  end
+end

data/lib/sanitize_email/version.rb

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

data/sanitize_email.gemspec

@@ -1,26 +1,85 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'sanitize_email/version'
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
 
-Gem::Specification.new do |spec|
-  spec.name          = "sanitize_email"
-  spec.version       = SanitizeEmail::VERSION
-  spec.authors       = ["Peter Boling", "John Trupiano", "George Anderson"]
-  spec.email         = ["peter.boling@gmail.com", "jtrupiano@gmail.com", "george@benevolentcode.com"]
-  spec.summary       = %q{Test an application's email abilities without ever sending a message to actual live addresses}
-  spec.description   = %q{Test an application's email abilities without ever sending a message to actual live addresses}
-  spec.homepage      = "http://github.com/pboling/sanitize_email"
-  spec.license       = "MIT"
-  spec.rdoc_options = ["--charset=UTF-8"]
+Gem::Specification.new do |s|
+  s.name = "sanitize_email"
+  s.version = "1.0.0.alpha2"
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  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-07-28"
+  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.email = ["peter.boling@gmail.com", "jtrupiano@gmail.com", "george@benevolentcode.com"]
+  s.extra_rdoc_files = [
+    "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/config.rb",
+    "lib/sanitize_email/engine.rb",
+    "lib/sanitize_email/hook.rb",
+    "lib/sanitize_email/railtie.rb",
+    "lib/sanitize_email/sanitizer.rb",
+    "lib/sanitize_email/version.rb",
+    "sanitize_email.gemspec",
+    "spec/sanitize_email_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/tmp/mail_dump/1343461037_3f3edd7/plain.html"
+  ]
+  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"
 
-  spec.add_runtime_dependency(%q<actionmailer>, [">= 0",'<= 3.1'])
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
 
-  spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake"
+    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_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<letter_opener>, [">= 0"])
+      s.add_development_dependency(%q<launchy>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<mail>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 3.12"])
+      s.add_development_dependency(%q<reek>, [">= 1.2.8"])
+      s.add_development_dependency(%q<roodi>, [">= 2.1.0"])
+    else
+      s.add_dependency(%q<rails>, ["> 3"])
+      s.add_dependency(%q<actionmailer>, ["> 3"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<letter_opener>, [">= 0"])
+      s.add_dependency(%q<launchy>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<mail>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 3.12"])
+      s.add_dependency(%q<reek>, [">= 1.2.8"])
+      s.add_dependency(%q<roodi>, [">= 2.1.0"])
+    end
+  else
+    s.add_dependency(%q<rails>, ["> 3"])
+    s.add_dependency(%q<actionmailer>, ["> 3"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<letter_opener>, [">= 0"])
+    s.add_dependency(%q<launchy>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<mail>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 3.12"])
+    s.add_dependency(%q<reek>, [">= 1.2.8"])
+    s.add_dependency(%q<roodi>, [">= 2.1.0"])
+  end
 end
+

data/spec/sanitize_email_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe SanitizeEmail do
+
+  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] =   []
+    config[:use_actual_email_prepended_to_subject] = true
+    config[:use_actual_email_as_sanitized_user_name] = true
+  end
+
+  def sanitize_mail_delivery(sanitization_switch = false)
+    # Ensure that localish? will returns sanitization_switch
+    SanitizeEmail::Config.config[:force_sanitize] = sanitization_switch
+    Launchy.should_receive(:open)
+    mail = Mail.deliver do
+      from      'from@example.org'
+      to        'to@example.org'
+      cc        'cc@example.org'
+      reply_to  'reply_to@example.org'
+      subject   'original subject'
+    end
+  end
+
+  before(:each) do
+    Launchy.stub(:open)
+    location = File.expand_path('../tmp/mail_dump', __FILE__)
+    FileUtils.rm_rf(location)
+    Mail.defaults do
+      delivery_method LetterOpener::DeliveryMethod, :location => location
+    end
+    Mail.register_interceptor(SanitizeEmail::Hook)
+    @location = location
+  end
+
+  context "localish? is false" do
+    it "alters nothing" do
+      sanitize_mail_delivery(false)
+      # All the email gets dumped to file once for each type of recipient (:to, :cc, :bcc)
+      # Each file is identical, so we only need to check one of them:
+      email = File.read(Dir["#{@location}/*/plain.html"].first)
+      email.should have_from("from@example.org")
+      email.should have_to("to@example.org")
+      # Letter Opener won't let us test the cc
+      #email.should have_cc("cc@example.org")
+      # Letter Opener won't let us test the bcc
+      #email.should have_bcc("cc@example.org")
+      email.should have_subject("original subject")
+    end
+  end
+
+  context "localish? is true" do
+    it "should override" do
+      sanitize_mail_delivery(true)
+      # All the email gets dumped to file once for each type of recipient (:to, :cc, :bcc)
+      # Each file is identical, so we only need to check one of them:
+      email = File.read(Dir["#{@location}/*/plain.html"].first)
+      email.should have_from("from@example.org")
+      # Letter Opener won't let us test the to when the to has a 'user name'
+      #email.should have_to("~to at example.org~ <to@sanitize_email.org>")
+      # Letter Opener won't let us test the bcc
+      #email.should have_cc("cc@sanitize_email.org")
+      email.should have_subject("(to at example.org) original subject")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,40 @@
+require 'sanitize_email'
+require 'launchy'
+require 'mail'
+require 'rails'
+require 'letter_opener'
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  #config.filter_run :focus
+end
+
+RSpec::Matchers.define :have_from do |from|
+  match do |container|
+    container =~ Regexp.new(Regexp.escape(from))
+  end
+end
+RSpec::Matchers.define :have_to do |to|
+  match do |container|
+    container =~ Regexp.new(Regexp.escape(to))
+  end
+end
+RSpec::Matchers.define :have_cc do |cc|
+  match do |container|
+    container =~ Regexp.new(Regexp.escape(cc))
+  end
+end
+# The ActionMailer :file delivery method never prints bcc recipients...
+#   so not testable as such, but with letter_opener we can work magic
+RSpec::Matchers.define :have_bcc do |bcc|
+  match do |container|
+    container =~ Regexp.new(Regexp.escape(bcc))
+  end
+end
+RSpec::Matchers.define :have_subject do |subject|
+  match do |container|
+    container =~ Regexp.new(Regexp.escape(subject))
+  end
+end

data/spec/tmp/mail_dump/1343461037_3f3edd7/plain.html

@@ -0,0 +1,76 @@
+<style type="text/css">
+  #message_headers {
+    position: absolute;
+    top: 0px;
+    left: 0;
+    width: 100%;
+    height: 85px;
+    padding: 10px 0 0 0;
+    margin: 0;
+    background: #fff;
+    font-size: 12px;
+    font-family: "Lucida Grande";
+    border-bottom: 1px solid #dedede;
+    overflow: hidden;
+  }
+
+  #message_headers dl {
+    margin: 0;
+    padding: 0;
+  }
+
+  #message_headers dt {
+    width: 60px;
+    padding: 1px;
+    float: left;
+    text-align: right;
+    font-weight: bold;
+    color: #7f7f7f;
+  }
+
+  #message_headers dd {
+    margin-left: 70px;
+    padding: 1px;
+  }
+
+  #message_headers p.alternate {
+    position: absolute;
+    top: 0;
+    right: 15px;
+  }
+
+  #message_headers p.alternate a {
+    color: #09c;
+  }
+
+  pre#message_body {
+    padding: 10px;
+    word-wrap: break-word;
+  }
+
+  body {
+    margin-top: 96px;
+  }
+</style>
+
+<div id="message_headers">
+  <dl>
+    <dt>From:</dt>
+    <dd>from@example.org</dd>
+
+    <dt>Subject:</dt>
+    <dd><strong>(to at example.org) original subject</strong></dd>
+
+    <dt>Date:</dt>
+    <dd>Jul 28, 2012 03:37:17 AM EDT</dd>
+
+    <dt>To:</dt>
+    <dd>to@sanitize_email.org</dd>
+  </dl>
+
+  
+</div>
+
+
+  <pre id="message_body"></pre>
+