factorylabs-activewarehouse-etl 0.9.1.2

data/CHANGELOG

@@ -0,0 +1,198 @@
+0.1.0 - Dec 6, 2006
+* Initial release
+
+0.2.0 - Dec 7, 2006
+* Added an XML parser for source parsing
+* Added support for compound key constraints in destinations via the 
+  :unique => [] option
+* Added ability to declare explicit columns in bulk import
+* Added support for generators in destinations
+* Added a SurrogateKeyGenerator for cases where the database doesn't support
+  auto generated surrogate keys
+
+0.3.0 - Dec 19, 2006
+* Added support for calculated values in virtual fields with Proc
+
+0.4.0 - Jan 11, 2006
+* Added :skip_lines option to file source configurations, which can be used
+  to skip the first n lines in the source data file
+* Added better error handling in delimited parser - an error is now raised 
+  if the expected and actual field lengths do not match
+* Added :truncate option for database destination. Set to true to truncate 
+  before importing data.
+* Added support for :unique => [] option and virtual fields for the database 
+  destination
+
+0.5.0 - Feb 17, 2007
+* Changed require_gem to gem and added alias to allow for older versions of 
+  rubygems.
+* Added support for Hash in the source configuration where :name => :parser_name
+  defines the parser to use and :options => {} defines options to pass to the 
+  parser.
+* Added support for passing a custom Parser class in the source configuration.
+* Removed the need to include Enumerable in each parser implementation.
+* Added new date_to_string and string_to_date transformers.
+* Implemented foreign_key_lookup transform including an ActiveRecordResolver.
+* Added real time activity logging which is called when the etl bin script is 
+  invoked.
+* Improved error handling.
+* Default logger level is now WARN.
+
+0.5.1 - Feb 18, 2007
+* Fixed up truncate processor.
+* Updated HOW_TO_RELEASE doc.
+
+0.5.2 - Feb 19, 2007
+* Added error threshold.
+* Fixed problem with transform error handling.
+
+0.6.0 - Mar 8, 2007
+* Fixed missing method problem in validate in Control class.
+* Removed control validation for now (source could be code in the control file).
+* Transform interface now defined as taking 3 arguments, the field name, field 
+  value and the row. This is not backwards compatible.
+* Added HierarchyLookupTransform.
+* Added DefaultTransform which will return a specified value if the initial 
+  value is blank.
+* Added row-level processing.
+* Added HierarchyExploderProcessor which takes a single hierarchy row and 
+  explodes it to multiple rows as used in a hierarchy bridge.
+* Added ApacheCombinedLogParser which parses Apache Combined Log format, 
+  including parsing of the 
+  user agent string and the URI, returning a Hash.
+* Fixed bug in SAX parser so that attributes are now set when the start_element
+  event is received.
+* Added an HttpTools module which provides some parsing methods (for user agent
+  and URI).
+* Database source now uses its own class for establishing an ActiveRecord 
+  connection.
+* Log files are now timestamped.
+* Source files are now archived automatically during the extraction process
+* Added a :condition option to the destination configuration Hash that accepts 
+  a Proc with a single argument passed to it (the row).
+* Added an :append_rows option to the destination configuration Hash that 
+  accepts either a Hash (to append a single row) or an Array of Hashes (to 
+  append multiple rows).
+* Only print the read and written row counts if there is at least one source 
+  and one destination respectively.
+* Added a depends_on directive that accepts a list of arguments of either strings 
+  or symbols. Each symbol is converted to a string and .ctl is appended; 
+  strings are passed through directly. The dependencies are executed in the order 
+  they are specified.
+* The default field separator in the bulk loader is now a comma (was a tab).
+
+0.6.1 - Mar 22, 2007
+* Added support for absolute paths in file sources
+* Added CopyFieldProcessor
+
+0.7 - Apr 8, 2007
+* Job execution is now tracked in a database. This means that ActiveRecord is 
+  required regardless of the sources being used in the ETL scripts. An example 
+  database configuration for the etl can be found in test/database.example.yml. 
+  This file is loaded from either a.) the current working directory or b.) the 
+  location specified using the -c command line argument when running the etl 
+  command.
+* etl script now supports the following command line arguments:
+** -h or --help: Prints the usage
+** -l or --limit: Specifies a limit for the number of source rows to read, 
+   useful for testing your control files before executing a full ETL process
+** -o or --offset: Specified a start offset for reading from the source, useful
+   for testing your control files before executing a full ETL process
+** -c or --config: Specify the database.yml file to configure the ETL 
+   execution data store
+** -n or --newlog: Write to the logfile rather than appending to it
+* Database source now supports specifying the select, join and order parts of 
+  the query.
+* Database source understands the limit argument specified on the etl command 
+  line
+* Added CheckExistProcessor
+* Added CheckUniqueProcessor
+* Added SurrogateKeyProcessor. The SurrogateKey processor should be used in 
+  conjunction with the CheckExistProcessor and CheckUniqueProcessor to provide
+  surrogate keys for all dimension records.
+* Added SequenceProcessor
+* Added OrdinalizeTransform
+* Fixed a bug in the trim transform
+* Sources now provide a trigger file which can be used to indicate that the 
+  original source data has been completely extracted to the local file system. 
+  This is useful if you need to recover from a failed ETL process.
+* Updated README
+
+0.7.1 - Apr 8, 2007
+* Fixed source caching
+
+0.7.2 - Apr 8, 2007
+* Fixed quoting bug in CheckExistProcessor
+
+0.8.0 - Apr 12, 2007
+* Source now available through the current row source accessor.
+* Added new_rows_only configuration option to DatabaseSource. A date field must
+  be specified and only records that are greater than the date value in that 
+  field, relative to the last successful
+  execution, will be returned from the source.
+* Added an (untested) count feature which returns the number of rows for 
+  processing.
+* If no natural key is defined then an empty array will now be used, resulting
+  in the row being written to the output without going through change checks.
+* Mapping argument in destination is now optional. An empty hash will be used
+  if the mapping hash is not specified. If the mapping hash is not specified 
+  then the order will be determined using the originating source's order.
+* ActiveRecord configurations loaded from database.yml by the etl tool will be 
+  merged with ActiveRecord::Base.configurations.
+* Fixed several bugs in how record change detection was implemented.
+* Fixed how the read_locally functionality was implemented so that it will find
+  that last completed local source copy using the source's trigger file (untested).
+  
+0.8.1 - Apr 12, 2007
+* Added EnumerableSource
+* Added :type configuration option to the source directive, allowing the source
+  type to be explicitly specified. The source type can be a string or symbol 
+  (in which case the class will be constructed by appending Source to the type 
+  name), a class (which will be instantiate and passed the control, 
+  configuration and mapping) and finally an actual Source instance.
+  
+0.8.2 - April 15, 2007
+* Fixed bug with premature destination closing.
+* Added indexes to execution records table.
+* Added a PrintRowProcessor.
+* Added support for conditions and "group by" in the database source.
+* Added after_initialize hook in Processor base class.
+* Added examples directory
+
+0.8.3 - May 13, 2007
+* Added patches from Andy Triboletti
+
+0.8.4 - May 24, 2007
+* Added fix for backslash in file writer
+
+0.9.0 - August 9, 2007
+* Added support for batch processing through .ebf files. These files are
+  essentially control files that apply settings to an entire ETL process.
+* Implemented support for screen blocks. These blocks can be used to test
+  the data and raise an error if the screens do not pass.
+* Connections are now cached in a Hash available through 
+  ETL::Engine.connection(name). This should be used rather than including
+  connection information in the control files.
+* Implemented temp table support throughout.
+* DateDimensionBuilder now included in ActiveWarehouse ETL directly.
+* Time calculations for fiscal year now included in ActiveWarehouse ETL.
+
+0.9.1 -
+* SQLResolver now uses ETL::Engine.table so it may utilize temp tables. (aeden)
+* Added Thibaut Barrère's encode processor.
+* Added MockSource and MockDestination test helpers (thbar)
+* Added the block processor. Can call a block once (pre/post processor)
+  or once for each row (after_read/before_write row processor) (thbar)
+* Changed temp table to use new AdapterExtension copy_table method (aeden)
+* Added bin/etl.cmd windows batch - just add the bin folder to your PATH
+  and it will let you call etl on an unpacked/pistoned version of AW-ETL (thbar)
+* Upgraded to support Rails 2.1. No longer compatible with older versions of Rails.
+* Added ETL::Builder::TimeDimensionBuilder
+* Added :default option to ForeignKeyLookupTransform that will be used if no
+  foreign key is found.
+* Added :cache option to ForeignKeyLookupTransform that will preload the FK
+  mappings if the underlying resolver supports it. Currently supported by 
+  SQLResolver.
+* A Class extending ETL::Transform::Transform may now be passed as a transformer.
+  For example, in the control file you would define the transform as:
+  transform :a_field, MyTransform, {:option1 => 'option1'}.

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2006-2007 Anthony Eden
+
+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

