redis_cache_mailer_delivery 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.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 @@
+--colour
+--format documentation

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.3@redis_cache_mailer_delivery

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,11 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+# NOTE: When using watch with a block, you must return all files that should be reloaded.
+guard :rspectacle, :cli => '--format documentation --backtrace' do
+  watch('spec/spec_helper.rb')                        { %w(spec/spec_helper spec) }
+
+  watch(%r{^spec/.+_spec\.rb$})
+
+  watch(%r{^lib/(.+)\.rb$})                           { |m| ["lib/#{m[1]}.rb", "spec/lib/#{m[1]}_spec.rb"] }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Yi Wen
+
+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,54 @@
+# RedisCacheMailerDelivery
+
+This gem is inspired by https://github.com/p0deje/action_mailer_cache_delivery.
+
+If you are using Resque for sending mails asynchronously, and you want to test the mail sending asynchronously in your integration tests, then you can use this gem for just that.
+
+The gem adds a new delivery method to the ActionMailer and it stores the marshaled Mail::Message being delivered into a redis list which can be fetched by any other processes.
+
+A separate Resque worker process deliver emails, which being written into a redis storage. The test process (such as a cucumber step can then fetch the mail for examination).
+ 
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'redis_cache_mailer_delivery'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redis_cache_mailer_delivery
+
+## Usage
+
+In a Rails project, in your environment files such as config/environments/cucumber.rb
+
+```ruby
+config.action_mailer.delivery_method = :redis_cache
+config.action_mailer.redis_cache_settings = { :redis_key_name => "a_key_name_for_all_stored_emails" }
+```
+
+You don't have to define the redis_key_name, the default is 
+
+```ruby
+"redis_cache_mailer_delivery:mail_messages"
+```
+
+All the mails being delivered will be written into the redis storage. You can use
+
+```ruby
+ActionMailer::Base.cached_deliveries
+```
+
+to access all the mails
+
+## 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

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/redis_cache_mailer_delivery.rb

@@ -0,0 +1,16 @@
+require 'action_mailer'
+require 'redis_cache_mailer_delivery/version'
+require 'redis_cache_mailer_delivery/mail/cache_delivery'
+require 'redis_cache_mailer_delivery/action_mailer/base'
+
+module RedisCacheMailerDelivery
+  class << self
+    def install
+      ActionMailer::Base.add_delivery_method :redis_cache, Mail::CacheDelivery,
+        :redis_key_name => "redis_cache_mailer_delivery:mail_messages"
+    end
+
+  end # << self
+end # RedisCacheMailerDelivery
+require 'redis_cache_mailer_delivery/railtie'
+require "redis_cache_mailer_delivery/version"

data/lib/redis_cache_mailer_delivery/action_mailer/base.rb

@@ -0,0 +1,26 @@
+module ActionMailer
+  class Base
+    class << self
+
+      #
+      # Returns an array of delivered mails.
+      #
+      # @return [Array] array of mails (each mail is an instance of Mail.)
+      #
+      def cached_deliveries
+        list = Redis::List.new redis_cache_settings[:redis_key_name], :marshal => true
+        list.values.map{|m|Marshal.load(m)}
+      end
+
+      #
+      # Clears delivered mails.
+      #
+      # It also cleans ActionMailer::Base.deliveries
+      #
+      def clear_cache
+        $redis.del redis_cache_settings[:redis_key_name]
+      end
+
+    end # << self
+  end # Base
+end # ActionMailer

data/lib/redis_cache_mailer_delivery/mail/cache_delivery.rb

@@ -0,0 +1,32 @@
+module Mail
+  #
+  # Performs deliveries to temporary cache file, so mails can accessed from
+  # other processes.
+  #
+  # Default location of files is:
+  #   -  "tmp/cache/action_mailer_cache_deliveries.cache" if you use Rails
+  #   - "/tmp/cache/action_mailer_cache_deliveries.cache" if you don't use Rails
+  #
+  # However, you can overwrite location in configuration:
+  #
+  # @example
+  #   config.action_mailer.cache_settings = { location: "custom/path" }
+  #
+  class CacheDelivery
+
+    # @attr [Hash] settings Settings for CacheDelivery
+    attr_accessor :settings
+
+    # @api private
+    def initialize(settings)
+      @settings = settings
+    end
+
+    # @api private
+    def deliver!(mail)
+      list = Redis::List.new settings[:redis_key_name], :marshal => true
+      list << mail
+    end
+
+  end # CacheDelivery
+end # Mail

