longleaf 0.1.0.pre.2

data/lib/longleaf/services/storage_location_validator.rb

@@ -0,0 +1,60 @@
+require 'pathname'
+require 'longleaf/models/storage_location'
+require 'longleaf/models/app_fields'
+require 'longleaf/errors'
+require_relative 'configuration_validator'
+require 'longleaf/services/storage_path_validator'
+
+# Validates application configuration of storage locations
+module Longleaf
+  class StorageLocationValidator < ConfigurationValidator
+    AF ||= Longleaf::AppFields
+    
+    # Validates configuration to ensure that it is syntactically correct and does not violate 
+    # schema and uniqueness requirements.
+    # @param config [Hash] hash containing the application configuration
+    def self.validate_config(config)
+      assert("Configuration must be a hash, but a #{config.class} was provided", config.class == Hash)
+      assert("Configuration must contain a root '#{AF::LOCATIONS}' key", config.key?(AF::LOCATIONS))
+      locations = config[AF::LOCATIONS]
+      assert("'#{AF::LOCATIONS}' must be a hash of locations", locations.class == Hash)
+      
+      existing_paths = Array.new
+      locations.each do |name, properties|
+        assert("Name of storage location must be a string, but was of type #{name.class}", name.instance_of?(String))
+        assert("Storage location '#{name}' must be a hash, but a #{properties.class} was provided", properties.is_a?(Hash))
+        
+        assert_path_property_valid(name, AF::LOCATION_PATH, properties, existing_paths)
+        assert_path_property_valid(name, AF::METADATA_PATH, properties, existing_paths)
+      end
+    end
+    
+    private
+    def self.assert_path_property_valid(name, path_prop, properties, existing_paths)
+      path = properties[path_prop]
+      begin
+        StoragePathValidator::validate(path)
+      rescue InvalidStoragePathError => err
+        raise ConfigurationError.new(
+            "Storage location '#{name}' specifies invalid '#{path_prop}' property: #{err.message}")
+      end
+      assert("Storage location '#{name}' must specify a '#{path_prop}' property", !path.nil? && !path.empty?)
+      assert("Storage location '#{name}' must specify an absolute path for property '#{path_prop}'",
+          Pathname.new(path).absolute? && !path.include?('/..'))
+      # Ensure paths have trailing slash to avoid matching on partial directory names
+      path += '/' unless path.end_with?('/')
+      # Verify that the (metadata_)path property's value is not inside of another storage location or vice versa
+      existing_paths.each do |existing|
+        if existing.start_with?(path) || path.start_with?(existing)
+          msg = "Location '#{name}' defines property #{path_prop} with value '#{path}'" \
+                " which overlaps with another configured path '#{existing}'." \
+                " Storage locations must not define #{AF::LOCATION_PATH} or #{AF::METADATA_PATH}" \
+                " properties which are contained by another location property"
+          raise ConfigurationError.new(msg)
+        end
+      end
+      
+      existing_paths << path
+    end
+  end
+end

data/lib/longleaf/services/storage_path_validator.rb

@@ -0,0 +1,16 @@
+require 'longleaf/errors'
+
+# Validator for storage paths
+module Longleaf
+  class StoragePathValidator
+    # Checks that the given path is a syntactically valid storage path
+    # @param path [String] file storage path to validate
+    # @raises [InvalidStoragePathError]
+    def self.validate(path)
+      raise InvalidStoragePathError.new("Path must not be empty") if path.to_s.strip.empty?
+      raise InvalidStoragePathError.new("Path must be absolute") unless Pathname.new(path).absolute?
+      raise InvalidStoragePathError.new("Path must not contain any relative modifiers (/..)") \
+          if path.include?('/..')
+    end
+  end
+end

data/lib/longleaf/specs/config_builder.rb

