require_env 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8873d2fe4dd5389196b6854022c31f7bfc49f757
+  data.tar.gz: 01ac5d2b6ef15c421f72bc265ebd2fe3e38b51cf
+SHA512:
+  metadata.gz: 871c3aa4c3fa584e68e521ec607e7058589f21869a3446c00f33a98d7e14641ea873d709ce6913d58cc36b5d91687533a4986120532d2b74f4a2547308ab0b53
+  data.tar.gz: a792a8397f994323bb6fed208119061de24a76c192304fae00df409dc8d3e1104d62727d67d01042db352fb1e742694c9396b77f9892afb7fb873fcf4fd0b7e2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Geoffroy Planquart
+
+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,51 @@
+# RequireEnv
+
+Check environment variable presence easily.
+
+## Install
+
+`bundle install require_env`
+
+## Usage
+
+Create a YAML file, e.g. `config/environment.yml`, where you define the environment variables
+required by your application, for the different environment it will run 
+(test, development, production by default) 
+
+- You can use ERB code to provide computed values
+- You can use YAML defaults.
+- An optional default value can be given for any key
+- Keys ending with _IF_OTHER_VARIABLE will only be checked if OTHER_VARIABLE is defined and not equal 'false'
+- Default value have precedence over the _IF_OTHER_VARIABLE rule
+
+Here is an example presenting the different possibilities:
+
+```yaml
+DEFAULTS: &DEFAULTS
+  BEANSTALK_URL: 'beanstalk://127.0.0.1'
+
+  SLACK_TOKEN:
+
+  # Use the environment variable TOKEN_SCALINGO as a default value if provided
+  SCALINGO_TOKEN: "<%= ENV['TOKEN_SCALINGO'] %>"
+
+  # Declare STRIPE_ENABLED to check for STRIPE_PUBLIC_KEY and STRIPE_SECRET_KEY
+  STRIPE_PUBLIC_KEY_IF_STRIPE_ENABLED:
+  STRIPE_SECRET_KEY_IF_STRIPE_ENABLED:
+
+test:
+  <<: *DEFAULTS
+  IGNORE_EVENT_DELAY: 'true'
+
+development:
+  <<: *DEFAULTS
+  IGNORE_EVENT_DELAY: 'true'
+
+production:
+  <<: *DEFAULTS
+```
+
+When your application starts, simply call `RequireEnv.check(Rails.root.join('config', 'environment.yml'))`
+to check if the required environment variables are provided.
+
+If any variable is missing, `RequireEnv::Missing` will be raised, detailing the missing environment variable.

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RequireEnv'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/require_env.rb

@@ -0,0 +1,57 @@
+require 'require_env/missing'
+require 'safe_yaml/load'
+require 'erb'
+
+module RequireEnv
+  def self.check(*files)
+    check_multiple_requirements(files.map do |file|
+      requirements = requirements_from_file(file)[application_environment]
+      if requirements.nil?
+        raise ArgumentError.new("#{file} does not define anything for environment: #{application_environment}")
+      end
+      [file, requirements]
+    end)
+  end
+
+  def self.requirements_from_file(file)
+    if File.exist?(file)
+      SafeYAML.load(ERB.new(File.read(file)).result)
+    else
+      raise ArgumentError.new("File not found: #{file}")
+    end
+  end
+
+  def self.check_multiple_requirements(multiple_requirements)
+    missing_requirements = multiple_requirements.map do |file, requirements|
+      missing = check_requirements(requirements)
+      if missing.present?
+        [file, missing]
+      end
+    end.compact
+
+    if missing_requirements.present?
+      raise RequireEnv::Missing.new(missing_requirements)
+    end
+  end
+
+  def self.check_requirements(requirements)
+    requirements.map do |key, value|
+      if ENV.has_key?(key) || ENV.has_key?(key.split('_IF_').first)
+        next nil
+      elsif value
+        ENV[key] = value.to_s
+        next nil
+      elsif key.include?('_IF_')
+        if (condition = ENV[key.split('_IF_').last]) && condition != 'false'
+          next key.split('_IF_').first
+        end
+      else
+        next key
+      end
+    end.compact
+  end
+
+  def self.application_environment
+    ENV['RAILS_ENV']
+  end
+end

data/lib/require_env/missing.rb

@@ -0,0 +1,13 @@
+module RequireEnv
+  class Missing < StandardError
+    def initialize(requirements)
+      message = "Missing environment variables!\n"
+      requirements.each do |file, reqs|
+        message += "- Declared in `#{file}':\n"
+        message += reqs.map{|env| "\t- #{env}"}.join("\n")
+        message += "\n"
+      end
+      super(message)
+    end
+  end
+end

