env_loader 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c79eedfc26cd79c97063ec9c90f2499f84c84f01
-  data.tar.gz: e0e6405bf21904e512513e56e3ab27d7426fbcd5
+  metadata.gz: 073794c2413a0207c67b431f6168a026a742d340
+  data.tar.gz: 17efae9f198ae06171c30e2944acbbe4fa4b438b
 SHA512:
-  metadata.gz: ce8cf474d9b68bcf2bb016cc3a250ee076113e9e5e89ab6148e0aa4a30e9107b83ae988d1cd02a7ee21a03d44e5e77225b140b5e27acf07f5ae0b98829995dc9
-  data.tar.gz: 5a7a05fa3e475284f8ffa8536f1a58a52f831cf89913eb83344a0cb11632d7b0a9e4c448df4a113f54d6a8c250c55be13717535d63e658031e78003aecd1b62a
+  metadata.gz: 81af0b62308846e32d38998c26ea26836422a76f7472ffe1f8ab75bc4bc947379d2924f08d4d32d2e08ea481772c00d6604e005d762d5eb0aecae7ce1ecc0dfa
+  data.tar.gz: e2f11343c85b0019ba1a970dd6b8626ce3faaa7ca9f43b2a500c127965c364fd812ccae4a970bd50a2906a5551892f0914e901407ebcbcbf775b3b1236820763

data/.gitignore

@@ -1,17 +1,9 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Endri Gjiri
+Copyright (c) 2015 Endri Gjiri
 
 MIT License
 

data/README.md

@@ -2,7 +2,7 @@
 
 By: Endri Gjiri *www.name-reaction.com*
 
-**EnvLoader** is a utility module with a single `read` method which can read a .yml file and store its data in environment variables. This is useful when dealing with sensitive data that should not be directly entered in the code and stored in version control. Passwords and other information can now simply be stored in a yaml file which is added to .gitignore and then can be accessed through the env_loader gem via ENV variables
+**EnvLoader** is a utility module with methods to load a .yml file and store its data in environment variables. This is useful when dealing with sensitive data that should not be directly entered in the code and stored in version control. Passwords and other information can now simply be stored in a yaml file which should be added to .gitignore and then can be accessed through the env_loader gem via ENV variables
 
 ## Installation
 
@@ -19,16 +19,29 @@ Or install it yourself as:
     $ gem install env_loader
 
 ## Usage
+##### TODO: Better Document this section
+* `EnvLoader.setup_monolith`
+* `EnvLoader.setup_microservice`
+
+---
+
+## DEPRECATED Usage
 
 1. Include the env_loader gem directly or through bundler
 ```ruby
 require 'env_loader'
 ```
 
-2. Create a .yml file with all the desired information. For example create a file called credentials.yml with the following content:
+2. Create a .yml file with all the desired information. For example:
 ```yml
-username: endri
-password: secret
+default: &default
+     username: 'endri'
+development:
+     <<: *default
+     password: 'password'
+production:
+     <<: *default
+     password: 'secret'
 ```
 
 3. Read the .yml file through the env_loader gem as follows:
