jsgoecke-echi_files 0.1.0

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+ 
+Copyright (c) 2009 Jason Goecke
+ 
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+ 
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+ 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.textile

@@ -0,0 +1,55 @@
+h1. ECHI Files Ruby Library
+
+h2. Description
+
+A library that allows one to take an ASCII or Binary file from an <a href="http://www.google.com/url?sa=t&source=web&ct=res&cd=1&url=http%3A%2F%2Fsupport.avaya.com%2Fjapple%2Fcss%2Fjapple%3FPAGE%3DProduct%26temp.productID%3D107584&ei=h1tlSaXpDomQtQO9_8mVAw&usg=AFQjCNGdjBmfY-7VhcTninYr1c9byz0U3w&sig2=qV5YXM9h76TFe_xodJ7CHg">Avaya CMS</a> <a href="http://support.avaya.com/elmodocs2/cms/R14/ECHI.pdf">External Call History Interface (ECHI)</a> and convert it into a Ruby hash for further processing.
+
+h2. Features
+
+* Convert Binary file to Ruby hash
+* Convert ASCII file to Ruby hash
+* Support both standard and extended file formats 
+* Tested with both Ruby 1.8.6 and JRuby 1.1.5
+
+h2. Example
+    <pre>
+	<code>
+	require 'echi_files'
+	
+	#Provide a filename to process as an argument on the commandline
+	filename = File.expand_path(ARGV[0])
+
+	#Open the file
+	filehandle = open(filename, "rb")
+
+	#Instantiate an EchiFiles class to process your ASCII or BINARY files
+	echi_handler = EchiFiles.new
+	
+	#Use this to process a binary file
+	file_type = 'BINARY'
+	format = 'EXTENDED'
+	#In some cases the extra_byte is needed
+	extra_byte = true
+	data = echi_handler.process_file(filehandle, file_type, format, extra_byte)
+
+	#Use this to process a binary file
+	file_type = 'ASCII'
+	format = 'EXTENDED'
+	extra_byte = true
+	#Use this to process an ASCII file
+	data = echi_handler.process_file(filehandle, file_type, format, extra_byte)
+	
+	#If you need to strip in characters from the asaiuui field
+	#@data Is the Array of Hashes converted above
+	#@array_of_decimal_values Is an array of decimal ascii values to be stripped
+	data = echi_handler.strip_asaiuui(data, array_of_decimal_values)
+	</code>
+	</pre>	
+
+h2. Dependencies
+
+* FasterCSV 1.4.0+
+
+h2. Installation
+
+	sudo gem install jsgoecke-echi_files --source=http://gems.github.com/

data/echi_files.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |s|
+  s.name = "echi_files"
+  s.version = "0.1.0"
+  s.date = "2009-01-19"
+  s.summary = "Ruby Library for Processing Avaya ECHI Files"
+  s.description = "Ruby Library for processing External Call History (ECHI) files from the Avaya CMS"
+  s.authors = ["Jason Goecke"]
+  s.email = ["jason -at- goecke.net"]
+  s.has_rdoc = false
+  s.homepage = "http://jsgoecke.github.com/echi_files"
+  s.rubygems_version = "1.3.1"
+ 
+  s.files = ["lib/echi_files.rb", 
+             "lib/extended-definition.yml",
+             "lib/standard-definition.yml", 
+             "LICENSE", 
+             "README.textile", 
+             "echi_files.gemspec"]
+  s.require_paths = ["lib"]
+ 
+  s.add_dependency("fastercsv", ">=", "1.4.0")
+end

data/lib/echi_files.rb

