sanitize_email 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f2dcec848cb80945d5c1e1401891002dc28fb62
-  data.tar.gz: b1b05a2965281e341720c78ceac9b66e10cdbf71
+  metadata.gz: 289e6af15ea68e8b10617cc2803055254cca058a
+  data.tar.gz: 4404c4335975e05532e2ada1a12f447687aef097
 SHA512:
-  metadata.gz: 0755c678a8004229ee7f5368798bfe5f33c5ab55170a99b4b8ebb65d2132b8d99bade1ab6e448df6b556c3eca9582e93a667c5ada1799b0bb1b03030677b266d
-  data.tar.gz: ad9ae2126562b3beec645ca2cc2bb48d233cf5cbd1013162c60c509ebfe0c3dcf685a009954db92b259593a0a754c2f4d6f3ff322be666fc3d75e2c4a75e2e5d
+  metadata.gz: 2c38011a2de7fb6317130462b6ab153b041e46eee7fc2eab19250899dd260ab49b4d962d648cfa529d5df24f003632098bbfd5078956c5b496c1b0f778990c49
+  data.tar.gz: 15a4766d74108c6ab0e076a328fe0a359972b550281038d260ad87488e5d2f56e1dc5f1e9cd027ffeb10a88a926f535c10df84940fa8b1e3042d6b60fed9b8ca

data/.ruby-version

@@ -1 +1 @@
-ruby-2.2.3
+ruby-2.3.1

data/.travis.yml

@@ -2,26 +2,67 @@ language: ruby
 cache: bundler
 sudo: false
 rvm:
+#  - 1.9
   - 2.0
   - 2.1
   - 2.2
-  - ruby-head
+  - 2.3.1
+#  - ruby-head
 gemfile:
-  - gemfiles/Gemfile.rails-3.2.x
-  - gemfiles/Gemfile.rails-4.0.x
-  - gemfiles/Gemfile.rails-4.1.x
-  - gemfiles/Gemfile.rails-4.2.x
+  - gemfiles/rails_3_0.gemfile
+  - gemfiles/rails_3_1.gemfile
+  - gemfiles/rails_3_2.gemfile
+  - gemfiles/rails_4_0.gemfile
+  - gemfiles/rails_4_1.gemfile
+  - gemfiles/rails_4_2.gemfile
+  - gemfiles/rails_5_0.gemfile
 matrix:
   allow_failures:
-    - rvm: ruby-head
-    - rvm: 1.9
+#    - rvm: ruby-head
+#    - rvm: 1.9
   exclude:
-    - rvm: 2.0
-      gemfile: gemfiles/Gemfile.rails-4.2.x
-    - rvm: 2.1
-      gemfile: gemfiles/Gemfile.rails-4.2.x
-  include:
     - rvm: 1.9
-      gemfile: gemfiles/Gemfile.rails-3.0.x
+      gemfile: gemfiles/rails_3_2.gemfile
+    - rvm: 1.9
+      gemfile: gemfiles/rails_4_0.gemfile
     - rvm: 1.9
-      gemfile: gemfiles/Gemfile.rails-3.1.x
+      gemfile: gemfiles/rails_4_1.gemfile
+    - rvm: 1.9
+      gemfile: gemfiles/rails_4_2.gemfile
+    - rvm: 1.9
+      gemfile: gemfiles/rails_5_0.gemfile
+    - rvm: 2.0
+      gemfile: gemfiles/rails_3_0.gemfile
+    - rvm: 2.0
+      gemfile: gemfiles/rails_3_1.gemfile
+    - rvm: 2.0
+      gemfile: gemfiles/rails_4_2.gemfile
+    - rvm: 2.0
+      gemfile: gemfiles/rails_5_0.gemfile
+    - rvm: 2.1
+      gemfile: gemfiles/rails_3_0.gemfile
+    - rvm: 2.1
+      gemfile: gemfiles/rails_3_1.gemfile
+    - rvm: 2.1
+      gemfile: gemfiles/rails_4_2.gemfile
+    - rvm: 2.1
+      gemfile: gemfiles/rails_5_0.gemfile
+    - rvm: 2.2
+      gemfile: gemfiles/rails_3_0.gemfile
+    - rvm: 2.2
+      gemfile: gemfiles/rails_3_1.gemfile
+    - rvm: 2.2
+      gemfile: gemfiles/rails_5_0.gemfile
+    - rvm: 2.3.1
+      gemfile: gemfiles/rails_3_0.gemfile
+    - rvm: 2.3.1
+      gemfile: gemfiles/rails_3_1.gemfile
+#    - rvm: ruby-head
+#      gemfile: gemfiles/rails_5_0.gemfile
+#  include:
+#    - rvm: 1.9
+#      gemfile: gemfiles/rails_3_0.gemfile
+#    - rvm: 1.9
+#      gemfile: gemfiles/rails_3_1.gemfile
+install:
+  - bundle install

