cached_mailer 0.0.1.pre1

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) 2009 Scenario4
+
+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,60 @@
+= Cached Mailer
+
+Cached Mailer simply stores a copy of all the email you send with ActionMailer to the database. The template used is also stored so you can run queries on the database for specific emails.
+
+Note: This gem was almost completely taken from ar_mailer. It basically does the same thing, but instead actually sends the emails at a later date. This doesn't work well on Heroku, so I made cached_mailer to simply store the emails for record keeping purposes.
+
+== Installing Cached Mailer
+
+First, if you haven't already:
+
+  $ sudo gem install gemcutter
+  $ sudo gem tumble
+
+Then
+
+  $ sudo gem install cached_mailer
+  
+For Rails >= 2.1, in your environment.rb:
+
+  config.gem "cached_mailer", :lib => 'action_mailer/cached_mailer', :source => 'http://gemcutter.com'
+
+For Rails 2.0, in an initializer file:
+
+  require 'action_mailer/cached_mailer'
+
+== Usage
+
+Go to your Rails project:
+
+  $ cd your_rails_project
+
+Create the migration and model:
+
+This shows the options which are only the model name, which defaults to Email
+
+  ./script/generate cached_mailer -h
+
+Then run with defaults
+
+  ./script/generate cached_mailer
+
+Or specify a custom model name
+
+  ./script/generate cached_mailer Newsletter
+
+Done! All the emails you send with ActionMailer will automagically be cached to the database for later reference.
+
+== 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) 2009 Scenario4. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "cached_mailer"
+    gem.summary = %Q{Email caching for ActionMailer - for when you want to keep track of sent emails}
+    gem.description = %Q{Cached Mailer simply stores a copy of all the email you send with ActionMailer to the database. The template used is also stored so you can run queries on the database for specific emails.}
+    gem.email = "mhodgson@scenario4.com"
+    gem.homepage = "http://github.com/mhodgson/cached_mailer"
+    gem.authors = ["mhodgson"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "cached_mailer #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1.pre1

data/cached_mailer.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{cached_mailer}
+  s.version = "0.0.1.pre1"
+
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.authors = ["mhodgson"]
+  s.date = %q{2009-12-12}
+  s.description = %q{Cached Mailer simply stores a copy of all the email you send with ActionMailer to the database. The template used is also stored so you can run queries on the database for specific emails.}
+  s.email = %q{mhodgson@scenario4.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "cached_mailer.gemspec",
+     "generators/cached_mailer_generators.rb",
+     "generators/templates/migration.rb",
+     "generators/templates/model.rb",
+     "lib/action_mailer/cached_mailer.rb",
+     "test/helper.rb",
+     "test/test_cached_mailer.rb"
+  ]
+  s.homepage = %q{http://github.com/mhodgson/cached_mailer}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Email caching for ActionMailer - for when you want to keep track of sent emails}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_cached_mailer.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/generators/cached_mailer_generators.rb

@@ -0,0 +1,25 @@
+class CachedMailerGenerator < Rails::Generator::NamedBase
+
+  def initialize(runtime_args, runtime_options = {})
+    runtime_args.unshift('Email') if runtime_args.empty?
+    super
+  end
+
+  def manifest
+    record do |m|
+      m.class_collisions class_name
+      
+      m.template 'model.rb', File.join('app/models', class_path, "#{file_name}.rb")
+      
+      m.migration_template 'migration.rb', 'db/migrate', :assigns => {
+        :migration_name => "Create#{class_name.pluralize.gsub(/::/, '')}"
+      }, :migration_file_name => "create_#{file_path.gsub(/\//, '_').pluralize}"
+    end
+  end
+  
+  protected
+    def banner
+      "Usage: #{$0} #{spec.name} EmailModelName (default: Email)"
+    end
+
+end

data/generators/templates/migration.rb

@@ -0,0 +1,15 @@
+class <%= migration_name %> < ActiveRecord::Migration
+  def self.up
+    create_table :<%= table_name %> do |t|
+      t.column :from, :string
+      t.column :to, :string
+      t.column :template, :string
+      t.column :mail, :text
+      t.column :created_on, :datetime
+    end
+  end
+
+  def self.down
+    drop_table :<%= table_name %>
+  end
+end

data/generators/templates/model.rb

@@ -0,0 +1,2 @@
+class <%= class_name %> < ActiveRecord::Base
+end

data/lib/action_mailer/cached_mailer.rb

@@ -0,0 +1,20 @@
+class ActionMailer::Base
+
+  @@email_class_name = 'Email'
+  
+  def self.email_class=(klass)
+    @@email_class_name = klass.to_s
+  end
+  
+  def self.email_class
+    @@email_class_name.constantize
+  end
+  
+  def deliver_with_cache!(mail)
+    mail.destinations.each do |destination|
+      self.class.email_class.create :mail => mail.encoded, :to => destination, :from => mail.from.first, :template => @template
+    end
+  end
+  alias_method_chain :deliver!, :cache
+
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'cached_mailer'
+
+class Test::Unit::TestCase
+end

data/test/test_cached_mailer.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestCachedMailer < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: cached_mailer
+version: !ruby/object:Gem::Version 
+  version: 0.0.1.pre1
+platform: ruby
+authors: 
+- mhodgson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-12 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Cached Mailer simply stores a copy of all the email you send with ActionMailer to the database. The template used is also stored so you can run queries on the database for specific emails.
+email: mhodgson@scenario4.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- cached_mailer.gemspec
+- generators/cached_mailer_generators.rb
+- generators/templates/migration.rb
+- generators/templates/model.rb
+- lib/action_mailer/cached_mailer.rb
+- test/helper.rb
+- test/test_cached_mailer.rb
+has_rdoc: true
+homepage: http://github.com/mhodgson/cached_mailer
+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: 1.3.1
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Email caching for ActionMailer - for when you want to keep track of sent emails
+test_files: 
+- test/helper.rb
+- test/test_cached_mailer.rb