@@ -0,0 +1,185 @@
+require 'yaml'
+require 'fastercsv'
+
+class EchiFiles
+  
+  def initialize
+    @extended = YAML::load_file(File.expand_path(File.dirname(__FILE__) + "/extended-definition.yml"))
+    @standard = YAML::load_file(File.expand_path(File.dirname(__FILE__) + "/standard-definition.yml"))
+  end
+  
+  #Method for parsing the various datatypes from the ECH file
+  def dump_binary(filehandle, type, length)
+    case type
+    when 'int'
+      #Process integers, assigning appropriate profile based on length
+      #such as long int, short int and tiny int.
+      case length
+      when 4
+        value = filehandle.read(length).unpack("l").first.to_i
+      when 2
+        value = filehandle.read(length).unpack("s").first.to_i
+      when 1
+        value = filehandle.read(length).unpack("U").first.to_i
+      end
+    #Process appropriate intergers into datetime format in the database
+    when 'datetime'
+      case length
+      when 4
+        value = filehandle.read(length).unpack("l").first.to_i
+        puts value.inspect
+        value = Time.at(value)
+      end
+    #Process strings
+    when 'str'
+      value = filehandle.read(length).unpack("M").first.to_s.rstrip
+    #Process individual bits that are booleans
+    when 'bool'
+      value = filehandle.read(length).unpack("b8").last.to_s
+    #Process that one wierd boolean that is actually an int, instead of a bit
+    when 'boolint'
+      value = filehandle.read(length).unpack("U").first.to_i
+      #Change the values of the field to Y/N for the varchar(1) representation of BOOLEAN
+      if value == 1
+        value = 'Y'
+      else
+        value = 'N'
+      end
+    end
+    return value
+  end
+
+  #Mehtod that performs the conversions
+  def convert_binary_file(filehandle, schema, extra_byte)
+    
+    #Read header information first
+    fileversion = dump_binary(filehandle, 'int', 4)
+    filenumber = dump_binary(filehandle, 'int', 4)
+
+    bool_cnt = 0
+    bytearray = nil
+    data = Array.new
+    while filehandle.eof == FALSE do
+      record = Hash.new
+      schema["echi_records"].each do | field |
+        #We handle the 'boolean' fields differently, as they are all encoded as bits in a single 8-bit byte
+        if field["type"] == 'bool'
+          if bool_cnt == 0
+            bytearray = dump_binary(filehandle, field["type"], field["length"])
+          end
+          #Ensure we parse the bytearray and set the appropriate flags
+          #We need to make sure the entire array is not nil, in order to do Y/N
+          #if Nil we then set all no
+          if bytearray != '00000000'
+            if bytearray.slice(bool_cnt,1) == '1'
+              value = 'Y'
+            else
+              value = 'N'
+            end
+          else
+            value = 'N'
+          end
+          record.merge!({ field["name"] => value })
+          bool_cnt += 1
+          if bool_cnt == 8
+            bool_cnt = 0
+          end
+        else
+          #Process 'standard' fields
+          value = dump_binary(filehandle, field["type"], field["length"])
+          record.merge!({ field["name"] => value })
+        end
+        
+      end
+
+      #Scan past the end of line record if enabled in the configuration file
+      #Comment this out if you do not need to read the 'extra byte'
+      if extra_byte
+        filehandle.read(1)
+      end
+      data << record
+    end
+    
+    return data
+  end
+
+  #Method to create a Ruby hash out of the Avaya ECHI files
+  #@filehandle The filehandle
+  #@type Whether this is ASCII or Binary data
+  #@schema Whether this is the ECHI EXTENDED or STANDARD file format
+  def convert_ascii_file(filehandle, schema)
+
+    data = Array.new
+    filehandle.each do |line|
+      record = Hash.new
+      FasterCSV.parse(line) do |row|
+        cnt = 0
+        row.each do |field|
+          if field != nil
+            if schema["echi_records"][cnt]["type"] == "bool" || schema["echi_records"][cnt]["type"] == "boolint"
+              case field
+              when "0"
+                record.merge!({ schema["echi_records"][cnt]["name"] => "N" })
+              when "1"
+                record.merge!({ schema["echi_records"][cnt]["name"] => "Y" })
+              when nil
+                record.merge!({ schema["echi_records"][cnt]["name"] => "N" })
+              else
+                record.merge!({ schema["echi_records"][cnt]["name"] => "Y" })
+              end
+            else
+              record.merge!({ schema["echi_records"][cnt]["name"] => field })
+            end
+            cnt += 1
+          end
+        end
+      end
+      data << record
+    end
+    
+    return data
+  end
+  
+  #Pass a filehandle of the file to process that includes
+  #@filehandle The filehandle
+  #@type Whether this is ASCII or Binary data
+  #@format Whether this is the ECHI EXTENDED or STANDARD file format
+  #@extra_byte Set to true if you want to read an extra byte at the end of each record
+  #This method will return an array of hashes of the resulting data processed
+  def process_file(filehandle, type, format, extra_byte)
+    
+    #Set the appropriate schema format for standard or extended from the Avaya CMS
+    case format
+    when 'EXTENDED'
+      schema = @extended
+    when 'STANDARD'
+      schema = @standard
+    end
+    
+    #Process based on the filetype passed
+    case type
+    when 'ASCII'
+      return convert_ascii_file(filehandle, schema)
+    when 'BINARY'
+      return convert_binary_file(filehandle, schema, extra_byte)
+    end
+    
+  end
+  
+  #Method used to strip special characters
+  #@data An Array of Hashes to be processed
+  #@characters An Array of charcters to be stripped
+  def strip_asaiuui(data, characters)
+    
+    stripped_data = Array.new
+    data.each do |row|
+      characters.each do |char|
+        row["asaiuui"].gsub!(char.chr,"")
+      end
+      stripped_data << row
+    end
+    
+    return stripped_data
+  end
+  
+end

