soar_environment 0.1.11

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cefa3bc5eaa71c5da03f09bd9d4dc5bfe1c51ec2
+  data.tar.gz: 2383ea89e73de67d0a573aeaea107fce11808321
+SHA512:
+  metadata.gz: 40a3795e20c120d02df36b6d6ebd3440e950287009b260aabb99d6fe55b3956ca7f7fe56f874428b1b946680e68742dc91602b61c821a80ebd1db0796273b793
+  data.tar.gz: 052c104809d196139d8fae3f1438d7134ad0e0b9f436b72b47382527d8f8aa1d7a55f3e0a27e42aa78ca355b42d7a2b3f1eb537dd78d605add93992c71ea030f

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+*.gem
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+soar_environment

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.12.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ernst Van Graan
+
+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,56 @@
+# SoarEnvironment
+
+This library provides environment discovery functionality for the SOAR architecture and includes obtaining variables from the environment, and supplementing with an environment YAML file. When RUBY_PLATFORM is 'java', system properties are used instead of ENV. Once loaded, the configuration can be supplemented with values for keys in SOAR_CONFIGURATION_KEYS supplied in a configuration provided.
+
+Exceptions raised:
+- ArgumentError when RACK_ENV is not set in the process environment nor environment file
+- ArgumentError when a configuration is not provided or is not a Hash when supplementing environment with configuration
+- SoarEnvironment::LoadError when an environment file does not exist when loading environment
+- 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.
+ 
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'soar-environment'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install soar-environment
+
+## Usage
+
+```
+@iut = SoarEnvironment::Environment.new
+environment = @iut.load_environment
+
+@iut = SoarEnvironment::Environment.new(@environment_file_path)
+environment = @iut.load_environment
+```
+
+Once loaded, the environment can be supplemented with a configuration:
+
+```
+environment = @iut.supplement_with_configuration(config)
+```
+
+## Contributing
+
+Please send feedback and comments to the author at:
+
+Ernst van Graan <ernst.van.graan@hetzner.co.za>
+
+This gem is sponsored by Hetzner (Pty) Ltd - http://hetzner.co.za
+
+## 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 "soar_environment"
+
+# 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

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/lib/soar_environment/version.rb

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

data/lib/soar_environment.rb

@@ -0,0 +1,60 @@
+require "soar_environment/version"
+require "psych"
+require "yaml"
+
+module SoarEnvironment
+  class LoadError < RuntimeError; end
+
+  class Environment
+    SOAR_CONFIGURATION_KEYS = ['IDENTIFIER', 'CAS_SERVER', 'SESSION_KEY', 'SESSION_SECRET'] if not defined? SOAR_CONFIGURATION_KEYS; SOAR_CONFIGURATION_KEYS.freeze
+
+    attr_reader :environment_file
+    attr_reader :environment
+
+    def initialize(environment_file = nil)
+      @environment_file = environment_file
+    end
+
+    def load_environment
+      @environment = merge(load_file(@environment_file), load_env)
+      raise ArgumentError.new("RACK_ENV not set in environment nor in properties or configuration") if (@environment['RACK_ENV'].nil?) or (@environment['RACK_ENV'].strip == "")
+      @environment
+    end
+
+    def supplement_with_configuration(configuration, keys = SOAR_CONFIGURATION_KEYS)
+      raise ArgumentError.new("configuration not provided") if (configuration.nil?)
+      raise ArgumentError.new("configuration not valid") if not (configuration.is_a?(Hash))
+      keys.each do |key|
+        @environment[key] ||= configuration[key]
+      end
+      @environment
+    end
+
+    private
+
+    # Produce a union of hashes, with duplicate keys overriden by the last specified hash to include them.
+    def merge(*hashes)
+      hashes.inject { |m, s| m.merge(s) }
+    end
+
+    def load_env
+      env = (RUBY_PLATFORM == "java" ? java.lang.System.properties.merge(ENV) : ENV)
+      env.to_h
+    end
+
+    def load_file(filename)
+      if filename
+        raise SoarEnvironment::LoadError.new("Failed to load file #{filename} : File does not exist") if not File.exist?(@environment_file)
+        stringify_values(::YAML.load_file(filename))
+      else
+        {}
+      end
+    rescue IOError, SystemCallError, ::Psych::Exception => ex
+      raise SoarEnvironment::LoadError.new("Failed to load file #{@environment_file} : #{ex}")
+    end
+
+    def stringify_values(hash)
+      Hash[hash.map{ |k, v| [k, v.to_s] }]
+    end      
+  end
+end

data/soar_environment.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'soar_environment/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "soar_environment"
+  spec.version       = SoarEnvironment::VERSION
+  spec.authors       = ["Ernst Van Graan"]
+  spec.email         = ["ernst.van.graan@hetzner.co.za"]
+
+  spec.summary       = %q{This library determines the set of environment variables for a service component in the SOAR architecture}
+  spec.description   = %q{This library determines the set of environment variables for a service component in the SOAR architecture}
+  spec.homepage      = "https://github.com/hetznerZA/soar_environment"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "psych", "~> 2.1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: soar_environment
+version: !ruby/object:Gem::Version
+  version: 0.1.11
+platform: ruby
+authors:
+- Ernst Van Graan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: psych
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: byebug
+  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:
+- ernst.van.graan@hetzner.co.za
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/soar_environment.rb
+- lib/soar_environment/version.rb
+- soar_environment.gemspec
+homepage: https://github.com/hetznerZA/soar_environment
+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.5.1
+signing_key: 
+specification_version: 4
+summary: This library determines the set of environment variables for a service component
+  in the SOAR architecture
+test_files: []