echi-converter 0.3.3 → 0.3.4

data/lib/echi-converter/version.rb

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

data/lib/ftp_fetcher.rb

@@ -0,0 +1,82 @@
+class FtpFetcher < Net::FTP
+  
+  #Connect to the ftp server
+  def connect_ftp_session log
+    begin
+      #ftp_session = Net::FTP.new($config["echi_host"])
+      ftp_session = Net::FTP.new
+      ftp_session.connect($config["echi_host"], $config["echi_port"])
+      ftp_session.login $config["echi_username"], $config["echi_password"]
+      log.info "Successfully connected to the ECHI FTP server"
+    rescue => err
+      log.info "Could not connect with the FTP server - " + err
+      return -1
+    end
+    return ftp_session
+  end
+  
+  #Obtain the list of files available on the server
+  def fetch_list log
+    attempts = 0
+    ftp_session = -1
+    while ftp_session == -1 do
+      ftp_session = connect_ftp_session log
+      if ftp_session == -1
+        sleep 5
+      end
+      attempts += 1
+      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"])
+        end
+        files = ftp_session.list('chr*')
+
+        #Also fetch the *.dat files if it is configured to be processed
+        if $config["echi_process_dat_files"] == "Y"
+          files = files + ftp_session.list("*.dat")
+        end
+        #Build the queue of files to be fetched for the threads
+        filequeue = Queue.new
+        files.each do |file|
+          file_data = file.split(' ')
+          filequeue.push(file_data[8])
+        end
+        ftp_session.close
+        return filequeue
+      rescue => err
+        log.info "Unable to fetch list from ftp server - " + err
+        return nil
+      end
+    end
+  end
+  
+  #Connect to the ftp server and fetch the files each time
+  def fetch_ftp_files filequeue, log
+    begin
+      ftp_session = connect_ftp_session log
+      if $config["echi_ftp_directory"] != nil
+        ftp_session.chdir($config["echi_ftp_directory"])
+      end
+      while filequeue.empty? != true
+        filename = filequeue.pop
+        local_filename = $workingdir + '/../files/to_process/' + filename
+        ftp_session.getbinaryfile(filename, local_filename)
+        if $config["echi_ftp_delete"] == 'Y'
+          ftp_session.delete(filename)
+        end
+      end
+      ftp_session.close
+      log.info "Closed ftp session."
+      return true
+    rescue => err
+      log.info "Could not fetch from ftp server - " + err
+      return false
+    end
+  end
+  
+end

data/lib/main.rb

@@ -31,12 +31,15 @@ if $config["export_type"] == 'database' || $config["export_type"] == 'both'
 end
 
 $init_date = Time.now
-@log.info "Running..."
+@log.info "ECHI-Converter daemon started with these settings:"
+@log.info $config.inspect
 
 #Our Main loop
 loop do
   #Process the files
-  fetch_ftp_files
+  #fetch_ftp_files
+  get_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/"
@@ -55,8 +58,8 @@ loop do
     end
   end
 
-  if $config["echi_update_agent_data"] == "Y" && $config["pco_process"] == "N"
-    process_agent_data
+  if $config["echi_process_dat_files"] == "Y" && $config["pco_process"] == "N"
+    process_dat_files
   end
   
   sleep $config["fetch_interval"]

data/lib/main_win32.rb

@@ -50,11 +50,12 @@ class EchiDaemon < Daemon
   end
 
   def service_main
-    @log.info "ECHI-Converter service started"
+    @log.info "ECHI-Converter service started with these settings:"
+    @log.info $config.inspect
     while running?
       if state == RUNNING
         #Process the files
-        fetch_ftp_files
+        get_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/"
@@ -73,8 +74,8 @@ class EchiDaemon < Daemon
           end
         end
         
-        if $config["echi_update_agent_data"] == "Y" && $config["pco_process"] == "N"
-          process_agent_data
+        if $config["echi_process_dat_files"] == "Y" && $config["pco_process"] == "N"
+          process_dat_files
         end
         
         sleep $config["fetch_interval"]

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.3</a>
+      <a href="http://rubyforge.org/projects/echi-converter" class="numbers">0.3.4</a>
     </div>
     <h1>&#x2192; &#8216;echi-converter&#8217;</h1>
 
@@ -63,8 +63,9 @@
 		<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>Supports inserting agent names from agname.dat</li>
+		<li>Supports inserting data from the various &#8217;.dat&#8217; files provided</li>
 		<li>Runs as a daemon (via fork) on *NIX and a service on Windows</li>
+		<li>Allows for multiple <span class="caps">FTP</span> sessions to be used for greater performance (via <a href="http://en.wikipedia.org/wiki/Green_threads">green threads</a>)</li>
 	</ol>
 
 
@@ -73,7 +74,10 @@
 	<ol>
 	<li>echi_records &#8211; stores all <span class="caps">ECHI</span> data        </li>
 		<li>echi_logs &#8211; stores a log entry for each file processed</li>
-		<li>echi_agents &#8211; stores the data from the agname.dat file</li>
+		<li>echi_agents &#8211; stores the data from the agname.dat file </li>
+		<li>echi_aux_reasons &#8211; stores the data from the aux_rsn.dat file</li>
+		<li>echi_cwcs &#8211; stores data from the cwc.dat file</li>
+		<li>echi_vdns &#8211; stores data from the vdn.dat file</li>
 	</ol></li>
 	</ol>
 
@@ -151,7 +155,7 @@
 	</ol>
 
 
