echi-converter 0.0.1

data/Manifest.txt

@@ -0,0 +1,29 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+echi-converter
+lib/main.rb
+lib/echi-converter/version.rb
+lib/database.rb
+lib/main.rb
+lib/echi-converter.rb
+scripts/txt2html
+setup.rb
+test/test_echi-converter.rb
+test/test_helper.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.rhtml
+config/application.yml
+config/database.yml
+config/extended_version12.yml
+db/migrate/001_create_echi_records.rb
+db/migrate/002_create_echi_logs.rb
+bin/echi-converter-create
+examples/extended_version12/chr0003
+examples/extended_version12/chr0003.txt
+

data/README.txt

@@ -0,0 +1,33 @@
+README for echi_converter
+==========================
+ECHI Converter - The Binary to ASCII converter for Avaya CMS External Call History files
+
+--- background ---
+
+See more info on the Avaya ECHI format here (note, these overviews are version specific):
+
+http://support.avaya.com/elmodocs2/cms/R12/ECHI.pdf
+
+--- command ---
+
+Usage: ruby echi-converter-daemon.rb <command> <options> -- <application 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
+
+Common options:
+    -h, --help                       Show this message
+        --version                    Show version
+
+--- overview ---
+
+Blah, blah here

data/Rakefile

@@ -0,0 +1,143 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'fileutils'
+require 'hoe'
+require 'active_record'  
+require 'yaml'
+
+include FileUtils
+require File.join(File.dirname(__FILE__), 'lib', 'echi-converter', 'version')
+
+AUTHOR = 'Jason Goecke'  # can also be an array of Authors
+EMAIL = "jason [at] goecke.net"
+DESCRIPTION = "ECHI Conversion Utility - Provides a utility to fetch Avaya CMS / ECHI binary files, convert them and insert into a database table via ActiveRecord"
+GEM_NAME = 'echi-converter' # what ppl will type to install your gem
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}"
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  @rubyforge_username ||= @config["username"]
+end
+
+RUBYFORGE_PROJECT = 'echi-converter' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+NAME = "echi-converter"
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = EchiConverter::VERSION::STRING + (REV ? ".#{REV}" : "")
+CLEAN.include ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']
+RDOC_OPTS = ['--quiet', '--title', 'echi-converter documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject { |x| Array(x).first == 'hoe' } 
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= CLEAN  #An array of file patterns to delete on clean.
+  
+  # == 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.spec_extras = {}    # A hash of extra values to set in the gemspec.
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\n\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+
+desc 'Generate website files'
+task :website_generate do
+  Dir['website/**/*.txt'].each do |txt|
+    sh %{ ruby scripts/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  host = "#{rubyforge_username}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{PATH}/"
+  local_dir = 'website'
+  sh %{rsync -aCv #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload, :publish_docs]
+
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+##Add the ability to use ActiveRecord Migrations to create the database
+desc "Migrate the database through scripts in db/migrate. Target specific version with VERSION=x"  
+  task :migrate => :environment do  
+    #Load the working directoy and configuration file
+    workingdirectory = File.expand_path(File.dirname(__FILE__))
+    configfile = workingdirectory + '/config/application.yml'
+    config = YAML::load(File.open(configfile))
+
+    #Load the configured schema
+    schemafile = workingdirectory + "/config/" + config["echi_schema"]
+    @@echi_schema = YAML::load(File.open(schemafile))
+    
+    ActiveRecord::Migrator.migrate('db/migrate', ENV["VERSION"] ? ENV["VERSION"].to_i : nil )  
+end  
+   
+task :environment do  
+  ActiveRecord::Base.establish_connection(YAML::load(File.open('config/database.yml')))  
+  ActiveRecord::Base.logger = Logger.new(File.open('log/database.log', 'a'))  
+end

data/bin/echi-converter-create

@@ -0,0 +1,76 @@
+#!/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/config/application.yml

@@ -0,0 +1,33 @@
+#Configuration details for the application
+
+#Connection details for the Avaya CMS/ECHI host
+echi_host:      localhost
+echi_port:      22
+echi_username:  jsgoecke
+echi_password:  sanfran2007!
+echi_connect_type:  ftp #only ftp supported now, possible for ssh in the future
+echi_ftp_directory:  /Users/ftp/anonymous
+echi_ftp_retry: 3
+echi_schema: extended_version12.yml
+
+#Currently only ftp supported, but may want to add UUCP/Serial later
+echi_xfer_type: ftp
+
+#How frequently to fetch records off of the Avaya CMS ftp server
+fetch_interval: 60  #in seconds
+
+#Whether or not to insert into a database, into a csv file or both
+export_type:    database
+
+#Options are:
+    #FATAL:	an unhandleable error that results in a program crash
+    #ERROR:	a handleable error condition
+    #WARN:	a warning
+    #INFO:	generic (useful) information about system operation
+    #DEBUG:	low-level information for developers
+    #NONE:  turn off logging
+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

data/config/database.yml

@@ -0,0 +1,6 @@
+#Database connection configuration, uses Active Record from Ruby on Rails
+adapter: mysql
+database: echi_records
+username: root
+password:
+host: localhost

data/config/extended_version12.yml

@@ -0,0 +1,234 @@
+#ECH File construct, order is important, as the application sequentially reads the file
+#Version 12 - Extended Schema
+fields:
+    - name: callid
+      type: int
+      length: 4
+    - name: acwtime
+      type: int
+      length: 4
+    - name: onholdtime
+      type: int
+      length: 4
+    - name: consulttime
+      type: int
+      length: 4
+    - name: disptime
+      type: int
+      length: 4
+    - name: duration
+      type: int
+      length: 4
+    - name: segstart
+      type: datetime
+      length: 4
+    - name: segstop
+      type: datetime
+      length: 4
+    - name: talktime
+      type: int
+      length: 4
+    - name: netintime
+      type: int
+      length: 4
+    - name: origholdtime
+      type: int
+      length: 4
+    - name: queuetime
+      type: int
+      length: 4
+    - name: ringtime
+      type: int
+      length: 4
+    - name: dispivector
+      type: int
+      length: 2
+    - name: dispsplit
+      type: int
+      length: 2
+    - name: firstivector
+      type: int
+      length: 2
+    - name: split1
+      type: int
+      length: 2
+    - name: split2
+      type: int
+      length: 2
+    - name: split3
+      type: int
+      length: 2
+    - name: trunkgroup
+      type: int
+      length: 2
+    - name: tk_locid
+      type: int
+      length: 2
+    - name: orig_locid
+      type: int
+      length: 2
+    - name: answer_locid
+      type: int
+      length: 2
+    - name: obs_locid
+      type: int
+      length: 2
+    - name: uui_len
+      type: int
+      length: 2
+    - name: assist
+      type: bool
+      length: 1
+    - name: audio_difficulty
+      type: bool
+      length: 1
+    - name: conference
+      type: bool
+      length: 1
+    - name: da_queued
+      type: bool
+      length: 1
+    - name: hold_abn
+      type: bool
+      length: 1
+    - name: malicious
+      type: bool
+      length: 1
+    - name: observing_call
+      type: bool
+      length: 1
+    - name: transferred
+      type: bool
+      length: 1
+    - name: agent_released
+      type: bool_int
+      length: 1
+    - name: acdnum
+      type: int
+      length: 1
+    - name: call_disp
+      type: int
+      length: 1
+    - name: disppriority
+      type: int
+      length: 1
+    - name: holds
+      type: int
+      length: 1
+    - name: segment
+      type: int
+      length: 1
+    - name: ansreason
+      type: int
+      length: 1
+    - name: origreason
+      type: int
+      length: 1
+    - name: dispsklevel
+      type: int
+      length: 1
+    - name: events0
+      type: int
+      length: 1
+    - name: events1
+      type: int
+      length: 1
+    - name: events2
+      type: int
+      length: 1
+    - name: events3
+      type: int
+      length: 1
+    - name: events4
+      type: int
+      length: 1
+    - name: events5
+      type: int
+      length: 1
+    - name: events6
+      type: int
+      length: 1
+    - name: events7
+      type: int
+      length: 1
+    - name: events8
+      type: int
+      length: 1
+    - name: ucid
+      type: str
+      length: 21
+    - name: dispvdn
+      type: str
+      length: 8
+    - name: eqloc
+      type: str
+      length: 10
+    - name: firstvdn 
+      type: str
+      length: 8
+    - name: orig_logid
+      type: str
+      length: 10
+    - name: ans_logid
+      type: str
+      length: 10
+    - name: last_observer
+      type: str
+      length: 10
+    - name: dialed_number
+      type: str
+      length: 25
+    - name: calling_party
+      type: str
+      length: 13
+    - name: collect_digits
+      type: str
+      length: 17
+    - name: cwc_digits
+      type: str
+      length: 17
+    - name: calling_II
+      type: str
+      length: 3
+    - name: cwcs0
+      type: str
+      length: 17
+    - name: cwcs1
+      type: str
+      length: 17
+    - name: cwcs2
+      type: str
+      length: 17
+    - name: cwcs3
+      type: str
+      length: 17
+    - name: cwcs4
+      type: str
+      length: 17
+    - name: vdn2
+      type: str
+      length: 8
+    - name: vdn3
+      type: str
+      length: 8
+    - name: vdn4
+      type: str
+      length: 8
+    - name: vdn5
+      type: str
+      length: 8
+    - name: vdn6
+      type: str
+      length: 8
+    - name: vdn7
+      type: str
+      length: 8
+    - name: vdn8
+      type: str
+      length: 8
+    - name: vdn9
+      type: str
+      length: 8
+    - name: asaiuui
+      type: str
+      length: 96