legion-settings 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: '09fab9f1b8877a7e4edd48838b81985de665106e'
+  data.tar.gz: 5f7fd30a767e066a87987ad0fdd04a3b605b1f87
+SHA512:
+  metadata.gz: 1ccfdc0cee0c2983d381dca59260089b42141e600d97afaeaeaca94d093df0b35d88875526a5ed7528ec4416b29ae15ce753275e2574628f63b4c338ab285574
+  data.tar.gz: 45ed2014eb19bae521caad7cfd4cbe5baab5620d6adfb3138cc70a582f96e246ff9d1b872f67cb729d8b28cbc9f7cd7cbcc049e8c94c774fb5ca0c57043e57d1

data/.circleci/config.yml

@@ -0,0 +1,167 @@
+version: 2 # use CircleCI 2.0
+jobs:
+  "rubocop":
+    docker:
+      - image: circleci/ruby:2.4-node
+    steps:
+      - checkout
+      - run: gem install rubocop
+      - run:
+          name: Run Rubocop
+          command: rubocop
+      - store_test_results:
+          path: test_results
+  "ruby-2.0":
+    docker:
+      - image: circleci/ruby:2.0
+    steps:
+      - checkout
+      - run:
+          name: Bundle Install
+          command: bundle install
+      - run:
+          name: Run RSpec
+          command: bundle exec rspec --format progress --format RspecJunitFormatter -o test-results/rspec/results.xml
+          when: always
+      - store_test_results:
+          path: test-results
+  "ruby-2.1":
+    docker:
+      - image: circleci/ruby:2.1
+    steps:
+      - checkout
+      - run:
+          name: Bundle Install
+          command: bundle install
+      - run:
+          name: Run RSpec
+          command: bundle exec rspec --format progress --format RspecJunitFormatter -o test-results/rspec/results.xml
+          when: always
+      - store_test_results:
+          path: test-results
+  "ruby-2.2":
+    docker:
+      - image: circleci/ruby:2.2
+    steps:
+      - checkout
+      - run:
+          name: Bundle Install
+          command: bundle install
+      - run:
+          name: Run RSpec
+          command: bundle exec rspec --format progress --format RspecJunitFormatter -o test-results/rspec/results.xml
+          when: always
+      - store_test_results:
+          path: test-results
+
+  "ruby-2.3":
+    docker:
+      - image: circleci/ruby:2.3
+    steps:
+      - checkout
+      - run:
+          name: Bundle Install
+          command: bundle install
+      - run:
+          name: Run RSpec
+          command: bundle exec rspec --format progress --format RspecJunitFormatter -o test-results/rspec/results.xml
+          when: always
+      - store_test_results:
+          path: test-results
+
+  "ruby-2.4":
+    docker:
+      - image: circleci/ruby:2.4-node
+    steps:
+      - checkout
+      - run:
+          name: Bundle Install
+          command: bundle install
+      - run:
+          name: Run RSpec
+          command: bundle exec rspec --format progress --format RspecJunitFormatter -o test-results/rspec/results.xml
+          when: always
+      - store_test_results:
+          path: test-results
+  "ruby-2.5":
+    docker:
+      - image: circleci/ruby:2.5-node
+    steps:
+      - checkout
+      - run:
+          name: Bundle Install
+          command: bundle install
+      - run:
+          name: Run RSpec
+          command: bundle exec rspec --format progress --format RspecJunitFormatter -o test-results/rspec/results.xml
+          when: always
+      - store_test_results:
+          path: test-results
+  "ruby-2.6":
+    docker:
+      - image: circleci/ruby:2.6-node
+    steps:
+      - checkout
+      - run:
+          name: Bundle Install
+          command: bundle install
+      - run:
+          name: Run RSpec
+          command: bundle exec rspec --format progress --format RspecJunitFormatter -o test-results/rspec/results.xml
+          when: always
+      - store_test_results:
+          path: test-results
+  "jruby-9.2":
+    docker:
+      - image: circleci/jruby:9.2
+    steps:
+      - checkout
+      - run:
+          name: Bundle Install
+          command: bundle install
+      - run:
+          name: Run RSpec
+          command: bundle exec rspec --format progress --format RspecJunitFormatter -o test-results/rspec/results.xml
+          when: always
+      - store_test_results:
+          path: test-results
+
+workflows:
+  version: 2
+  cop_rake_deploy:
+    jobs:
+      - rubocop
+      #      - ruby-2.2:
+      #          requires:
+      #            - ruby-2.4
+      #          filters:
+      #            branches:
+      #              only: /\bdevelop\b|\bmaster\b/
+      - ruby-2.3:
+          requires:
+            - ruby-2.4
+          filters:
+            branches:
+              only: /\bdevelop\b|\bmaster\b/
+      - ruby-2.4:
+          requires:
+            - rubocop
+      - ruby-2.5:
+          requires:
+            - ruby-2.4
+          filters:
+            branches:
+              only: /\bdevelop\b|\bmaster\b/
+      - ruby-2.6:
+          requires:
+            - ruby-2.4
+          filters:
+            branches:
+              only: /\bdevelop\b|\bmaster\b/
+#      - jruby-9.2:
+#          requires:
+#            - ruby-2.2
+#            - ruby-2.3
+#            - ruby-2.4
+#            - ruby-2.5
+#            - ruby-2.6

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,25 @@
+Metrics/LineLength:
+  Max: 120
+Metrics/MethodLength:
+  Max: 30
+Metrics/ClassLength:
+  Max: 1500
+Metrics/BlockLength:
+  Max: 50
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: space
+Style/SymbolArray:
+  Enabled: true
+Layout/AlignHash:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys
+Style/Documentation:
+  Enabled: false
+AllCops:
+  TargetRubyVersion: 2.4
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Naming/FileName:
+  Enabled: false

