actionmailer_extensions 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Peter MacRobert and Empire42 Ltd (UK)
+
+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/README.rdoc

@@ -0,0 +1,17 @@
+= actionmailer_extensions
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Peter MacRobert. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "actionmailer_extensions"
+    gem.summary = %Q{Handy "save to disk" and "safe recipients" features for ActionMailer}
+    gem.description = %Q{Wraps the deliver! method on ActionMailer to save the outgoing mail to a .eml file, 
+      which can be opened by most email clients. Also provides a mechanism for only sending to an approved list of
+      email recipients, which is useful for ensuring your application doesn't send email outside of an organization.}
+    gem.email = "originalpete@gmail.com"
+    gem.homepage = "http://github.com/originalpete/actionmailer_extensions"
+    gem.authors = ["Peter MacRobert"]
+    gem.add_development_dependency "yard", ">= 0"
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "rr", ">= 0.10.5"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :test => :check_dependencies
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/actionmailer_extensions.rb

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'action_mailer'
+
+module ActionmailerExtensions
+  
+  def deliver_with_disk_save!(mail = @mail)
+    if save_emails_to_disk
+      FileUtils.mkdir_p(email_output_dir) unless File.directory?(email_output_dir)
+      filename = "#{Time.now.to_i}_#{mail.to.join(',')}.eml"
+      File.open(File.join(email_output_dir, filename), "w+") {|f|
+        f << mail.encoded
+      }
+    end
+    
+    # ensure that the mail's "to" recipients are all contained in the safe_recipients list
+    send = case
+    when !safe_recipients || safe_recipients.empty? then false
+    when safe_recipients.include?(:any) then true
+    when (mail.to.map(&:downcase) - safe_recipients.map{|r| r.to_s.downcase}).empty? then true
+    end
+    
+    return mail unless send
+    
+    deliver_without_disk_save!(mail)
+    mail
+  end
+  
+end
+
+module ActionMailer
+  class Base
+    
+    # Add some additional class attributes that we need.
+    @@safe_recipients = [:any]
+    cattr_accessor :safe_recipients
+    
+    @@save_emails_to_disk = false
+    cattr_accessor :save_emails_to_disk
+    
+    @@email_output_dir = "/tmp/actionmailer_output_emails"
+    cattr_accessor :email_output_dir
+    
+    private
+    include ActionmailerExtensions
+    alias_method_chain :deliver!, :disk_save
+  end
+end

data/spec/action_mailer_extensions_spec.rb

@@ -0,0 +1,142 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe ActionmailerExtensions do
+
+  # Creates an anonmyous throw-away class of type=parent, with an additional
+  # proc for defining methods on the class.
+  def new_anon_class(parent, name="", &proc)
+    klass = Class.new(parent)  
+    mc = klass.instance_eval{ class << self ; self ; end }
+    mc.send(:define_method, :to_s) {name}
+    klass.class_eval(&proc) if proc
+    klass
+  end
+
+  # create a new anonymous ActionMailer::Base descendant class
+  def new_mailer_class(name, &proc)
+    return new_anon_class(ActionMailer::Base, name, proc) if proc
+    new_anon_class(ActionMailer::Base, name){
+      def test_email(to="someone@example.com")
+        from          "noreply@nowhere.local"
+        recipients    to
+        subject       "test email"
+        content_type  "text/plain"
+        body          "test email"
+      end
+    }
+  end
+
+  before do
+    ActionMailer::Base.delivery_method = :test
+    ActionMailer::Base.deliveries = []
+    ActionMailer::Base.perform_deliveries = true
+    @test_mailer_klass = new_mailer_class('TestMailer')
+  end
+
+  describe "alias chain" do
+    it "should create new methods" do
+      ActionMailer::Base.instance_methods.include?("deliver!").should be_true
+      ActionMailer::Base.instance_methods.include?("deliver_with_disk_save!").should be_true
+      ActionMailer::Base.instance_methods.include?("deliver_without_disk_save!").should be_true
+    end
+  end
+
+  describe "deliver_with_disk_save!" do
+
+    describe "saving emails to disk" do
+      before do
+        ActionMailer::Base.save_emails_to_disk = true
+        ActionMailer::Base.email_output_dir = "/tmp/actionmailer_output_emails"
+      end
+
+      after do
+        # cleanup any mails we wrote to disk
+        FileUtils.rm_r(ActionMailer::Base.email_output_dir) if File.directory?(ActionMailer::Base.email_output_dir)
+      end
+
+      it "should create the output dir if it does not exist" do
+        File.directory?(ActionMailer::Base.email_output_dir).should be_false
+        @test_mailer_klass.deliver_test_email
+        File.directory?(ActionMailer::Base.email_output_dir).should be_true
+      end
+
+      it "should save email contents to disk if enabled" do
+        @mail = @test_mailer_klass.deliver_test_email
+        files = Dir[File.join(ActionMailer::Base.email_output_dir, "*")]
+        files.size.should == 1
+        IO.read(files.first).should == @mail.encoded
+      end
+
+      it "should not save email to disk if not enabled" do
+        ActionMailer::Base.save_emails_to_disk = false
+        @mail = @test_mailer_klass.deliver_test_email
+        files = Dir[File.join(ActionMailer::Base.email_output_dir, "*")].size.should == 0
+      end
+    end
+
+    describe "safe recipients" do
+      before do
+        ActionMailer::Base.safe_recipients = ['a@example.com', 'b@example.com']
+        @test_mailer_klass.create_test_email.to.should == ["someone@example.com"]
+      end
+
+      it "should restrict sending when list is empty" do
+        ActionMailer::Base.safe_recipients = []
+        lambda{
+          @test_mailer_klass.deliver_test_email()
+        }.should_not change{ActionMailer::Base.deliveries.size}
+      end
+
+      it "should restrict sending when list is nil" do
+        ActionMailer::Base.safe_recipients = nil
+        lambda{
+          @test_mailer_klass.deliver_test_email
+        }.should_not change{ActionMailer::Base.deliveries.size}
+      end
+
+      it "should not restrict sending when recipient is in the list" do
+        ActionMailer::Base.safe_recipients = ["someone@example.com"]
+        lambda{
+          @test_mailer_klass.deliver_test_email
+        }.should change{ActionMailer::Base.deliveries.size}.by(1)
+      end
+
+      it "should send to any address when safe recipients list contains :any" do
+        ActionMailer::Base.safe_recipients = [:any]
+        lambda{
+          @test_mailer_klass.deliver_test_email
+        }.should change{ActionMailer::Base.deliveries.size}.by(1)
+      end
+
+      it "should restrict sending when recipient is not in the list" do
+        ActionMailer::Base.safe_recipients.include?("someone@example.com").should be_false
+        lambda{
+          @test_mailer_klass.deliver_test_email
+        }.should_not change{ActionMailer::Base.deliveries.size}
+      end
+
+      it "should not have side-effects on the safe recipients list" do
+        ActionMailer::Base.safe_recipients = [:any, "foo@foo.com", "bar@bar.com"]
+        @test_mailer_klass.deliver_test_email
+        ActionMailer::Base.safe_recipients.should == [:any, "foo@foo.com", "bar@bar.com"]
+      end
+
+      it "should allow sending when multiple recipients are all in the safe list" do
+        ActionMailer::Base.safe_recipients = ['a@example.com', 'b@example.com']
+        lambda{
+          @test_mailer_klass.deliver_test_email(['a@example.com', 'b@example.com'])
+        }.should change{ActionMailer::Base.deliveries.size}.by(1)
+      end
+
+      it "should restrict sending when not all recipients are in the safe list" do
+        ActionMailer::Base.safe_recipients = ['a@example.com', 'b@example.com']
+        lambda{
+          @test_mailer_klass.deliver_test_email(['a@example.com', 'foo@example.com'])
+        }.should_not change{ActionMailer::Base.deliveries.size}
+      end
+
+    end
+
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--colour
+--format specdoc

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'spec'
+require 'spec/autorun'
+require 'actionmailer_extensions'
+
+Spec::Runner.configure do |config|
+  config.mock_with :rr
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: actionmailer_extensions
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Peter MacRobert
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-20 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rr
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.10.5
+    version: 
+description: |-
+  Wraps the deliver! method on ActionMailer to save the outgoing mail to a .eml file, 
+        which can be opened by most email clients. Also provides a mechanism for only sending to an approved list of
+        email recipients, which is useful for ensuring your application doesn't send email outside of an organization.
+email: originalpete@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/actionmailer_extensions.rb
+- spec/action_mailer_extensions_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/originalpete/actionmailer_extensions
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Handy "save to disk" and "safe recipients" features for ActionMailer
+test_files: 
+- spec/action_mailer_extensions_spec.rb
+- spec/spec_helper.rb