required_env_fetcher 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3c05aaed51a04e734c9cade8ba3c5ce66250a552bad4bbca11c7f34befc57c97
+  data.tar.gz: 033a4a04fb363c3146c9780888efb6d1f5f76bde96a4b0ac82c7f97ea3aaea14
+SHA512:
+  metadata.gz: d2cf669516608c1cd592f08bd94bd43724da76b8216762f51f5f8522ec3096af87d9192465e9d76970a2348da78e173b7d5734774327991e7d91d29d0f0c7945
+  data.tar.gz: 6088b2bf25e937eed0d29f2d0cab30424897cd68ea4d8ad93cc584f132661e6668dd601706e037e415e59f6f0991f889a42500e61c061b8dcd75f976c876a19e

data/.codeclimate.yml

@@ -0,0 +1,53 @@
+version: "2"
+checks:
+  file-lines:
+    enabled: false
+  method-lines:
+    enabled: false
+plugins:
+  csslint:
+    enabled: true
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+      - javascript
+  fixme:
+    enabled: true
+exclude_patterns:
+- config/
+- db/
+- script/
+- spec/
+- vendor/
+- "**.jpg"
+- "**.png"
+- "**.gif"
+- "**.svg"
+- "**.scss"
+- "**.md"
+- ".rubocop.yml"
+- "Dockerfile"
+- "Capfile"
+- "README.md"
+- "**.erb"
+- "**.jbuilder"
+- "**.rabl"
+- "**.zip"
+- "**.crt"
+- "**.txt"
+- "**.ico"
+- "**.eot"
+- "**.pdf"
+- "**.html"
+- "**.key"
+- "**.docx"
+- "**.fcgi"
+- "**.xml"
+- "**.pem"
+- "**.csr"
+- "**.org"
+- "**.cgi"
+- "**.ru"
+- "**.pptx"

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# required_env_fetcher
+
+## v0.1.0
+- Initial version

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# override the :github shortcut to be secure by using HTTPS
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}.git" }
+
+# Specify your gem's dependencies in required_env_fetcher.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 ezCater, Inc.
+
+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,76 @@
+# required_env_fetcher
+
+In certain situations it makes sense to allow default values of environment variables that
+are otherwise required. For example, imagine we're precompiling assets as part of CI when
+we don't have access to some environment variables we require for the app be up and
+accepting requests, but aren't required for asset compilation. Using this library we can
+designate it safe to use default values in those situations.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "required_env_fetcher"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install required_env_fetcher
+
+## Usage
+
+When you have an environment variable that is required - perhaps with code like:
+
+```ruby
+# in config/application.rb
+module MyApp
+  class Application < Rails::Application
+    config.x.redis_url = ENV.fetch("REDIS_URL")
+  end
+end
+```
+
+When you run `rails assets:precompile` you'll always need to have a `REDIS_URL` set or else loading
+the application environment will fail. You can update your initializer to do something like:
+
+```ruby
+config.x.redis_url = RequiredEnvFetcher.fetch("REDIS_URL")
+```
+
+Now you can run `SKIP_REQUIRED_ENV_VAR_ENFORCEMENT=true rails assets:precompile` and so long as none of
+your assets rely on the redis URL they will be able to compile.
+
+If you need a specific default value (for example, if the value needs to be a valid URL) you can do:
+
+```ruby
+config.x.redis_url = RequiredEnvFetcher.fetch("REDIS_URL", "http://example.com")
+```
+
+## 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 rake install`.
+
+To release a new version, update the version number in `version.rb`, and then
+run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org)
+.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/ezcater/required_env_fetcher-ruby.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).

data/lib/required_env_fetcher.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "required_env_fetcher/version"
+
+module RequiredEnvFetcher
+  def self.fetch(key, default = nil)
+    if ENV["SKIP_REQUIRED_ENV_VAR_ENFORCEMENT"] == "true"
+      ENV.fetch(key, default || "")
+    else
+      ENV.fetch(key)
+    end
+  end
+end

data/lib/required_env_fetcher/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RequiredEnvFetcher
+  VERSION = "0.1.0"
+end

data/required_env_fetcher.gemspec

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "required_env_fetcher/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "required_env_fetcher"
+  spec.version       = RequiredEnvFetcher::VERSION
+  spec.authors       = ["ezCater, Inc"]
+  spec.email         = ["engineering@ezcater.com"]
+
+  spec.summary       = "Allow a default value to be used for a required environment variable"
+  spec.description   = <<~DESC
+    In certain situations it makes sense to allow default values of environment variables that
+    are otherwise required. For example, imagine we're precompiling assets as part of CI when
+    we don't have access to some environment variables we require for the app be up and
+    accepting requests, but aren't required for asset compilation. Using this library we can
+    designate it safe to use default values in those situations.
+  DESC
+  spec.homepage      = "https://github.com/ezcater/required_env_fetcher-ruby"
+
+  spec.license       = "MIT"
+
+  # Set "allowed_push_post" to control where this gem can be published.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  excluded_files = %w(.circleci/config.yml
+                      .github/PULL_REQUEST_TEMPLATE.md
+                      .gitignore
+                      .rspec
+                      .rubocop.yml
+                      .ruby-gemset
+                      .ruby-version
+                      .travis.yml
+                      bin/console
+                      bin/setup
+                      Rakefile)
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(/^(test|spec|features)\//)
+  end - excluded_files
+  spec.bindir        = "bin"
+  spec.executables   = []
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+
+  spec.add_development_dependency "climate_control"
+  spec.add_development_dependency "ezcater_rubocop", "0.58.0"
+  spec.add_development_dependency "overcommit"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "rspec_junit_formatter", "0.2.2"
+  spec.add_development_dependency "simplecov"
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: required_env_fetcher
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ezCater, Inc
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-18 00:00:00.000000000 Z
+dependencies:
+- !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: climate_control
+  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: ezcater_rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.58.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.58.0
+- !ruby/object:Gem::Dependency
+  name: overcommit
+  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.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+- !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'
+description: |
+  In certain situations it makes sense to allow default values of environment variables that
+  are otherwise required. For example, imagine we're precompiling assets as part of CI when
+  we don't have access to some environment variables we require for the app be up and
+  accepting requests, but aren't required for asset compilation. Using this library we can
+  designate it safe to use default values in those situations.
+email:
+- engineering@ezcater.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- lib/required_env_fetcher.rb
+- lib/required_env_fetcher/version.rb
+- required_env_fetcher.gemspec
+homepage: https://github.com/ezcater/required_env_fetcher-ruby
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.7.8
+signing_key: 
+specification_version: 4
+summary: Allow a default value to be used for a required environment variable
+test_files: []