data/Gemfile

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

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,42 @@
+# Legion::Settings
+
+Legion::Settings is part of the Legion Framework
+
+
+## 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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'legion/settings'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

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,34 @@
+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.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1'
+  spec.add_development_dependency 'codecov', '~> 0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec_junit_formatter', '~> 0'
+  if RUBY_ENGINE == 'jruby'
+    spec.add_dependency('legion-json-jruby', '~> 0.1')
+  else
+    spec.add_dependency('legion-json', '~> 0.1')
+  end
+  spec.add_dependency 'legion-logging', '~> 0.1'
+end

data/lib/legion/settings.rb

@@ -0,0 +1,40 @@
+require 'legion/json'
+require 'legion/settings/version'
+require 'legion/json/parse_error'
+require 'legion/settings/loader'
+
+module Legion
+  # Base Legion::Settings module
+  module Settings
+    # Base settings, needs to be refactored
+    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.warn('Legion::Settings was not loading, auto loading now!') if @loader.nil?
+        @loader = load if @loader.nil?
+        @loader[key]
+      end
+
+      def set_prop(key, value)
+        Legion::Logging.warn('Legion::Settings was not loading, auto loading now!') if @loader.nil?
+        @loader = load if @loader.nil?
+        @loader[key] = value
+      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,282 @@
+module Legion
+  module Settings
+    # This is the main settings class, needs refactor
+    class Loader
+      # This is the standard error
+      class Error < RuntimeError; end
+
+      attr_reader :warnings
+      attr_reader :errors
+      attr_reader :loaded_files
+
+      def initialize
+        @warnings = []
+        @errors = []
+        @settings = default_settings
+        @indifferent_access = false
+        @loaded_files = []
+        self.class.create_category_methods
+      end
+
+      def client_defaults
+        {
+          name:    system_hostname,
+          address: system_address
+        }
+      end
+
+      def default_settings
+        default = {
+          client:    {},
+          legion:    {
+            spawn: {
+              limit: 12
+            }
+          },
+          transport: {
+            rabbitmq: {
+              user:     'guest',
+              password: 'guest',
+              host:     '127.0.0.1'
+            }
+          },
+          data:      {
+            mysql: {
+              user:            'legion',
+              password:        'legion',
+              max_connections: 20,
+              database:        'legion',
+              host:            '127.0.0.1',
+              debug:           false
+            }
+          }
+        }
+        default[:client] = client_defaults if %w[client rspec].include?(legion_service_name)
+        default
+      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_file(file)
+        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 => error
+            Legion::Logging.error('config file must be valid json')
+            Legion::Logging.debug("file:#{file}, error: #{error}")
+          end
+        else
+          Legion::Logging.warn("Config file does not exist or is not readable file:#{file}")
+        end
+      end
+
+      def load_directory(directory)
+        warning('loading config files from directory', 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,170 @@
+module Legion
+  module Settings
+    module Rules
+      # Check that a value is a hash.
+      #
+      # @param value [Object] to check.
+      # @return [TrueClass, FalseClass]
+      def must_be_a_hash(value)
+        value.is_a?(Hash)
+      end
+      alias is_a_hash? must_be_a_hash
+
+      # Check that a value is a hash, if set (not nil).
+      #
+      # @param value [Object] to check.
+      # @return [TrueClass, FalseClass]
+      def must_be_a_hash_if_set(value)
+        value.nil? ? true : must_be_a_hash(value)
+      end
+
+      # Check that a value is an array.
+      #
+      # @param value [Object] to check.
+      # @return [TrueClass, FalseClass]
+      def must_be_an_array(value)
+        value.is_a?(Array)
+      end
+      alias is_an_array? must_be_an_array
+
+      # Check that a value is an array, if set (not nil).
+      #
+      # @param value [Object] to check.
+      # @return [TrueClass, FalseClass]
+      def must_be_an_array_if_set(value)
+        value.nil? ? true : must_be_an_array(value)
+      end
+
+      # Check that a value is a string.
+      #
+      # @param value [Object] to check.
+      # @return [TrueClass, FalseClass]
+      def must_be_a_string(value)
+        value.is_a?(String)
+      end
+      alias is_a_string? must_be_a_string
+
+      # Check that a value is a string, if set (not nil).
+      #
+      # @param value [Object] to check.
+      # @return [TrueClass, FalseClass]
+      def must_be_a_string_if_set(value)
+        value.nil? ? true : must_be_a_string(value)
+      end
+
+      # Check that a value is an integer.
+      #
+      # @param value [Object] to check.
+      # @return [TrueClass, FalseClass]
+      def must_be_an_integer(value)
+        value.is_a?(Integer)
+      end
+      alias is_an_integer? must_be_an_integer
+
+      # Check that a value is an integer, if set (not nil).
+      #
+      # @param value [Object] to check.
+      # @return [TrueClass, FalseClass]
+      def must_be_an_integer_if_set(value)
+        value.nil? ? true : must_be_an_integer(value)
+      end
+
+      # Check that a value is numeric.
+      #
+      # @param value [Object] to check.
+      # @return [TrueClass, FalseClass]
+      def must_be_a_numeric(value)
+        value.is_a?(Numeric)
+      end
+
+      # Check that a value is numeric, if set (not nil).
+      #
+      # @param value [Object] to check.
+      # @return [TrueClass, FalseClass]
+      def must_be_a_numeric_if_set(value)
+        value.nil? ? true : must_be_a_numeric(value)
+      end
+
+      # Check that a value matches a regular expression.
+      #
+      # @param regex [Regexp] pattern to compare with value.
+      # @param value [Object] to check if matches pattern.
+      # @return [TrueClass, FalseClass]
+      def must_match_regex(regex, value)
+        (value =~ regex).zero?
+      end
+
+      # Check if a value is boolean.
+      #
+      # @param value [Object] to check.
+      # @return [TrueClass, FalseClass]
+      def must_be_boolean(value)
+        !value.nil?
+      end
+
+      # Check if a value is boolean, if set (no nil).
+      #
+      # @param value [Object] to check.
+      # @return [TrueClass, FalseClass]
+      def must_be_boolean_if_set(value)
+        value.nil? ? true : must_be_boolean(value)
+      end
+
+      # Check that value items are all strings and not empty.
+      #
+      # @param value [Array] with items to check.
+      # @param regex [Regexp] to validate string items with.
+      # @return [TrueClass, FalseClass]
+      def items_must_be_strings(value, regex = nil)
+        value.all? do |item|
+          item.is_a?(String) && !item.empty? &&
+            (regex.nil? || item =~ regex)
+        end
+      end
+
+      # Check if either of the values are set (not nil).
+      #
+      # @param values [Array<Object>] to check if not nil.
+      # @return [TrueClass, FalseClass]
+      def either_are_set?(*values)
+        values.any? do |value|
+          !value.nil?
+        end
+      end
+
+      # Check if values are valid times (can be parsed).
+      #
+      # @param values [Array<Object>] to check if valid time.
+      # @return [TrueClass, FalseClass]
+      def must_be_time(*values)
+        values.all? do |value|
+          begin
+            Time.parse(value)
+          rescue StandardError
+            false
+          end
+        end
+      end
+
+      # Check if values are allowed.
+      #
+      # @param allowed [Array<Object>] allowed values.
+      # @param values [Array<Object>] to check if allowed.
+      # @return [TrueClass, FalseClass]
+      def must_be_either(allowed, *values)
+        values.flatten.all? do |value|
+          allowed.include?(value)
+        end
+      end
+
+      # Check if values are allowed, if set (not nil).
+      #
+      # @param allowed [Array<Object>] allowed values.
+      # @param values [Array<Object>] to check if allowed.
+      # @return [TrueClass, FalseClass]
+      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,80 @@
+require 'legion/settings/rules'
+require 'legion/settings/validators'
+require 'legion/settings/constants'
+
+module Legion
+  module Settings
+    class Validator
+      include Rules
+      include Validators
+
+      # @!attribute [r] failures
+      #   @return [Array] validation failures.
+      attr_reader :failures
+
+      def initialize
+        @failures = []
+      end
+
+      # Run the validator.
+      #
+      # @param settings [Hash] legion settings to validate.
+      # @param service [String] legion service to validate for.
+      # @return [Array] validation failures.
+      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
+
+      # Validate setting categories: checks, filters, mutators, and
+      # handlers.
+      #
+      # @param settings [Hash] legion settings to validate.
+      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
+
+      # Record an invalid object with a message.
+      #
+      # @param object [Object] invalid object.
+      # @param message [String] message explaining why the object is
+      #   invalid.
+      # @return [Array] current validation failures.
+      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,37 @@
+module Legion
+  module Settings
+    module Validators
+      module Legion
+        # Validate Legion spawn.
+        # Validates: limit
+        #
+        # @param legion [Hash] legion definition.
+        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
+
+        # Validate a Legion definition.
+        # Validates: spawn
+        #
+        # @param legion [Hash] legion definition.
+        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 = '0.1.0'.freeze
+  end
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: legion-settings
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Esity
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  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: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.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: legion-json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: legion-logging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Based on Sensu's implementation of settings
+email:
+- matthewdiverson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- 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
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Used to load the json settings files
+test_files: []