letter_stamp_mail_delivery 1.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*~
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+rvm:
+  - 1.9.2-p320
+  - 1.9.3-p194
+  - ree

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in letter_stamp_mail_delivery.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Kenta Murata
+
+MIT License
+
+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.md

@@ -0,0 +1,59 @@
+# LetterStampMailDelivery
+
+[![Build Status](https://secure.travis-ci.org/mrkn/letter_stamp_mail_delivery.png?branch=master)](http://travis-ci.org/mrkn/letter_stamp_mail_delivery)
+
+Mail delivery method to save delivered mails with filenames that allows us to easily recognize the location at which mails are delivered.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'letter_stamp_mail_delivery'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install letter_stamp_mail_delivery
+
+## Usage
+
+### for RSpec
+
+```ruby
+require 'letter_stamp_mail_delivery'
+require 'letter_stamp_mail_delivery/rspec_support'
+
+RSpec.configure do |config|
+  LetterStampMailDelivery::RSpecSupport.install(config)
+end
+```
+
+### for test-unit
+
+Not supported yet.
+
+### with ActionMailer
+
+```ruby
+require 'letter_stamp_mail_delivery'
+require 'letter_stamp_mail_delivery/action_mailer_support'
+
+LetterStampMailDelivery::ActionMailerSupport.install
+
+ActionMailer::Base.delivery_method :letter_stamp
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Thanks
+
+- Ryo Nakamura (@r7kamura) for the name "Letter Stamp".

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+task :default => [:spec]
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['-b -fd']
+end

data/letter_stamp_mail_delivery.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/letter_stamp_mail_delivery/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Kenta Murata"]
+  gem.email         = ["mrkn@cookpad.com"]
+  gem.description   = %q{Mail delivery method to save delivered mails with filenames that allows us to easily recognize the location at which mails are delivered.}
+  gem.summary       = %q{Mail delivery method for saving mails with filenames of posting locations}
+  gem.homepage      = "http://github.com/mrkn/letter_stamp_mail_delivery"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "letter_stamp_mail_delivery"
+  gem.require_paths = ["lib"]
+  gem.version       = LetterStampMailDelivery::VERSION
+
+  gem.add_dependency('mail', '>= 2.2.0')
+
+  gem.add_development_dependency('rake')
+  gem.add_development_dependency('rspec', '~> 2.10.0')
+  gem.add_development_dependency('actionmailer', '>= 3.0.10')
+end

data/lib/letter_stamp_mail_delivery.rb

@@ -0,0 +1,2 @@
+require "letter_stamp_mail_delivery/version"
+require "letter_stamp_mail_delivery/delivery_method"

data/lib/letter_stamp_mail_delivery/action_mailer_support.rb

@@ -0,0 +1,11 @@
+require 'letter_stamp_mail_delivery/delivery_method'
+
+require 'action_mailer'
+
+module LetterStampMailDelivery
+  module ActionMailerSupport
+    def self.install
+      ActionMailer::Base.add_delivery_method :letter_stamp, DeliveryMethod
+    end
+  end
+end

data/lib/letter_stamp_mail_delivery/delivery_method.rb

@@ -0,0 +1,70 @@
+require 'mail/network/delivery_methods/test_mailer'
+
+require 'fileutils'
+
+module LetterStampMailDelivery
+  class DeliveryMethod < ::Mail::TestMailer
+    class << self
+      attr_accessor :posting_location
+    end
+
+    def self.start
+      @mail_counts = Hash.new(0)
+    end
+
+    def self.mail_count
+      @mail_counts[posting_location]
+    end
+
+    class << self
+      def increment_mail_count
+        @mail_counts[posting_location] += 1
+      end
+      private :increment_mail_count
+    end
+
+    def initialize(settings)
+      super
+      self.settings = {
+        :delivery_location => "#{tmpdir}/letter_stamp_mails",
+      }.update(settings)
+    end
+
+    def deliver!(mail)
+      super
+      save_raw_mail(mail.encoded)
+    end
+
+    private
+
+    def tmpdir
+      defined?(::Rails) ? "#{::Rails.root}/tmp" : Dir.tmpdir
+    end
+
+    def posting_location
+      self.class.posting_location
+    end
+
+    def delivery_location
+      settings[:delivery_location]
+    end
+
+    def generate_filename
+      stem = [posting_location, self.class.mail_count].flatten.join('_')
+      "#{delivery_location}/#{stem}.eml"
+    end
+
+    def save_raw_mail(raw_mail)
+      if posting_location && delivery_location
+        increment_mail_count
+        filename = generate_filename
+        FileUtils.mkdir_p(File.dirname(filename))
+        open(filename, 'wb') {|io| io.write(raw_mail) }
+      end
+    end
+
+    def increment_mail_count
+      self.class.send :increment_mail_count
+    end
+  end
+end

data/lib/letter_stamp_mail_delivery/rspec_support.rb

@@ -0,0 +1,58 @@
+require 'rspec/core/formatters/base_formatter'
+
+module LetterStampMailDelivery
+  module RSpecSupport
+    class ExampleLocationNotifier < ::RSpec::Core::Formatters::BaseFormatter
+      def initialize(*args)
+        # nothing
+      end
+
+      def close
+        # nothing
+      end
+
+      def start(example_count)
+        ::LetterStampMailDelivery::DeliveryMethod.start
+      end
+
+      def example_group_started(example_group)
+        # nothing
+      end
+
+      def example_group_finished(example_group)
+        # nothing
+      end
+
+      def example_started(example)
+        ::LetterStampMailDelivery::DeliveryMethod.posting_location = posting_location(example)
+      end
+
+      def example_passed(example)
+        example_finished
+      end
+
+      def example_pending(example)
+        example_finished
+      end
+
+      def example_failed(example)
+        example_finished
+      end
+
+      private
+
+      def posting_location(example)
+        spec_file, lineno = example.location.split(':')
+        [spec_file, lineno.to_i]
+      end
+
+      def example_finished
+        ::LetterStampMailDelivery::DeliveryMethod.posting_location = nil
+      end
+    end
+
+    def self.install(rspec_configuration)
+      rspec_configuration.add_formatter(ExampleLocationNotifier)
+    end
+  end
+end

data/lib/letter_stamp_mail_delivery/version.rb

@@ -0,0 +1,3 @@
+module LetterStampMailDelivery
+  VERSION = "1.0.1"
+end

data/spec/letter_stamp_mail_delivery/action_mailer_support_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+require 'letter_stamp_mail_delivery/action_mailer_support'
+
+module LetterStampMailDelivery
+  describe ActionMailerSupport do
+    describe '.install' do
+      it "should add_delivery_method :letter_stamp" do
+        described_class.install
+        ActionMailer::Base.delivery_methods.should include(:letter_stamp)
+      end
+    end
+  end
+end

data/spec/letter_stamp_mail_delivery/delivery_method_spec.rb

@@ -0,0 +1,180 @@
+require 'spec_helper'
+require 'mail'
+require 'tmpdir'
+
+module LetterStampMailDelivery
+  describe DeliveryMethod do
+    shared_context "setup and enter temporary directory" do
+      around :each do |example|
+        Dir.mktmpdir do |tmpdir|
+          Dir.chdir(tmpdir) do
+            example.run
+          end
+        end
+      end
+    end
+
+    shared_context "initialize without :delivery_location" do
+      before :each do
+        Mail.defaults do
+          delivery_method DeliveryMethod
+        end
+      end
+    end
+
+    shared_context "initialize with :delivery_location" do
+      before :each do
+        Mail.defaults do
+          delivery_method DeliveryMethod,
+            :delivery_location => "#{Dir.pwd}/tmp/mails"
+        end
+      end
+    end
+
+    before :each do
+      # Reset all defaults back to original state
+      Mail.defaults do
+        delivery_method :smtp, { :address              => "localhost",
+                                 :port                 => 25,
+                                 :domain               => 'localhost.localdomain',
+                                 :user_name            => nil,
+                                 :password             => nil,
+                                 :authentication       => nil,
+                                 :enable_starttls_auto => true,
+                                 :openssl_verify_mode  => nil }
+        DeliveryMethod.deliveries.clear
+        DeliveryMethod.start
+      end
+    end
+
+    context "just initialized" do
+      include_context "initialize without :delivery_location"
+
+      describe ".deliveries" do
+        subject { described_class.deliveries }
+
+        it { should be_empty }
+      end
+    end
+
+    context "initialize without :delivery_location parameter" do
+      include_context "setup and enter temporary directory"
+
+      describe "#settings[:delivery_location]" do
+        subject { Mail.delivery_method.settings[:delivery_location] }
+
+        context "Rails isn't defined" do
+          include_context "initialize without :delivery_location"
+
+          it "should have the correct temporary directory" do
+            subject.should eq("#{Dir.tmpdir}/letter_stamp_mails")
+          end
+        end
+
+        context "Rails.root is defined" do
+          before :each do
+            Object.const_set(:Rails, double("Rails")) unless defined?(::Rails)
+            ::Rails.stub(:root).and_return(Dir.pwd)
+          end
+
+          after :each do
+            Object.send(:remove_const, :Rails) if ::Rails.is_a?(::RSpec::Mocks::Mock)
+          end
+
+          include_context "initialize without :delivery_location"
+
+          it "should have \"\#{Rails.root}/tmp/letter_stamp_mails\"" do
+            subject.should eq("#{::Rails.root}/tmp/letter_stamp_mails")
+          end
+        end
+      end
+    end
+
+    context "initialize with :delivery_location parameter" do
+      include_context "setup and enter temporary directory"
+      include_context "initialize with :delivery_location"
+
+      describe "#settings[:delivery_location]" do
+        subject { Mail.delivery_method.settings[:delivery_location] }
+
+        it "should have the value specified at the initialization" do
+          subject.should eq("#{Dir.pwd}/tmp/mails")
+        end
+      end
+    end
+
+    it "should deliver an email into the LetterStampMailDelivery.deliveries array" do
+      Mail.defaults do
+        delivery_method DeliveryMethod
+      end
+      mail = Mail.new do
+        to 'mikel@me.com'
+        from 'you@you.com'
+        subject 'testing'
+        body 'hello'
+      end
+      mail.deliver
+      described_class.deliveries.should have(1).item
+      described_class.deliveries.first.should eq(mail)
+    end
+
+    context "do not set posting_location" do
+      include_context "setup and enter temporary directory"
+      include_context "initialize with :delivery_location"
+
+      it "should not save an email as a file" do
+        mail = Mail.new do
+          to 'mikel@me.com'
+          from 'you@you.com'
+          subject 'testing'
+          body 'hello'
+        end
+        mail.deliver
+        Dir.glob("#{Dir.pwd}/tmp/mails/*").should have(0).item
+      end
+    end
+
+    context "posting_location is given" do
+      include_context "setup and enter temporary directory"
+      include_context "initialize with :delivery_location"
+
+      before :each do
+        DeliveryMethod.posting_location = ['foo_spec.rb', 42]
+      end
+
+      let(:mail) do
+        Mail.new do
+          to 'mikel@me.com'
+          from 'you@you.com'
+          subject 'testing'
+          body 'hello'
+        end
+      end
+
+      it "should save an email as a file named foo_spec.rb_42_1.eml" do
+        mail.deliver
+        File.should be_file("#{Dir.pwd}/tmp/mails/foo_spec.rb_42_1.eml")
+      end
+
+      it "should save the second email as a file named foo_spec.rb_42_2.eml" do
+        2.times { mail.deliver }
+        File.should be_file("#{Dir.pwd}/tmp/mails/foo_spec.rb_42_2.eml")
+      end
+
+      it "should increment mail_count" do
+        expect { mail.deliver }.to change {
+          described_class.mail_count
+        }.by(1)
+      end
+
+      describe ".mail_count" do
+        it "should maintain for each posting_location" do
+          described_class.posting_location = ['foo_spec.rb', 42]
+          mail.deliver
+          described_class.posting_location = ['bar_spec.rb', 42]
+          described_class.mail_count.should eq(0)
+        end
+      end
+    end
+  end
+end

data/spec/letter_stamp_mail_delivery/rspec_support_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+require 'letter_stamp_mail_delivery/rspec_support'
+
+module LetterStampMailDelivery
+  describe RSpecSupport do
+    describe ".install" do
+      let(:rspec_configuration) { ::RSpec::Core::Configuration.new }
+
+      it "should add_formatter ExampleLocationNotifier" do
+        rspec_configuration.should_receive(:add_formatter).with(described_class::ExampleLocationNotifier)
+        described_class.install(rspec_configuration)
+      end
+    end
+  end
+end
+
+module LetterStampMailDelivery::RSpecSupport
+  describe ExampleLocationNotifier do
+    let(:dummy_output) { double("dummy output") }
+
+    subject { described_class.new(dummy_output) }
+
+    describe "#start" do
+      it "should call LetterStampMailerDelivery::DeliveryMethod.start" do
+        ::LetterStampMailDelivery::DeliveryMethod.should_receive(:start).once
+        subject.start(0)
+      end
+    end
+
+    describe "#example_started" do
+      context "with an example located at foo_spec.rb:42" do
+        let(:example) { double("example", :location => "foo_spec.rb:42") }
+
+        it "should set LetterStampMailerDelivery::DeliveryMethod.posting_location ['foo_spec.rb', 42]" do
+          subject.example_started(example)
+          ::LetterStampMailDelivery::DeliveryMethod.posting_location.should eq(["foo_spec.rb", 42])
+        end
+      end
+
+      context "with an example located at bar_spec.rb:17" do
+        let(:example) { double("example", :location => "bar_spec.rb:17") }
+
+        it "should set LetterStampMailerDelivery::DeliveryMethod.posting_location ['bar_spec.rb', 16]" do
+          subject.example_started(example)
+          ::LetterStampMailDelivery::DeliveryMethod.posting_location.should eq(["bar_spec.rb", 17])
+        end
+      end
+    end
+
+    shared_examples_for "LetterStampMailDelivery::DeliveryMethod.posting_location should be nil" do |method_name|
+      context "LetterStampMailDelivery::DeliveryMethod.posting_location is ['foo_spec.rb', 42]" do
+        before :each do
+          ::LetterStampMailDelivery::DeliveryMethod.posting_location = ['foo_spec.rb', 42]
+        end
+
+        it "should do LetterStampMailDelivery::DeliveryMethod.posting_location = nil" do
+          subject.send(method_name, example)
+          ::LetterStampMailDelivery::DeliveryMethod.posting_location.should be_nil
+        end
+      end
+    end
+
+    describe "#example_passed" do
+      it_should_behave_like "LetterStampMailDelivery::DeliveryMethod.posting_location should be nil", :example_passed
+    end
+
+    describe "#example_pending" do
+      it_should_behave_like "LetterStampMailDelivery::DeliveryMethod.posting_location should be nil", :example_pending
+    end
+
+    describe "#example_failed" do
+      it_should_behave_like "LetterStampMailDelivery::DeliveryMethod.posting_location should be nil", :example_failed
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'letter_stamp_mail_delivery'
+
+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

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: letter_stamp_mail_delivery
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kenta Murata
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.10
+description: Mail delivery method to save delivered mails with filenames that allows
+  us to easily recognize the location at which mails are delivered.
+email:
+- mrkn@cookpad.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- letter_stamp_mail_delivery.gemspec
+- lib/letter_stamp_mail_delivery.rb
+- lib/letter_stamp_mail_delivery/action_mailer_support.rb
+- lib/letter_stamp_mail_delivery/delivery_method.rb
+- lib/letter_stamp_mail_delivery/rspec_support.rb
+- lib/letter_stamp_mail_delivery/version.rb
+- spec/letter_stamp_mail_delivery/action_mailer_support_spec.rb
+- spec/letter_stamp_mail_delivery/delivery_method_spec.rb
+- spec/letter_stamp_mail_delivery/rspec_support_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/mrkn/letter_stamp_mail_delivery
+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.23
+signing_key: 
+specification_version: 3
+summary: Mail delivery method for saving mails with filenames of posting locations
+test_files:
+- spec/letter_stamp_mail_delivery/action_mailer_support_spec.rb
+- spec/letter_stamp_mail_delivery/delivery_method_spec.rb
+- spec/letter_stamp_mail_delivery/rspec_support_spec.rb
+- spec/spec_helper.rb
+has_rdoc: