legion-settings 1.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bac4b40b52e35751f9b72eb5bb806c7a83702f887f0e817ca11505d72f32a008
+  data.tar.gz: e9e01f6af6b63cfb2860c64d6f8a80d80c70a9647f94a7c6365091a716dadca9
+SHA512:
+  metadata.gz: 5dbafcc1e2994fe5bc1f3a915765388b47f8cabf7575a63a92130c149be6aa0fe2d767f586e110878ac0595260ad77293720dc7eb8b1c906e90c37d482b1395d
+  data.tar.gz: a3fc8d52a94daf8e430489299435eb2ba5c974d14fd99cd92ec8577561325ae8a1aa10322baa1c7d1e052fcbaad9386b784aa6c09ba5b758e2813a8bf95abadf

data/.circleci/config.yml

@@ -0,0 +1,83 @@
+version: 2.1
+orbs:
+  ruby: circleci/ruby@0.2.1
+  sonarcloud: sonarsource/sonarcloud@1.0.1
+
+jobs:
+  "rubocop":
+    docker:
+      - image: circleci/ruby:2.7-node
+    steps:
+      - checkout
+      - ruby/load-cache
+      - ruby/install-deps
+      - run:
+          name: Run Rubocop
+          command: bundle exec rubocop
+      - ruby/save-cache
+  "ruby-two-five":
+    docker:
+      - image: circleci/ruby:2.5
+    steps:
+      - checkout
+      - ruby/load-cache
+      - run:
+          name: update bundler
+          command: gem update bundler
+      - ruby/install-deps
+      - ruby/run-tests
+      - ruby/save-cache
+  "ruby-two-six":
+    docker:
+      - image: circleci/ruby:2.6
+    steps:
+      - checkout
+      - ruby/load-cache
+      - run:
+          name: update bundler
+          command: gem update bundler
+      - ruby/install-deps
+      - ruby/run-tests
+      - ruby/save-cache
+  "ruby-two-seven":
+    docker:
+      - image: circleci/ruby:2.7
+      - image: memcached:1.5-alpine
+    steps:
+      - checkout
+      - ruby/load-cache
+      - ruby/install-deps
+      - ruby/run-tests
+      - ruby/save-cache
+  "sonarcloud":
+    docker:
+      - image: circleci/ruby:2.7
+    steps:
+      - checkout
+      - ruby/load-cache
+      - ruby/install-deps
+      - ruby/run-tests
+      - run:
+          name: Run Rubocop
+          command: bundle exec rubocop --format=json --out=rubocop-result.json
+      - sonarcloud/scan
+      - ruby/save-cache
+
+workflows:
+  version: 2
+  rubocop-rspec:
+    jobs:
+      - rubocop
+      - ruby-two-five:
+          requires:
+            - rubocop
+      - ruby-two-six:
+          requires:
+            - ruby-two-five
+      - ruby-two-seven:
+          requires:
+            - ruby-two-five
+      - sonarcloud:
+          requires:
+            - ruby-two-seven
+            - ruby-two-six

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/rspec/
+/test-results/
+
+# rspec failure tracking
+.rspec_status
+

data/.rubocop.yml