@@ -0,0 +1,85 @@
+Ruby Extract-Transform-Load (ETL) tool.
+
+== Requirements
+
+* Ruby 1.8.5 or higher
+* Rubygems
+
+== Online Documentation
+
+Available at http://activewarehouse.rubyforge.org/docs/activewarehouse-etl.html
+
+== Features
+
+Current supported features:
+
+* ETL Domain Specific Language (DSL) - Control files are specified in a Ruby-based DSL
+* Multiple source types. Current supported types:
+  * Fixed-width and delimited text files
+  * XML files through SAX
+  * Apache combined log format
+* Multiple destination types - file and database destinations
+* Support for extracting from multiple sources in a single job
+* Support for writing to multiple destinations in a single job
+* A variety of built-in transformations are included:
+  * Date-to-string, string-to-date, string-to-datetime, string-to-timestamp
+  * Type transformation supporting strings, integers, floats and big decimals
+  * Trim
+  * SHA-1
+  * Decode from an external decode file
+  * Default replacement for empty values
+  * Ordinalize
+  * Hierarchy lookup
+  * Foreign key lookup
+  * Ruby blocks
+  * Any custom transformation class
+* A variety of build-in row-level processors
+  * Check exists processor to determine if the record already exists in the destination database
+  * Check unique processor to determine whether a matching record was processed during this job execution
+  * Copy field
+  * Rename field
+  * Hierarchy exploder which takes a tree structure defined through a parent id and explodes it into a hierarchy bridge table
+  * Surrogate key generator including support for looking up the last surrogate key from the target table using a custom query
+  * Sequence generator including support for context-sensitive sequences where the context can be defined as a combination of fields from the source data
+  * New row-level processors can easily be defined and applied
+* Pre-processing
+  * Truncate processor
+* Post-processing
+  * Bulk import using native RDBMS bulk loader tools
+* Virtual fields - Add a field to the destination data which doesn't exist in the source data
+* Built in job and record meta data
+* Support for type 1 and type 2 slowly changing dimensions
+  * Automated effective date and end date time stamping for type 2
+  * CRC checking
+
+== Dependencies
+ActiveWarehouse ETL depends on the following gems:
+* ActiveSupport Gem
+* ActiveRecord Gem
+* FasterCSV Gem
+* AdapterExtensions Gem
+
+== Usage
+Once the ActiveWarehouse ETL gem is installed jobs can be invoked using the
+included `etl` script. The etl script includes several command line options
+and can process multiple control files at a time.
+
+Command line options:
+* <tt>--help, -h</tt>: Display the usage message.
+* <tt>--config, -c</tt>: Specify a database.yml configuration file to use.
+* <tt>--limit, -l</tt>: Specify a limit to the number of rows to process. This option is currently only applicable to database sources.
+* <tt>--offset, -o</tt>: Specify the start offset for reading from the source. This option is currently only applicable to database sources.
+* <tt>--newlog, -n</tt>: Instruct the engine to create a new ETL log rather than append to the last ETL log.
+* <tt>--skip-bulk-import, -s</tt>: Skip any bulk imports.
+* <tt>--read-locally</tt>: Read from the local cache (skip source extraction)
+
+== Control File Examples
+Control file examples can be found in the examples directory.
+
+== Running Tests
+The tests require Shoulda 1.x.
+
+== Feedback
+This is a work in progress. Comments should be made on the 
+activewarehouse-discuss mailing list at the moment. Contributions are always
+welcome.

