ynw-ar_mailer 0.0.1

data/History.txt

@@ -0,0 +1,135 @@
+= 2.1.5
+
+* Bugs fixed
+  * Load ar_mailer after environment to fix issue with lazy loading of ActionMailer in Rails 2.3
+
+= 2.1.4
+
+* Bugs fixed
+  * Explicitly require ar_mailer in ar_sendmail because its not getting loaded by the Rails environment for some reason
+
+= 2.1.3
+
+* Tests now pass on gem install
+* Removed deprecated ActionMailer::ARMailer class
+* Bugs fixed
+  * Fixed issue with pre-loading ActionMailer. No use ActionMailer::Base.email_class directly rather than store in ARSendmail instance var so no need to pre-load ActionMailer.
+
+= 2.1.2
+
+* Bugs fixed
+  * Require ar_mailer in ar_sendmail since the change to remove TableName and use email_class
+
+= 2.1.1
+ 
+ * Force gem rebuild
+
+= 2.1.0
+
+* Switched to using a Rails generator for migration and model files. The ar_sendmail options have been removed.
+
+= 2.0.2
+
+* Removed TableName option from ar_sendmail options as its redundant. The Rails environment gets loaded so the settings for email class also get loaded
+* Bugs fixed
+  * Email class reloading issue in development mode causing AR email class defaults to be lost when cached
+
+= 2.0.1
+
+* Added option to use smtp setting of :tls => false to disable TLS auto start in Ruby 1.8.7+
+* Removed some cruft which can be handled by ActiveSupport
+
+= 2.0.0
+
+* Removed need to use ARMailer subclass. Just set the delivery method and you are ready to go. Backwards compatible with a deprecation notice if you subclass old ARMailer class.
+* Only include SMTP TLS patch if Ruby version < 1.8.7 as it has an alternative. Changes based on Calvin Yu's [cyu] fork.
+* Renamed default migration name to the modern Rails default
+* Only authenticate if emails waiting to be sent
+* Added --version switch to ar_sendmail binary
+* Created a lighthouse account for this project (adzap fork only). See README.
+
+= 1.4.4
+
+* Exit init.d script with message if no mailers defined.
+
+= 1.4.3
+
+* Bugs fixed
+  * Replaced mistaken call to log when removing pid file artifact for 
+    non-running daemon
+
+= 1.4.2
+
+* New Features
+  * Added Ruby based linux init.d script for handling daemon startup using yaml
+    config file. See files share/linux/ar_sendmail and ar_sendmail.conf
+* Bugs fixed
+  * Proper handling for relative and absolute paths for the pid file
+* Removed hoe dependency since we need the explicit gemspec file for github and 
+  not deploying to RubyForge its not as useful.
+* Moved old BSD rc.d script to share/bsd folder 
+* Updated README with github gem install, docs and init script info
+ 
+= 1.4.1
+
+* Bugs fixed
+  * Daemon failed on startup fixed with expanding full path of pid file
+
+= 1.4.0
+
+* Forked gem and published on GitHub (gem sources -a http://gems.github.com)
+* New Features
+  * Added pid file creation on daemonize with command line option to specify pid filename [Dylan Egan]
+
+= 1.3.1
+
+* Fix bug #12530, gmail causes SSL errors.  Submitted by Kyle Maxwell
+  and Alex Ostleitner.
+* Try ActionMailer::Base::server_settings then ::smtp_settings.  Fixes
+  bug #12516.  Submitted by Alex Ostleitner.
+
+= 1.3.0
+
+* New Features
+  * Added automatic mail queue cleanup.
+    * MAY CAUSE LOSS OF DATA.  If you haven't run ar_sendmail within
+      the expiry time, set it to 0.
+* Bugs fixed
+  * Authentication errors are now handled by retrying once.
+
+= 1.2.0
+
+* Bugs fixed
+  * Handle SMTPServerBusy by backing off @delay seconds then re-queueing
+  * Allow email delivery class to be set in ARMailer.
+  * ar_sendmail --mailq works with --table-name now.
+* Miscellaneous Updates
+  * Added documentation to require 'action_mailer/ar_mailer' in
+    instructions.
+  * Moved to ZSS p4 repository
+  * Supports TLS now.  Requested by Dave Thomas. smtp_tls.rb from Kyle
+    Maxwell & etc.
+
+= 1.1.0
+
+* Features
+  * Added --chdir to set rails directory
+  * Added --environment to set RAILS_ENV
+  * Exits cleanly on TERM or INT signals
+  * Added FreeBSD rc.d script
+  * Exceptions during SMTP sending are now logged
+  * No longer waits if sending email took too long
+* Bugs fixed
+  * Fixed last send attempt in --mailq
+  * Better SMTP error handling
+    * Messages are removed from the queue on 5xx errors
+    * Added Net::SMTP.reset to avoid needing to recreate the connection
+
+= 1.0.1
+
+* Bugs fixed
+  * From and to of email destination were swapped
+
+= 1.0.0
+
+* Birthday

data/LICENSE.txt

@@ -0,0 +1,28 @@
+Original code copyright 2006, 2007, Eric Hodel, The Robot Co-op.  All
+rights reserved.  Some code under other license, see individual files
+for details.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+3. Neither the names of the authors nor the names of their contributors
+   may be used to endorse or promote products derived from this software
+   without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS
+OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
+OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.rdoc

@@ -0,0 +1,165 @@
+= ar_mailer
+
+A two-phase delivery agent for ActionMailer
+
+GitHub Project:
+
+http://rubyforge.org/projects/seattlerb
+
+Documentation:
+
+http://seattlerb.rubyforge.org/ar_mailer/
+
+== About ar_mailer
+
+Even delivering email to the local machine may take too long when you have to
+send hundreds of messages.  ar_mailer allows you to store messages into the
+database for later delivery by a separate process, ar_sendmail.
+
+== About this fork
+
+GitHub Project:
+
+http://github.com/artemv/ar_mailer
+
+We didn't really needed ar_mailer - instead we wanted to digest error email notifications sent by ExceptionNotifier.
+Sometimes Prod can face some issue that make it error like hell. There's no need to receive these errors one by one - we wanted them to be combined into digest periodically - in our case SMTP provider's tariff plan limits outgoing messages number. So we used adzap-ar_mailer for error messages buffering and then made it combine them to digests based on To field. Also we already had BackgrounDRB so we didn't need separate ar_sendmail process. So, what does this fork do out of the box:
+ 
+* ARMailer messages don't get send until they are combined into digests
+
+* all messages to same addressee are combined into one digest email
+
+* it only supports text/plain messages
+
+* if the digest mail is too big it gets truncated, and full digest is dumped to a file on server; truncated digest will tell about it
+
+* the sending itself can be triggered by method call, so now you have options to use ar_sendmail process or smth else, e.g. BackgrounDRB job
+
+* you can specify :smtp_settings to be used when sending digests: we needed it to be other than default ActionMailer::Base.smtp_settings
+
+Usage example:
+
+    ActionMailer::ARSendmail.digest_error_emails :dump_path => '/var/log/myapp',
+                                                 :subj_prefix => ExceptionNotifier.email_prefix,
+                                                 :smtp_settings =>   {:address =>     "localhost",
+                                                      :port =>        25,
+                                                      :domain =>      'my_domain.com',
+                                                      :tls =>          false,}
+
+Adzap's fork is great because you can use ar_mailer for just one class with it - just what we needed. So we decided to opensource our tweaks in hope that it will be helpful for someone. The code is quite limited but it's fine for our needs, and if you need more you have smth to start with. E.g. it could be improved to support text/html messages or to make certain classes bypass digesting when sending emails with ARMailer.
+
+The fork is contributed by Your Net Works, Inc.
+
+== Installing ar_mailer (forked)
+
+Before installing you will need to make sure the original gem is uninstalled as they can't coexist:
+
+  $ sudo gem uninstall ar_mailer
+
+Install the gem from Gemcutter gems server:
+
+First, if you haven't already:
+
+  $ sudo gem sources -a http://gemcutter.org
+
+Then
+
+  $ sudo gem install ynw-ar_mailer
+
+For Rails >= 2.1, in your environment.rb:
+  
+  config.gem "ynw-ar_mailer", :lib => 'action_mailer/ar_mailer', :source => 'http://gemcutter.org'
+
+For Rails 2.0, in an initializer file:
+
+  require 'action_mailer/ar_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 ar_mailer -h
+
+Then run with defaults
+
+  ./script/generate ar_mailer
+
+Or specify a custom model name
+
+  ./script/generate ar_mailer Newsletter
+
+See Alternate Mail Storage if you use a custom model name
+
+In your mailer class methods you must be sure to set the From address for your emails.
+Something like:
+
+  def list_send(recipient)
+    from 'no_reply@example.com'
+    # ...
+
+Edit config/environments/production.rb and set the delivery method:
+
+  config.action_mailer.delivery_method = :activerecord
+
+Or if you need to, you can set each mailer class delivery method individually:
+
+  class MyMailer < ActionMailer::Base
+    self.delivery_method = :activerecord
+  end
+
+This can be useful when using plugins like ExceptionNotification. Where it
+might be foolish to tie the sending of the email alert to the database when the 
+database might be causing the exception being raised. In this instance you could
+override ExceptionNofitier delivery method to be smtp or set the other 
+mailer classes to use ARMailer explicitly.
+
+Then to run it:
+
+  $ ar_sendmail
+
+You can also run it from cron with -o, or as a daemon with -d.
+
+See <tt>ar_sendmail -h</tt> for full details.
+
+=== Alternate Mail Storage
+
+By default ar_mailer assumes you are using an ActiveRecord model called
+Email to store the emails created before sending. If you want to change
+this you alter it in an intializer like so:
+
+  ActionMailer::Base.email_class = Newsletter
+
+=== A Word on TLS
+
+If you are using Ruby >= 1.8.7, TLS will be enabled automatically if your
+SMTP server supports it. If you do not want it to automatically enabled then
+set the :tls option to false in your smtp_settings.
+
+If you are on Ruby <= 1.8.6, then the TLS patch included in this plugin will
+be loaded, so you don't need another TLS plugin to add the capability. This 
+patch allows you to explicit set if the server supports TLS by setting the
+:tls option to true in your smtp_settings.
+
+=== Help
+
+See ar_sendmail -h for options to ar_sendmail.
+
+NOTE: You may need to delete an smtp_tls.rb file if you have one lying
+around.  ar_mailer supplies it own.
+
+== Run as a service (init.d/rc.d scripts)
+
+For Linux both script and demo config files are in share/linux. 
+See ar_sendmail.conf for setting up your config. Copy the ar_sendmail file 
+to /etc/init.d/ and make it executable. Then for Debian based distros run
+'sudo update-rc.d ar_sendmail defaults' and it should work. Make sure you have 
+the config file /etc/ar_sendmail.conf in place before starting.
+
+For FreeBSD or NetBSD script is share/bsd/ar_sendmail. This is old and does not
+support the config file unless someone wants to submit a patch.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+$:.unshift(File.expand_path(File.dirname(__FILE__) + '/lib'))
+
+require './lib/action_mailer/ar_sendmail'
+ 
+ar_mailer_gemspec = Gem::Specification.new do |s|
+  s.name = %q{ar_mailer}
+  s.version = ActionMailer::ARSendmail::VERSION
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Eric Hodel", "Adam Meehan"]
+  s.default_executable = %q{ar_sendmail}
+  s.description = %q{Even delivering email to the local machine may take too long when you have to send hundreds of messages.  ar_mailer allows you to store messages into the database for later delivery by a separate process, ar_sendmail.}
+  s.email = %q{adam.meehan@gmail.com}
+  s.executables = ["ar_sendmail"]
+  s.extra_rdoc_files = ["History.txt", "LICENSE.txt", "README.rdoc"]
+  s.files = ["History.txt", "LICENSE.txt", "README.rdoc", "Rakefile", "bin/ar_sendmail", "generators/ar_mailer/ar_mailer_generator.rb", "generators/ar_mailer/templates/migration.rb", "generators/ar_mailer/templates/model.rb", "lib/action_mailer/ar_mailer.rb", "lib/action_mailer/ar_sendmail.rb", "lib/smtp_tls.rb", "share/bsd/ar_sendmail", "share/linux/ar_sendmail", "share/linux/ar_sendmail.conf", "test/resources/action_mailer.rb", "test/test_armailer.rb", "test/test_arsendmail.rb", "test/test_helper.rb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/adzap/ar_mailer}
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{seattlerb}
+  s.summary = %q{A two-phase delivery agent for ActionMailer}
+  s.test_files = ["test/test_armailer.rb", "test/test_arsendmail.rb"]
+end 
+
+Rake::GemPackageTask.new(ar_mailer_gemspec) do |pkg|
+  pkg.gem_spec = ar_mailer_gemspec
+end
+ 
+desc "Update ar_mailer.gemspec"
+task :make_spec do
+  File.open("ar_mailer.gemspec", "w") do |f|
+    f.puts(ar_mailer_gemspec.to_ruby)
+  end
+end
+ 
+desc "Build packages and install"
+task :install => :package do
+  sh %{sudo gem install --local --test pkg/ar_mailer-#{ActionMailer::ARSendmail::VERSION}}
+end
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the ar_mailer gem.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib' << 'test'
+  t.test_files = FileList['test/**/test_*.rb'].exclude("test/test_helper.rb")
+  t.verbose = true
+end

data/bin/ar_sendmail

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'action_mailer/ar_sendmail'
+
+ActionMailer::ARSendmail.run
+

data/generators/ar_mailer/ar_mailer_generator.rb

@@ -0,0 +1,25 @@
+class ArMailerGenerator < 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/ar_mailer/templates/migration.rb

@@ -0,0 +1,16 @@
+class <%= migration_name %> < ActiveRecord::Migration
+  def self.up
+    create_table :<%= table_name %> do |t|
+      t.column :from, :string
+      t.column :to, :string
+      t.column :last_send_attempt, :integer, :default => 0
+      t.column :mail, :text
+      t.column :created_on, :datetime
+      t.column :ready, :boolean, :default => 0, :null => false
+    end
+  end
+
+  def self.down
+    drop_table :<%= table_name %>
+  end
+end

data/generators/ar_mailer/templates/model.rb

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

data/lib/action_mailer/ar_mailer.rb

@@ -0,0 +1,31 @@
+##
+# Adds sending email through an ActiveRecord table as a delivery method for
+# ActionMailer.
+#
+
+class ActionMailer::Base
+
+  ##
+  # Set the email class for deliveries. Handle class reloading issues which prevents caching the email class.
+  #
+  @@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
+
+  ##
+  # Adds +mail+ to the Email table.  Only the first From address for +mail+ is
+  # used.
+
+  def perform_delivery_activerecord(mail)
+    mail.destinations.each do |destination|
+      self.class.email_class.create :mail => mail.encoded, :to => destination, :from => mail.from.first
+    end
+  end
+
+end