canvas_oss-configuration 0.1.0.pre.alpha.pre.7

data/lib/canvas_oss/configuration/version.rb

@@ -0,0 +1,20 @@
+# Copyright 2018-02-24
+# Remy BOISSEZON boissezon.remy@gmail.com
+# Valentin PRODHOMME valentin@prodhomme.me
+# Dylan TROLES chill3d@protonmail.com
+# Alexandre ZANNI alexandre.zanni@engineer.com
+#
+# This software is governed by the CeCILL license under French law and
+# abiding by the rules of distribution of free software.  You can  use,
+# modify and/ or redistribute the software under the terms of the CeCILL
+# license as circulated by CEA, CNRS and INRIA at the following URL
+# "http://www.cecill.info".
+#
+# The fact that you are presently reading this means that you have had
+# knowledge of the CeCILL license and that you accept its terms.
+
+module CanvasOss
+  class Configuration
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/canvas_oss/configuration.rb

@@ -0,0 +1,83 @@
+# Copyright 2018-02-24
+# Remy BOISSEZON boissezon.remy@gmail.com
+# Valentin PRODHOMME valentin@prodhomme.me
+# Dylan TROLES chill3d@protonmail.com
+# Alexandre ZANNI alexandre.zanni@engineer.com
+#
+# This software is governed by the CeCILL license under French law and
+# abiding by the rules of distribution of free software.  You can  use,
+# modify and/ or redistribute the software under the terms of the CeCILL
+# license as circulated by CEA, CNRS and INRIA at the following URL
+# "http://www.cecill.info".
+#
+# The fact that you are presently reading this means that you have had
+# knowledge of the CeCILL license and that you accept its terms.
+
+require 'canvas_oss/configuration/version'
+require 'canvas_oss/configuration/default_path'
+require 'yaml'
+
+module CanvasOss
+  # A class that open a CANVAS configuration file and parse it
+  # @example Load configuration from a CANVAS subsystem_name subsystem configuration file. A default file URI is assumed.
+  # => configuration = new Configuration(uri)
+  class Configuration
+    # :global contains CANVAS global configuration as a hash
+    attr_reader :global
+    # :subsys contains CANVAS subsystem configuration as a hash
+    attr_reader :subsys
+
+    SUBSYSTEM_NAME = 'subsystem_name'.freeze
+
+    # Load CANVAS configuration file from `uri` file or from default file
+    def initialize(uri = nil)
+      filename = File.realpath(File.join(DEFAULT_PATH, configuration_filename)) unless uri
+      filename = File.realpath(uri) if uri.is_a?(String) && uri.length.positive?
+      # Load YAML configuration file
+      documents = []
+      YAML.load_stream(File.read(filename)) do |document|
+        documents << document
+      end
+      # CANVAS Configuration file contain CANVAS global configuration
+      @global = validate_global(documents[0])
+      # CANVAS Configuration file contains CANVAS product-inventory subprocess configuration
+      @subsys = validate_subsys(documents[1])
+    end
+
+    # Ensure that CANVAS configuration contains at least some parameters
+    def validate_global(hash)
+      # CANVAS global configuration contains `canvas`
+      hash.key?(:canvas)
+      # CANVAS global configuration contains database parameters
+      hash[:canvas].key?(:database)
+      # CANVAS global configuration contains `canvas_configuration` database parameters
+      hash[:canvas][:database].key?(:canvas_configuration)
+      hash[:canvas][:database][:canvas_configuration].key?(:host)
+      hash[:canvas][:database][:canvas_configuration].key?(:port)
+      hash[:canvas][:database][:canvas_configuration].key?(:database)
+      hash[:canvas][:database][:canvas_configuration].key?(:username)
+      hash[:canvas][:database][:canvas_configuration].key?(:password)
+      # CANVAS global configuration contains `canvas_data` database parameters
+      hash[:canvas][:database].key?(:canvas_data)
+      hash[:canvas][:database][:canvas_data].key?(:host)
+      hash[:canvas][:database][:canvas_data].key?(:port)
+      hash[:canvas][:database][:canvas_data].key?(:database)
+      hash[:canvas][:database][:canvas_data].key?(:username)
+      hash[:canvas][:database][:canvas_data].key?(:password)
+      return hash[:canvas]
+    end
+
+    # Ensure that CANVAS subsystem configuration contains at least some parameters
+    # This method should be overloaded
+    def validate_subsys(hash)
+      # CANVAS global configuration contains `subsystem_name`
+      hash.key?(:subsystem_name)
+      return hash[:subsystem_name]
+    end
+
+    # Return configuration filename
+    def configuration_filename
+      return SUBSYSTEM_NAME + '.yml'
+    end
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: canvas_oss-configuration
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre.alpha.pre.7
+platform: ruby
+authors:
+- "'Remy"
+- BOISSEZON'
+- "'Valentin"
+- PRODHOMME'
+- "'Dylan"
+- TROLES'
+- "'Alexandre"
+- ZANNI'
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-24 00:00:00.000000000 Z
+dependencies:
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: A little API to load and use CANVAS yaml configuration files
+email:
+- boissezon.remy@gmail.com
+- valentin@prodhomme.me
+- chill3d@protonmail.com
+- alexandre.zanni@engineer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.CECILL-EN
+- LICENSE.CECILL-FR
+- README.md
+- Rakefile
+- canvas_oss-configuration.gemspec
+- files/canvas-configuration-sample.yml
+- lib/canvas_oss/configuration.rb
+- lib/canvas_oss/configuration/default_path.rb
+- lib/canvas_oss/configuration/version.rb
+homepage: https://github.com/canvas-oss/canvas-configuration
+licenses:
+- CECILL-2.1
+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: API for used by CANVAS subsystems
+test_files: []