eyepaste-mail 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in eyepaste-mail.gemspec
+gemspec

data/README.md

@@ -0,0 +1,74 @@
+# eyepaste-mail
+
+## Description
+
+eyepaste-mail is a ruby gem that implements a "mail interceptor" as specified by the popular [Mail](https://github.com/mikel/mail) gem.
+
+After registering the eyepaste-mail interceptor with the Mail gem, any emails sent with Mail are inspected before delivery and the "to" addresses are munged in the following way:
+
+`inbox@example.com -> inbox_example.com@eyepaste.com`
+
+After delivery, the above email would be available at:
+
+`http://www.eyepaste.com/inbox/inbox_example.com@eyepaste.com`
+
+And as RSS at:
+
+`http://www.eyepaste.com/inbox/inbox_example.com@eyepaste.com.rss`
+
+
+## Whitelisting
+
+By default, the eyepaste-mail interceptor munges all addresses. To allow some addresses to pass through unaltered, you can define a whitelist in the following ways:
+
+```ruby
+# pass a regexp
+Eyepaste::Mail::Interceptor.set_white_list /.+?@example.com/
+
+# pass an array of regexps
+Eyepaste::Mail::Interceptor.set_white_list [/.+?@example.com/, /^testing_.+?@example.com/]
+
+# pass a block, it will be called every time a message is examined and munged
+Eyepaste::Mail::Interceptor.set_white_list do
+  # must return a regexp object or array of regexp objects
+end
+```
+
+## Registering The Interceptor
+
+To register the interceptor with the Mail gem, call:
+
+```ruby
+# optionally define a white_list:
+Eyepaste::Mail::Interceptor.set_white_list /.+?@example.com/
+
+# register with Mail
+Mail.register_interceptor(Eyepaste::Mail::Interceptor)
+```
+
+
+## Rails 3.2
+
+Make sure eyepaste-mail is required by your Gemfile and you have then run `bundle install`
+
+To only munge emails in a particular environment, you can place the following in an environment file. For development, place in `config/environments/development.rb`:
+
+```ruby
+# optionally define a white_list:
+Eyepaste::Mail::Interceptor.set_white_list /.+?@example.com/
+
+# register with ActionMailer::Base (which wraps the call to Mail.register_interceptor)
+ActionMailer::Base.register_interceptor(Eyepaste::Mail::Interceptor)
+```
+
+## License
+
+eyepaste-email is licensed under the MIT license:
+
+Copyright (c) 2012. Jon Moniaci.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/eyepaste-mail.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "eyepaste-mail/version"
+
+Gem::Specification.new do |s|
+  s.name        = "eyepaste-mail"
+  s.version     = Eyepaste::Mail::VERSION
+  s.authors     = ["Jon Moniaci"]
+  s.email       = ["jonmoniaci [at] gmail.com"]
+  s.homepage    = "https://github.com/corporealfunk/eyepaste-mail"
+  s.summary     = %q{Works with Mail gem to munge email 'To:' addresses into @eyepaste.com addresses}
+  s.description = %q{Implements an email interceptor which, when registered with the Mail gem, munges all "To:" email address to @eyepaste.com addresses. Especially helpful in dev or staging environments when you don't want emails delivered to actual addresses, but you may want to verify actual delivery.}
+
+  s.rubyforge_project = "eyepaste-mail"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec"
+  s.add_runtime_dependency "mail"
+end

data/lib/eyepaste-mail.rb

@@ -0,0 +1,7 @@
+require "eyepaste-mail/version"
+
+module Eyepaste
+  module Mail
+    require 'eyepaste-mail/interceptor.rb'
+  end
+end

data/lib/eyepaste-mail/interceptor.rb

@@ -0,0 +1,34 @@
+module Eyepaste
+  module Mail
+    class Interceptor
+      @@white_list = nil
+
+      def self.set_white_list(white_list=nil, &block)
+        @@white_list = block || white_list
+      end
+
+      def self.get_white_list
+        return [] if @@white_list.nil?
+
+        white_list = @@white_list.kind_of?(Proc) ? @@white_list.call : @@white_list
+
+        white_list.respond_to?(:each) ? white_list : [white_list]
+      end
+
+      def self.delivering_email(message)
+        message.to = message[:to].addrs.map do |addr|
+          email = addr.address
+          on_white_list = get_white_list.any? { |regexp| regexp.match(email)}
+          if !on_white_list
+            munged_email = "#{email.gsub(/@/, '_')}@eyepaste.com"
+            formatted_address = addr.format.gsub(email, munged_email)
+          else
+            formatted_address = addr.format
+          end
+
+          formatted_address
+        end
+      end
+    end
+  end
+end

data/lib/eyepaste-mail/version.rb

@@ -0,0 +1,5 @@
+module Eyepaste
+  module Mail
+    VERSION = "0.0.1"
+  end
+end

data/spec/interceptor_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+require 'mail'
+
+describe Eyepaste::Mail::Interceptor do
+  after(:each) do
+    # clear the white list after each test
+    Eyepaste::Mail::Interceptor.set_white_list(nil)
+  end
+
+  describe ".set_white_list" do
+    context "when regexp passed" do
+      it "sets the white_list to an array with the regexp as only element" do
+        Eyepaste::Mail::Interceptor.set_white_list(/.+?@testdomain\.com/)
+        Eyepaste::Mail::Interceptor.get_white_list.should == [/.+?@testdomain\.com/]
+      end
+    end
+
+    context "when array of regexps passed" do
+      it "sets the white_list to the array" do
+        Eyepaste::Mail::Interceptor.set_white_list([/.+?@testdomain\.com/])
+        Eyepaste::Mail::Interceptor.get_white_list.should == [/.+?@testdomain\.com/]
+      end
+    end
+
+    context "when block passed" do
+      context "when block returns a regexp" do
+        it "return value of proc is wrapped in an array" do
+          Eyepaste::Mail::Interceptor.set_white_list do
+            /white list proc/
+          end
+          Eyepaste::Mail::Interceptor.get_white_list.should == [/white list proc/]
+        end
+      end
+
+      context "when block returns an array" do
+        it "return value of proc is an array" do
+          Eyepaste::Mail::Interceptor.set_white_list do
+            [/white list proc/]
+          end
+          Eyepaste::Mail::Interceptor.get_white_list.should == [/white list proc/]
+        end
+      end
+    end
+  end
+
+  describe ".delivering_mail" do
+    context "when single to address" do
+      before(:each) do
+        @message = Mail.new do
+          to  'Hallow World <hallowworld@example.com>'
+        end
+      end
+
+      context "when address matches white_list" do
+        before(:each) do
+          Eyepaste::Mail::Interceptor.set_white_list(/.+?@example\.com/)
+        end
+
+        it "does not alter the to address" do
+          expect {
+            Eyepaste::Mail::Interceptor.delivering_email(@message)
+          }.to_not change(@message[:to], :to_s)
+        end
+
+        it "retains the formatted To: header" do
+          Eyepaste::Mail::Interceptor.delivering_email(@message)
+          @message[:to].to_s.should == 'Hallow World <hallowworld@example.com>'
+        end
+      end
+
+      context "when address does not match white_list" do
+        it "alters the to address" do
+          expect {
+            Eyepaste::Mail::Interceptor.delivering_email(@message)
+          }.to change(@message[:to], :to_s)
+        end
+
+        it "munges the to address to an eyepaste email" do
+          Eyepaste::Mail::Interceptor.delivering_email(@message)
+          @message[:to].addresses.first.should == 'hallowworld_example.com@eyepaste.com'
+        end
+
+        it "retains the formatted To: header" do
+          Eyepaste::Mail::Interceptor.delivering_email(@message)
+          @message[:to].to_s.should == 'Hallow World <hallowworld_example.com@eyepaste.com>'
+        end
+      end
+    end
+
+    context "when multiple to addresses" do
+      before(:each) do
+        Eyepaste::Mail::Interceptor.set_white_list(/.+?@example\.com/)
+        @message = Mail.new do
+          to  'Hallow World <hallowworld@example.com>, flatearth@domain.com'
+        end
+      end
+
+      it "alters the to addresses that don't match the white list" do
+        Eyepaste::Mail::Interceptor.delivering_email(@message)
+        @message[:to].addresses.should == ['hallowworld@example.com', 'flatearth_domain.com@eyepaste.com']
+      end
+
+      it "retains the formatted To: header" do
+        Eyepaste::Mail::Interceptor.delivering_email(@message)
+        @message[:to].to_s.should == 'Hallow World <hallowworld@example.com>, flatearth_domain.com@eyepaste.com'
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'eyepaste-mail'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: eyepaste-mail
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jon Moniaci
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-05 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70100348192140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70100348192140
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: &70100348191720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70100348191720
+description: Implements an email interceptor which, when registered with the Mail
+  gem, munges all "To:" email address to @eyepaste.com addresses. Especially helpful
+  in dev or staging environments when you don't want emails delivered to actual addresses,
+  but you may want to verify actual delivery.
+email:
+- jonmoniaci [at] gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- eyepaste-mail.gemspec
+- lib/eyepaste-mail.rb
+- lib/eyepaste-mail/interceptor.rb
+- lib/eyepaste-mail/version.rb
+- spec/interceptor_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/corporealfunk/eyepaste-mail
+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: eyepaste-mail
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Works with Mail gem to munge email 'To:' addresses into @eyepaste.com addresses
+test_files:
+- spec/interceptor_spec.rb
+- spec/spec_helper.rb