data/Rakefile

@@ -0,0 +1,153 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/contrib/rubyforgepublisher'
+
+require File.join(File.dirname(__FILE__), 'lib/etl', 'version')
+
+module AWETL
+  PKG_BUILD       = ENV['PKG_BUILD'] ? '.' + ENV['PKG_BUILD'] : ''
+  PKG_NAME        = 'activewarehouse-etl'
+  PKG_VERSION     = ETL::VERSION::STRING + PKG_BUILD
+  PKG_FILE_NAME   = "#{PKG_NAME}-#{PKG_VERSION}"
+  PKG_DESTINATION = ENV["PKG_DESTINATION"] || "../#{PKG_NAME}"
+end
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the ETL application.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+  # TODO: reset the database
+end
+
+desc 'Generate documentation for the ETL application.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActiveWarehouse ETL'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+namespace :rcov do
+  desc 'Measures test coverage'
+  task :test do
+    rm_f 'coverage.data'
+    mkdir 'coverage' unless File.exist?('coverage')
+    rcov = "rcov --aggregate coverage.data --text-summary -Ilib"
+    system("#{rcov} test/*_test.rb")
+    # system("open coverage/index.html") if PLATFORM['darwin']
+  end
+end
+
+# Gem Spec
+
+module AWETL
+  def self.package_files(package_prefix)
+    FileList[
+      "#{package_prefix}CHANGELOG",
+      "#{package_prefix}LICENSE",
+      "#{package_prefix}README",
+      "#{package_prefix}TODO",
+      "#{package_prefix}Rakefile",
+      "#{package_prefix}bin/**/*",
+      "#{package_prefix}doc/**/*",
+      "#{package_prefix}lib/**/*",
+      "#{package_prefix}examples/**/*",
+    ] - [ "#{package_prefix}test" ]
+  end
+
+  def self.spec(package_prefix = '')
+    Gem::Specification.new do |s|
+      s.name = 'activewarehouse-etl'
+      s.version = AWETL::PKG_VERSION
+      s.summary = "Pure Ruby ETL package."
+      s.description = <<-EOF
+        ActiveWarehouse ETL is a pure Ruby Extract-Transform-Load application for loading data into a database.
+      EOF
+
+      s.add_dependency('rake',                '>= 0.7.1')
+      s.add_dependency('activesupport',       '>= 1.3.1')
+      s.add_dependency('activerecord',        '>= 1.14.4')
+      s.add_dependency('fastercsv',           '>= 1.2.0')
+      s.add_dependency('adapter_extensions',  '>= 0.1.0')
+
+      s.rdoc_options << '--exclude' << '.'
+      s.has_rdoc = false
+
+      s.files = package_files(package_prefix).to_a.delete_if {|f| f.include?('.svn')}
+      s.require_path = 'lib'
+
+      s.bindir = "#{package_prefix}bin" # Use these for applications.
+      s.executables = ['etl']
+      s.default_executable = "etl"
+
+      s.author = "Anthony Eden"
+      s.email = "anthonyeden@gmail.com"
+      s.homepage = "http://activewarehouse.rubyforge.org/etl"
+      s.rubyforge_project = "activewarehouse"
+    end
+  end
+end
+
+Rake::GemPackageTask.new(AWETL.spec) do |pkg|
+  pkg.gem_spec = AWETL.spec
+  pkg.need_tar = true
+  pkg.need_zip = true
+end
+
+desc "Generate code statistics"
+task :lines do
+  lines, codelines, total_lines, total_codelines = 0, 0, 0, 0
+
+  for file_name in FileList["lib/**/*.rb"]
+    next if file_name =~ /vendor/
+    f = File.open(file_name)
+
+    while line = f.gets
+      lines += 1
+      next if line =~ /^\s*$/
+      next if line =~ /^\s*#/
+      codelines += 1
+    end
+    puts "L: #{sprintf("%4d", lines)}, LOC #{sprintf("%4d", codelines)} | #{file_name}"
+
+    total_lines     += lines
+    total_codelines += codelines
+
+    lines, codelines = 0, 0
+  end
+
+  puts "Total: Lines #{total_lines}, LOC #{total_codelines}"
+end
+
+desc "Publish the release files to RubyForge."
+task :release => [ :package ] do
+  `rubyforge login`
+
+  for ext in %w( gem tgz zip )
+    release_command = "rubyforge add_release activewarehouse #{AWETL::PKG_NAME} 'REL #{AWETL::PKG_VERSION}' pkg/#{AWETL::PKG_NAME}-#{AWETL::PKG_VERSION}.#{ext}"
+    puts release_command
+    system(release_command)
+  end
+end
+
+desc "Publish the API documentation"
+task :pdoc => [:rdoc] do 
+  Rake::SshDirPublisher.new("aeden@rubyforge.org", "/var/www/gforge-projects/activewarehouse/etl/rdoc", "rdoc").upload
+end
+
+desc "Reinstall the gem from a local package copy"
+task :reinstall => [:package] do
+  windows = RUBY_PLATFORM =~ /mswin/
+  sudo = windows ? '' : 'sudo'
+  gem = windows ? 'gem.bat' : 'gem'
+  `#{sudo} #{gem} uninstall #{AWETL::PKG_NAME} -x`
+  `#{sudo} #{gem} install pkg/#{AWETL::PKG_NAME}-#{AWETL::PKG_VERSION}`
+end

data/TODO

@@ -0,0 +1,28 @@
+TODO
+
+* Add build-in support for audit_dimension
+* Do not rerun the processing if it isn't needed, i.e. the source and control files have not been modified (allow forced override)
+* Provide greater control in error handling
+** Allow a error threshold
+** Don't die completely if a parse error, just stop processing that specific file if error threshold is reached
+** Allow mismatch row length error in delimited parser to be ignored
+* Improve error messages throughout, but especially in problems with the control files
+* Add support for paritioned views during the insert process. Use specifiable columns as the trigger columns for determining the data output destination.
+* Check if a temp table exists and the last job run was successful, in which case skip during the current run
+* Create models for each of the tables in each of the databases defined in ETL::Engine.connections
+
+Audit Record
+  
+Process-Level
+  * Start Time
+  * End Time
+  * (Duration)
+  * Rows Read
+  * Rows Written
+  * Rows Rejected
+  * Errors
+  * Destination
+Record-Level
+  * Source
+  * Timestamp
+  * Transformation Log