echi-converter 0.3.0 → 0.3.1

data/History.txt

@@ -102,4 +102,14 @@
   * 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
+  * Fixed bug so that the log file properly reports when a file is processed
+
+== 0.3.1 2007-11-TBD
+
+* Major enhancement(s):
+* Minor enhancement(s):
+  * Removed the need for the default install requirement, Ruby may now be installed anywhere on the Windows system (FR#15302)
+  * Modified the return status when creating or manipulating a Windows service
+  * Add the 'echi-converter status' command to check the status of a Windows service
+* Bug fix(es):
+  * Fixed bug #15293, the service now exists cleanly

data/bin/echi-converter

@@ -19,6 +19,7 @@ if RUBY_PLATFORM["-mswin32"]
      echi-converter stop - stop the service
      echi-converter pause - pause the service
      echi-converter resume - resume the service
+     echi-converter status - check the status of a configured service
      echi-converter uninstall - uninstall the service
      echi-converter delete - delete the service"
 else
@@ -102,9 +103,10 @@ end
 
 #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"
+    rubyw_path = Config::CONFIG["bindir"] + "/" + Config::CONFIG["RUBYW_INSTALL_NAME"] + Config::CONFIG["EXEEXT"]
+    rubyw_path = rubyw_path.gsub("/","\\")
+    service_exe = '"' + rubyw_path + '" "' + project_name + "\\lib\\main_win32.rb" + '"'
   end
   begin
     case run_type
@@ -112,25 +114,32 @@ def launch_service run_type, project_name
       s = Service.new()
       s.create_service { |s|
         s.service_name = "ECHI-Converter"
-        s.binary_path_name = service_exe
+        s.binary_path_name = service_exe.gsub(" ","\s")
         #s.service_type = Service::AUTO_START
         s.display_name = "ECHI-Converter"
         s.service_description = "ECHI-Converter Service for " + project_name
       }
       s.close
+      service_status = "Service successfully created."
     when "start"
-      Service.start("ECHI-Converter")
+      service_status = Service.start("ECHI-Converter")
+      service_status = "Service successfully started"
     when "stop"
-      Service.stop("ECHI-Converter")
+      service_status = Service.stop("ECHI-Converter")
+      service_status = "Service successfully stopped"
     when "pause"
-      Service.pause("ECHI-Converter")
+      service_status = Service.pause("ECHI-Converter")
+      service_status = "Service successfully paused"
     when "resume"
-      Service.resume("ECHI-Converter")
+      service_status = Service.resume("ECHI-Converter")
+      service_status = "Service successfully resumed"
     when "delete"
       Service.delete("ECHI-Converter")
+      service_status = "Service successfully deleted"
+    when "status"
+      service_status = Service.status("ECHI-Converter").current_state
     end
-    service_status = Service.status("ECHI-Converter")
-    return service_status.current_state
+    return service_status
   rescue => err
     return err
   end

data/lib/echi-converter.rb

@@ -243,7 +243,6 @@ module EchiConverter
   def fetch_ftp_files
    attempts = 0
    ftp_session = -1
-   files_to_process = Array.new
    while ftp_session == -1 do
      ftp_session = connect_ftpsession
      if ftp_session == -1
@@ -262,12 +261,9 @@ module EchiConverter
        files = ftp_session.list('chr*')
        file_cnt = 0
        files.each do | file |
-         #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 = $workingdir + '/../files/to_process/' + remote_filename
-         ftp_session.getbinaryfile(remote_filename, local_filename)
-         files_to_process[file_cnt] = remote_filename
+         local_filename = $workingdir + '/../files/to_process/' + file_data[8]
+         ftp_session.getbinaryfile(file_data[8], local_filename)
          if $config["echi_ftp_delete"] == 'Y'
            begin
              ftp_session.delete(remote_filename)
@@ -282,7 +278,7 @@ module EchiConverter
       @log.fatal "Could not fetch from ftp server - " + err
     end
    end
-   return files_to_process
+   return 
   end
 end
 

data/lib/echi-converter/version.rb

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

data/lib/main.rb

@@ -35,7 +35,7 @@ end
 #Our Main loop
 loop do
   #Process the files
-  ftp_files = fetch_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/"

data/lib/main_win32.rb

@@ -9,7 +9,20 @@ class EchiDaemon < Daemon
   require $workingdir + '/echi-converter.rb'
   include EchiConverter
     
-  def initialize
+  def service_stop
+    @log.info "ECHI-Converter service stopped"
+    @log.close
+  end
+
+  def service_pause
+    @log.info "ECHI-Converter service paused"
+  end
+
+  def service_resume
+    @log.info "ECHI-Converter service resumed"
+  end
+  
+  def service_init
     #Open the configuration file
     configfile = $workingdir + '/../config/application.yml' 
     $config = YAML::load(File.open(configfile))
@@ -27,53 +40,53 @@ class EchiDaemon < Daemon
 
     #Open the logfile with appropriate output level
     initiate_logger
-  
+    @log.info "ECHI-Converter service initializing"
+    
     #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/"
+    @log.info "ECHI-Converter service started"
+    while running?
+      if state == RUNNING
+        #Process the 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)
+        #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
+        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
-          @log.info "Processed file #{file} with #{record_cnt.to_s} records"
         end
-      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'
-        connect_database
+        #Make sure we did not lose our database connection while we slept
+        if ActiveRecord::Base.connected? == 'FALSE'
+          connect_database
+        end
+      end
+      
+      if state == PAUSED
+        @log.info "ECHI-Converter service paused"
+        sleep $config["fetch_interval"]
       end
     end
   end
-
-  def service_cleanup
-    #Close the logfile
-    @log.info "Shutdown..."
-    @log.close
-  end
 end
 
 d = EchiDaemon.new
-d.mainloop
-d.service_cleanup
+d.mainloop

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.3.0</a>
+      <a href="http://rubyforge.org/projects/echi-converter" class="numbers">0.3.1</a>
     </div>
     <h1>&#x2192; &#8216;echi-converter&#8217;</h1>
 
@@ -87,7 +87,7 @@
 		<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>
-    # <a href="http://win32utils.rubyforge.org/">Win32-service v.0.5.2+</a> (Manual install for Windows only)</li>
+    # <a href="http://win32utils.rubyforge.org/">Win32-service v.0.5.0+</a> (Manual install for Windows only)</li>
 		<li><a href="http://rubyforge.org/projects/seattlerb/">Hoe v1.2.2+</a></li>
 	</ol>
 
@@ -161,11 +161,12 @@
 
 
 	<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 install myproject &#8211; install the service (must specify complete path such as c:\path\to\my\project &#8211; if the directory name or path has any spaces, please enclose the &#8216;myproject&#8217; in double quotes )</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 status &#8211; returns the status of a configured service</li>
 		<li>echi-converter uninstall &#8211; uninstall the service</li>
 		<li>echi-converter delete &#8211; delete the service&#8221;</li>
 	</ol>
@@ -184,21 +185,6 @@
 
 <pre syntax="ruby">echi-converter stop myproject</pre>
 
-	<h2>Limitations</h2>
-
-
-	<p>Items to be done to move this out of alpha stage:</p>
-
-
-	<ol>
-	<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>
-
-
 	<h2>Screencast</h2>
 
 
@@ -231,7 +217,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>, 2nd November 2007<br>
+      <a href="mailto:drnicwilliams@gmail.com">Dr Nic</a>, 4th November 2007<br>
       Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
     </p>
 </div>

data/website/index.txt

@@ -38,8 +38,8 @@ 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/
+        # "Win32-service v.0.5.0+":http://win32utils.rubyforge.org/ (Manual install for Windows only)
+	# "Hoe v1.2.2+":http://rubyforge.org/projects/seattlerb/
 
 
 h2. Installing
@@ -86,11 +86,12 @@ For *NIX:
 
 For Windows:
 
-# echi-converter install myproject - install the service (must specify complete path such as c:\path\to\my\project )
+# echi-converter install myproject - install the service (must specify complete path such as c:\path\to\my\project - if the directory name or path has any spaces, please enclose the 'myproject' in double quotes )
 # 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 status - returns the status of a configured service
 # echi-converter uninstall - uninstall the service
 # echi-converter delete - delete the service"
 
@@ -104,15 +105,6 @@ Stop the daemon/service:
 
 <pre syntax="ruby">echi-converter stop myproject</pre>
 
-
-h2. Limitations
-
-Items to be done to move this out of alpha stage:
-
-# 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
 
 You may view the screencast on howto install and use the ECHI-Converter "here":http://www.screencast.com/t/lQQkIVkUZMr.
@@ -121,7 +113,6 @@ h2. Forum
 
 "Google Groups - ECHI Converter":http://groups.google.com/group/echi-converter
 
-
 h2. How to submit patches
 
 Read the "8 steps for fixing other people's code":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/ and for section "8b: Submit patch to Google Groups":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups, use the Google Group above.

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: echi-converter
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
-date: 2007-11-03 00:00:00 -07:00
+  version: 0.3.1
+date: 2007-11-04 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