@@ -0,0 +1,102 @@
+require_relative '../models/app_fields'
+require_relative '../models/service_fields'
+require 'yaml'
+
+# Test helper for constructing application configuration hashes
+module Longleaf
+  class ConfigBuilder
+    AF ||= Longleaf::AppFields
+    SF ||= Longleaf::ServiceFields
+    
+    attr_accessor :config
+  
+    def initialize
+      @config = Hash.new
+    end
+  
+    # Add a root 'locations' field to the config
+    # @param locations [Hash] value for the locations fields. Default is {}
+    # @return this builder
+    def with_locations(locations = Hash.new)
+      @config[AF::LOCATIONS] = locations
+      self
+    end
+  
+    # Add a 'location' to the config
+    # @param name [String] name of the location
+    # @param path [String] value for the 'path' field
+    # @param md_path [String] value for the 'metadata_path' field
+    # @return this builder
+    def with_location(name:, path: '/file/path/', md_path: '/metadata/path/')
+      @config[AF::LOCATIONS] = Hash.new unless @config.key?(AF::LOCATIONS)
+      
+      location = {}
+      @config[AF::LOCATIONS][name] = location
+      location[AF::LOCATION_PATH] = path unless path.nil?
+      location[AF::METADATA_PATH] = md_path unless md_path.nil?
+      self
+    end
+    
+    # Add a root 'services' field to the config
+    # @param services [Hash] value for the services field. Default is {}
+    # @return this builder
+    def with_services(services = Hash.new)
+      @config[AF::SERVICES] = services
+      self
+    end
+    
+    # Add a 'service' to the config
+    # @param name [String] name of the service
+    # @param work_script [String] value for the 'work_script' field
+    # @param frequency [String] value for the 'frequency' field
+    # @param delay [String] value for the 'delay' field
+    # @param properties [Hash] hash of additional properties to include in the service
+    # @return this builder
+    def with_service(name:, work_script: 'some_pres_service.rb', frequency: nil, delay: nil, properties: nil)
+      @config[AF::SERVICES] = Hash.new unless @config.key?(AF::SERVICES)
+      
+      service = {}
+      service[SF::WORK_SCRIPT] = work_script
+      service[SF::FREQUENCY] = frequency unless frequency.nil?
+      service[SF::DELAY] = delay unless delay.nil?
+      service = service.merge(properties) unless properties.nil?
+      @config[AF::SERVICES][name] = service
+      self
+    end
+    
+    # Adds a 'service_mappings' section to the config
+    # @param mappings [Object] the mappings config
+    # @return this builder
+    def with_mappings(mappings = Hash.new)
+      @config[AF::SERVICE_MAPPINGS] = mappings
+      self
+    end
+    
+    # Add a mapping from one or more services to one or more location
+    # @param loc_names [Object] one or more location names. Can be a string or array.
+    # @param service_names [Object] one or more service names. Can be a string or array.
+    def map_services(loc_names, service_names)
+      @config[AF::SERVICE_MAPPINGS] = Array.new unless @config.key?(AF::SERVICE_MAPPINGS)
+      
+      mapping = Hash.new
+      mapping[AF::LOCATIONS] = loc_names unless loc_names.nil?
+      mapping[AF::SERVICES] = service_names unless service_names.nil?
+      @config[AF::SERVICE_MAPPINGS].push(mapping)
+      self
+    end
+    
+    # @return the constructed configuration
+    def get
+      @config
+    end
+    
+    # Writes the configuration from this builder into a temporary file
+    # @return the file path of the config file
+    def write_to_yaml_file
+      Tempfile.open('config') do |f|
+        f.write(@config.to_yaml)
+        return f.path
+      end
+    end
+  end
+end

data/lib/longleaf/version.rb

@@ -0,0 +1,3 @@
+module Longleaf
+  VERSION = "0.1.0.pre.2"
+end

data/lib/longleaf.rb

@@ -0,0 +1,4 @@
+require "longleaf/version"
+
+module Longleaf
+end

data/longleaf.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'longleaf/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "longleaf"
+  spec.version       = Longleaf::VERSION
+  spec.authors       = ["bbpennel"]
+  spec.email         = ["bbpennel@email.unc.edu"]
+
+  spec.summary       = %q{Longleaf preservation services tool}
+  spec.description   = %q{Provides a framework for performing preservation services over sets of files.}
+  spec.homepage      = "https://github.com/UNC-Libraries/"
+  spec.license       = "Apache-2.0"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = "longleaf"
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "thor", "~> 0.20.0"
+  spec.add_dependency "yard", "~> 0.9.16"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.6.0"
+  spec.add_development_dependency "factory_bot", "~> 4.0"
+  spec.add_development_dependency "aruba", "~> 0.14.0"
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: longleaf
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre.2
+platform: ruby
+authors:
+- bbpennel
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.16
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.16
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+description: Provides a framework for performing preservation services over sets of
+  files.
+email:
+- bbpennel@email.unc.edu
+executables:
+- longleaf
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/longleaf
+- lib/longleaf.rb
+- lib/longleaf/cli.rb
+- lib/longleaf/commands/abstract_command.rb
+- lib/longleaf/commands/register_command.rb
+- lib/longleaf/commands/validate_config_command.rb
+- lib/longleaf/errors.rb
+- lib/longleaf/events/register_event.rb
+- lib/longleaf/logging.rb
+- lib/longleaf/logging/redirecting_logger.rb
+- lib/longleaf/models/app_fields.rb
+- lib/longleaf/models/file_record.rb
+- lib/longleaf/models/md_fields.rb
+- lib/longleaf/models/metadata_record.rb
+- lib/longleaf/models/service_definition.rb
+- lib/longleaf/models/service_fields.rb
+- lib/longleaf/models/service_record.rb
+- lib/longleaf/models/storage_location.rb
+- lib/longleaf/services/application_config_deserializer.rb
+- lib/longleaf/services/application_config_manager.rb
+- lib/longleaf/services/application_config_validator.rb
+- lib/longleaf/services/configuration_validator.rb
+- lib/longleaf/services/metadata_deserializer.rb
+- lib/longleaf/services/metadata_serializer.rb
+- lib/longleaf/services/service_definition_manager.rb
+- lib/longleaf/services/service_definition_validator.rb
+- lib/longleaf/services/service_manager.rb
+- lib/longleaf/services/service_mapping_manager.rb
+- lib/longleaf/services/service_mapping_validator.rb
+- lib/longleaf/services/storage_location_manager.rb
+- lib/longleaf/services/storage_location_validator.rb
+- lib/longleaf/services/storage_path_validator.rb
+- lib/longleaf/specs/config_builder.rb
+- lib/longleaf/version.rb
+- longleaf.gemspec
+homepage: https://github.com/UNC-Libraries/
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Longleaf preservation services tool
+test_files: []