data/lib/redis_cache_mailer_delivery/railtie.rb

@@ -0,0 +1,16 @@
+module RedisCacheMailerDelivery 
+  class Railtie < Rails::Railtie
+
+    #
+    # Make settings available before configuration:
+    #
+    # @example
+    #   config.action_mailer.delivery_method = :redis_cache
+    #   config.action_mailer.cache_settings = { redis_key_name => "redis_cache_mailer_delivery:mail_messages" }
+    #
+    config.before_configuration do
+      RedisCacheMailerDelivery.install
+    end
+
+  end # Railtie
+end

data/lib/redis_cache_mailer_delivery/version.rb

@@ -0,0 +1,3 @@
+module RedisCacheMailerDelivery
+  VERSION = "0.0.1"
+end

data/redis_cache_mailer_delivery.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/redis_cache_mailer_delivery/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Yi Wen"]
+  gem.email         = ["hayafirst@gmail.com"]
+  gem.description   = %q{Use Redis to store the Mail::Message when using in Rails}
+  gem.summary       = %q{Use Redis to store the Mail::Message when using in Rails}
+  gem.homepage      = "https://github.com/ywen/redis_cache_mailer_delivery"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "redis_cache_mailer_delivery"
+  gem.require_paths = ["lib"]
+  gem.version       = RedisCacheMailerDelivery::VERSION
+  gem.add_runtime_dependency(%q<redis>)
+  gem.add_runtime_dependency(%q<redis-objects>)
+  gem.add_runtime_dependency(%q<actionmailer>)
+  gem.add_development_dependency(%q<rspec>)
+  gem.add_development_dependency(%q<guard-rspectacle>)
+  gem.add_development_dependency(%q<growl>)
+  gem.add_development_dependency(%q<rb-fsevent>)
+end

data/spec/redis_cache_mailer_delivery_spec.rb

@@ -0,0 +1,10 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "spec_helper"))
+
+describe RedisCacheMailerDelivery do
+  describe ".install" do
+    it "adds a delivery method to the ActionMailer" do
+      described_class.install
+      ActionMailer::Base.delivery_methods.should include(:redis_cache => Mail::CacheDelivery)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+require 'rspec/core'
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+require "#{File.dirname(__FILE__)}/../lib/redis_cache_mailer_delivery"
+Dir["#{File.dirname(__FILE__)}/../lib/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+  # out = ENV['CC_BUILD_ARTIFACTS'] || "#{Rails.root}"
+  # config.output_stream = File.open("#{out}/UnitTests/index.html", "w") if config.formatter_class.name =~ /HtmlFormatter/
+
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, comment the following line or assign false
+  # instead of true.
+end

data/spec/support/faked_rails.rb

@@ -0,0 +1,14 @@
+module Rails
+  class Railtie
+    class << self
+      def config
+        Configuration.new
+      end
+    end
+    
+    class Configuration
+      def before_configuration
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: redis_cache_mailer_delivery
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Yi Wen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: &70203010834820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70203010834820
+- !ruby/object:Gem::Dependency
+  name: redis-objects
+  requirement: &70203010834180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70203010834180
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: &70203010833380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70203010833380
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70203010832580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70203010832580
+- !ruby/object:Gem::Dependency
+  name: guard-rspectacle
+  requirement: &70203010831940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70203010831940
+- !ruby/object:Gem::Dependency
+  name: growl
+  requirement: &70203010831400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70203010831400
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: &70203010830820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70203010830820
+description: Use Redis to store the Mail::Message when using in Rails
+email:
+- hayafirst@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/redis_cache_mailer_delivery.rb
+- lib/redis_cache_mailer_delivery/action_mailer/base.rb
+- lib/redis_cache_mailer_delivery/mail/cache_delivery.rb
+- lib/redis_cache_mailer_delivery/railtie.rb
+- lib/redis_cache_mailer_delivery/version.rb
+- redis_cache_mailer_delivery.gemspec
+- spec/redis_cache_mailer_delivery_spec.rb
+- spec/spec_helper.rb
+- spec/support/faked_rails.rb
+homepage: https://github.com/ywen/redis_cache_mailer_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.17
+signing_key: 
+specification_version: 3
+summary: Use Redis to store the Mail::Message when using in Rails
+test_files:
+- spec/redis_cache_mailer_delivery_spec.rb
+- spec/spec_helper.rb
+- spec/support/faked_rails.rb