email_sanitizer 0.0.1

data/LICENSE

@@ -0,0 +1 @@
+MIT

data/README.md

@@ -0,0 +1 @@
+TODO

data/lib/email_sanitizer.rb

@@ -0,0 +1,36 @@
+module EmailSanitizer
+  class << self
+    attr_accessor :base_email 
+    def base_email
+      @base_email ||= "default@example.com"
+    end
+
+    def base_local
+      base_email.split('@').first
+    end
+
+    def base_domain
+      base_email.split('@').last
+    end
+
+    def sanitize(email_addresses)
+      email_addresses = normalize_email_addresses(email_addresses)
+      email_addresses.inject([]) { |arry, address| arry << do_sanitize(address) }
+    end
+
+    private
+
+    def normalize_email_addresses(email_addresses)
+      return email_addresses.split(/[,;\s]+/) if email_addresses.class == String
+      email_addresses 
+    end
+
+    def do_sanitize(email_address)
+      local, domain = email_address.split('@')
+      "#{base_local}+#{local}_at_#{domain}@#{base_domain}"
+    end
+  end
+end
+
+require 'email_sanitizer/interceptor'
+Mail.register_interceptor(EmailSanitizer::Interceptor)

data/lib/email_sanitizer/interceptor.rb

@@ -0,0 +1,7 @@
+module EmailSanitizer
+  class Interceptor
+    def self.delivering_email(email)
+      email.to = EmailSanitizer.sanitize(email.to)
+    end
+  end
+end

data/spec/email_sanitizer_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe "When required" do 
+  it "should register itself through Mail.register_interceptor" do 
+    require 'email_sanitizer'
+    Mail.class_variable_get(:@@delivery_interceptors).should include(EmailSanitizer::Interceptor)
+  end
+end
+
+require 'email_sanitizer'
+
+describe EmailSanitizer do 
+
+  describe "#base_email" do 
+    it "should default to default@example.com" do 
+      EmailSanitizer.base_email.should == "default@example.com"
+    end
+
+    it "should be changeable" do 
+      EmailSanitizer.base_email = "test@example.com"
+      EmailSanitizer.base_email.should == "test@example.com"
+    end
+  end
+
+  describe '#sanitize' do 
+    it 'should modify a email with correct format' do 
+      EmailSanitizer.base_email = 'default@example.com'
+      email = "foo@bar.com"
+      EmailSanitizer.sanitize(email).should == ['default+foo_at_bar.com@example.com']
+    end
+
+    it 'should be able to take a string of email addresses' do 
+      EmailSanitizer.base_email = 'default@example.com'
+      [ "foo@bar.com, test@bar.com, abc@example.com", "foo@bar.com test@bar.com abc@example.com", "foo@bar.com; test@bar.com; abc@example.com"].each do |s|
+        EmailSanitizer.sanitize(s).should == ["default+foo_at_bar.com@example.com", "default+test_at_bar.com@example.com", "default+abc_at_example.com@example.com"]  
+      end      
+    end
+
+    it "should be able to take an array of email addresses" do 
+      EmailSanitizer.base_email = 'default@example.com'
+      EmailSanitizer.sanitize(["foo@bar.com", "abc@example.com"]).should == ["default+foo_at_bar.com@example.com", 'default+abc_at_example.com@example.com']
+    end
+  end
+
+  describe "usage" do 
+    before(:each) do 
+      ActionMailer::Base.delivery_method = :test
+      EmailSanitizer.base_email = "default@example.com"
+      @email = TestMailer.notification
+      @email.to.should == ["foo@bar.com"]
+    end
+
+    it "should work as advertised when calling .deliver!" do
+      @email.deliver
+      @email.to.should == ["default+foo_at_bar.com@example.com"]
+    end
+
+    # This will be fixed in Mail gem soon
+    # it "should work as advertised when calling through .delvier!" do 
+    #   @email.deliver!
+    #   @email.to.should == ["default+foo_at_bar.com@example.com"]
+    # end
+  end
+  
+
+
+  
+end
+

data/spec/interceptor_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+require 'email_sanitizer'
+
+describe EmailSanitizer::Interceptor do 
+  describe "#delivering_email" do 
+    it "should sanitize 'to' field on email" do
+      email_address = "foo@bar.com"
+      email = Mail.new(:to => email_address)
+      EmailSanitizer::Interceptor.delivering_email(email)
+      email.to.should == EmailSanitizer.sanitize(email_address)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'awesome_print'
+require 'action_mailer'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper.rb"` to ensure that it is only
+# loaded once.
+#
+# 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
+
+Dir[ File.dirname(__FILE__) + '/support/**/*.rb'].each { |file| require file }

data/spec/support/test_mailer.rb

@@ -0,0 +1,5 @@
+class TestMailer < ActionMailer::Base
+  def notification
+    mail(:to => "foo@bar.com", :from => "test@example.com")
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: email_sanitizer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Eric Zou
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-30 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: &70243766892720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70243766892720
+- !ruby/object:Gem::Dependency
+  name: autotest
+  requirement: &70243766892200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.4.6
+  type: :development
+  prerelease: false
+  version_requirements: *70243766892200
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: &70243766891740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70243766891740
+description: Email Sanitizer lets you avoid accidentally sending out emails to your
+  customers from staging, demo or other non-production environments
+email: hello@ericzou.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/email_sanitizer/interceptor.rb
+- lib/email_sanitizer.rb
+- spec/email_sanitizer_spec.rb
+- spec/interceptor_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_mailer.rb
+homepage: https://github.com/ericzou/email_sanitizer
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Email Sanitizer lets you avoid accidentally sending out emails to your customers
+  from staging, demo or other non-production environments
+test_files: []