data/lib/extended-definition.yml

@@ -0,0 +1,234 @@
+#ECH File construct, order is important, as the application sequentially reads the file
+#Version 12 through 15 - Extended Schema
+echi_records:
+    - 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: tklocid
+      type: int
+      length: 2
+    - name: origlocid
+      type: int
+      length: 2
+    - name: answerlocid
+      type: int
+      length: 2
+    - name: obslocid
+      type: int
+      length: 2
+    - name: uuilen
+      type: int
+      length: 2
+    - name: assist
+      type: bool
+      length: 1
+    - name: audiodifficulty
+      type: bool
+      length: 1
+    - name: conference
+      type: bool
+      length: 1
+    - name: daqueued
+      type: bool
+      length: 1
+    - name: holdabn
+      type: bool
+      length: 1
+    - name: malicious
+      type: bool
+      length: 1
+    - name: observingcall
+      type: bool
+      length: 1
+    - name: transferred
+      type: bool
+      length: 1
+    - name: agentreleased
+      type: boolint
+      length: 1
+    - name: acdnum
+      type: int
+      length: 1
+    - name: calldisp
+      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: origlogid
+      type: str
+      length: 10
+    - name: anslogid
+      type: str
+      length: 10
+    - name: lastobserver
+      type: str
+      length: 10
+    - name: dialednumber
+      type: str
+      length: 25
+    - name: callingparty
+      type: str
+      length: 13
+    - name: collectdigits
+      type: str
+      length: 17
+    - name: cwcdigits
+      type: str
+      length: 17
+    - name: callingII
+      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

data/lib/standard-definition.yml

@@ -0,0 +1,198 @@
+#ECH File construct, order is important, as the application sequentially reads the file
+#Version 14 - Standard Schema
+echi_records:
+    - 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: 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: tklocid
+      type: int
+      length: 2
+    - name: origlocid
+      type: int
+      length: 2
+    - name: answerlocid
+      type: int
+      length: 2
+    - name: obslocid
+      type: int
+      length: 2
+    - name: assist
+      type: bool
+      length: 1
+    - name: audiodifficulty
+      type: bool
+      length: 1
+    - name: conference
+      type: bool
+      length: 1
+    - name: daqueued
+      type: bool
+      length: 1
+    - name: holdabn
+      type: bool
+      length: 1
+    - name: malicious
+      type: bool
+      length: 1
+    - name: observingcall
+      type: bool
+      length: 1
+    - name: transferred
+      type: bool
+      length: 1
+    - name: agentreleased
+      type: boolint
+      length: 1
+    - name: acdnum
+      type: int
+      length: 1
+    - name: calldisp
+      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: origlogid
+      type: str
+      length: 10
+    - name: anslogid
+      type: str
+      length: 10
+    - name: lastobserver
+      type: str
+      length: 10
+    - name: dialednumber
+      type: str
+      length: 25
+    - name: callingparty
+      type: str
+      length: 13
+    - name: collectdigits
+      type: str
+      length: 17
+    - name: cwcdigits
+      type: str
+      length: 17
+    - name: callingII
+      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

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: jsgoecke-echi_files
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jason Goecke
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-19 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: fastercsv
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.4.0
+    version: 
+description: Ruby Library for processing External Call History (ECHI) files from the Avaya CMS
+email: 
+- jason -at- goecke.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/echi_files.rb
+- lib/extended-definition.yml
+- lib/standard-definition.yml
+- LICENSE
+- README.textile
+- echi_files.gemspec
+has_rdoc: false
+homepage: http://jsgoecke.github.com/echi_files
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Ruby Library for Processing Avaya ECHI Files
+test_files: []
+