soar_environment 0.1.11 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cefa3bc5eaa71c5da03f09bd9d4dc5bfe1c51ec2
-  data.tar.gz: 2383ea89e73de67d0a573aeaea107fce11808321
+  metadata.gz: 2e1f515041de21ba072c785abd2980fddec6d379
+  data.tar.gz: 928898d6d632dbb2440cf78db7f714143a4eb86f
 SHA512:
-  metadata.gz: 40a3795e20c120d02df36b6d6ebd3440e950287009b260aabb99d6fe55b3956ca7f7fe56f874428b1b946680e68742dc91602b61c821a80ebd1db0796273b793
-  data.tar.gz: 052c104809d196139d8fae3f1438d7134ad0e0b9f436b72b47382527d8f8aa1d7a55f3e0a27e42aa78ca355b42d7a2b3f1eb537dd78d605add93992c71ea030f
+  metadata.gz: '019aa4c6bdae200c2f18f710d2ba3251a7076b224b677ac0ead12d5f0b3910a19de54319f029c34d329e5e7b7f4d8173a4f7ae6276b664c4a49fd398dc9e58b7'
+  data.tar.gz: f17f0ce4ac3ed112d8b79b613d34ce549c3090168eaf63e11fea662420652965cdba2c2dd49e8963773797891549a5577e02de03f104a762670a2b70c206ea31

data/README.md

@@ -9,6 +9,8 @@ Exceptions raised:
 - SoarEnvironment::LoadError when an environment file cannot be loaded when loading environment
 
 Once an environment is loaded (taking process and environment file into account), supplementing from configuration can be performed. Supplementing only provides values if the keys are not already present in the environment, thus if present in an environment file, that entry would be preferred above presence in configuration.
+
+This library also provides an environment validator that expects an IDENTIFIER and RACK_ENV to be set to one of SoarEnvironment::EnvironmentValidator::VALID_EXECUTION_ENVIRONMENTS
  
 ## Installation
 
@@ -42,6 +44,14 @@ Once loaded, the environment can be supplemented with a configuration:
 environment = @iut.supplement_with_configuration(config)
 ```
 
+An environment can be validated:
+
+```
+validator = SoarEnvironment::EnvironmentValidator.new
+errors = validator.validate(environment)
+# => [ invalid service identifier', 'Missing execution environment indicator', 'Invalid execution environment indicator' ]
+```
+
 ## Contributing
 
 Please send feedback and comments to the author at:

data/lib/soar_environment.rb

@@ -1,4 +1,5 @@
 require "soar_environment/version"
+require "soar_environment/environment_validator"
 require "psych"
 require "yaml"
 

data/lib/soar_environment/environment_validator.rb

@@ -0,0 +1,13 @@
+module SoarEnvironment
+  class EnvironmentValidator
+    VALID_EXECUTION_ENVIRONMENTS = ['production','development'] unless defined? VALID_EXECUTION_ENVIRONMENTS; VALID_EXECUTION_ENVIRONMENTS.freeze
+
+    def validate(environment)
+      errors = []
+      errors << 'invalid service identifier' if (environment['IDENTIFIER'].nil?) or (environment['IDENTIFIER'].strip == "")
+      errors << 'Missing execution environment indicator' if (environment['RACK_ENV'] == 'none') or (environment['RACK_ENV'].nil?) or (environment['RACK_ENV'].strip == "")
+      errors << 'Invalid execution environment indicator' if not VALID_EXECUTION_ENVIRONMENTS.include?(environment['RACK_ENV'])
+      errors
+    end
+  end
+end

data/lib/soar_environment/version.rb

@@ -1,3 +1,3 @@
 module SoarEnvironment
-  VERSION = "0.1.11"
+  VERSION = "0.2.0"
 end

data/soar_environment.gemspec

@@ -33,4 +33,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "byebug"
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov-rcov'
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soar_environment
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.2.0
 platform: ruby
 authors:
 - Ernst Van Graan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-12 00:00:00.000000000 Z
+date: 2016-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: psych
@@ -80,6 +80,34 @@ dependencies:
     - - ">="
       - !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: simplecov-rcov
+  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'
 description: This library determines the set of environment variables for a service
   component in the SOAR architecture
 email:
@@ -100,6 +128,7 @@ files:
 - bin/console
 - bin/setup
 - lib/soar_environment.rb
+- lib/soar_environment/environment_validator.rb
 - lib/soar_environment/version.rb
 - soar_environment.gemspec
 homepage: https://github.com/hetznerZA/soar_environment