@@ -42,7 +55,7 @@ ENV['USERNAME'] # => "endri"
 ENV['PASSWORD'] # => "secret"
 ```
 
-## Usage with Rails
+## DEPRECATED Usage with Rails
 
 1. Add the env_loader gem to the Gemfile and run `Bundle install`
 

data/Rakefile

@@ -1 +1,6 @@
-require "bundler/gem_tasks"
+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 'env_loader'
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/env_loader.gemspec

@@ -4,20 +4,24 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'env_loader/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "env_loader"
+  spec.name          = 'env_loader'
   spec.version       = EnvLoader::VERSION
-  spec.authors       = ["Endri Gjiri"]
-  spec.email         = ["egjiri@gmail.com"]
-  spec.description   = %q{Reads a YAML file and creates ENV variables from it}
-  spec.summary       = %q{Reads a YAML file and creates ENV variables from it}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.authors       = ['Endri Gjiri']
+  spec.email         = ['egjiri@gmail.com']
 
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.summary       = 'Reads a YAML file and creates ENV variables from it'
+  spec.description   = 'Reads a YAML file and creates ENV variables from it'
+  # spec.homepage      = "TODO: Put your gem's website or public repo URL here."
+  spec.license       = 'MIT'
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+  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 'uiux'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
 end

data/lib/env_loader/configurator.rb

@@ -0,0 +1,50 @@
+require 'yaml'
+require 'json'
+
+module EnvLoader
+  class Configurator
+    attr_reader :raw_config
+
+    def initialize(config_file: nil, config_content: nil, config_subtree_key: nil)
+      if config_file
+        @raw_config = config_from_file(config_file, config_subtree_key)
+      elsif config_content
+        @raw_config = config_from_content(config_content, config_subtree_key)
+      end
+    end
+
+    def config
+      raw_config.each_with_object({}) do |hash, new_hash|
+        key, value = hash
+        value = value.is_a?(Hash) ? value.to_json : value.to_s unless value.nil?
+        new_hash[key.upcase] = value
+      end
+    end
+
+    def expose_values_as_environment_variables
+      config.each { |key, value| ENV[key] = value }
+    end
+
+    private
+
+    def config_from_file(config_file, config_subtree_key = nil)
+      return {} unless File.exist?(config_file)
+      config_content = File.read(config_file)
+      config_from_content(config_content, config_subtree_key)
+    end
+
+    def config_from_content(config_content, config_subtree_key = nil)
+      global_config = YAML.load(config_content)
+      return global_config unless config_subtree_key
+      extract_subhash_from_hash_and_keys(global_config, config_subtree_key.to_s.split('.'))
+    end
+
+    def extract_subhash_from_hash_and_keys(hash, subhash_keys)
+      key = subhash_keys.shift
+      return unless key
+      return hash['default'] || {} unless hash.key?(key)
+      return hash[key] if subhash_keys.empty?
+      extract_subhash_from_hash_and_keys(hash[key], subhash_keys)
+    end
+  end
+end

data/lib/env_loader/version.rb

@@ -1,3 +1,3 @@
 module EnvLoader
-  VERSION = "0.1.0"
+  VERSION = '0.3.0'
 end

data/lib/env_loader.rb

@@ -1,38 +1,34 @@
 require 'env_loader/version'
-require 'yaml'
+require 'env_loader/configurator'
+require 'uiux'
 
 module EnvLoader
+  # A .monolith-config.yml file must be placed at the root of the monolith
+  def self.setup_monolith
+    config(config_file: File.join('.monolith-config.yml'), config_subtree_key: environment)
+  end
 
-  def self.read(env_yml_file = File.join('config', 'env_variables.yml'))
-    if File.exists? env_yml_file
-      if hash = YAML.load_file(env_yml_file)
-        hash.each do |key, value|
-          if value
-            ENV[key.upcase] = format_value(value)
-          end
-        end
-      end
-    end
+  # A .microservices-config.yml file must be placed at the parent directory of the microservice
+  def self.setup_microservice
+    subtree_key = environment
+    subtree_key += ".#{Rails.application.class.parent_name.underscore}" if defined?(Rails)
+    config(config_file: File.join('..', '.microservices-config.yml'), config_subtree_key: subtree_key)
   end
 
-  def self.get(key)
-    if value = ENV[key.to_s.upcase]
-      if value.match(/^\{.*\}$/)
-        JSON.parse(value).with_indifferent_access
-      else
-        value
-      end
-    end
+  # DEPRECATED (<= 0.2.0):
+  # Legacy setup which will be replaced by the above
+  def self.read(config_file = File.join('config', 'env_variables.yml'))
+    config(config_file: config_file)
   end
 
   private
 
-  def self.format_value(value)
-    if value.is_a? Hash
-      value = value.to_json
-    else
-      value = value.to_s
-    end
+  def self.environment
+    Rails.env if defined?(Rails)
   end
-end
 
+  def self.config(config_file: nil, config_content: nil, config_subtree_key: nil)
+    configurator = Configurator.new(config_file: config_file, config_content: config_content, config_subtree_key: config_subtree_key)
+    configurator.expose_values_as_environment_variables if configurator
+  end
+end

metadata

@@ -1,41 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: env_loader
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Endri Gjiri
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2014-04-14 00:00:00.000000000 Z
+date: 2015-11-05 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: uiux
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.10'
 - !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: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Reads a YAML file and creates ENV variables from it
@@ -45,15 +73,20 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
+- bin/setup
 - env_loader.gemspec
 - lib/env_loader.rb
+- lib/env_loader/configurator.rb
 - lib/env_loader/version.rb
-homepage: ''
+homepage: 
 licenses:
 - MIT
 metadata: {}
@@ -63,17 +96,17 @@ 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.0.14
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Reads a YAML file and creates ENV variables from it