-	<p>For *NIX:</p>
+	<p>For <span class="caps">POSIX</span>:</p>
 
 
 	<ol>
@@ -159,7 +163,7 @@
 		<li>echi-converter start myproject &#8211; Start the <span class="caps">ECHI</span> converter in daemon mode from the location given</li>
 		<li>echi-converter stop myproject &#8211; Stop the <span class="caps">ECHI</span> converter daemon</li>
 		<li>echi-converter restart myproject &#8211; Restart the <span class="caps">ECHI</span> converter </li>
-		<li>echi-converter zap myrpoject &#8211; If there has been an unexpected close and the system still thinks the converter is running, clean up the pid files</li>
+		<li>echi-converter zap myproject &#8211; If there has been an unexpected close and the system still thinks the converter is running, clean up the pid files</li>
 	</ol>
 
 
@@ -185,6 +189,14 @@
 	</ol>
 
 
+	<p>Multi-byte character support:</p>
+
+
+	<ol>
+	<li>If you require multi-byte character support be sure to set your database to &#8216;utf8&#8217; as well as uncomment the option &#8216;encoding: utf8&#8217; in the config/database.yml file</li>
+	</ol>
+
+
 	<h2>Demonstration of usage</h2>
 
 
@@ -198,6 +210,24 @@
 
 <pre syntax="ruby">echi-converter stop myproject</pre>
 
+	<h2>Supported Platforms</h2>
+
+
+	<p>While the use of Ruby allows for operation on a multitude of platforms, these are the platforms that have actually been tested on.  If you have success running on other platforms, please feel free to provide details on the Google Group.</p>
+
+
+	<h4>Operating Systems</h4>
+
+
+	<p><span class="caps">POSIX</span>, Windows <span class="caps">XP SP2</span>, Windows 2000 and Windows 2003.</p>
+
+
+	<h4><span class="caps">FTP</span> Servers</h4>
+
+
+	<p><span class="caps">VSFTP</span> and Windows 2003/XP <span class="caps">FTP</span> Servers.</p>
+
+
 	<h2>Screencast</h2>
 
 
@@ -230,7 +260,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>, 6th November 2007<br>
+      <a href="mailto:drnicwilliams@gmail.com">Dr Nic</a>, 25th November 2007<br>
       Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
     </p>
 </div>

data/website/index.txt

@@ -22,13 +22,17 @@ 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
-	# Supports inserting agent names from agname.dat
+	# Supports inserting data from the various '.dat' files provided
 	# Runs as a daemon (via fork) on *NIX and a service on Windows
+	# Allows for multiple FTP sessions to be used for greater performance (via "green threads":http://en.wikipedia.org/wiki/Green_threads)
 
 # Table names:
 ## echi_records - stores all ECHI data        
 ## echi_logs - stores a log entry for each file processed
 ## echi_agents - stores the data from the agname.dat file 
+## echi_aux_reasons - stores the data from the aux_rsn.dat file
+## echi_cwcs - stores data from the cwc.dat file
+## echi_vdns - stores data from the vdn.dat file
 
 
 h2. Requirements
@@ -79,13 +83,13 @@ 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:
+For POSIX:
 
 # 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
+# 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
 
 For Windows:
 
@@ -100,6 +104,10 @@ For Windows:
 # If you would like to run the script interactively, you may also execute this command: 
 ## ruby "c:\myproject\lib\main_win32.rb"
 
+Multi-byte character support:
+
+# If you require multi-byte character support be sure to set your database to 'utf8' as well as uncomment the option 'encoding: utf8' in the config/database.yml file
+
 h2. Demonstration of usage
 
 Start the daemon/service:
@@ -110,6 +118,18 @@ Stop the daemon/service:
 
 <pre syntax="ruby">echi-converter stop myproject</pre>
 
+h2. Supported Platforms
+
+While the use of Ruby allows for operation on a multitude of platforms, these are the platforms that have actually been tested on.  If you have success running on other platforms, please feel free to provide details on the Google Group.
+
+h4. Operating Systems
+
+POSIX, Windows XP SP2, Windows 2000 and Windows 2003.
+
+h4. FTP Servers
+
+VSFTP and Windows 2003/XP FTP Servers.
+
 h2. Screencast
 
 You may view the screencast on howto install and use the ECHI-Converter "here":http://www.screencast.com/t/lQQkIVkUZMr.

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: echi-converter
 version: !ruby/object:Gem::Version 
-  version: 0.3.3
-date: 2007-11-06 00:00:00 -08:00
+  version: 0.3.4
+date: 2007-11-25 00:00:00 -08: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
@@ -40,6 +40,7 @@ files:
 - lib/database_presence.rb
 - lib/main_win32.rb
 - lib/echi-converter.rb
+- lib/ftp_fetcher.rb
 - scripts/txt2html
 - setup.rb
 - test/test_echi-converter.rb
@@ -61,11 +62,15 @@ files:
 - db/migrate/003_create_echi_agents.rb
 - db/migrate/004_change_log_name_size.rb
 - db/migrate/005_change_log_processedat_name.rb
+- db/migrate/006_create_echi_aux_reasons.rb
+- db/migrate/007_create_echi_cwcs.rb
+- db/migrate/008_create_echi_vdns.rb
 - bin/echi-converter
 - examples/extended_version12/chr0003
 - examples/extended_version12/chr0003.txt
 - examples/schemas/oracle_echi.sql
 - examples/ascii_csv/chr5500.123
+- examples/db_connect_test.rb
 test_files: 
 - test/test_echi-converter.rb
 - test/test_helper.rb