adzap-ar_mailer 1.4.1 → 1.4.2

data/History.txt

@@ -1,3 +1,15 @@
+= 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

data/Manifest.txt

@@ -7,7 +7,9 @@ bin/ar_sendmail
 lib/action_mailer/ar_mailer.rb
 lib/action_mailer/ar_sendmail.rb
 lib/smtp_tls.rb
-share/ar_sendmail
+share/bsd/ar_sendmail
+share/linux/ar_sendmail
+share/linux/ar_sendmail.conf
 test/action_mailer.rb
 test/test_armailer.rb
 test/test_arsendmail.rb

data/README.txt

@@ -10,6 +10,10 @@ Documentation:
 
 http://seattlerb.org/ar_mailer
 
+and for forked additions
+
+http://github.com/adzap/ar_mailer/wikis
+
 Bugs:
 
 http://rubyforge.org/tracker/?func=add&group_id=1513&atid=5921
@@ -20,11 +24,17 @@ 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.
 
-== Installing ar_mailer
+== Installing ar_mailer (forked)
+
+Install the gem from GitHub gems server:
+
+First, if you haven't already
+
+  $ sudo gem sources -a http://gems.github.com
 
-Just install the gem:
+Then
 
-  $ sudo gem install ar_mailer
+  $ sudo gem install adzap-ar_mailer
 
 See ActionMailer::ARMailer for instructions on converting to ARMailer.
 
@@ -33,7 +43,13 @@ 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.
 
-=== ar_sendmail on FreeBSD or NetBSD
+=== init.d/rc.d scripts
 
-An rc.d script is included in share/ar_sendmail.
+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