data/lib/require_env/version.rb

@@ -0,0 +1,3 @@
+module RequireEnv
+  VERSION = '1.0.0'
+end

data/test/require_env_test.rb

@@ -0,0 +1,100 @@
+require 'test_helper'
+
+class RequireEnvTest < ActiveSupport::TestCase
+  setup do
+    ENV.delete('RAILS_ENV')
+    ENV.delete('VAR')
+    ENV.delete('SUM')
+    ENV.delete('FOO')
+    ENV.delete('BAR')
+    ENV.delete('BAZ')
+  end
+
+  test 'truth' do
+    assert_kind_of Module, RequireEnv
+  end
+
+  test 'check' do
+    file = File.expand_path('../test.yml', __FILE__)
+
+    assert_raise(ArgumentError) do
+      RequireEnv.check(file, file)
+    end
+
+    ENV['RAILS_ENV'] = 'test'
+    assert_raise(RequireEnv::Missing) do
+      RequireEnv.check(file)
+    end
+
+    ENV['FOO'] = 'bar'
+    RequireEnv.check(file)
+  end
+
+  test 'application_environment' do
+    assert_equal nil, RequireEnv.application_environment
+
+    ENV['RAILS_ENV'] = 'test'
+    assert_equal 'test', RequireEnv.application_environment
+
+    ENV['RAILS_ENV'] = 'foo'
+    assert_equal 'foo', RequireEnv.application_environment
+  end
+
+  test 'requirements_from_file' do
+    assert_raise(ArgumentError) do
+      RequireEnv.requirements_from_file('foobar')
+    end
+
+    file = File.expand_path('../test.yml', __FILE__)
+    result = RequireEnv.requirements_from_file(file)
+
+    assert_kind_of Hash, result
+    assert_equal 'foo', result.dig('test', 'VAR')
+    assert_equal 2, result.dig('test', 'SUM')
+    assert_equal nil, result.dig('test', 'FOO')
+  end
+
+  test 'check_requirements' do
+    requirements = {
+      'VAR' => nil,
+      'FOO' => 'BAR',
+      'BAR_IF_CONDITION' => nil,
+    }
+
+    missing = RequireEnv.check_requirements(requirements)
+    assert_equal ['VAR'], missing
+    assert_equal 'BAR', ENV['FOO']
+
+    ENV['CONDITION'] = 'false'
+    ENV['VAR'] = 'bla'
+    missing = RequireEnv.check_requirements(requirements)
+
+    ENV['CONDITION'] = 'foo'
+    missing = RequireEnv.check_requirements(requirements)
+    assert_equal ['BAR'], missing
+  end
+
+  test 'check_multiple_requirements' do
+    multiple_requirements = {
+      'foo.yml' => {
+        'VAR' => nil,
+        'FOO' => 'BAR',
+      },
+      'bar.yml' => {
+        'BAR' => nil,
+        'BAZ' => nil,
+      },
+    }
+
+    ENV['BAR'] = 'test'
+
+    assert_raise(RequireEnv::Missing) do
+      RequireEnv.check_multiple_requirements(multiple_requirements)
+    end
+    ENV['BAZ'] = 'test'
+    assert_raise(RequireEnv::Missing) do
+      RequireEnv.check_multiple_requirements(multiple_requirements)
+    end
+    ENV['VAR'] = 'bla'
+  end
+end

data/test/test.yml

@@ -0,0 +1,4 @@
+test:
+  VAR: 'foo'
+  SUM: <%= 1 + 1 %>
+  FOO:

data/test/test_helper.rb

@@ -0,0 +1,16 @@
+require 'bundler/setup'
+require 'simplecov'
+SimpleCov.configure do
+  add_filter '/test/'
+end
+SimpleCov.start if ENV['COVERAGE']
+
+require 'active_support'
+require 'minitest/autorun'
+
+require 'require_env'
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+ActiveSupport::TestCase.test_order = :random

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: require_env
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Geoffroy Planquart
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: safe_yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Check environment variable presence with minimal YAML file
+email:
+- geoffroy@planquart.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/require_env.rb
+- lib/require_env/missing.rb
+- lib/require_env/version.rb
+- test/require_env_test.rb
+- test/test.yml
+- test/test_helper.rb
+homepage: https://github.com/Aethelflaed/require_env
+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: Simple environment variable check
+test_files:
+- test/require_env_test.rb
+- test/test.yml
+- test/test_helper.rb