topographer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0f240a307703861f83b040a054ad1f89ae397823
+  data.tar.gz: 3fab2dc9130cd3507b2f7fccb169ab1082847b38
+SHA512:
+  metadata.gz: f5a4c37297d5ee4c31f125b39e371067b2b78bff094a4052a3e48c690a6969ade6cc752542652a7bcc37ca4eca76d115bc1eeab41cecec4b6e154bfc794c174e
+  data.tar.gz: 6f18ca76a190026fc57a216ede46e51d2354df44de0b8c6270c1b224e230b712a2151af4aec806b0b5c54a33d86b2fd26be6e2dd8fcb2186eaf56830e58764bb

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in Topographer.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 SciMed Solutions
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 SciMed Solutions
+
+MIT License
+
+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.md

@@ -0,0 +1,38 @@
+# Topographer
+
+Topographer is a gem that provides functionality to conveniently import from various data sources into
+ActiveRecord or other ORM systems.  This accomplished by defining an input wrapper, a mapping from input data to
+ models, and a strategy for use in persisting data.
+
+ Check back soon for more documentation.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'Topographer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install Topographer
+
+## Usage
+
+Check back soon for detailed usage instructions
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+=======
+Topographer
+===========
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/Topographer/exceptions.rb

@@ -0,0 +1,4 @@
+class Topographer::InvalidMappingError < StandardError; end
+class Topographer::InvalidStructureError < Topographer::InvalidMappingError; end
+class Topographer::MappingFailure < Topographer::InvalidMappingError; end
+

data/lib/Topographer/importer.rb

@@ -0,0 +1,57 @@
+class Importer
+  require_relative 'importer/mapper'
+  require_relative 'importer/strategy'
+  require_relative 'importer/importable'
+  require_relative 'importer/logger'
+  require_relative 'importer/input'
+  require_relative 'importer/helpers'
+
+  attr_reader :logger
+
+  def self.build_mapper(model_class, &mapper_definition)
+    Mapper.build_mapper(model_class, &mapper_definition)
+  end
+
+  def self.import_data(input, import_class, strategy_class, logger, options = {})
+    dry_run = options.fetch(:dry_run, false)
+    importer = new(input, import_class, strategy_class, logger, dry_run)
+    importer.logger
+  end
+
+  def initialize(input, import_class, strategy_class, logger, dry_run)
+    @logger = logger
+    mapper = import_class.get_mapper(strategy_class)
+    valid_header = mapper.input_structure_valid?(input.get_header)
+
+    if valid_header
+      strategy = strategy_class.new(mapper)
+      strategy.dry_run = dry_run
+      import_data(strategy, input, mapper.model_class.name)
+    else
+      log_invalid_header(input, mapper)
+    end
+  end
+
+  def import_data(strategy, input, import_class)
+    input.each do |data|
+      status = strategy.import_record(data)
+      log_entry = Logger::LogEntry.new(input.input_identifier, import_class, status)
+      @logger.log_import(log_entry)
+    end
+  end
+
+  private
+
+  def log_invalid_header(input, mapper)
+    @logger.log_fatal input.input_identifier,
+                      invalid_header_message(mapper)
+  end
+
+  def invalid_header_message(mapper)
+    'Invalid Input Header - Missing Columns: ' +
+      mapper.missing_columns.join(', ') +
+      ' Invalid Columns: ' +
+      mapper.bad_columns.join(', ')
+  end
+
+end

data/lib/Topographer/importer/helpers.rb

@@ -0,0 +1,18 @@
+module Importer::Helpers
+  require_relative 'helpers/write_log_to_csv'
+
+  def boolify(word)
+    return nil if word.nil?
+
+    case word.downcase
+    when 'yes'
+      true
+    when 'no'
+      false
+    when 'true'
+      true
+    when 'false'
+      false
+    end
+  end
+end

data/lib/Topographer/importer/helpers/write_log_to_csv.rb

@@ -0,0 +1,85 @@
+require 'singleton'
+require 'csv'
+class Importer::Helpers::WriteLogToCSV
+  include Singleton
+
+  def initialize
+
+  end
+
+  def write_log_to_csv(log, output_file_path, options = {})
+    @log = log
+    @write_all = options.fetch(:write_all, true)
+    CSV.open(output_file_path, 'wb') do |csv_file|
+      csv_file << get_detail_header
+      csv_file << get_details
+      csv_file << get_log_header if @log.entries?
+      @log.all_entries.each do |entry|
+        if entry.failure? || @write_all
+
+          csv_file << format_log_entry(entry)
+        end
+      end
+    end
+  end
+
+  private
+
+    def get_detail_header
+      if @write_all
+        ['Fatal Errors', 'Total Imports', 'Successful Imports', 'Failed Imports']
+      else
+        ['Fatal Errors', 'Failed Imports']
+      end
+    end
+
+    def get_details
+      details = []
+      details << ((@log.fatal_error?) ? @log.fatal_errors.size : 'None')
+      if @write_all
+        details << @log.total_imports
+        details << @log.successful_imports
+      end
+      details << @log.failed_imports
+    end
+
+    def get_log_header
+      header = []
+      header << 'Input Identifier'
+      header << 'Source Identifier'
+      header << 'Model Class'
+      header << 'Timestamp'
+      header << 'Status'
+      header << 'Message'
+      header << 'Details'
+    end
+
+    def format_log_entry(log_entry)
+      entry = []
+      entry << log_entry.input_identifier
+      entry << log_entry.source_identifier
+      entry << log_entry.model_name
+      entry << log_entry.timestamp.strftime('%F - %T:%L')
+      entry << ((log_entry.success?) ? 'Success' : 'Failure')
+      entry << log_entry.message
+      entry << format_log_entry_details(log_entry.details)
+    end
+
+    def format_log_entry_details(details)
+      if details
+        formatted_details = []
+        details.keys.each do |key|
+          detail_string = ''
+          detail_messages = Array(details[key])
+          if detail_messages.any?
+            detail_string << key.to_s.capitalize << ': '
+            detail_string << detail_messages.join(', ')
+          end
+          formatted_details << detail_string unless detail_string.empty?
+        end
+        formatted_details.join("; ")
+      else
+        ''
+      end
+    end
+end