@@ -1,14 +1,60 @@
-require 'hoe'
+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"]
+  s.date = %q{2008-07-04}
+  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{drbrain@segment7.net}
+  s.executables = ["ar_sendmail"]
+  s.extra_rdoc_files = ["History.txt", "LICENSE.txt", "Manifest.txt", "README.txt"]
+  s.files = ["History.txt", "LICENSE.txt", "Manifest.txt", "README.txt", "Rakefile", "bin/ar_sendmail", "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/action_mailer.rb", "test/test_armailer.rb", "test/test_arsendmail.rb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://seattlerb.org/ar_mailer}
+  s.rdoc_options = ["--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{seattlerb}
+  s.rubygems_version = %q{1.2.0}
+  s.summary = %q{A two-phase delivery agent for ActionMailer}
+  s.test_files = ["test/test_armailer.rb", "test/test_arsendmail.rb"]
+end 
 
-Hoe.new 'ar_mailer', ActionMailer::ARSendmail::VERSION do |s|
-  s.rubyforge_name = 'seattlerb'
-  s.summary = s.paragraphs_of('README.txt', 1).join(' ')
-  s.description = s.paragraphs_of('README.txt', 9).join(' ')
-  s.url = s.paragraphs_of('README.txt', 5).join(' ')
-  s.author = 'Eric Hodel'
-  s.email = 'drbrain@segment7.net'
-  s.changes = s.paragraphs_of('History.txt', 0..1).join("\n\n")
+Rake::GemPackageTask.new(ar_mailer_gemspec) do |pkg|
+  pkg.gem_spec = ar_mailer_gemspec
+end
+ 
+namespace :gem do
+  namespace :spec do
+    desc "Update ar_mailer.gemspec"
+    task :generate do
+      File.open("ar_mailer.gemspec", "w") do |f|
+        f.puts(ar_mailer_gemspec.to_ruby)
+      end
+    end
+  end
+end
+ 
+desc "Build packages and install"
+task :install => :package do
+  sh %{sudo gem install --local 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.pattern = 'test/**/test_*.rb'
+  t.verbose = true
+end

data/lib/action_mailer/ar_sendmail.rb

@@ -54,7 +54,7 @@ class ActionMailer::ARSendmail
   ##
   # The version of ActionMailer::ARSendmail you are running.
 
-  VERSION = '1.4.1'
+  VERSION = '1.4.2'
 
   ##
   # Maximum number of times authentication will be consecutively retried
@@ -351,7 +351,7 @@ end
 
     if options[:Daemon] then
       require 'webrick/server'
-      @@pid_file = File.expand_path(options[:Pidfile])
+      @@pid_file = File.expand_path(options[:Pidfile], options[:Chdir])
       if File.exists? @@pid_file
         # check to see if process is actually running
         pid = ''

data/share/linux/ar_sendmail

@@ -0,0 +1,75 @@
+#!/usr/bin/env ruby
+#
+# ar_sendmail Startup script for ar_mailer by Adam Meehan
+#
+# chkconfig: - 85 15
+# description: ar_sendmail manages sending emails for Rails apps. 
+#
+require 'yaml'
+
+# Config file app mailers
+config_file = '/etc/ar_sendmail.conf'
+
+begin
+  config = YAML::load(IO.read(config_file)) 
+rescue Errno::ENOENT
+  puts "Config file not found at '#{config_file}'!"
+  exit
+end
+
+default_options = {'pidfile' => './log/ar_sendmail.pid'}.merge(config.delete('defaults') || {})
+
+command, app_name = *ARGV
+
+def start(app, options)
+  switches = ""
+  options.each {|k, v| switches << " --#{k} #{v}"}
+  STDOUT.write "Starting mailer for #{app} in #{options['environment']} mode ... "
+  status = system("ar_sendmail -d #{switches}") ? "started" : "failed"
+  puts status
+end
+
+def stop(app, options)
+  path = options['chdir']
+  pid_file = File.expand_path(options['pidfile'], path)
+  if File.exist? pid_file
+    begin
+      pid = open(pid_file).read.to_i
+      STDOUT.write "Stopping mailer for #{app}... "
+      Process.kill('TERM', pid)
+      puts "stopped"
+    rescue Errno::ESRCH
+      puts "Mailer process does not exist. Is not running."
+    end
+  else
+    puts "Skipping mailer for #{app}, no pid file."
+  end
+end
+
+def restart(app, options)
+  puts "Restarting mailer for #{app} ..."
+  stop app, options  
+  start app, options
+end
+
+def command_error(msg)
+  puts msg
+  exit
+end
+
+if ['start', 'stop', 'restart'].include?(command)
+  apps = config
+  if app_name
+    command_error "No such app defined in ar_sendmail config" unless config.include?(app_name)
+    app_options = config[app_name]
+    command_error "Must specify chdir for app in ar_sendmail config" if app_options['chdir'].nil?    
+    apps = {app_name => app_options}
+  end
+
+  apps.each do |app, options|     
+    options = default_options.merge(options)
+    send(command, app, options)
+  end
+else
+  command_error "Usage: ar_sendmail {start|stop|restart} [optional app_name]"
+end

data/share/linux/ar_sendmail.conf

@@ -0,0 +1,30 @@
+# This is a configuration file for ar_sendmail daemon init.d script
+#
+# Define the settings for each app which has a mailer that you want start 
+# automatically on startup.
+#
+# You can define an optional defaults section which will apply to all 
+# applications unless the setting is specified under the applications specific 
+# config.
+#
+# Settings not specified in either the defaults or app config section will
+# be implied by the gem binary defaults. The option names are the same as the 
+# long format binary option switches. Run 'ar_sendmail -h' to see option switches
+# and default values.
+#
+# Copy this file to /etc/ar_sendmail.conf and it will be read by the init.d
+# script.
+#
+
+## Demo app config
+#
+#defaults:
+#  batch-size: 10
+#  max-age: 0
+#  delay: 60
+#
+#app_name:
+#  chdir: /var/www/apps/app_name
+#  environment: production
+#  pidfile: ./log/ar_sendmail.pid
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: adzap-ar_mailer
 version: !ruby/object:Gem::Version 
-  version: 1.4.1
+  version: 1.4.2
 platform: ruby
 authors: 
 - Eric Hodel
@@ -9,18 +9,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-07-03 00:00:00 -07:00
+date: 2008-07-04 00:00:00 -07:00
 default_executable: ar_sendmail
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.7.0
-    version: 
+dependencies: []
+
 description: 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.
 email: drbrain@segment7.net
 executables: 
@@ -42,7 +34,9 @@ files:
 - lib/action_mailer/ar_mailer.rb
 - lib/action_mailer/ar_sendmail.rb
 - lib/smtp_tls.rb
-- share/ar_sendmail
+- share/bsd/ar_sendmail
+- share/linux/ar_sendmail
+- share/linux/ar_sendmail.conf
 - test/action_mailer.rb
 - test/test_armailer.rb
 - test/test_arsendmail.rb