jsgoecke-echi_files 0.2.0 → 0.2.1

data/echi_files.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name = "echi_files"
-  s.version = "0.2.0"
-  s.date = "2009-01-19"
+  s.version = "0.2.1"
+  s.date = "2009-01-26"
   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"]

data/lib/echi_files.rb

@@ -1,14 +1,35 @@
+# This library is used to process Avaya CMS ECHI Files
+#
+# Author::    Jason Goecke  (mailto:jason@goecke.net)
+# Copyright:: Copyright (c) 2009 Jason Goecke
+# License::   Distributes under the MIT License
+#
+# This class contains the methods for processing both
+# binary and ascii files from the Avaya CMS
+
 require 'yaml'
 require 'fastercsv'
 
 class EchiFiles
   
+  #Load the associated schema definitions of the Avaya ECHI files
   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
+  #Method to determine if the file is binary or ASCII encoded
+  def detect_filetype(filehandle)
+    if filehandle.read(1).is_binary_data?
+      type = 'BINARY'
+    else
+      type = 'ASCII'
+    end
+    filehandle.rewind
+    return type
+  end
+  
+  #Method for parsing the various datatypes from the binary ECHI file
   def dump_binary(filehandle, type, length)
     case type
     when 'int'
@@ -48,7 +69,7 @@ class EchiFiles
     return value
   end
 
-  #Mehtod that performs the conversions
+  #Mehtod that performs the conversions of files
   def convert_binary_file(filehandle, schema, extra_byte)
     
     #Read header information first
@@ -145,7 +166,7 @@ class EchiFiles
   #@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)
+  def process_file(filehandle, format, extra_byte)
     
     #Set the appropriate schema format for standard or extended from the Avaya CMS
     case format
@@ -156,7 +177,7 @@ class EchiFiles
     end
     
     #Process based on the filetype passed
-    case type
+    case detect_filetype(filehandle)
     when 'ASCII'
       return convert_ascii_file(filehandle, schema)
     when 'BINARY'
@@ -170,7 +191,6 @@ class EchiFiles
   #@fields An array of fields to strip characters from
   #@characters An Array of characters to be stripped
   def strip_special_characters(data, fields, characters)
-
     stripped_data = Array.new
     data.each do |row|
       fields.each do |field|
@@ -182,7 +202,6 @@ class EchiFiles
       end
       stripped_data << row
     end
-    
     return stripped_data
   end
   

data/test/test_echi_files.rb

@@ -8,6 +8,7 @@ class EchiFiles_Test < Test::Unit::TestCase
     #Provide a filename to process as an argument on the commandline
     binary_file = File.open(File.expand_path("test/example_binary_file"))
     ascii_file = File.open(File.expand_path("test/example_ascii_file"))
+    
     @proper_unstripped = YAML::load(File.open(File.expand_path("test/proper_unstripped.yml")))
     @proper_stripped = YAML::load(File.open(File.expand_path("test/proper_stripped.yml")))
     @proper_ascii = YAML::load(File.open(File.expand_path("test/proper_ascii.yml")))
@@ -15,12 +16,17 @@ class EchiFiles_Test < Test::Unit::TestCase
     #Create a new EchiFiles object
     echi_handler = EchiFiles.new
 
+    #Set filetype details
+    @filetype_binary = echi_handler.detect_filetype(binary_file)
+    binary_file.rewind
+    @filetype_ascii = echi_handler.detect_filetype(ascii_file)
+    ascii_file.rewind
+    
     #Use this to process a binary file
-    file_type = 'BINARY'
     format = 'EXTENDED'
     #In some cases the extra_byte is needed
     extra_byte = true
-    @binary_data = echi_handler.process_file(binary_file, file_type, format, extra_byte)
+    @binary_data = echi_handler.process_file(binary_file, format, extra_byte)
     #If you need to strip in characters from the asaiuui field
     @stripped_data = Array.new
     @binary_data.each do |data|
@@ -28,14 +34,23 @@ class EchiFiles_Test < Test::Unit::TestCase
     end
     
     #Use this to process an ASCII file
-    file_type = 'ASCII'
     format = 'EXTENDED'
-    @ascii_data = echi_handler.process_file(ascii_file, file_type, format, extra_byte)
+    @ascii_data = echi_handler.process_file(ascii_file, format, extra_byte)
   end
   
   def teardown
   end
   
+  #Test method that determine filetype
+  def test_filetype_ascii
+    assert_equal("ASCII", @filetype_ascii)
+  end
+  
+  #Test method that determine filetype
+  def test_filetype_binary
+    assert_equal("BINARY", @filetype_binary)
+  end
+  
   #Test that processing a binary file works
   def test_binary_file
     assert_equal(@proper_unstripped, @binary_data)
@@ -50,4 +65,5 @@ class EchiFiles_Test < Test::Unit::TestCase
   def test_ascii_file
     assert_equal(@ascii_data, @proper_ascii)
   end
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jsgoecke-echi_files
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Jason Goecke
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-19 00:00:00 -08:00
+date: 2009-01-26 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency