ar_mailer_service 0.1.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.1.0 / 2007-10-26
+
+* launched
+

data/Manifest.txt

@@ -0,0 +1,11 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/ar_sendmail_daemon
+bin/ar_sendmail_service
+lib/ar_mailer_service.rb
+lib/ar_mailer_service/ar_sendmail.rb
+lib/ar_mailer_service/service.rb
+lib/ar_mailer_service/daemon.rb
+test/test_ar_mailer_service.rb

data/README.txt

@@ -0,0 +1,82 @@
+ar_mailer_service
+    by Adam Meehan
+    http://armailerservice.rubyforge.org/
+
+== DESCRIPTION:
+  
+A windows service for the ar_mailer gem by Eric Hodel (http://segment7.com/) from the Seattle.rb https://rubyforge.org/projects/seattlerb/.
+
+== FEATURES/PROBLEMS:
+
+Creates a windows service to run the ar_sendmail script from the ar_mailer gem using a subset of settings which apply to a service. 
+
+== SYNOPSIS:
+
+To install as windows service:
+
+  ar_sendmail_service install -N rails_app_mailer -c c:/my/app/root -e production  
+  
+  For an explanation of options see the ar_mailer gem by running
+
+  ar_sendmail -h
+
+  only the -c, -e, -b, --delay and --max-age options apply to the service
+
+  
+To remove service:
+
+  ar_sendmail_service remove -N rails_app_mailer
+  
+  OR
+  
+  sc.exe delete rails_app_mailer (Windows service controller)
+
+To start service:
+
+  ar_sendmail_service start -N rails_app_mailer
+
+  OR
+  
+  net start rails_app_mailer
+
+To stop service:
+
+  ar_sendmail_service stop -N rails_app_mailer
+  
+  OR
+  
+  net stop rails_app_mailer
+
+== REQUIREMENTS:
+
+ar_mailer gem
+win32-service gem required to run as service
+
+== INSTALL:
+
+gem install ar_mailer_service
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2007 Adam Meehan
+
+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/Rakefile

@@ -0,0 +1,20 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/ar_mailer_service.rb'
+
+Hoe.new('ar_mailer_service', ARMailerService::VERSION) do |p|
+  p.rubyforge_name = 'armailersvc'
+  p.author = 'Adam Meehan'
+  p.email = 'adam.meehan@gmail.com'
+  p.summary = 'A windows service for the ar_mailer gem'
+  p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
+  p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.extra_deps << ['win32-service', '>= 0.5.2']
+  p.extra_deps << ['ar_mailer', '>= 1.3.1']
+  p.remote_rdoc_dir = ''
+end
+
+# vim: syntax=Ruby

data/bin/ar_sendmail_daemon

@@ -0,0 +1,6 @@
+#!/usr/local/bin/ruby
+
+require 'ar_mailer_service/daemon'
+
+d = ARMailerService::Daemon.new(ARGV)
+d.mainloop

data/bin/ar_sendmail_service

@@ -0,0 +1,5 @@
+#!/usr/local/bin/ruby
+
+require 'ar_mailer_service/service'
+
+ARMailerService::Service.new.run(ARGV)

data/lib/ar_mailer_service/ar_sendmail.rb

@@ -0,0 +1,24 @@
+require 'action_mailer/ar_sendmail'
+
+module ActionMailer
+  
+  # The ARMailer class which does all the work defined in the ar_mailer gem.
+  class ARSendmail
+    
+    # This class method is required to allow the command args to be processed 
+    # and return an instance of ARSendmail. The :Once option is set so that 
+    # control is returned to the containing object after processing the mail,
+    # in this case the daemon object. Otherwise it is not possible to stop 
+    # the service once started, as ar_sendmail is designed to run standalone
+    # and exit on the TERM or INT signal which the windows service controller 
+    # does not send.
+    #
+    def self.setup(args = ARGV)
+      options = process_args(args)
+      options[:Once] = true
+      new(options)      
+    end 
+    
+  end
+end
+

data/lib/ar_mailer_service/daemon.rb

@@ -0,0 +1,30 @@
+require 'ar_mailer_service/ar_sendmail'
+require 'win32/service'
+
+module ARMailerService  
+  
+  class Daemon < Win32::Daemon    
+    attr_accessor :args, :mailer
+    
+    def initialize(args = ARGV)
+      @args = args      
+    end
+    
+    # Create an ARSendmail instance using the command line options, when service 
+    # is started.
+    def service_init
+      @mailer = ActionMailer::ARSendmail.setup(args)
+    end
+    
+    # while the service is running it executes the ARSendmail run method 
+    # every delay seconds, which sends any waiting mail.
+    def service_main      
+      while running?        
+        @mailer.run
+        # sleep for 1 second by the number of seconds in delay. This prevents process blocking in win32-service
+        @mailer.delay.times {sleep 1}        
+      end
+    end
+    
+  end
+end

data/lib/ar_mailer_service/service.rb

@@ -0,0 +1,166 @@
+require 'optparse'
+require 'win32/service'
+
+module ARMailerService 
+  class ServiceCommand    
+    attr_reader :command, :options
+    
+    def run(args)
+      @command = args.shift
+      @command = @command.dup.downcase if @command      
+      
+      parse(args)
+      @options
+    end
+    
+    def parse(args)
+      begin
+        options = {}        
+        
+        # This is a subset of options replicated from the ar_mailer gem
+        opts = OptionParser.new do |opts|
+          opts.banner = "Usage: ar_mailer_service <command> [options]"
+          opts.separator ""
+          opts.separator "Specific options:"
+          
+          opts.on("-N", "--name SERVICE_NAME", String, "Config file with projects session files to check") do |name|
+            options[:ServiceName] = name
+          end
+          
+          opts.on("-b", "--batch-size BATCH_SIZE",
+                  "Maximum number of emails to send per delay",
+                  "Default: Deliver all available emails", Integer) do |batch_size|
+            options[:BatchSize] = batch_size
+          end
+    
+          opts.on(      "--delay DELAY",
+                  "Delay between checks for new mail",
+                  "in the database",
+                  "Default: #{options[:Delay]}", Integer) do |delay|
+            options[:Delay] = delay
+          end
+    
+          opts.on(      "--max-age MAX_AGE",
+                  "Maxmimum age for an email. After this",
+                  "it will be removed from the queue.",
+                  "Set to 0 to disable queue cleanup.",
+                  "Default: #{options[:MaxAge]} seconds", Integer) do |max_age|
+            options[:MaxAge] = max_age
+          end
+          
+          opts.on("-c", "--chdir PATH",
+                  "Use PATH for the application path",
+                  "Default: #{options[:Chdir]}") do |path|            
+            options[:Chdir] = path
+          end
+          
+          opts.on("-e", "--environment RAILS_ENV",
+                  "Set the RAILS_ENV constant",
+                  "Default: #{options[:RailsEnv]}") do |env|
+            options[:RailsEnv] = env
+          end
+    
+          opts.on("-t", "--table-name TABLE_NAME",
+                  "Name of table holding emails",
+                  "Used for both sendmail and",
+                  "migration creation",
+                  "Default: #{options[:TableName]}") do |name|
+            options[:TableName] = name
+          end  
+    
+          opts.on_tail("-h", "--help", "Show this message") do
+            puts opts
+            exit
+          end
+        end
+        opts.parse!(args)
+        @options = options
+        validate_options
+        @options
+      rescue OptionParser::ParseError => e
+        puts e
+        puts opts
+      end
+    end  
+      
+    def validate_options
+      errors = []
+      errors << "Service name is required (switch -N)" unless @options[:ServiceName]      
+      errors << "App diretory is required (switch -c)" if !@options[:Chdir] && @command == 'install'
+      errors << "Rails environment is required (switch -e)" if !@options[:RailsEnv] && @command == 'install'
+      if errors.size > 0
+        puts "Error found."
+        puts errors.join("\n")
+        exit
+      end
+    end
+            
+  end
+  
+  class Service
+    attr_accessor :name
+    
+    def install
+      svc = Win32::Service.new      
+      begin
+        if Win32::Service.exists?(name)
+          puts "Service name '#{name}' already exists."
+          return
+        end 
+        
+        svc.create_service do |s|
+          s.service_name = name
+          s.display_name = name
+          s.binary_path_name = binary_path_name
+        end
+        
+        svc.close
+        puts "ARMailer service '#{name}' installed."
+      rescue => e
+        puts e.inspect
+      end      
+    end
+    
+    def start
+      Win32::Service.start(name)
+    end
+    
+    def stop    
+      Win32::Service.stop(name)
+    end
+    
+    def remove
+      begin
+        Win32::Service.stop(name)
+      rescue
+      end
+      
+      begin
+        Win32::Service.delete(name)
+        puts "'#{name}' service removed."
+      rescue => e
+        puts e.inspect
+      end      
+    end
+    
+    
+    # Sets up the command with options to execute when the service starts    
+    def binary_path_name      
+      path = "#{Config::CONFIG['bindir']}/rubyw #{Config::CONFIG['bindir']}/ar_sendmail_daemon"      
+      path << " -c #{@options[:Chdir]}"
+      path << " -e #{@options[:RailsEnv]}"
+      path << " -t #{@options[:TableName]}" if @options[:TableName]
+      path << " --delay #{@options[:Delay]}" if @options[:Delay]
+      path << " -b #{@options[:BatchSize]}" if @options[:BatchSize]
+      path << " --max-age #{@options[:MaxAge]}" if @options[:MaxAge]
+      path
+    end
+    
+    def run(args)
+      command = ARMailerService::ServiceCommand.new
+      @options = command.run(args)
+      self.name = @options[:ServiceName]      
+      self.send(command.command.to_sym)
+    end
+  end
+end

data/lib/ar_mailer_service.rb

@@ -0,0 +1,3 @@
+class ARMailerService
+  VERSION = '0.1.0'
+end

data/test/test_ar_mailer_service.rb

@@ -0,0 +1,60 @@
+require 'test/unit'
+require 'ar_mailer_service/ar_sendmail'
+require 'ar_mailer_service/service'
+require 'win32/service'
+
+class TestARMailerService < Test::Unit::TestCase  
+  
+  def setup    
+    @service_name = 'test_rails_mailer' 
+    @install_args = %w{install -N test_rails_mailer -c c:/test_app -e production -t Emails --delay 60 -b 10 --max-age 300}    
+  end
+  
+  def test_ar_sendmail_class_has_setup_method
+    assert ActionMailer::ARSendmail.respond_to?(:setup)
+  end 
+  
+  def test_service_command_created_with_correct_values    
+    sc = ARMailerService::ServiceCommand.new
+    sc.run( @install_args )
+    assert_equal 'install',  sc.command
+    assert_equal 'test_rails_mailer', sc.options[:ServiceName]
+    assert_equal 60,  sc.options[:Delay]
+    assert_equal 10,  sc.options[:BatchSize]
+    assert_equal 300, sc.options[:MaxAge]
+    assert_equal 'production', sc.options[:RailsEnv]
+    assert_equal 'c:/test_app', sc.options[:Chdir]
+    assert_equal 'Emails', sc.options[:TableName]
+  end
+  
+  def test_service_created_and_has_correct_binary_path
+    ARMailerService::Service.new.run( @install_args.dup )
+    
+    assert Win32::Service.exists?( @service_name )
+    svc = get_service @service_name
+    assert_match( /^#{ruby_bin_path} #{daemon_bin_path}/, svc.binary_path_name )    
+    args_str = @install_args[3..-1].join(' ')
+    
+    assert_match( /#{args_str}/, svc.binary_path_name )
+    
+    Win32::Service.delete( @service_name )
+  end
+
+  def ruby_bin_path
+    "#{Config::CONFIG['bindir']}/rubyw"
+  end
+  
+  def daemon_bin_path
+    "#{Config::CONFIG['bindir']}/ar_sendmail_daemon"
+  end
+  
+  def get_service(name)
+    svc = nil
+    Win32::Service.services { |s| svc = s if s.service_name == name }
+    svc
+  end
+  
+  def teardown
+    Win32::Service.delete( @service_name ) rescue nil  
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: ar_mailer_service
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+date: 2007-10-26 00:00:00 +10:00
+summary: A windows service for the ar_mailer gem
+require_paths: 
+- lib
+email: adam.meehan@gmail.com
+homepage: "    by Adam Meehan"
+rubyforge_project: armailersvc
+description: "== FEATURES/PROBLEMS:  Creates a windows service to run the ar_sendmail script from the ar_mailer gem using a subset of settings which apply to a service.   == SYNOPSIS:  To install as windows service:"
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Adam Meehan
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/ar_sendmail_daemon
+- bin/ar_sendmail_service
+- lib/ar_mailer_service.rb
+- lib/ar_mailer_service/ar_sendmail.rb
+- lib/ar_mailer_service/service.rb
+- lib/ar_mailer_service/daemon.rb
+- test/test_ar_mailer_service.rb
+test_files: 
+- test/test_ar_mailer_service.rb
+rdoc_options: 
+- --main
+- README.txt
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+executables: 
+- ar_sendmail_daemon
+- ar_sendmail_service
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: win32-service
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.5.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: ar_mailer
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: