echi-converter 0.2.1 → 0.3.0

data/History.txt

@@ -84,4 +84,22 @@
 * Major enhancement(s):
 * Minor enhancement(s):
 * Bug fix(es):
-  * Fixed the database schema to pull from the appropriate config file information for the PCO schema
+  * Fixed the database schema to pull from the appropriate config file information for the PCO schema
+
+== 0.2.2 2007-10-26
+
+* Major enhancement(s):
+* Minor enhancement(s):
+* Bug fix(es):
+  * Fixed the utility to only process files with the prefix 'chr' in order to avoid picking up other files from the 'to_process' directory
+  * Fixed the database_presence.rb to explicitly define tables rather than derive from the application.yml
+
+== 0.3.0 2007-11-02
+
+* Major enhancement(s):
+  * Added the ability to auto-recognize when running on Windows and enable running as a Windows Service (FR#14856/14852)
+* Minor enhancement(s):
+  * Changed 'echi_ftp_delete:' default setting to 'Y'
+  * A fair amount of internal code refactoring
+* Bug fix(es):
+  * Fixed bug so that the log file properly reports when a file is processed

data/Manifest.txt

@@ -8,6 +8,7 @@ lib/echi-converter/version.rb
 lib/database.rb
 lib/database_presence.rb
 lib/main.rb
+lib/main_win32.rb
 lib/echi-converter.rb
 scripts/txt2html
 setup.rb

data/bin/echi-converter

@@ -4,6 +4,32 @@ require 'daemons'
 require 'fileutils'
 include FileUtils
 
+usage = "Usage: 
+  echi-converter create myproject - create the local project to run the ECHI converter from (on Windows, directory names must not have spaces)
+  echi-converter upgrade myproject - location of project to upgrade after a new gem version is installed"
+
+#If we are running on Windows lets load the libraries necessary to run a win32 service
+if RUBY_PLATFORM["-mswin32"]
+  require 'win32/service'
+  include Win32
+  usage = usage +
+    "
+     echi-converter install myproject - install the service (must specify complete path such as c:\path\to\my\project )
+     echi-converter start - start the service
+     echi-converter stop - stop the service
+     echi-converter pause - pause the service
+     echi-converter resume - resume the service
+     echi-converter uninstall - uninstall the service
+     echi-converter delete - delete the service"
+else
+  usage = usage + 
+    "echi-converter run myproject - Run the ECHI converter interactively from the location given
+    echi-converter start myproject - Start the ECHI converter in daemon mode from the location given
+    echi-converter stop myproject - Stop the ECHI converter daemon
+    echi-converter restart myproject - Restart the ECHI converter 
+    echi-converter zap myproject - If there has been an unexpected close and the system still thinks the converter is running, clean up the pid files"
+end
+
 def set_operating_environ
   #Build details on the gem installed and its location and version
   gem_searcher = Gem::GemPathSearcher.new
@@ -15,7 +41,11 @@ end
 def create_project dir_name
   if dir_name == nil
     puts 'You must specify a directory name, proper usage is:'
-    puts 'echi-converter-create /path/to/my/directory'
+    if RUBY_PLATFORM['-mswin']
+      puts 'echi-converter create c:\path\to\my\directory'
+    else
+      puts 'echi-converter create /path/to/my/directory'
+    end
     puts 'Exiting...'
     exit
   end
@@ -70,7 +100,43 @@ def upgrade_project project_name
   puts 'Successfully upgraded ' + project_name
 end
 
-#Used launch dynamically or as a deamon
+#Launches as a Windows Service
+def launch_service run_type, project_name
+  service_status = nil
+  if project_name != nil
+    service_exe = "c:\\ruby\\bin\\rubyw.exe " + project_name + "\\lib\\main_win32.rb"
+  end
+  begin
+    case run_type
+    when "install"
+      s = Service.new()
+      s.create_service { |s|
+        s.service_name = "ECHI-Converter"
+        s.binary_path_name = service_exe
+        #s.service_type = Service::AUTO_START
+        s.display_name = "ECHI-Converter"
+        s.service_description = "ECHI-Converter Service for " + project_name
+      }
+      s.close
+    when "start"
+      Service.start("ECHI-Converter")
+    when "stop"
+      Service.stop("ECHI-Converter")
+    when "pause"
+      Service.pause("ECHI-Converter")
+    when "resume"
+      Service.resume("ECHI-Converter")
+    when "delete"
+      Service.delete("ECHI-Converter")
+    end
+    service_status = Service.status("ECHI-Converter")
+    return service_status.current_state
+  rescue => err
+    return err
+  end
+end
+
+#Launches dynamically or as a deamon for *NIX platforms
 def launch_project run_type, project_name
   
   #Set various file paths
@@ -113,17 +179,15 @@ if ARGV[0] == 'create'
   create_project ARGV[1]
 elsif ARGV[0] == 'upgrade'
   upgrade_project ARGV[1]
+elsif RUBY_PLATFORM["-mswin32"]
+  if ARGV[0] == 'install' || ARGV[0] == 'start' ||  ARGV[0] == 'stop' || ARGV[0] == 'pause' || ARGV[0] == 'resume' || ARGV[0] == 'uninstall' || ARGV[0] == 'delete' || ARGV[0] == 'status'
+    service_status = launch_service ARGV[0], ARGV[1]
+    puts 'ECHI-Converter: ' + service_status
+  else
+    puts usage
+  end
 elsif ARGV[0] == 'run' || ARGV[0] == 'start' || ARGV[0] == 'stop' || ARGV[0] == 'zap' || ARGV[0] == 'restart'
   launch_project ARGV[0], ARGV[1]
 else
-  usage = "Usage: 
-    echi-converter create myproject - create the local project to run the ECHI converter from
-    echi-converter upgrade myproject - location of project to upgrade after a new gem version is installed
-
-    echi-converter run myproject - Run the ECHI converter interactively from the location given
-    echi-converter start myproject - Start the ECHI converter in daemon mode from the location given
-    echi-converter stop myproject - Stop the ECHI converter daemon
-    echi-converter restart myproject - Restart the ECHI converter 
-    echi-converter zap myproject - If there has been an unexpected close and the system still thinks the converter is running, clean up the pid files"
   puts usage
-end
+end

data/config/application.yml

@@ -8,7 +8,7 @@ echi_password:
 echi_connect_type:  ftp #only ftp supported now, possible for ssh in the future
 echi_ftp_directory:  #/Users/ftp/anonymous #If blank/nil, the system will not do a CD at the start
 echi_ftp_retry: 3
-echi_ftp_delete:  N #to not delete the files off of the FTP server set to N
+echi_ftp_delete:  Y #to not delete the files off of the FTP server set to N, Y to delete the files
 echi_schema: extended_version13.yml
 echi_format: BINARY #valid settings are ASCII or BINARY
 echi_process_log: Y #valid is Y/N to turn it on or off
@@ -42,8 +42,4 @@ smtp_server: mail.presenceco.com
 smtp_port: 25
 
 #Special settings for a specific application database
-pco_process: N #Set to yes or no if running with a PCO database
-pco_record_tablename: PCO_ECHIRECORD
-pco_record_seqname: PCO_ECHIRECORDSEQ
-pco_log_tablename: PCO_ECHILOG
-pco_log_seqname: PCO_ECHILOGSEQ
+pco_process: N #Set to yes or no if running with a PCO database

data/config/install_files.yml

@@ -37,6 +37,7 @@ files_to_copy:
     - name: lib/database_presence.rb
     - name: lib/echi-converter.rb
     - name: lib/main.rb
+    - name: lib/main_win32.rb
     - name: lib/echi-converter/version.rb
     - name: examples/schemas/oracle_echi.sql
     
@@ -45,4 +46,5 @@ files_to_upgrade:
     - name: lib/database_presence.rb
     - name: lib/echi-converter.rb
     - name: lib/main.rb
+    - name: lib/main_win32.rb
     - name: lib/echi-converter/version.rb

data/lib/database_presence.rb

@@ -1,9 +1,9 @@
 class EchiRecord < ActiveRecord::Base
-  set_table_name @config["pco_record_tablename"]
-  set_sequence_name @config["pco_record_seqname"]
+  set_table_name "PCO_ECHIRECORD"
+  set_sequence_name "PCO_ECHIRECORDSEQ"
 end
 
 class EchiLog < ActiveRecord::Base
-  set_table_name @config["pco_log_tablename"]
-  set_sequence_name @config["pco_log_seqname"]
+  set_table_name "PCO_ECHILOG"
+  set_sequence_name "PCO_ECHILOGSEQ"
 end

data/lib/echi-converter.rb

@@ -15,10 +15,10 @@ end
 module EchiConverter
   
   def connect_database
-    databaseconfig = @workingdirectory + '/../config/database.yml'
-    dblogfile = @workingdirectory + '/../log/database.log'
-    ActiveRecord::Base.logger = Logger.new(dblogfile, @config["log_number"], @config["log_length"])  
-    case @config["log_level"]
+    databaseconfig = $workingdir + '/../config/database.yml'
+    dblogfile = $workingdir + '/../log/database.log'
+    ActiveRecord::Base.logger = Logger.new(dblogfile, $config["log_number"], $config["log_length"])  
+    case $config["log_level"]
       when 'FATAL'
         ActiveRecord::Base.logger.level = Logger::FATAL
       when 'ERROR'
@@ -41,9 +41,9 @@ module EchiConverter
   
   #Method to open our application log
   def initiate_logger
-    logfile = @workingdirectory + '/../log/application.log'
-    @log = Logger.new(logfile, @config["log_number"], @config["log_length"])
-    case @config["log_level"]
+    logfile = $workingdir + '/../log/application.log'
+    @log = Logger.new(logfile, $config["log_number"], $config["log_length"])
+    case $config["log_level"]
       when 'FATAL'
         @log.level = Logger::FATAL
       when 'ERROR'
@@ -60,10 +60,10 @@ module EchiConverter
   #Method to send alert emails
   def send_email_alert reason
     begin
-      Net::SMTP.start(@config["smtp_server"], @config["smtp_port"]) do |smtp|
-        smtp.open_message_stream('donotreply@echi-converter.rubyforge.org', [@config["alert_email_address"]]) do |f|
+      Net::SMTP.start($config["smtp_server"], $config["smtp_port"]) do |smtp|
+        smtp.open_message_stream('donotreply@echi-converter.rubyforge.org', [$config["alert_email_address"]]) do |f|
           f.puts "From: donotreply@echi-converter.rubyforge.org"
-          f.puts "To: " + @config['alert_email_address']
+          f.puts "To: " + $config['alert_email_address']
           f.puts "Subject: ECHI-Converter Failure"
           case reason 
           when "DATABASE"
@@ -140,7 +140,7 @@ module EchiConverter
   #Mehtod that performs the conversions
   def convert_binary_file filename
     #Open the file to process
-    echi_file = @workingdirectory + "/../files/to_process/" + filename
+    echi_file = $workingdir + "/../files/to_process/" + filename
     @binary_file = open(echi_file,"rb")
     @log.debug "File size: " + @binary_file.stat.size.to_s
     
@@ -150,7 +150,7 @@ module EchiConverter
     fileversion = dump_binary 'int', 4
     @log.debug "Version " + fileversion.to_s
 
-    if @config["echi_process_log"] == "Y"
+    if $config["echi_process_log"] == "Y"
       #Log the file
       echi_log = EchiLog.new
       echi_log.filename = filename
@@ -208,7 +208,7 @@ module EchiConverter
     #Move the file to the processed directory
     FileUtils.mv(echi_file, @processeddirectory)
     
-    if @config["echi_process_log"] == "Y"
+    if $config["echi_process_log"] == "Y"
       #Finish logging the details on the file
       echi_log.records = @record_cnt
       echi_log.processed_at = Time.now
@@ -221,9 +221,9 @@ module EchiConverter
   def connect_ftpsession
     #Open ftp connection
     begin
-      if @config["echi_connect_type"] == 'ftp'
-        ftp_session = Net::FTP.new(@config["echi_host"])
-        ftp_session.login @config["echi_username"], @config["echi_password"]
+      if $config["echi_connect_type"] == 'ftp'
+        ftp_session = Net::FTP.new($config["echi_host"])
+        ftp_session.login $config["echi_username"], $config["echi_password"]
         @log.info "Successfully connected to the ECHI FTP server"
       else
         #Stub for possible SSH support in the future
@@ -250,14 +250,14 @@ module EchiConverter
        sleep 5
      end
      attempts += 1
-     if @config["echi_ftp_retry"] == attempts
+     if $config["echi_ftp_retry"] == attempts
        ftp_session = 0
      end
    end
    if ftp_session != 0
      begin
-       if @config["echi_ftp_directory"] != nil
-         ftp_session.chdir(@config["echi_ftp_directory"])
+       if $config["echi_ftp_directory"] != nil
+         ftp_session.chdir($config["echi_ftp_directory"])
        end
        files = ftp_session.list('chr*')
        file_cnt = 0
@@ -265,10 +265,10 @@ module EchiConverter
          #ACTION:  Need to detect which OS we are running on and then parse the ftp data appropriately
          file_data = file.split(' ')
          remote_filename = file_data[8]
-         local_filename = @workingdirectory + '/../files/to_process/' + remote_filename
+         local_filename = $workingdir + '/../files/to_process/' + remote_filename
          ftp_session.getbinaryfile(remote_filename, local_filename)
          files_to_process[file_cnt] = remote_filename
-         if @config["echi_ftp_delete"] == 'Y'
+         if $config["echi_ftp_delete"] == 'Y'
            begin
              ftp_session.delete(remote_filename)
            rescue => err
@@ -287,9 +287,9 @@ module EchiConverter
 end
 
 def process_ascii filename
-  echi_file = @workingdirectory + "/../files/to_process/" + filename
+  echi_file = $workingdir + "/../files/to_process/" + filename
   
-  if @config["echi_process_log"] == "Y"
+  if $config["echi_process_log"] == "Y"
     #Log the file
     echi_log = EchiLog.new
     echi_log.filename = filename
@@ -333,7 +333,7 @@ def process_ascii filename
   #Move the file to the processed directory
   FileUtils.mv(echi_file, @processeddirectory)
   
-  if @config["echi_process_log"] == "Y"
+  if $config["echi_process_log"] == "Y"
     #Finish logging the details on the file
     echi_log.records = @record_cnt
     echi_log.processed_at = Time.now
@@ -343,4 +343,4 @@ def process_ascii filename
   return @record_cnt
 end
 
-require @workingdirectory + '/echi-converter/version.rb'
+require $workingdir + '/echi-converter/version.rb'

data/lib/echi-converter/version.rb

@@ -1,8 +1,8 @@
 module EchiConverter #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 2
-    TINY  = 1
+    MINOR = 3
+    TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/main.rb

@@ -2,57 +2,59 @@ require 'rubygems'
 require 'yaml'
 
 #Determine our working directory
-@workingdirectory = File.expand_path(File.dirname(__FILE__))
-require @workingdirectory + '/echi-converter.rb'
+$workingdir = File.expand_path File.dirname(__FILE__) 
+require $workingdir + '/echi-converter.rb'
 include EchiConverter
+  
 
 #Open the configuration file
-configfile = @workingdirectory + '/../config/application.yml' 
-@config = YAML::load(File.open(configfile))
+configfile = $workingdir + '/../config/application.yml' 
+$config = YAML::load(File.open(configfile))
 
 #Load ActiveRecord Models
-if @config["pco_process"] == 'Y'
-  require @workingdirectory + '/database_presence.rb'
+if $config["pco_process"] == 'Y'
+  require $workingdir + '/database_presence.rb'
 else
-  require @workingdirectory + '/database.rb'
+  require $workingdir + '/database.rb'
 end
 
 #Load the configured schema
-schemafile = @workingdirectory + "/../config/" + @config["echi_schema"]
+schemafile = $workingdir + "/../config/" + $config["echi_schema"]
 @echi_schema = YAML::load(File.open(schemafile))
 
 #Open the logfile with appropriate output level
 initiate_logger
   
 #If configured for database insertion, connect to the database
-if @config["export_type"] == 'database' || @config["export_type"] == 'both'
+if $config["export_type"] == 'database' || $config["export_type"] == 'both'
   connect_database
 end
 
 @log.info "Running..."
 
+#Our Main loop
 loop do
   #Process the files
   ftp_files = fetch_ftp_files
   #Grab filenames from the to_process directory after an FTP fetch, so if the 
   #system fails it may pick up where it left off
-  to_process_dir = @workingdirectory + "/../files/to_process/"
+  to_process_dir = $workingdir + "/../files/to_process/"
   
   #Establish where to copy the processed files to
-  @processeddirectory = set_directory(@workingdirectory)
+  @processeddirectory = set_directory($workingdir)
   
   Dir.entries(to_process_dir).each do | file |
-    if file != "." && file != ".."
-      if @config["echi_format"] == 'BINARY'
+    if file.slice(0,3) == 'chr'
+      if $config["echi_format"] == 'BINARY'
         record_cnt = convert_binary_file file
-      elsif @config["echi_format"] == 'ASCII'
+      elsif $config["echi_format"] == 'ASCII'
         record_cnt = process_ascii file
       end
+      @log.info "Processed file #{file} with #{record_cnt.to_s} records"
     end
-    @log.info "Processed file #{file} with #{record_cnt.to_s} records"
   end
 
-  sleep @config["fetch_interval"]
+  sleep $config["fetch_interval"]
 
   #Make sure we did not lose our database connection while we slept
   if ActiveRecord::Base.connected? == 'FALSE'

data/lib/main_win32.rb

@@ -0,0 +1,79 @@
+require 'rubygems'
+require 'yaml'
+require 'win32/service'
+include Win32
+
+class EchiDaemon < Daemon
+  #Determine our working directory
+  $workingdir = File.expand_path File.dirname(__FILE__) 
+  require $workingdir + '/echi-converter.rb'
+  include EchiConverter
+    
+  def initialize
+    #Open the configuration file
+    configfile = $workingdir + '/../config/application.yml' 
+    $config = YAML::load(File.open(configfile))
+
+    #Load ActiveRecord Models
+    if $config["pco_process"] == 'Y'
+      require $workingdir + '/database_presence.rb'
+    else
+      require $workingdir + '/database.rb'
+    end
+
+    #Load the configured schema
+    schemafile = $workingdir + "/../config/" + $config["echi_schema"]
+    @echi_schema = YAML::load(File.open(schemafile))
+
+    #Open the logfile with appropriate output level
+    initiate_logger
+  
+    #If configured for database insertion, connect to the database
+    if $config["export_type"] == 'database' || $config["export_type"] == 'both'
+      connect_database
+    end
+
+    @log.info "Running..."
+  end
+
+  def service_main
+    loop do
+      #Process the files
+      ftp_files = fetch_ftp_files
+      #Grab filenames from the to_process directory after an FTP fetch, so if the 
+      #system fails it may pick up where it left off
+      to_process_dir = $workingdir + "/../files/to_process/"
+  
+      #Establish where to copy the processed files to
+      @processeddirectory = set_directory($workingdir)
+  
+      Dir.entries(to_process_dir).each do | file |
+        if file.slice(0,3) == 'chr'
+          if $config["echi_format"] == 'BINARY'
+            record_cnt = convert_binary_file file
+          elsif $config["echi_format"] == 'ASCII'
+            record_cnt = process_ascii file
+          end
+          @log.info "Processed file #{file} with #{record_cnt.to_s} records"
+        end
+      end
+
+      sleep $config["fetch_interval"]
+
+      #Make sure we did not lose our database connection while we slept
+      if ActiveRecord::Base.connected? == 'FALSE'
+        connect_database
+      end
+    end
+  end
+
+  def service_cleanup
+    #Close the logfile
+    @log.info "Shutdown..."
+    @log.close
+  end
+end
+
+d = EchiDaemon.new
+d.mainloop
+d.service_cleanup

data/website/index.html

@@ -33,7 +33,7 @@
     <h1>ECHI Converter</h1>
     <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/echi-converter"; return false'>
       <p>Get Version</p>
-      <a href="http://rubyforge.org/projects/echi-converter" class="numbers">0.2.1</a>
+      <a href="http://rubyforge.org/projects/echi-converter" class="numbers">0.3.0</a>
     </div>
     <h1>&#x2192; &#8216;echi-converter&#8217;</h1>
 
@@ -63,6 +63,7 @@
 		<li>Convert from the defined Binary format to <span class="caps">ASCII</span></li>
 		<li>Insert the records into the defined database table using database transactions, via ActiveRecord, on a per file basis to support recovery on failure</li>
 		<li>Change schema structure via <span class="caps">YML</span> configuration file to accommodate various releases of the <span class="caps">ECHI</span> format</li>
+		<li>Runs as a daemon (via fork) on *NIX and a service on Windows</li>
 	</ol>
 
 
@@ -85,7 +86,8 @@
 		<li><a href="http://activesupport.rubyforge.org/">ActiveSupport v1.4.2+</a></li>
 		<li><a href="http://daemons.rubyforge.org/">Daemons v1.0.7+</a></li>
 		<li><a href="http://fastercsv.rubyforge.org/">FasterCSV v1.2.0+</a></li>
-		<li><a href="http://rake.rubyforge.org/">Rake v0.7.3+</a></li>
+		<li><a href="http://rake.rubyforge.org/">Rake v0.7.3+</a>
+    # <a href="http://win32utils.rubyforge.org/">Win32-service v.0.5.2+</a> (Manual install for Windows only)</li>
 		<li><a href="http://rubyforge.org/projects/seattlerb/">Hoe v1.2.2+</a></li>
 	</ol>
 
@@ -143,6 +145,9 @@
 	</ol>
 
 
+	<p>For *NIX:</p>
+
+
 	<ol>
 	<li>echi-converter run myproject &#8211; Run the <span class="caps">ECHI</span> converter interactively from the location given</li>
 		<li>echi-converter start myproject &#8211; Start the <span class="caps">ECHI</span> converter in daemon mode from the location given</li>
@@ -152,6 +157,20 @@
 	</ol>
 
 
+	<p>For Windows:</p>
+
+
+	<ol>
+	<li>echi-converter install myproject &#8211; install the service (must specify complete path such as c:\path\to\my\project )</li>
+		<li>echi-converter start &#8211; start the service</li>
+		<li>echi-converter stop &#8211; stop the service</li>
+		<li>echi-converter pause &#8211; pause the service</li>
+		<li>echi-converter resume &#8211; resume the service</li>
+		<li>echi-converter uninstall &#8211; uninstall the service</li>
+		<li>echi-converter delete &#8211; delete the service&#8221;</li>
+	</ol>
+
+
 	<h2>Demonstration of usage</h2>
 
 
@@ -165,14 +184,18 @@
 
 <pre syntax="ruby">echi-converter stop myproject</pre>
 
-	<h2>ToDo</h2>
+	<h2>Limitations</h2>
 
 
 	<p>Items to be done to move this out of alpha stage:</p>
 
 
 	<ol>
-	<li>&#8216;echi-converter create&#8217; works fine with <span class="caps">OSX</span>/Linux, need to test validate with a Win32 platform, therefore currently recommended to only run on a Linux/OSX platform, could use <a href="http://www.vmware.com">VMWare</a> to do this on Windows.</li>
+	<li>There are currently two limitations when running on Windows
+	<ol>
+	<li>Project directories may not have spaces</li>
+		<li>The Ruby interpreter must be installed in the default location of c:\ruby\bin</li>
+	</ol></li>
 	</ol>
 
 
@@ -208,7 +231,7 @@
 
 	<p>Comments are welcome. Send an email to <a href="mailto:jason@goecke.net">jason [at] goecke.net</a>.</p>
     <p class="coda">
-      <a href="mailto:drnicwilliams@gmail.com">Dr Nic</a>, 26th October 2007<br>
+      <a href="mailto:drnicwilliams@gmail.com">Dr Nic</a>, 2nd November 2007<br>
       Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
     </p>
 </div>

data/website/index.txt

@@ -22,6 +22,7 @@ The utility provides the following capabilities:
 	# Convert from the defined Binary format to ASCII
 	# Insert the records into the defined database table using database transactions, via ActiveRecord, on a per file basis to support recovery on failure
 	# Change schema structure via YML configuration file to accommodate various releases of the ECHI format
+	# Runs as a daemon (via fork) on *NIX and a service on Windows
 
 # Table names:
 ## echi_records - stores all ECHI data        
@@ -37,6 +38,7 @@ h2. Requirements
 	# "Daemons v1.0.7+":http://daemons.rubyforge.org/
 	# "FasterCSV v1.2.0+":http://fastercsv.rubyforge.org/
 	# "Rake v0.7.3+":http://rake.rubyforge.org/
+        # "Win32-service v.0.5.2+":http://win32utils.rubyforge.org/ (Manual install for Windows only)
     # "Hoe v1.2.2+":http://rubyforge.org/projects/seattlerb/
 
 
@@ -74,12 +76,23 @@ h2. Usage
 # echi-converter create myproject - create the local project to run the ECHI converter from
 # echi-converter upgrade myproject - location of project to upgrade after a new gem is installed
 
+For *NIX:
+
 # echi-converter run myproject - Run the ECHI converter interactively from the location given
 # echi-converter start myproject - Start the ECHI converter in daemon mode from the location given
 # echi-converter stop myproject - Stop the ECHI converter daemon
 # echi-converter restart myproject - Restart the ECHI converter 
 # echi-converter zap myrpoject - If there has been an unexpected close and the system still thinks the converter is running, clean up the pid files
 
+For Windows:
+
+# echi-converter install myproject - install the service (must specify complete path such as c:\path\to\my\project )
+# echi-converter start - start the service
+# echi-converter stop - stop the service
+# echi-converter pause - pause the service
+# echi-converter resume - resume the service
+# echi-converter uninstall - uninstall the service
+# echi-converter delete - delete the service"
 
 h2. Demonstration of usage
 
@@ -92,11 +105,13 @@ Stop the daemon/service:
 <pre syntax="ruby">echi-converter stop myproject</pre>
 
 
-h2. ToDo
+h2. Limitations
 
 Items to be done to move this out of alpha stage:
 
-# 'echi-converter create' works fine with OSX/Linux, need to test validate with a Win32 platform, therefore currently recommended to only run on a Linux/OSX platform, could use "VMWare":http://www.vmware.com to do this on Windows.
+# There are currently two limitations when running on Windows
+## Project directories may not have spaces
+## The Ruby interpreter must be installed in the default location of c:\ruby\bin
 
 h2. Screencast
 

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: echi-converter
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
-date: 2007-10-26 00:00:00 -07:00
+  version: 0.3.0
+date: 2007-11-03 00:00:00 -07:00
 summary: ECHI Conversion Utility - Provides a utility to fetch Avaya CMS / ECHI binary files, convert them and insert into a database table via ActiveRecord
 require_paths: 
 - lib
@@ -38,6 +38,7 @@ files:
 - lib/echi-converter/version.rb
 - lib/database.rb
 - lib/database_presence.rb
+- lib/main_win32.rb
 - lib/echi-converter.rb
 - scripts/txt2html
 - setup.rb