data/Appraisals

@@ -0,0 +1,55 @@
+appraise "rails-3-0" do
+    gem "rails", "~> 3.0.0"
+    gem "reek", "~> 2.0" # for Ruby < 2.0
+    gem "tins", "~> 1.6.0" # for Ruby < 2.0
+    gem "json", "~> 1.8.3"
+    gem "rake", "~> 11.2.2"
+    gem "rest-client", "~> 1.8.0"
+end
+appraise "rails-3-1" do
+    gem "actionmailer", "~> 3.1.0"
+    gem "railties", "~> 3.1.0"
+    gem "reek", "~> 2.0" # for Ruby < 2.0
+    gem "tins", "~> 1.6.0" # for Ruby < 2.0
+    gem "json", "~> 1.8.3"
+    gem "rake", "~> 11.2.2"
+    gem "rest-client", "~> 1.8.0"
+end
+appraise "rails-3-2" do
+    gem "actionmailer", "~> 3.2.0"
+    gem "railties", "~> 3.2.0"
+    # reek >= 4.0 requires Ruby 2.1 minimum
+    gem "reek", "~>3.11.0"
+    gem "json", "~> 1.8.3"
+    gem "rake", "~> 11.2.2"
+end
+
+appraise "rails-4-0" do
+    gem "actionmailer", "~> 4.0.0"
+    gem "railties", "~> 4.0.0"
+    # reek >= 4.0 requires Ruby 2.1 minimum
+    gem "reek", "~>3.11.0"
+    gem "json", "~> 1.8.3"
+    gem "rake", "~> 11.2.2"
+end
+appraise "rails-4-1" do
+    gem "actionmailer", "~> 4.1.0"
+    gem "railties", "~> 4.1.0"
+    # reek >= 4.0 requires Ruby 2.1 minimum
+    gem "reek", "~>3.11.0"
+    gem "json", "~> 1.8.3"
+    gem "rake", "~> 11.2.2"
+end
+appraise "rails-4-2" do
+    gem "actionmailer", "~> 4.2.0"
+    gem "railties", "~> 4.2.0"
+    gem "json", "~> 1.8.3"
+    gem "rake", "~> 11.2.2"
+end
+
+appraise "rails-5-0" do
+    gem "actionmailer", "~> 5.0.0"
+    gem "railties", "~> 5.0.0"
+    gem "json", "~> 2.0.2"
+    gem "rake", "~> 11.2.2"
+end

data/CHANGELOG.md

@@ -1,6 +1,6 @@
 HEAD
 