@@ -0,0 +1,24 @@
+Layout/LineLength:
+  Max: 120
+Metrics/MethodLength:
+  Max: 30
+Metrics/ClassLength:
+  Max: 1500
+Metrics/BlockLength:
+  Max: 50
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: space
+Style/SymbolArray:
+  Enabled: true
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+Style/Documentation:
+  Enabled: false
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: enable
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Naming/FileName:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Legion::Settings Changelog
+
+## v0.2.0
+* Adding merge settings method
+* Updating default settings
+
+## v0.1.1
+* Updating default hash to include legion:{extensions:{}}
+* Fixing rubocop errors

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    legion-settings (1.1.1)
+      legion-json
+      legion-logging
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    diff-lcs (1.4.4)
+    docile (1.3.2)
+    legion-json (1.1.0)
+      multi_json
+    legion-logging (1.1.0)
+      rainbow (~> 3)
+    multi_json (1.15.0)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (0.88.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.1.0, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.2.0)
+      parser (>= 2.7.0.1)
+    ruby-progressbar (1.10.1)
+    simplecov (0.18.5)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  legion-settings!
+  rake
+  rspec
+  rspec_junit_formatter
+  rubocop
+  simplecov
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Esity
+
+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,55 @@
+# Legion::Settings
+
+Legion::Settings is part of the Legion Framework
+
+###Badges
+####CICD
+|         | License | CircleCI | CodeCov | CodeBeat |
+|---------|---------|----------|---------|----------|
+| Master  |[![MIT Licence](https://badges.frapsoft.com/os/mit/mit.svg?v=103)](https://opensource.org/licenses/mit-license.php)|[![CircleCI](https://circleci.com/bb/legion-io/legion-settings/tree/master.svg?style=svg)](https://circleci.com/bb/legion-io/legion-settings/tree/master)|[![codecov](https://codecov.io/bb/legion-io/legion-settings/branch/master/graph/badge.svg)](https://codecov.io/bb/legion-io/legion-settings)|[![codebeat badge](https://codebeat.co/badges/e86dbe3e-b463-4f3c-91a8-c85492fd3833)](https://codebeat.co/projects/bitbucket-org-legion-io-legion-settings-master)|
+| Develop |[![MIT Licence](https://badges.frapsoft.com/os/mit/mit.svg?v=103)](https://opensource.org/licenses/mit-license.php)|[![CircleCI](https://circleci.com/bb/legion-io/legion-settings/tree/develop.svg?style=svg)](https://circleci.com/bb/legion-io/legion-settings/tree/develop)|[![codecov](https://codecov.io/bb/legion-io/legion-settings/branch/develop/graph/badge.svg)](https://codecov.io/bb/legion-io/legion-settings)|[![codebeat badge](https://codebeat.co/badges/e86dbe3e-b463-4f3c-91a8-c85492fd3833)](https://codebeat.co/projects/bitbucket-org-legion-io-legion-settings-develop)|
+
+#####RubyGems
+![](https://ruby-gem-downloads-badge.herokuapp.com/legion-settings)
+[![Gem Version](https://badge.fury.io/rb/legion-settings.svg)](https://badge.fury.io/rb/legion-settings)
+
+#####Bitbucket
+![](https://img.shields.io/bitbucket/issues-raw/legion-io/legion-settings.svg)
+![](https://img.shields.io/bitbucket/pr-raw/legion-io/legion-settings.svg)
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'legion-settings'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install legion-settings
+
+## Usage
+
+This library is utilized by Legion to load config files
+
+## Gem
+
+This gem can be viewed and download from [RubyGems - Legion-Settings](https://rubygems.org/gems/legion-settings)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec install`. 
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://bitbucket.org/legion-io/legion-settings/issues This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bitbucket-pipelines.yml

@@ -0,0 +1,39 @@
+image: ruby:2.4.0
+
+pipelines:
+  branches:
+    master:
+    - step:
+        caches:
+        - bundler
+        script:
+        - gem install bundle rubocop
+        - bundle install
+        - rubocop
+        - rake
+    - step:
+        name: Deploy to test gem server
+        deployment: test
+        script:
+        - gem install bundle geminabox
+        - bundle install
+        - gem build legion-settings.gemspec
+        - gem inabox legion-settings*.gem -g https://gems.whonodes.org/ -o
+    - step:
+        name: Deploy to RubyGems
+        deployment: production
+        trigger: manual
+        script:
+        - gem build legion-settings.gemspec
+  default:
+  - step:
+      caches:
+      - bundler
+      script:
+      - gem install bundle rubocop
+      - bundle install
+      - rubocop
+      - rake
+definitions:
+  caches:
+    bundler: vendor/bundle

data/legion-settings.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'legion/settings/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'legion-settings'
+  spec.version       = Legion::Settings::VERSION
+  spec.authors       = ['Esity']
+  spec.email         = ['matthewdiverson@gmail.com']
+
+  spec.summary       = 'Used to load the json settings files'
+  spec.description   = "Based on Sensu's implementation of settings"
+  spec.homepage      = 'https://bitbucket.org/whonodes/legion-settings'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec_junit_formatter'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
+  spec.add_dependency 'legion-json'
+  spec.add_dependency 'legion-logging'
+end

data/lib/legion/settings.rb

@@ -0,0 +1,48 @@
+require 'legion/json'
+require 'legion/settings/version'
+require 'legion/json/parse_error'
+require 'legion/settings/loader'
+
+module Legion
+  module Settings
+    class << self
+      attr_accessor :loader
+
+      def load(options = {})
+        @loader = Legion::Settings::Loader.new
+        @loader.load_env
+        @loader.load_file(options[:config_file]) if options[:config_file]
+        @loader.load_directory(options[:config_dir]) if options[:config_dir]
+        options[:config_dirs]&.each do |directory|
+          @loader.load_directory(directory)
+        end
+        @loader
+      end
+
+      def get(options = {})
+        @loader || @loader = load(options)
+      end
+
+      def [](key)
+        Legion::Logging.info('Legion::Settings was not loading, auto loading now!') if @loader.nil?
+        @loader = load if @loader.nil?
+        @loader[key]
+      rescue NoMethodError, TypeError
+        Legion::Logging.fatal 'rescue inside [](key)'
+        nil
+      end
+
+      def set_prop(key, value)
+        @loader = load if @loader.nil?
+        @loader[key] = value
+      end
+
+      def merge_settings(key, hash)
+        @loader = load if @loader.nil?
+        thing = {}
+        thing[key.to_sym] = hash
+        @loader.load_module_settings(thing)
+      end
+    end
+  end
+end

data/lib/legion/settings/constants.rb

@@ -0,0 +1,5 @@
+module Legion
+  module Settings
+    CATEGORIES = [:interations].freeze
+  end
+end

data/lib/legion/settings/loader.rb

@@ -0,0 +1,285 @@
+require 'socket'
+
+module Legion
+  module Settings
+    class Loader
+      class Error < RuntimeError; end
+      attr_reader :warnings, :errors, :loaded_files, :settings
+
+      def initialize
+        @warnings = []
+        @errors = []
+        @settings = default_settings
+        @indifferent_access = false
+        @loaded_files = []
+        self.class.create_category_methods
+      end
+
+      def client_defaults
+        {
+          hostname: system_hostname,
+          address:  system_address,
+          name:     "#{::Socket.gethostname.gsub('.', '_')}.#{::Process.pid}",
+          ready:    false
+        }
+      end
+
+      def default_settings
+        {
+          client:                     client_defaults,
+          cluster:                    { public_keys: {} },
+          crypt:                      {
+            cluster_secret:         nil,
+            cluster_secret_timeout: 5,
+            vault:                  { connected: false }
+          },
+          cache:                      { enabled: true, connected: false, driver: 'dalli' },
+          extensions:                 {},
+          default_extension_settings: {
+            logger: { level: 'info', trace: false, extended: false }
+          },
+          logging:                    {
+            level:             'info',
+            location:          'stdout',
+            trace:             true,
+            backtrace_logging: true
+          },
+          transport:                  { connected: false },
+          data:                       { connected: false }
+        }
+      end
+
+      def self.create_category_methods
+        # CATEGORIES.each do |category|
+        #   define_method(category) do
+        #     setting_category(category)
+        #   end
+        #   method_name = category.to_s.chop + "_exists?"
+        #   define_method(method_name.to_sym) do |name|
+        #     definition_exists?(category, name)
+        #   end
+        # end
+      end
+
+      def to_hash
+        unless @indifferent_access
+          indifferent_access!
+          @hexdigest = nil
+        end
+        @settings
+      end
+
+      def [](key)
+        to_hash[key]
+      end
+
+      def hexdigest
+        if @hexdigest && @indifferent_access
+          @hexdigest
+        else
+          hash = case legion_service_name
+                 when 'client', 'rspec'
+                   to_hash
+                 else
+                   to_hash.reject do |key, _value|
+                     key.to_s == 'client'
+                   end
+                 end
+          @hexdigest = Digest::SHA256.hexdigest(hash.to_s)
+        end
+      end
+
+      def load_env
+        load_api_env
+      end
+
+      def load_module_settings(config)
+        @settings = deep_merge(config, @settings)
+      end
+
+      def load_module_default(config)
+        merged = deep_merge(@settings, config)
+        deep_diff(@settings, merged) unless @loaded_files.empty?
+        @settings = merged
+      end
+
+      def load_file(file) # rubocop:disable Metrics/AbcSize
+        Legion::Logging.debug("Trying to load file #{file}")
+        if File.file?(file) && File.readable?(file)
+          begin
+            contents = read_config_file(file)
+            config = contents.empty? ? {} : Legion::JSON.load(contents)
+            merged = deep_merge(@settings, config)
+            deep_diff(@settings, merged) unless @loaded_files.empty?
+            @settings = merged
+            # @indifferent_access = false
+            @loaded_files << file
+          rescue Legion::JSON::ParseError => e
+            Legion::Logging.error('config file must be valid json')
+            Legion::Logging.debug("file:#{file}, error: #{e}")
+          end
+        else
+          Legion::Logging.warn("Config file does not exist or is not readable file:#{file}")
+        end
+      end
+
+      def load_directory(directory)
+        path = directory.gsub(/\\(?=\S)/, '/')
+        if File.readable?(path) && File.executable?(path)
+          Dir.glob(File.join(path, '**{,/*/**}/*.json')).uniq.each do |file|
+            load_file(file)
+          end
+        else
+          load_error('insufficient permissions for loading', directory: directory)
+        end
+      end
+
+      def load_client_overrides
+        @settings[:client][:subscriptions] ||= []
+        if @settings[:client][:subscriptions].is_a?(Array)
+          @settings[:client][:subscriptions] << "client:#{@settings[:client][:name]}"
+          @settings[:client][:subscriptions].uniq!
+          @indifferent_access = false
+        else
+          Legion::Logging.warn('unable to apply legion client overrides, reason: client subscriptions is not an array')
+        end
+      end
+
+      def load_overrides!
+        load_client_overrides if %w[client rspec].include?(legion_service_name)
+      end
+
+      def set_env!
+        ENV['LEGION_LOADED_TEMPFILE'] = create_loaded_tempfile!
+      end
+
+      def validate
+        validator = Validator.new
+        @errors += validator.run(@settings, legion_service_name)
+      end
+
+      private
+
+      def setting_category(category)
+        @settings[category].map do |name, details|
+          details.merge(name: name.to_s)
+        end
+      end
+
+      def definition_exists?(category, name)
+        @settings[category].key?(name.to_sym)
+      end
+
+      def indifferent_hash
+        Hash.new do |hash, key|
+          hash[key.to_sym] if key.is_a?(String)
+        end
+      end
+
+      def with_indifferent_access(hash)
+        hash = indifferent_hash.merge(hash)
+        hash.each do |key, value|
+          hash[key] = with_indifferent_access(value) if value.is_a?(Hash)
+        end
+      end
+
+      def indifferent_access!
+        @settings = with_indifferent_access(@settings)
+        @indifferent_access = true
+      end
+
+      def load_api_env
+        return unless ENV['LEGION_API_PORT']
+
+        @settings[:api] ||= {}
+        @settings[:api][:port] = ENV['LEGION_API_PORT'].to_i
+        Legion::Logging.warn("using api port environment variable, api: #{@settings[:api]}")
+        @indifferent_access = false
+      end
+
+      def read_config_file(file)
+        contents = IO.read(file)
+        if contents.respond_to?(:force_encoding)
+          encoding = ::Encoding::ASCII_8BIT
+          contents = contents.force_encoding(encoding)
+          contents.sub!("\xEF\xBB\xBF".force_encoding(encoding), '')
+        else
+          contents.sub!(/^\357\273\277/, '')
+        end
+        contents.strip
+      end
+
+      def deep_merge(hash_one, hash_two)
+        merged = hash_one.dup
+        hash_two.each do |key, value|
+          merged[key] = if hash_one[key].is_a?(Hash) && value.is_a?(Hash)
+                          deep_merge(hash_one[key], value)
+                        elsif hash_one[key].is_a?(Array) && value.is_a?(Array)
+                          hash_one[key].concat(value).uniq
+                        else
+                          value
+                        end
+        end
+        merged
+      end
+
+      # rubocop:disable Metrics/AbcSize
+      def deep_diff(hash_one, hash_two)
+        keys = hash_one.keys.concat(hash_two.keys).uniq
+        keys.each_with_object({}) do |key, diff|
+          next if hash_one[key] == hash_two[key]
+
+          diff[key] = if hash_one[key].is_a?(Hash) && hash_two[key].is_a?(Hash)
+                        deep_diff(hash_one[key], hash_two[key])
+                      else
+                        [hash_one[key], hash_two[key]]
+                      end
+        end
+      end
+      # rubocop:enable Metrics/AbcSize
+
+      def create_loaded_tempfile!
+        dir = ENV['LEGION_LOADED_TEMPFILE_DIR'] || Dir.tmpdir
+        file_name = "legion_#{legion_service_name}_loaded_files"
+        path = File.join(dir, file_name)
+        File.open(path, 'w') do |file|
+          file.write(@loaded_files.join(':'))
+        end
+        path
+      end
+
+      def legion_service_name
+        File.basename($PROGRAM_NAME).split('-').last
+      end
+
+      def system_hostname
+        Socket.gethostname
+      rescue StandardError
+        'unknown'
+      end
+
+      def system_address
+        Socket.ip_address_list.find do |address|
+          address.ipv4? && !address.ipv4_loopback?
+        end.ip_address
+      rescue StandardError
+        'unknown'
+      end
+
+      def warning(message, data = {})
+        @warnings << {
+          message: message
+        }.merge(data)
+        Legion::Logging.warn(message)
+      end
+
+      def load_error(message, data = {})
+        @errors << {
+          message: message
+        }.merge(data)
+        Legion::Logging.error(message)
+        raise(Error, message)
+      end
+    end
+  end
+end

data/lib/legion/settings/rules.rb

@@ -0,0 +1,92 @@
+module Legion
+  module Settings
+    module Rules
+      def must_be_a_hash(value)
+        value.is_a?(Hash)
+      end
+      alias is_a_hash? must_be_a_hash
+
+      def must_be_a_hash_if_set(value)
+        value.nil? ? true : must_be_a_hash(value)
+      end
+
+      def must_be_an_array(value)
+        value.is_a?(Array)
+      end
+      alias is_an_array? must_be_an_array
+
+      def must_be_an_array_if_set(value)
+        value.nil? ? true : must_be_an_array(value)
+      end
+
+      def must_be_a_string(value)
+        value.is_a?(String)
+      end
+      alias is_a_string? must_be_a_string
+
+      def must_be_a_string_if_set(value)
+        value.nil? ? true : must_be_a_string(value)
+      end
+
+      def must_be_an_integer(value)
+        value.is_a?(Integer)
+      end
+      alias is_an_integer? must_be_an_integer
+
+      def must_be_an_integer_if_set(value)
+        value.nil? ? true : must_be_an_integer(value)
+      end
+
+      def must_be_a_numeric(value)
+        value.is_a?(Numeric)
+      end
+
+      def must_be_a_numeric_if_set(value)
+        value.nil? ? true : must_be_a_numeric(value)
+      end
+
+      def must_match_regex(regex, value)
+        (value =~ regex).zero?
+      end
+
+      def must_be_boolean(value)
+        !value.nil?
+      end
+
+      def must_be_boolean_if_set(value)
+        value.nil? ? true : must_be_boolean(value)
+      end
+
+      def items_must_be_strings(value, regex = nil)
+        value.all? do |item|
+          item.is_a?(String) && !item.empty? &&
+            (regex.nil? || item =~ regex)
+        end
+      end
+
+      def either_are_set?(*values)
+        values.any? do |value|
+          !value.nil?
+        end
+      end
+
+      def must_be_time(*values)
+        values.all? do |value|
+          Time.parse(value)
+        rescue StandardError
+          false
+        end
+      end
+
+      def must_be_either(allowed, *values)
+        values.flatten.all? do |value|
+          allowed.include?(value)
+        end
+      end
+
+      def must_be_either_if_set(allowed, *values)
+        values[0].nil? ? true : must_be_either(allowed, values)
+      end
+    end
+  end
+end

data/lib/legion/settings/validator.rb

@@ -0,0 +1,63 @@
+require 'legion/settings/rules'
+require 'legion/settings/validators'
+require 'legion/settings/constants'
+
+module Legion
+  module Settings
+    class Validator
+      include Rules
+      include Validators
+
+      attr_reader :failures
+
+      def initialize
+        @failures = []
+      end
+
+      def run(settings, service = nil)
+        validate_legion(settings[:legion])
+        validate_transport(settings[:transport])
+        validate_categories(settings)
+        case service
+        when 'client'
+          validate_client(settings[:client])
+        when 'api'
+          validate_api(settings[:api])
+        when 'rspec'
+          validate_client(settings[:client])
+          validate_api(settings[:api])
+        end
+        @failures
+      end
+
+      def reset!
+        failure_count = @failures.size
+        @failures = []
+        failure_count
+      end
+      alias reset reset!
+
+      private
+
+      def validate_categories(settings)
+        CATEGORIES.each do |category|
+          if is_a_hash?(settings[category])
+            validate_method = ('validate_' + category.to_s.chop).to_sym
+            settings[category].each do |name, details|
+              send(validate_method, details.merge(name: name.to_s))
+            end
+          else
+            invalid(settings[category], "#{category} must be a hash")
+          end
+        end
+      end
+
+      def invalid(object, message)
+        @failures << {
+          object:  object,
+          message: message
+        }
+      end
+    end
+  end
+end

data/lib/legion/settings/validators.rb

@@ -0,0 +1,9 @@
+require 'legion/settings/validators/legion'
+
+module Legion
+  module Settings
+    module Validators
+      include Legion
+    end
+  end
+end

data/lib/legion/settings/validators/legion.rb

@@ -0,0 +1,29 @@
+module Legion
+  module Settings
+    module Validators
+      module Legion
+        def validate_legion_spawn(legion)
+          spawn = legion[:spawn]
+          if is_a_hash?(spawn)
+            if is_an_integer?(spawn[:limit])
+              (spawn[:limit]).positive? ||
+                invalid(legion, 'legion spawn limit must be greater than 0')
+            else
+              invalid(legion, 'legion spawn limit must be an integer')
+            end
+          else
+            invalid(legion, 'legion spawn must be a hash')
+          end
+        end
+
+        def validate_legion(legion)
+          if is_a_hash?(legion)
+            validate_legion_spawn(legion)
+          else
+            invalid(legion, 'legion must be a hash')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/legion/settings/version.rb

@@ -0,0 +1,5 @@
+module Legion
+  module Settings
+    VERSION = '1.1.1'.freeze
+  end
+end

data/sonar-project.properties

@@ -0,0 +1,12 @@
+sonar.projectKey=legion-io_legion-settings
+sonar.organization=legion-io
+sonar.projectName=Legion::Settings
+sonar.sources=.
+sonar.exclusions=vendor/**
+sonar.coverage.exclusions=spec/**
+sonar.ruby.coverage.reportPath=coverage/.resultset.json
+sonar.ruby.file.suffixes=rb,ruby
+sonar.ruby.coverage.framework=RSpec
+sonar.ruby.rubocopConfig=.rubocop.yml
+sonar.ruby.rubocop.reportPath=rubocop-result.json
+sonar.ruby.rubocop.filePath=.

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: legion-settings
+version: !ruby/object:Gem::Version
+  version: 1.1.1
+platform: ruby
+authors:
+- Esity
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: legion-json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: legion-logging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Based on Sensu's implementation of settings
+email:
+- matthewdiverson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bitbucket-pipelines.yml
+- legion-settings.gemspec
+- lib/legion/settings.rb
+- lib/legion/settings/constants.rb
+- lib/legion/settings/loader.rb
+- lib/legion/settings/rules.rb
+- lib/legion/settings/validator.rb
+- lib/legion/settings/validators.rb
+- lib/legion/settings/validators/legion.rb
+- lib/legion/settings/version.rb
+- sonar-project.properties
+homepage: https://bitbucket.org/whonodes/legion-settings
+licenses:
+- MIT
+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: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Used to load the json settings files
+test_files: []