echi-converter 0.0.3 → 0.0.4

data/History.txt

@@ -24,5 +24,19 @@
   * Added support of processing 'chr' files only (FR#12996)
   * Added a configuration element to turn logging of file processing to a table on/off
   * Removed the net/ssh library include, as not using sftp for now
+  * Added dependencies for other gems in the Rakefile for auto-install from Rubyforge
 * Bug fix(es):
-  * Added proper error handling when ftp user does not have delete rights
+  * Added proper error handling when ftp user does not have delete rights
+
+== 0.0.4 2007-08-16
+
+* Major enhancement(s):
+  * Removed the 'echi-conveterter-create' bin file and replaced with 'echi-converter' to have one uniform executable for installation and operation (FR#12784)
+* Minor enhancement(s):
+  * Added configuration file config/install_files.yml for the new install method
+  * Added support for a monitor process using the Daemons library
+  * Reworked the way you create, run, start and stop a project that has been created, see the README.txt for details as well as the website
+  * Added the ability to set specific table names when using a specific PCO application
+  * Added the ability to upgrade the files when a new gem is installed
+* Bug fix(es):
+  * Bug #13062 - Corrected log table population

data/Manifest.txt

@@ -3,7 +3,6 @@ License.txt
 Manifest.txt
 README.txt
 Rakefile
-echi-converter
 lib/main.rb
 lib/echi-converter/version.rb
 lib/database.rb
@@ -22,9 +21,11 @@ config/application.yml
 config/database.yml
 config/extended_version12.yml
 config/extended_version13.yml
+config/install_files.yml
 db/migrate/001_create_echi_records.rb
 db/migrate/002_create_echi_logs.rb
-bin/echi-converter-create
+bin/echi-converter
 examples/extended_version12/chr0003
 examples/extended_version12/chr0003.txt
+examples/schemas/oracle_echi.sql
 

data/README.txt

@@ -10,24 +10,17 @@ http://support.avaya.com/elmodocs2/cms/R12/ECHI.pdf
 
 --- command ---
 
-Usage: ruby echi-converter-daemon.rb <command> <options> -- <application options>
+Usage: 
 
-* where <command> is one of:
-  start         start an instance of the application
-  stop          stop all instances of the application
-  restart       stop all instances and restart them afterwards
-  run           start the application and stay on top
-  zap           set the application to a stopped state
+# 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
 
-* and where <options> may contain several of the following:
-
-    -t, --ontop                      Stay on top (does not daemonize)
-    -f, --force                      Force operation
-
-Common options:
-    -h, --help                       Show this message
-        --version                    Show version
+# 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
 
 --- overview ---
 
-Blah, blah here
+More to come...

data/Rakefile

@@ -74,6 +74,13 @@ hoe = Hoe.new(GEM_NAME, VERS) do |p|
   # == Optional
   p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
   #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  p.extra_deps = [
+    ['activerecord', '>=1.15.3'],
+    ['activesupport', '>=1.4.2'],
+    ['daemons', '>=1.0.7'],
+    ['fastercsv', '>=1.2.0'],
+    ['rake', '>=0.7.3']
+  ]
   #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
 end
 

data/bin/echi-converter

@@ -0,0 +1,129 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'daemons'
+require 'fileutils'
+include FileUtils
+
+def set_operating_environ
+  #Build details on the gem installed and its location and version
+  gem_searcher = Gem::GemPathSearcher.new
+  @echi_converter_gem = gem_searcher.find('echi-converter')
+  @echi_gem_loc = Gem::dir + '/gems/' + @echi_converter_gem.name + '-' + @echi_converter_gem.version.version
+end
+
+#Method for creating the project itself
+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'
+    puts 'Exiting...'
+    exit
+  end
+
+  #Assemble elements to create root directory
+  dest_dir_relative = dir_name || Dir.pwd
+  dest_dir = File.expand_path dest_dir_relative
+  base_dir = File.expand_path File.dirname(__FILE__)
+
+  begin
+    echi_install_conf = YAML::load(File.open("#{@echi_gem_loc}/config/install_files.yml"))
+    #Make root directory of project
+    FileUtils.mkdir dest_dir
+    #Create subdirectories
+    echi_install_conf["dirs_to_create"].each do |dir|
+      FileUtils.mkdir dir_name + '/' + dir["name"]
+      puts 'Created directory: ' + dir_name + '/' + dir["name"]
+    end
+    #Copy files
+    echi_install_conf["files_to_copy"].each do |file|
+      FileUtils.cp "#{@echi_gem_loc}/#{file["name"]}", "#{dest_dir}/#{file["name"]}"
+      puts 'Created file: ' + dir_name + '/' + file["name"]
+    end
+  rescue => err
+    puts err
+    puts 'Fatal...exiting...'
+    exit
+  end
+  puts ''
+  puts 'Successfully created project in directory ' + dest_dir
+end
+
+#Stub to allow the upgrade of the project
+def upgrade_project project_name
+  #Assemble elements to create root directory
+  dest_dir_relative = project_name || Dir.pwd
+  dest_dir = File.expand_path dest_dir_relative
+  base_dir = File.expand_path File.dirname(__FILE__)
+  
+  begin 
+    echi_install_conf = YAML::load(File.open("#{@echi_gem_loc}/config/install_files.yml"))
+    #Copy files
+    echi_install_conf["files_to_upgrade"].each do |file|
+      FileUtils.cp "#{@echi_gem_loc}/#{file["name"]}", "#{dest_dir}/#{file["name"]}"
+      puts 'Upgraded file: ' + project_name + '/' + file["name"]
+    end
+  rescue => err
+    puts err
+    exit
+  end
+  puts ''
+  puts 'Successfully upgraded ' + project_name
+end
+
+#Used launch dynamically or as a deamon
+def launch_project run_type, project_name
+  
+  #Set various file paths
+  pid_directory = project_name + '/log'
+  script_path = project_name + '/lib/main.rb'
+  
+  #Build options to run as a daemon
+  options = {
+    :app_name => 'echi-converter',
+    :ARGV => [run_type],
+    :ontop => false,
+    :multiple => false,
+    :backtrace => true,
+    :monitor => true,
+    :dir_mode => :normal,
+    :dir => pid_directory,
+    :script => ''
+  }
+  
+  #If set, run interactively and not as a daemon
+  if run_type == 'run'
+    options["ontop"] = true
+  end
+  
+  #Daemonize
+  Daemons.run(script_path, options)
+end
+
+#We need to locate the echi-converter gem and set some variables
+set_operating_environ
+#Display initial banner of information
+puts '[' + @echi_converter_gem.name + ' ' + @echi_converter_gem.version.version + ']'
+puts @echi_converter_gem.summary
+puts ''
+puts @echi_converter_gem.homepage
+puts ''
+
+#Evaluate the selection and execute
+if ARGV[0] == 'create'
+  create_project ARGV[1]
+elsif ARGV[0] == 'upgrade'
+  upgrade_project ARGV[1]
+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

data/config/application.yml

@@ -11,7 +11,7 @@ echi_ftp_retry: 3
 echi_ftp_delete:  N #to not delete the files off of the FTP server set to N
 echi_schema: extended_version13.yml
 echi_format: ASCII #valid settings are ASCII or BINARY
-echi_process_log: N #valid is Y/N to turn it on or off
+echi_process_log: Y #valid is Y/N to turn it on or off
 
 #Currently only ftp supported, but may want to add UUCP/Serial later
 echi_xfer_type: ftp
@@ -33,4 +33,11 @@ log_level:  DEBUG
 #How many log files to create and the length before cycling through
 log_number: 10
 #The size of each individual log file
-log_length: 10240000
+log_length: 10240000
+
+#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

data/config/install_files.yml

@@ -0,0 +1,44 @@
+#Lets the echi-conveter-create utility know which files and directories to load
+dirs_to_create:
+    - name: test
+    - name: config
+    - name: log
+    - name: csv
+    - name: files
+    - name: files/to_process
+    - name: files/processed
+    - name: db
+    - name: db/migrate
+    - name: examples
+    - name: examples/extended_version12
+    - name: examples/schemas
+    - name: lib
+    - name: lib/echi-converter
+
+files_to_copy: 
+    - name: History.txt
+    - name: License.txt
+    - name: Manifest.txt
+    - name: README.txt
+    - name: Rakefile
+    - name: test/test_echi-converter.rb
+    - name: test/test_helper.rb
+    - name: config/application.yml
+    - name: config/database.yml
+    - name: config/extended_version12.yml
+    - name: config/extended_version13.yml
+    - name: db/migrate/001_create_echi_records.rb
+    - name: db/migrate/002_create_echi_logs.rb
+    - name: examples/extended_version12/chr0003
+    - name: examples/extended_version12/chr0003.txt
+    - name: lib/database.rb
+    - name: lib/echi-converter.rb
+    - name: lib/main.rb
+    - name: lib/echi-converter/version.rb
+    - name: examples/schemas/oracle_echi.sql
+    
+files_to_upgrade:
+    - name: lib/database.rb
+    - name: lib/echi-converter.rb
+    - name: lib/main.rb
+    - name: lib/echi-converter/version.rb

data/examples/schemas/oracle_echi.sql

@@ -0,0 +1,129 @@
+CREATE TABLE PCO_ECHILOG (
+  ID NUMBER,
+  FILENAME VARCHAR2(10),
+  FILENUMBER NUMBER,
+  VERSION NUMBER,
+  RECORDS VARCHAR2(2),
+  PROCESSEDAT DATE
+);
+
+ALTER TABLE PCO_ECHILOG ADD CONSTRAINT PCO_ECHILOGPK PRIMARY KEY (ID)
+USING INDEX TABLESPACE PINDEX;
+ALTER TABLE PCO_ECHILOG ENABLE CONSTRAINT PCO_ECHILOGPK;
+
+CREATE SEQUENCE PCO_ECHILOGSEQ ORDER;
+
+CREATE OR REPLACE TRIGGER PCO_ECHILOGTRG BEFORE INSERT ON PCO_ECHILOG
+REFERENCING OLD AS OLD NEW AS NEW FOR EACH ROW DECLARE
+  TEMP NUMBER;
+BEGIN
+
+  SELECT PCO_ECHILOGSEQ.NEXTVAL
+  INTO TEMP
+  FROM DUAL;
+
+  :NEW.ID:=TEMP;
+
+END;
+/
+
+CREATE TABLE PCO_ECHIRECORD (
+  ID NUMBER,
+  CALLID NUMBER,
+  ACWTIME NUMBER,
+  ONHOLDTIME NUMBER,
+  CONSULTTIME NUMBER,
+  DISPTIME NUMBER,
+  DURATION NUMBER,
+  SEGSTART DATE,
+  SEGSTOP DATE,
+  TALKTIME NUMBER,
+  NETINTIME NUMBER,
+  ORIGHOLDTIME NUMBER,
+  QUEUETIME NUMBER,
+  RINGTIME NUMBER,
+  DISPIVECTOR NUMBER,
+  DISPSPLIT NUMBER,
+  FIRSTIVECTOR NUMBER,
+  SPLIT1 NUMBER,
+  SPLIT2 NUMBER,
+  SPLIT3 NUMBER,
+  TRUNGROUP NUMBER,
+  TKLOCID NUMBER,
+  ORIGLOCID NUMBER,
+  ANSWERLOCID NUMBER,
+  OBSLOCID NUMBER,
+  UUILEN NUMBER,
+  ASSIST CHAR(1), 
+  AUDIODIFFICULTY CHAR(1),
+  CONFERENCE CHAR(1),
+  DAQUEUED CHAR(1),
+  HOLDABN CHAR(1),
+  MALICIOUS CHAR(1),
+  OBSERVINGCALL CHAR(1),
+  TRANSFERRED CHAR(1),
+  AGENTRELEASED CHAR(1),
+  ACDNUM NUMBER,
+  CALLDISP NUMBER,
+  DISPPRIORITY NUMBER,
+  HOLDS NUMBER,
+  SEGMENT NUMBER,
+  ANSREASON NUMBER,
+  ORIGREASON NUMBER,
+  DISPSKLEVEL NUMBER,
+  EVENTS0 NUMBER,
+  EVENTS1 NUMBER,
+  EVENTS2 NUMBER,
+  EVENTS3 NUMBER,
+  EVENTS4 NUMBER,
+  EVENTS5 NUMBER,
+  EVENTS6 NUMBER,
+  EVENTS7 NUMBER,
+  EVENTS8 NUMBER,
+  UCID VARCHAR2(21),
+  DISPVDN VARCHAR2(8),
+  EQLOC VARCHAR2(10),
+  FIRSTVDN VARCHAR2(8),
+  ORIGLOGID VARCHAR2(10),
+  ANSLOGID VARCHAR2(10),
+  LASTOBSERVER VARCHAR2(10),
+  DIALEDNUMBER VARCHAR2(25),
+  CALLINGPARTY VARCHAR2(13),
+  COLLECTDIGITS VARCHAR2(17),
+  CWCDIGITS VARCHAR2(17),
+  CALLINGII VARCHAR2(3),
+  CWCS0 VARCHAR2(17),
+  CWCS1 VARCHAR2(17),
+  CWCS2 VARCHAR2(17),
+  CWCS3 VARCHAR2(17),
+  CWCS4 VARCHAR2(17),
+  VDN2 VARCHAR2(8),
+  VDN3 VARCHAR2(8),
+  VDN4 VARCHAR2(8),
+  VDN5 VARCHAR2(8),
+  VDN6 VARCHAR2(8),
+  VDN7 VARCHAR2(8),
+  VDN8 VARCHAR2(8),
+  VDN9 VARCHAR2(8),
+  ASAIUUI VARCHAR2(96)
+);
+
+ALTER TABLE PCO_ECHIRECORD ADD CONSTRAINT PCO_ECHIRECORDPK PRIMARY KEY (ID)
+USING INDEX TABLESPACE PINDEX;
+ALTER TABLE PCO_ECHIRECORD ENABLE CONSTRAINT PCO_ECHIRECORDPK;
+
+CREATE SEQUENCE PCO_ECHIRECORDSEQ ORDER;
+
+CREATE OR REPLACE TRIGGER PCO_ECHIRECORDTRG BEFORE INSERT ON PCO_ECHIRECORD
+REFERENCING OLD AS OLD NEW AS NEW FOR EACH ROW DECLARE
+  TEMP NUMBER;
+BEGIN
+
+  SELECT PCO_ECHIRECORDSEQ.NEXTVAL
+  INTO TEMP
+  FROM DUAL;
+
+  :NEW.ID:=TEMP;
+
+END;
+/

data/lib/database.rb

@@ -1,5 +1,25 @@
 class EchiRecord < ActiveRecord::Base
+  #Determine our working directory
+  workingdirectory = File.expand_path(File.dirname(__FILE__))
+  #Open the configuration file
+  configfile = workingdirectory + '/../config/application.yml' 
+  config = YAML::load(File.open(configfile))
+  
+  if config["pco_process"] == 'Y'
+    set_table_name config["pco_record_tablename"]
+    set_sequence_name config["pco_record_seqname"]
+  end
 end
 
 class EchiLog < ActiveRecord::Base
+  #Determine our working directory
+  workingdirectory = File.expand_path(File.dirname(__FILE__))
+  #Open the configuration file
+  configfile = workingdirectory + '/../config/application.yml' 
+  config = YAML::load(File.open(configfile))
+  
+  if config["pco_process"] == 'Y'
+    set_table_name @config["pco_log_tablename"]
+    set_sequence_name @config["pco_log_seqname"]
+  end
 end

data/lib/echi-converter.rb

@@ -2,8 +2,6 @@ require 'rubygems'
 require 'active_record'
 require 'faster_csv'
 require 'net/ftp'
-#require 'net/ssh'
-#require 'net/sftp'
 require 'fileutils'
 
 class Logger
@@ -110,7 +108,7 @@ module EchiConverter
     fileversion = dump_binary 'int', 4
     @log.debug "Version " + fileversion.to_s
 
-    if @config["echi_process_log"] == "Yes"
+    if @config["echi_process_log"] == "Y"
       #Log the file
       echi_log = EchiLog.new
       echi_log.filename = filename
@@ -160,7 +158,7 @@ module EchiConverter
     destination_directory = @workingdirectory + '/../files/processed/'
     FileUtils.mv(echi_file, destination_directory)
     
-    if @config["echi_process_log"] == "Yes"
+    if @config["echi_process_log"] == "Y"
       #Finish logging the details on the file
       echi_log.records = record_cnt
       echi_log.processed_at = Time.now
@@ -238,12 +236,12 @@ end
 def process_ascii filename
   echi_file = @workingdirectory + "/../files/to_process/" + filename
   
-  if @config["echi_process_log"] == "Yes"
+  if @config["echi_process_log"] == "Y"
     #Log the file
     echi_log = EchiLog.new
     echi_log.filename = filename
-    echi_log.filenumber = filenumber
-    echi_log.version = fileversion
+    #echi_log.filenumber = filenumber
+    #echi_log.version = fileversion
   end
   
   record_cnt = 0
@@ -275,7 +273,7 @@ def process_ascii filename
     end
   end
   
-  if @config["echi_process_log"] == "Yes"
+  if @config["echi_process_log"] == "Y"
     #Finish logging the details on the file
     echi_log.records = record_cnt
     echi_log.processed_at = Time.now

data/lib/echi-converter/version.rb

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

data/lib/main.rb

@@ -6,14 +6,13 @@ require 'yaml'
 require @workingdirectory + '/echi-converter.rb'
 include EchiConverter
 
-#Load ActiveRecord Models
-require @workingdirectory + '/database.rb'
-
-configfile = @workingdirectory + '/../config/application.yml' 
-
 #Open the configuration file
+configfile = @workingdirectory + '/../config/application.yml' 
 @config = YAML::load(File.open(configfile))
 
+#Load ActiveRecord Models
+require @workingdirectory + '/database.rb'
+
 #Load the configured schema
 schemafile = @workingdirectory + "/../config/" + @config["echi_schema"]
 @echi_schema = YAML::load(File.open(schemafile))

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.0.3</a>
+      <a href="http://rubyforge.org/projects/echi-converter" class="numbers">0.0.4</a>
     </div>
     <h1>&#x2192; &#8216;echi-converter&#8217;</h1>
 
@@ -66,6 +66,15 @@
 	</ol>
 
 
+	<ol>
+	<li>Table names:
+	<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>
+	</ol></li>
+	</ol>
+
+
 	<h2>Requirements</h2>
 
 
@@ -91,7 +100,7 @@
 	<p>First, create the directory with all of the project files where you will run this application from:</p>
 
 
-<pre syntax="ruby">echi-converter-create path_to_my_directory</pre>
+<pre syntax="ruby">echi-converter create myproject</pre>
 
 	<p>Once you have installed a project into your preferred directory, you then need to configure for your environment.  The first step is to modify each of these files:</p>
 
@@ -99,7 +108,7 @@
 	<ol>
 	<li>config/application.yml
 	<ol>
-	<li>Change each of the &#8216;echi&#8217; settings for connecting to your local <span class="caps">FTP</span> server where the <span class="caps">CMS</span> puts the binary files</li>
+	<li>Change each of the &#8216;echi&#8217; settings for connecting to your local <span class="caps">FTP</span> server where the <span class="caps">CMS</span> puts the <span class="caps">ASCII</span>/binary files</li>
 		<li>Select which schema you would like to use (ie &#8211; extended_version12.yml) based on what you have in place</li>
 	</ol>
 	</li>
@@ -122,36 +131,18 @@
 	<h2>Usage</h2>
 
 
-	<p>Usage: echi-converter command options</p>
-
-
-	<ol>
-	<li>where command is one of:
-	<ol>
-	<li>start         start an instance of the application</li>
-		<li>stop          stop all instances of the application</li>
-		<li>restart       stop all instances and restart them afterwards</li>
-		<li>run           start the application and stay on top</li>
-		<li>zap           set the application to a stopped state</li>
-	</ol></li>
-	</ol>
-
-
 	<ol>
-	<li>and where options may contain several of the following:
-	<ol>
-	<li>-t,&#8212;ontop                      Stay on top (does not daemonize)</li>
-		<li>-f,&#8212;force                      Force operation</li>
-	</ol></li>
+	<li>echi-converter create myproject &#8211; create the local project to run the <span class="caps">ECHI</span> converter from</li>
+		<li>echi-converter upgrade myproject &#8211; location of project to upgrade after a new gem is installed</li>
 	</ol>
 
 
 	<ol>
-	<li>Common options:
-	<ol>
-	<li>-h,&#8212;help                       Show this message</li>
-		<li>&#8212;version                    Show version</li>
-	</ol></li>
+	<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>
+		<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>
 	</ol>
 
 
@@ -161,12 +152,12 @@
 	<p>Start the daemon/service:</p>
 
 
-<pre syntax="ruby">echi-converter start</pre>
+<pre syntax="ruby">echi-converter start myproject</pre>
 
 	<p>Stop the daemon/service:</p>
 
 
-<pre syntax="ruby">echi-converter stop</pre>
+<pre syntax="ruby">echi-converter stop myproject</pre>
 
 	<h2>ToDo</h2>
 
@@ -176,7 +167,6 @@
 
 	<ol>
 	<li>&#8216;echi-converter-create&#8217; works fine with <span class="caps">OSX</span>/Linux, need to test validate with a Win32 platform</li>
-		<li>Determine what to do with the files on the <span class="caps">FTP</span> server of the Avaya <span class="caps">CMS</span>, delete them or leave them and add methods to ensure no duplication</li>
 	</ol>
 
 
@@ -206,7 +196,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>, 11th August 2007<br>
+      <a href="mailto:drnicwilliams@gmail.com">Dr Nic</a>, 16th August 2007<br>
       Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
     </p>
 </div>

data/website/index.txt

@@ -23,6 +23,10 @@ The utility provides the following capabilities:
 	# Insert the records into the defined database table
 	# Change schema structure via YML configuration file to accommodate various releases of the ECHI format
 
+# Table names:
+## echi_records - stores all ECHI data        
+## echi_logs - stores a log entry for each file processed
+
 
 h2. Requirements
 
@@ -43,12 +47,12 @@ h2. Setup
 
 First, create the directory with all of the project files where you will run this application from:
 
-<pre syntax="ruby">echi-converter-create path_to_my_directory</pre>
+<pre syntax="ruby">echi-converter create myproject</pre>
 
 Once you have installed a project into your preferred directory, you then need to configure for your environment.  The first step is to modify each of these files:
 
 	# config/application.yml
-	## Change each of the 'echi' settings for connecting to your local FTP server where the CMS puts the binary files
+	## Change each of the 'echi' settings for connecting to your local FTP server where the CMS puts the ASCII/binary files
 	## Select which schema you would like to use (ie - extended_version12.yml) based on what you have in place
 	# config/database.yml
 	## Change to match your local database and database login credentials, full ActiveRecord support
@@ -61,33 +65,25 @@ Once this is complete, then simply run these commands from the project directory
 
 h2. Usage
 
-Usage: echi-converter command options 
-
-# where command is one of:
-## start         start an instance of the application
-## stop          stop all instances of the application
-## restart       stop all instances and restart them afterwards
-## run           start the application and stay on top
-## zap           set the application to a stopped state
-
-# and where options may contain several of the following:
-## -t, --ontop                      Stay on top (does not daemonize)
-## -f, --force                      Force operation
+# 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
 
-# Common options:
-## -h, --help                       Show this message
-## --version                    Show version
+# 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
 
 
 h2. Demonstration of usage
 
 Start the daemon/service:
 
-<pre syntax="ruby">echi-converter start</pre>
+<pre syntax="ruby">echi-converter start myproject</pre>
 
 Stop the daemon/service:
 
-<pre syntax="ruby">echi-converter stop</pre>
+<pre syntax="ruby">echi-converter stop myproject</pre>
 
 
 h2. ToDo
@@ -95,7 +91,6 @@ h2. ToDo
 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
-# Determine what to do with the files on the FTP server of the Avaya CMS, delete them or leave them and add methods to ensure no duplication
 
 
 h2. Forum

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: echi-converter
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
-date: 2007-08-11 00:00:00 -07:00
+  version: 0.0.4
+date: 2007-08-16 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
@@ -34,7 +34,6 @@ files:
 - Manifest.txt
 - README.txt
 - Rakefile
-- echi-converter
 - lib/main.rb
 - lib/echi-converter/version.rb
 - lib/database.rb
@@ -52,11 +51,13 @@ files:
 - config/database.yml
 - config/extended_version12.yml
 - config/extended_version13.yml
+- config/install_files.yml
 - db/migrate/001_create_echi_records.rb
 - db/migrate/002_create_echi_logs.rb
-- bin/echi-converter-create
+- bin/echi-converter
 - examples/extended_version12/chr0003
 - examples/extended_version12/chr0003.txt
+- examples/schemas/oracle_echi.sql
 test_files: 
 - test/test_echi-converter.rb
 - test/test_helper.rb
@@ -71,10 +72,54 @@ extra_rdoc_files:
 - website/index.txt
 - examples/extended_version12/chr0003.txt
 executables: 
-- echi-converter-create
+- echi-converter
 extensions: []
 
 requirements: []
 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.15.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.4.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: daemons
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.7
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: fastercsv
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.7.3
+    version: 

data/bin/echi-converter-create

@@ -1,76 +0,0 @@
-#!/usr/bin/env ruby
-require 'rubygems'
-require 'yaml'
-require 'fileutils'
-include FileUtils
-
-usage = "Usage: echi-converter-create /path/to/directory"
-     
-if ARGV[0] == nil
-  puts usage
-  puts "You must specify a directory name"
-  exit
-end
-
-dest_dir_relative = ARGV[0] || Dir.pwd
-dest_dir = File.expand_path dest_dir_relative
-base_dir = File.expand_path File.dirname(__FILE__)
-
-if RUBY_PLATFORM =~ /mswin32/
-  slash = "\ ".rstrip!
-  puts 'Windows'
-else
-  puts 'Linux/OSX'
-  slash = "/"
-end
-
-#Obtain the details of which Gem is installed
-gem_details = base_dir.split(slash)
-location = gem_details.length - 2
-puts 'Creating new ' + gem_details[location] + ' directory tree in ' + dest_dir
-puts ' '
-
-#Now, create the directory, must be a new 'fresh' one
-begin
-  result = FileUtils.mkdir dest_dir_relative
-  puts 'Created diretory "' + result.to_s + '"'
-rescue => err
-  puts 'ERROR: ' + err
-  puts 'Failed, exiting...'
-  exit
-end
-
-#Now create various directories
-logdir = dest_dir + slash +'log'
-filesdir = dest_dir + slash + 'files'
-csvdir = filesdir + slash + 'csv'
-processeddir = filesdir + slash + 'processed'
-toprocessdir = filesdir + slash + 'to_process'
-begin
-  FileUtils.mkdir logdir
-  FileUtils.mkdir filesdir
-  FileUtils.mkdir csvdir
-  FileUtils.mkdir processeddir
-  FileUtils.mkdir toprocessdir
-rescue => err
-  puts 'ERROR: ' + err
-  puts 'Failed, exiting...'
-  exit
-end
-
-#Now, start copying project files files
-substitute = slash + '.'
-base_dir = base_dir.sub('/bin', substitute)
-new_dest_dir = dest_dir + slash + '.'
-exe_file = dest_dir + slash + 'echi-converter'
-begin
-  FileUtils.cp_r base_dir, new_dest_dir
-  FileUtils.chmod 0755, exe_file
-rescue => err
-  puts 'ERROR: ' + err
-  puts 'Failed, exiting...'
-  exit
-end
-
-puts ' '
-puts 'ECHI Conveter directory created! Now ready for use.'

data/echi-converter

@@ -1,8 +0,0 @@
-#!/usr/bin/env ruby
-require 'rubygems'
-require 'daemons'
-
-#Run the application as a Daemon
-Daemons.run('lib/main.rb')
-
-