data/lib/Topographer/importer/importable.rb

@@ -0,0 +1,5 @@
+module Importer::Importable
+  def get_mapper(strategy)
+    raise NotImplementedError
+  end
+end

data/lib/Topographer/importer/input.rb

@@ -0,0 +1,5 @@
+class Importer::Input
+  require_relative 'input/source_data'
+  require_relative 'input/base'
+  require_relative 'input/roo'
+end

data/lib/Topographer/importer/input/base.rb

@@ -0,0 +1,13 @@
+class Importer::Input::Base
+  def get_header
+    raise NotImplementedError
+  end
+
+  def input_identifier
+    raise NotImplementedError
+  end
+
+  def each
+    raise NotImplementedError
+  end
+end

data/lib/Topographer/importer/input/roo.rb

@@ -0,0 +1,28 @@
+class Importer::Input::Roo < Importer::Input::Base
+  include Enumerable
+
+  def initialize(roo_sheet, header_row=1, data_row=2)
+    @sheet = roo_sheet
+    @header = @sheet.row(header_row).map(&:strip)
+    @start_data_row = data_row
+    @end_data_row = @sheet.last_row
+  end
+
+  def get_header
+    @header
+  end
+
+  def input_identifier
+    #This is apparently how you get the name of the sheet...this makes me sad
+    @sheet.default_sheet
+  end
+
+  def each
+    @start_data_row.upto @end_data_row do |row_number|
+      data = @sheet.row(row_number)
+      source_identifier = "Row: #{row_number}"
+      yield Importer::Input::SourceData.new(source_identifier,
+                                            Hash[@header.zip(data)])
+    end
+  end
+end

data/lib/Topographer/importer/input/source_data.rb

@@ -0,0 +1,8 @@
+class Importer::Input::SourceData
+  attr_reader :source_identifier, :data
+
+  def initialize(source_identifier, data)
+    @source_identifier = source_identifier
+    @data = data
+  end
+end

data/lib/Topographer/importer/logger.rb

@@ -0,0 +1,8 @@
+class Importer::Logger
+  require_relative 'logger/base'
+  require_relative 'logger/simple'
+  require_relative 'logger/file'
+  require_relative 'logger/log_entry'
+  require_relative 'logger/fatal_error_entry'
+
+end

data/lib/Topographer/importer/logger/base.rb

@@ -0,0 +1,69 @@
+class Importer::Logger::Base
+
+  attr_reader :fatal_errors
+
+  def initialize
+    @fatal_errors = []
+  end
+
+  def successes
+    raise NotImplementedError
+  end
+
+  def failures
+    raise NotImplementedError
+  end
+
+  def log_import(log_entry)
+    if log_entry.success?
+      log_success(log_entry)
+    else
+      log_failure(log_entry)
+    end
+  end
+
+  def log_success(log_entry)
+    raise NotImplementedError
+  end
+
+  def log_failure(log_entry)
+    raise NotImplementedError
+  end
+
+  def log_fatal(source, message)
+    @fatal_errors << Importer::Logger::FatalErrorEntry.new(source, message)
+  end
+
+  def successful_imports
+    raise NotImplementedError
+  end
+
+  def failed_imports
+    raise NotImplementedError
+  end
+
+  def entries?
+    total_imports > 0
+  end
+
+  def total_imports
+    (successful_imports + failed_imports)
+  end
+
+  def all_entries
+    (successes + failures + fatal_errors).sort {|a, b| a.timestamp <=> b.timestamp}
+  end
+
+  def errors?
+    fatal_error? || failed_imports > 0
+  end
+
+  def fatal_error?
+    @fatal_errors.any?
+  end
+
+  def save
+    raise NotImplementedError
+  end
+
+end

data/lib/Topographer/importer/logger/fatal_error_entry.rb

@@ -0,0 +1,19 @@
+class Importer::Logger::FatalErrorEntry < Importer::Logger::LogEntry
+  attr_reader :message, :timestamp, :model_name
+
+  def initialize(input_identifier, message)
+    @timestamp = DateTime.now
+    @input_identifier = input_identifier
+    @model_name = 'N/A'
+    @message = message
+  end
+  def source_identifier
+    'import failure'
+  end
+  def details
+    {}
+  end
+  def failure?
+    true
+  end
+end