-Version 1.2.0- JUL.24.2016
+Version 1.2.0 - JUL.24.2016
 * No longer registers instance of SanitizeEmail::Bleach to avoid the dev env reloading problem (fixes #12)
 * Instead registers SanitizeEmail::Bleach class.
 * Deprecate sending arguments to SanitizeEmail::Bleach.new

data/README.md

@@ -17,7 +17,7 @@ This gem allows you to override your mail delivery settings, globally or in a lo
 | homepage                |  [http://www.railsbling.com/tags/sanitize_email/][homepage] |
 | documentation           |  [http://rdoc.info/github/pboling/sanitize_email/frames][documentation] |
 | live chat               |  [![Join the chat at https://gitter.im/pboling/sanitize_email](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/pboling/sanitize_email?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |
-| Spread ~♡ⓛⓞⓥⓔ♡~      |  [on Coderbits](https://coderbits.com/pboling), [on Coderwall](http://coderwall.com/pboling) |
+| Spread ~♡ⓛⓞⓥⓔ♡~      |  [AngeList](https://angel.co/peter-boling), [on Coderwall](http://coderwall.com/pboling), [on TopCoder](https://www.topcoder.com/members/pboling/) |
 
 ## Summary
 
@@ -338,6 +338,25 @@ Follow the instructions for "Contributing" below.
 5. Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 6. Create new Pull Request
 
+## Running Specs
+
+The basic compatibility matrix:
+```
+appraisal install
+appraisal rake test
+```
+
+Run the whole travis compatibility matrix:
+```
+rake wwtd:bundle
+rake wwtd
+```
+
+Sometimes also:
+```
+appraisal update
+```
+
 ## Versioning
 
 This library aims to adhere to [Semantic Versioning 2.0.0][semver].
@@ -353,7 +372,7 @@ dependency on this gem using the [Pessimistic Version Constraint][pvc] with two
 For example:
 
 ```ruby
-spec.add_dependency 'sanitize_email', '~> 1.1'
+spec.add_dependency 'sanitize_email', '~> 1.3'
 ```
 
 ## References

data/Rakefile

@@ -1,13 +1,18 @@
 # encoding: utf-8
 #!/usr/bin/env rake
+require "rubygems"
+require "bundler/setup"
 require "bundler/gem_tasks"
 require "rake"
 
 begin
+  require "wwtd/tasks"
   require "rspec/core/rake_task"
   RSpec::Core::RakeTask.new(:spec)
   task :default => :spec
+  task :test => :spec
 rescue LoadError
+  warn "Failed to load rspec or wwtd"
 end
 
 require "reek/rake/task"
@@ -23,44 +28,6 @@ RoodiTask.new do |t|
   t.verbose = false
 end
 
-namespace :test do
-  desc "Test against all supported Rails versions"
-  task :all do
-    %w(3.0.x 3.1.x 3.2.x 4.0.x).each do |version|
-      system(<<-EOS
-          bash -i -c "rvm use 1.9.3"
-          BUNDLE_GEMFILE="gemfiles/Gemfile.rails-#{version}" bundle --quiet
-          BUNDLE_GEMFILE="gemfiles/Gemfile.rails-#{version}" bundle exec rspec spec
-      EOS
-      )
-    end
-    %w(3.2.x 4.0.x 4.1.x).each do |version|
-      system(<<-EOS
-          bash -i -c "rvm use 2.0.0"
-          BUNDLE_GEMFILE="gemfiles/Gemfile.rails-#{version}" bundle --quiet
-          BUNDLE_GEMFILE="gemfiles/Gemfile.rails-#{version}" bundle exec rspec spec
-        EOS
-      )
-    end
-    %w(3.2.x 4.0.x 4.1.x).each do |version|
-      system(<<-EOS
-          bash -i -c "rvm use 2.1.7"
-          BUNDLE_GEMFILE="gemfiles/Gemfile.rails-#{version}" bundle --quiet
-          BUNDLE_GEMFILE="gemfiles/Gemfile.rails-#{version}" bundle exec rspec spec
-      EOS
-      )
-    end
-    %w(3.2.x 4.0.x 4.1.x 4.2.x).each do |version|
-      system(<<-EOS
-          bash -i -c "rvm use 2.2.3"
-          BUNDLE_GEMFILE="gemfiles/Gemfile.rails-#{version}" bundle --quiet
-          BUNDLE_GEMFILE="gemfiles/Gemfile.rails-#{version}" bundle exec rspec spec
-      EOS
-      )
-    end
-  end
-end
-
 require File.expand_path("../lib/sanitize_email/version", __FILE__)
 require "rdoc"
 require "rdoc/task"

data/gemfiles/rails_3_0.gemfile

@@ -0,0 +1,12 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rails", "~> 3.0.0"
+gem "reek", "~> 2.0"
+gem "tins", "~> 1.6.0"
+gem "json", "~> 1.8.3"
+gem "rake", "~> 11.2.2"
+gem "rest-client", "~> 1.8.0"
+
+gemspec :path => "../"

data/gemfiles/rails_3_1.gemfile

@@ -0,0 +1,13 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "actionmailer", "~> 3.1.0"
+gem "railties", "~> 3.1.0"
+gem "reek", "~> 2.0"
+gem "tins", "~> 1.6.0"
+gem "json", "~> 1.8.3"
+gem "rake", "~> 11.2.2"
+gem "rest-client", "~> 1.8.0"
+
+gemspec :path => "../"

data/gemfiles/rails_3_2.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "actionmailer", "~> 3.2.0"
+gem "railties", "~> 3.2.0"
+gem "reek", "~>3.11.0"
+gem "json", "~> 1.8.3"
+gem "rake", "~> 11.2.2"
+
+gemspec :path => "../"

data/gemfiles/rails_4_0.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "actionmailer", "~> 4.0.0"
+gem "railties", "~> 4.0.0"
+gem "reek", "~>3.11.0"
+gem "json", "~> 1.8.3"
+gem "rake", "~> 11.2.2"
+
+gemspec :path => "../"

data/gemfiles/rails_4_1.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "actionmailer", "~> 4.1.0"
+gem "railties", "~> 4.1.0"
+gem "reek", "~>3.11.0"
+gem "json", "~> 1.8.3"
+gem "rake", "~> 11.2.2"
+
+gemspec :path => "../"

data/gemfiles/rails_4_2.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "actionmailer", "~> 4.2.0"
+gem "railties", "~> 4.2.0"
+gem "json", "~> 1.8.3"
+gem "rake", "~> 11.2.2"
+
+gemspec :path => "../"

data/gemfiles/rails_5_0.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "actionmailer", "~> 5.0.0"
+gem "railties", "~> 5.0.0"
+gem "json", "~> 2.0.2"
+gem "rake", "~> 11.2.2"
+
+gemspec :path => "../"

data/init.rb

@@ -1,2 +1,2 @@
-require 'sanitize_email'
+require "sanitize_email"
 

data/lib/sanitize_email/config.rb

@@ -3,7 +3,7 @@
 
 module SanitizeEmail
   # The API for configuring SanitizeEmail is via `SanitizeEmail.config`
-  # Available configuration options are listed in the `DEFAULTS`` constant.
+  # Available configuration options are listed in the `DEFAULTS` constant.
   class Config
 
     extend SanitizeEmail::Deprecation
@@ -13,14 +13,18 @@ module SanitizeEmail
     end
 
     DEFAULTS = {
-      # Specify the BCC addresses for the messages that go out in 'local' environments
+      # 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
+      # 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
+      # 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_to => nil,
 
       # a white list
@@ -29,13 +33,18 @@ module SanitizeEmail
       # a black list
       :bad_list => nil,
 
-      :environment => defined?(Rails) && Rails.env.present? ? ('[' << Rails.env << ']') : '[UNKNOWN ENVIRONMENT]',
+      :environment => if defined?(Rails) && Rails.env.present?
+                        ("[" << Rails.env << "]")
+                      else
+                        "[UNKNOWN ENVIRONMENT]"
+                      end,
 
-      # Use the 'real' email address as the username for the sanitized email address
+      # 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
+      # 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,
 
@@ -43,6 +52,10 @@ module SanitizeEmail
       # e.g. "[development] rest of subject"
       :use_actual_environment_prepended_to_subject => false,
 
+      # True / False turns on or off sanitization,
+      #   while nil ignores this setting and checks activation_proc
+      :engage => nil,
+
       :activation_proc => Proc.new { false }
     }
 
@@ -51,14 +64,18 @@ module SanitizeEmail
       yield @config
 
       # Gracefully handle deprecated config values.
-      # Actual deprecation warnings are thrown in the top SanitizeEmail module thanks to our use of dynamic methods.
+      # Actual deprecation warnings are thrown in the top SanitizeEmail module
+      #   thanks to our use of dynamic methods.
       if @config[:local_environments] && defined?(Rails)
-        @config[:activation_proc] = Proc.new { SanitizeEmail.local_environments.include?(Rails.env) }
+        @config[:activation_proc] = Proc.new {
+          SanitizeEmail.local_environments.include?(Rails.env)
+        }
       end
       if @config[:sanitized_recipients]
-        SanitizeEmail.sanitized_recipients # calling it to trigger the deprecation warning.
-                                           #Won't actually be set with any value,
-                                           # because we are still inside the configure block.
+        # calling it to trigger the deprecation warning.
+        # Won't actually be set with any value,
+        # because we are still inside the configure block.
+        SanitizeEmail.sanitized_recipients
         @config[:sanitized_to] = @config[:sanitized_recipients]
       end
       if !@config[:force_sanitize].nil?

data/lib/sanitize_email/mail_header_tools.rb

@@ -7,9 +7,16 @@ module SanitizeEmail
 
     def self.prepend_subject_array(message)
       prepend = []
-      prepend << SanitizeEmail::MailHeaderTools.prepend_email_to_subject(Array(message.to)) if SanitizeEmail.use_actual_email_prepended_to_subject
-      prepend << SanitizeEmail::MailHeaderTools.prepend_environment_to_subject if SanitizeEmail.use_actual_environment_prepended_to_subject
-      prepend << "" unless prepend.empty? # this will force later joins to add an extra space
+      if SanitizeEmail.use_actual_email_prepended_to_subject
+        prepend << SanitizeEmail::MailHeaderTools.
+          prepend_email_to_subject(Array(message.to))
+      end
+      if SanitizeEmail.use_actual_environment_prepended_to_subject
+        prepend << SanitizeEmail::MailHeaderTools.
+          prepend_environment_to_subject
+      end
+      # this will force later joins to add an extra space
+      prepend << "" unless prepend.empty?
       prepend
     end
 
@@ -22,27 +29,39 @@ module SanitizeEmail
     end
 
     def self.prepend_email_to_subject(actual_addresses)
-      "(#{actual_addresses.uniq.join(',').gsub(/@/, ' at ').gsub(/[<>]/, '~')})" if actual_addresses.respond_to?(:join)
+      "(#{Array(actual_addresses).uniq.join(',').gsub(/@/, ' at ').
+        gsub(/[<>]/, '~')})"
     end
 
     def self.add_original_addresses_as_headers(message)
-      ## Add headers by string concat. Setting hash values on message.headers does nothing, strangely. http://goo.gl/v46GY
+      # Add headers by string concat.
+      # Setting hash values on message.headers does nothing, strangely.
+      # See: http://goo.gl/v46GY
       {
-        'X-Sanitize-Email-To' => Array(message.to).uniq, # can be an array, so casting it as an array
-        'X-Sanitize-Email-Cc' => Array(message.cc).uniq  # can be an array, so casting it as an array
-        # Don't write out the BCC, as those addresses should not be visible in message headers for obvious reasons
+        # can be an arrays, so casting it as arrays
+        "X-Sanitize-Email-To" => Array(message.to).uniq,
+        "X-Sanitize-Email-Cc" => Array(message.cc).uniq
+        # Don't write out the BCC, as those addresses should not be visible
+        #   in message headers for obvious reasons
       }.each { |header_key, header_value|
         # For each type of address line
-        SanitizeEmail::MailHeaderTools.update_header(header_key, header_value, message)
+        SanitizeEmail::MailHeaderTools.update_header(
+          header_key,
+          header_value,
+          message
+        )
       }
     end
 
     def self.prepend_custom_subject(message)
       message.subject = "" unless message.subject
-      message.subject.prepend(SanitizeEmail::MailHeaderTools.custom_subject(message))
+      message.subject.prepend(
+        SanitizeEmail::MailHeaderTools.custom_subject(message)
+      )
     end
 
-    # According to https://github.com/mikel/mail this is the correct way to update headers.
+    # According to https://github.com/mikel/mail
+    #   this is the correct way to update headers.
     def self.update_header(header_key, header_value, message)
       # For each address, as header_value can be an array of addresses
       Array(header_value).each_with_index { |elem, index|

data/lib/sanitize_email/overridden_addresses.rb

@@ -42,15 +42,15 @@ module SanitizeEmail
     def to_override(actual_addresses)
       to = override_email(:to, actual_addresses)
       raise MissingTo, "after overriding :to (#{actual_addresses}) there are no addresses to send in To: header." if to.empty?
-      to.join(',')
+      to.join(",")
     end
 
     def cc_override(actual_addresses)
-      override_email(:cc, actual_addresses).join(',')
+      override_email(:cc, actual_addresses).join(",")
     end
 
     def bcc_override(actual_addresses)
-      override_email(:bcc, actual_addresses).join(',')
+      override_email(:bcc, actual_addresses).join(",")
     end
 
     def override_email(type, actual_addresses)
@@ -78,14 +78,14 @@ module SanitizeEmail
       sanitized_addresses = self.clean_addresses(sanitized_addresses, :bad_list)
       #puts "override_email 5: #{type} - #{sanitized_addresses}"
 
-      # If we don't want to inject the 'email' in the 'user name' section of the sanitized recipients,
+      # If we don't want to inject the "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
 
       with_user_names = self.inject_user_names(real_addresses, sanitized_addresses)
       #puts "real_addresses 2: #{real_addresses}"
       #puts "override_email 6: #{type} - #{with_user_names}"
-      # Otherwise inject the email as the 'user name'
+      # Otherwise inject the email as the "user name"
       return with_user_names
     end