env_configuration 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e16758211998964af2449e93f0d2752ca8a151e7
+  data.tar.gz: 33f121edd8f7bcf3a49cbdad4e7e81c98a0ad00f
+SHA512:
+  metadata.gz: e8bce5b57819d92dae03853a32772999c4bf80104dee81367e7d8074532d5b3f61dd3db1d059e77d392c8d668abd02b91a6fbc2bcf880283070a0884f52bda4c
+  data.tar.gz: 59348900392be1747750635cd405e93d7ed1300edf59329a4f90f08a8b5ac0c2a3d317cdfa287ae9035c2f8d943ca6f6140217c4b85ea36d1013e60557d3b503

data/.env

@@ -0,0 +1,6 @@
+APP_NAME='BookMeBus DotRoot'
+COMPANY_NAME='Camtasia Technology DotRoot'
+APP_VERSION='1.0.0-DotRoot'
+ENABLE_HTTPS='no-DotRoot'
+ASSET_HOST_URL='http://DotRoot.local'
+HOST='http://DotRoot.local'

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at channa.info@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in env_configuration.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,104 @@
+PATH
+  remote: .
+  specs:
+    env_configuration (0.1.1)
+      aws-sdk-ssm
+      dotenv-rails (= 2.7.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (5.2.3)
+      actionview (= 5.2.3)
+      activesupport (= 5.2.3)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.3)
+      activesupport (= 5.2.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    aws-eventstream (1.0.3)
+    aws-partitions (1.215.0)
+    aws-sdk-core (3.68.0)
+      aws-eventstream (~> 1.0, >= 1.0.2)
+      aws-partitions (~> 1.0)
+      aws-sigv4 (~> 1.1)
+      jmespath (~> 1.0)
+    aws-sdk-ssm (1.55.0)
+      aws-sdk-core (~> 3, >= 3.61.1)
+      aws-sigv4 (~> 1.1)
+    aws-sigv4 (1.1.0)
+      aws-eventstream (~> 1.0, >= 1.0.2)
+    builder (3.2.3)
+    concurrent-ruby (1.1.5)
+    crass (1.0.4)
+    diff-lcs (1.3)
+    dotenv (2.7.4)
+    dotenv-rails (2.7.4)
+      dotenv (= 2.7.4)
+      railties (>= 3.2, < 6.1)
+    erubi (1.8.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    jmespath (1.4.0)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (0.9.2)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    nokogiri (1.10.4)
+      mini_portile2 (~> 2.4.0)
+    rack (2.0.7)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.3)
+      actionpack (= 5.2.3)
+      activesupport (= 5.2.3)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  env_configuration!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Channa Ly
+
+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,289 @@
+# EnvConfiguration
+
+[![Build Status](https://travis-ci.org/channainfo/env_configuration.svg?branch=develop)](https://travis-ci.org/channainfo/env_configuration)
+
+This gem aims to load your config into ENV.  Currently configuration can be done via 3 different adapters
+
+1. Using .env powered by [dotenv](https://github.com/bkeepers/dotenv) gem. This is very popular in development environment.
+2. Using Yaml file config. As Yaml can be nested it is a bit more convenient than dotenv to separate setting between environment.
+3. Using [AWS System Manager Parameter Store](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html) - recommended for production.
+
+How about container service link [Heroku](https://heroku.com/) and [ElasticBeanstalk](https://aws.amazon.com/elasticbeanstalk/)?
+
+Heroku has an application settings for ENV which allows the config var to have up to 32kb max in size. ElasticBeanstalk has a similar approach by allowing you to set config var in the ElasticBeanstalk Settings, however[it allows only 4096bytes max for key, value combined](https://stackoverflow.com/questions/54344236/environmentvariables-default-value-length-is-greater-than-4096). This might cause issues for some application that integrate with many third parties.
+
+
+
+## Why Store config in the environment?
+
+An app’s  _config_  is everything that is likely to vary between  [deploys](https://12factor.net/codebase)  (staging, production, developer environments, etc). This includes:
+
+-   Resource handles to the database, Memcached, and other  [backing services](https://12factor.net/backing-services)
+-   Credentials to external services such as Amazon S3 or Twitter
+-   Per-deploy values such as the canonical hostname for the deploy
+
+Apps sometimes store config as constants in the code. This is a violation of twelve-factor, which requires  **strict separation of config from code**. Config varies substantially across deploys, code does not.
+
+A litmus test for whether an app has all config correctly factored out of the code is whether the codebase could be made open source at any moment, without compromising any credentials.
+
+## Installation
+```ruby
+gem 'env_configuration'
+
+```
+
+And then execute:
+
+```bash  
+$ bundle
+```
+
+
+Or install it yourself as:
+
+
+```bash
+$ gem install env_configuration
+```
+
+
+## Usage
+There are 3 types of adapter :dot_env,  :yaml,  :aws_ssm_parameter_store.
+```ruby
+EnvConfiguration::Configurator.load(:adapter_name, options={})
+```
+Options value varies from adapter to adapter.
+
+### Configure gem
+You can configure the gem with the following:
+```ruby
+EnvConfiguration.configure do |config|
+config.dot_env = { dot_env_file:  'config/app.env' }
+config.yaml    = { yaml_file:  'config/app.yaml'}
+config.aws_ssm_parameter_store  = { access_key_id:  'aws-key', secret_access_key:  'aws-secret', region:  'ap-southeast-1', path:  '/staging'}
+end
+```
+
+### DotEnv Adapter
+Internally EnvConfiguration use [https://github.com/bkeepers/dotenv](https://github.com/bkeepers/dotenv) to handle this:
+
+```ruby
+# Configuration (optional)
+# EnvConfiguration.configure do |config|
+#   config.dot_env = { dot_env_file:  'config/app.env' }
+# end
+
+options = { dot_env_file: 'your-dotenv-app.env' }
+EnvConfiguration::Configurator.load(:dot_env, options)
+```
+If options is not provided then the :dot_env adapter will try to get the from the gem configuration. It still does not exist then it will load the .env file located in the root of the project.
+
+### Yaml adapter
+Internally EnvConfiguration use 'yaml' library from ruby to handle this.
+```ruby
+# Configuration (optional)
+#EnvConfiguration.configure do |config|
+#  config.yaml  = { section:  'default-dev', yaml_file:  'config/default-app.yml'}
+#end
+
+# optional if you configure the gem above.
+options  = { yaml_file: 'config/app.yaml', __FILE__), section:  'development' }
+result  =  EnvConfiguration::Configurator.load(:yaml, options)
+```
+Both :yaml_file and :section must exist . If you options is being specified EnvConfiguration will take value from options. otherwise gem configuration must provide the values.
+
+if you miss to provide :yaml_file and :section the gem will raise the following errors:
+
+- :yaml_file in the options{} is required, for example config/application.yml
+- :section in the options{} is required, for example :staging, :test, :production
+
+As an example value of yaml_file: [config/app.yml.](https://github.com/channainfo/env_configuration/blob/develop/spec/config/app.yaml) Sections here are (test, development, staging, production)
+```yml
+default: &default
+APP_NAME: "BookMeBus"
+COMPANY_NAME: "Camtasia Technology"
+APP_VERSION: "Development"
+ENABLE_HTTPS: 'no'
+ASSET_HOST_URL: 'http://localhost:3000'
+HOST: 'http://localhost:3000'
+
+test:
+<<: *default
+
+development:
+<<: *default
+
+staging:
+<<: *default
+
+production:
+<<: *default
+```
+### AWS SSM Parameter Store
+
+EnvConfiguration will fetch from the aws ssm parameter store service 10 key, value per request. If you have hundred it will ended up fetching as many requests until it finishes.
+
+AWS Systems Manager Parameter Store provides secure, hierarchical storage for configuration data management and secrets management. You can store data such as passwords, database strings, and license codes as parameter values. You can store values as plain text or encrypted data. You can then reference values by using the unique name that you specified when you created the parameter. Highly scalable, available, and durable, Parameter Store is backed by the AWS Cloud.
+
+Internally EnvConfiguration use aws-sdk-ssm gem to handle this.
+
+```ruby
+# Configuration (optional)
+#EnvConfiguration.configure do |config|
+# options  = { access_key_id:  'default-key-id', secret_access_key:  'default-secret-key', region:  'default-region', path:  'default-path' }
+# config.aws_ssm_parameter_store  = options
+#end
+
+options = {access_key_id: 'your-aws-key', secret_access_key: 'your-aws-secret', region: 'your-region' , path:  '/staging'}
+EnvConfiguration::Configurator.load(:aws_ssm_parameter_store, options)
+```
+EnvConfiguration will use the options if options exists, otherwise it will use the options from the gem configuration above. The options will then be passed to aws-sdk-ssm.
+EnvConfiguration gem will hand over the options to aws-sdk-ssm. Interesting aws-sdk-ssk will follows the rules as below:
+
+### Access key id and secret_access_key
+:access_key_id, :secret_access_key are search for in the following locations:
+- :access_key_id, :secret_access_key
+- ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
+- ~/.aws/credentials
+- ~/.aws/config
+
+### The Region
+The region is search for in the following locations:
+- :region
+- ENV['AWS_REGION']
+- ENV['AMAZON_REGION']
+- ENV['AWS_DEFAULT_REGION']
+- ~/.aws/credentials
+- ~/.aws/config
+For more details on the configuration [https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSM/Client.html](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SSM/Client.html)
+
+
+### Aws policy for SSM Parameter Store
+In order to be able to fetch the parameter store from aws ssm you need at least **ssm:GetParametersByPath**  policy to attach to your IAM account
+```json
+{
+"Version": "2012-10-17",
+"Statement": [
+  {
+      "Sid": "VisualEditor0",
+      "Effect": "Allow",
+      "Action": [
+          "ssm:PutParameter",
+          "ssm:GetParametersByPath",
+          "ssm:GetParameters",
+          "ssm:GetParameter"
+      ],
+      "Resource": "*"
+  }
+]
+}
+```
+
+## Integrate with rails
+
+### Add Gem to application.rb
+Add the following line
+```ruby
+EnvConfiguration::Configurator.load(:dot_env)
+```
+right below the
+```ruby
+Bundler.require(*Rails.groups)
+```
+in the config/application.rb as below:
+
+```ruby
+require File.expand_path('boot', __dir__)
+require 'rails/all'
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
+# EnvConfiguration
+EnvConfiguration::Configurator.load(:dot_env)
+```
+As this gem does not handle the Rails env, you might need to do this yourself in case you use different adapters for each Rails env:
+
+```ruby
+require File.expand_path('boot', __dir__)
+
+require 'rails/all'
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
+
+# EnvConfiguration
+if(Rails.env.development?)
+EnvConfiguration::Configurator.load(:dot_env)
+elsif Rails.env.test?
+EnvConfiguration::Configurator.load(:yaml, yaml_file: "#{Rails.root}/config/app-test.yml")
+else
+#separete aws ssm parameter store from staging with production /Rails.env
+EnvConfiguration::Configurator.load(:aws_ssm_parameter_store, path: "/#{Rails.env}")
+end
+```
+
+
+### Gem configuration in config/initializers/env_configuration.rb
+```ruby
+EnvConfiguration.configure do |config|
+# Dot Env
+config.dot_env = { dot_env_file: 'config/app.env' }
+# Yaml Config
+config.yaml = { yaml_file: File.join(Rails.root, "config/application_#{Rails.env}.yaml" )}
+
+# Aws ssm parameter store
+config.aws_ssm_parameter_store = { access_key_id: ENV['AWS_ACCESS_KEY_ID'],
+                               secret_access_key: ENV['AWS_SECRET_ACCESS_KEY'],
+                               region: ENV['AWS_REGION'],
+                               path: "/#{Rails.env}"}
+end
+
+```
+
+
+### Putting Parameters to AWS SSM Parameter store
+The main purpose of this gem is to read the config however, it offers an easy way to import the existing config in yml to parameter store as followed:
+
+```ruby
+options = { access_key_id: ENV['AWS_ACCESS_KEY_ID'],
+      secret_access_key: ENV['AWS_SECRET_ACCESS_KEY'],
+      region: ENV['AWS_REGION'] }
+path = 'staging'
+writer = EnvConfiguration::AwsSsmParameterStoreWriter.new('staging', options)
+config_file = "project/application.yml"
+writer.put_configs_from_yaml_file(config_file)
+# output {APP_NAME: "BookMeBus" COMPANY_NAME: "BookMeBus Pte," APP_VERSION: "Staging" ,ENABLE_HTTPS: 'yes'}
+```
+
+application.yml
+```yaml
+default: &default
+APP_NAME: "BookMeBus"
+COMPANY_NAME: "BookMeBus Pte,"
+APP_VERSION: "Staging"
+ENABLE_HTTPS: 'yes'
+staging:
+<<: *default
+```
+
+> AWS parameter store put does not allow any var with value of length < 1. If you have any variable with empty value the variable will be ignored from pushing to aws ssm parameter store eventually you will lose it.
+
+## 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/channainfo/env_configuration. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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 "env_configuration"
+
+# 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(__FILE__)

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/env_configuration.gemspec

@@ -0,0 +1,47 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "env_configuration/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "env_configuration"
+  spec.version       = EnvConfiguration::VERSION
+  spec.authors       = ["Channa Ly"]
+  spec.email         = ["channa.info@gmail.com"]
+
+  spec.summary       = %q{
+    A gem to config env variable in development in dotenv, yaml, aws ssm parameter store, heroku in ruby and rails project.
+  }
+  spec.description   = %q{
+    This gem aims to load config to ENV varaible easily. Currently configuration can be done by a .env, a yaml file or by loading from 
+    AWS System Manager Parameter Store which is recommended for production deployment.
+
+  }
+  spec.homepage      = "https://github.com/channainfo/env_configuration"
+  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"] = "http://mygemserver.com"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "aws-sdk-ssm"
+  spec.add_dependency "dotenv-rails", "2.7.4"
+end

data/lib/env_configuration.rb

@@ -0,0 +1,27 @@
+require "env_configuration/version"
+require "env_configuration/configurator"
+require "env_configuration/configuration"
+require "env_configuration/aws_ssm_parameter_store_writer"
+
+module EnvConfiguration
+  class Error < StandardError; end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(self.configuration)
+    self.configuration
+  end
+
+  def self.reset_configuration
+    @configuration = Configuration.new
+  end
+
+end

data/lib/env_configuration/adapter/aws_ssm_parameter_store_adapter.rb

@@ -0,0 +1,91 @@
+module EnvConfiguration
+  module Adapter
+    class AwsSsmParameterStoreAdapter < Base
+
+      # if you set ENV['AWS_ACCESS_KEY_ID'],ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_REGION']
+      # you don't need to pass the options
+      # { access_key_id: ENV['AWS_ACCESS_KEY_ID'], secret_access_key: ENV['AWS_SECRET_ACCESS_KEY'], region: ENV['AWS_REGION']
+      def initialize(options={})
+        super(options)
+
+      end
+
+      def client
+        aws_options = {
+          access_key_id: access_key_id,
+          secret_access_key: secret_access_key,
+          region: region,
+        }
+        @client ||= Aws::SSM::Client.new(@options)
+      end
+
+      def access_key_id
+        @options[:access_key_id] || EnvConfiguration.configuration.aws_access_key_id
+      end
+
+      def secret_access_key
+        @options[:secret_access_key] || EnvConfiguration.configuration.aws_secret_access_key
+      end
+
+      def region
+        @options[:region] || EnvConfiguration.configuration.aws_region
+      end
+
+      def path
+        path_value = @options[:path] || EnvConfiguration.configuration.aws_path
+        raise ":path options is required for example /staging" if path_value.nil?
+        path_value
+      end
+
+      def load
+        # fetch_configs do |item|
+        #   ENV["#{item[:name]}"] = item[:value]
+        # end
+
+        configs = fetch_configs
+        ENV.update(configs)
+        configs
+      end
+
+      def fetch_configs(&block)
+        next_token = nil
+        result = {}
+
+        while(true)
+
+          fetch_options = {
+            path: path,
+            with_decryption: false,
+            recursive: true,
+            max_results: 10
+          }
+
+          fetch_options[:next_token] = next_token if next_token
+
+          response = client.get_parameters_by_path(fetch_options)
+
+          items = sanitize_configs(response.parameters, &block)
+          result.merge!(items)
+
+          next_token = response.next_token
+          break if next_token.nil?
+        end
+
+        result
+      end
+
+      def sanitize_configs(parameters, &block)
+        items = {}
+        parameters.each do |param|
+          name  = param.name.gsub("#{path}/", '')
+          value = param.value
+          item = {name: name, value: value}
+          items[name] = value
+          yield(item) if block_given?
+        end
+        items
+      end
+    end
+
+  end
+end

data/lib/env_configuration/adapter/base.rb

@@ -0,0 +1,15 @@
+module EnvConfiguration
+  module Adapter
+    attr_accessor :options
+
+    class Base
+      def initialize(options={})
+        @options = options.clone
+      end
+
+      def update_env_variable_with(configs)
+        ENV.update(configs)
+      end
+    end
+  end
+end

data/lib/env_configuration/adapter/dot_env_adapter.rb

@@ -0,0 +1,25 @@
+require 'dotenv'
+
+module EnvConfiguration
+  module Adapter
+    class DotEnvAdapter < Base
+
+      def initialize(options={})
+        super(options)
+      end
+
+      def file
+        @options[:dot_env_file] || EnvConfiguration.configuration.dot_env_file
+      end
+
+      def load
+        p file
+        if file.nil?
+          Dotenv.load
+        else
+          Dotenv.load(file)
+        end
+      end
+    end
+  end
+end

data/lib/env_configuration/adapter/yaml_adapter.rb

@@ -0,0 +1,34 @@
+require 'yaml'
+
+module EnvConfiguration
+  module Adapter
+    class YamlAdapter < Base
+ 
+      def initialize(options = {})
+        super(options)
+      end
+
+      def section
+        section_value = @options[:section] || EnvConfiguration.configuration.yaml_section
+        raise ":section in the options{} is required, for example :staging, :test, :production" if section_value.nil?
+        section_value
+      end
+      
+      def yaml_file
+        yaml_file_value = @options[:yaml_file] || EnvConfiguration.configuration.yaml_file
+        raise ":yaml_file in the options{} is required, for example config/application.yml" if yaml_file_value.nil?
+        yaml_file_value
+      end
+
+      def load
+        configs = fetch_configs
+        update_env_variable_with(configs)
+        configs
+      end
+
+      def fetch_configs
+        ::YAML.load_file(yaml_file)[section]
+      end
+    end
+  end
+end

data/lib/env_configuration/aws_ssm_parameter_store_writer.rb

@@ -0,0 +1,48 @@
+require 'aws-sdk-ssm'
+
+module EnvConfiguration
+  class AwsSsmParameterStoreWriter
+    attr_accessor :env_name #allow to reset env but not region
+
+    # if you set ENV['AWS_ACCESS_KEY_ID'],ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_REGION']
+    # you don't need to pass the options
+    # { access_key_id: ENV['AWS_ACCESS_KEY_ID'], secret_access_key: ENV['AWS_SECRET_ACCESS_KEY'], region: ENV['AWS_REGION']
+    def initialize(env_name, options = {})
+      @env_name = env_name
+      @options  = options
+    end
+
+    def client
+      @client ||= Aws::SSM::Client.new(@options)
+    end
+
+    def put_configs_from_yaml_file(config_yml)
+      configs = YAML.load_file(config_yml)[@env_name]
+      put_configs(configs)
+    end
+
+    def put_configs(configs)
+      configs.each do |key, value|
+        put_config(key, value) if !value.empty? #aws don't allow value to have empty value
+      end
+    end
+
+    def put_config(name, value, type='String')
+      Rails.logger.info { "preparing: #{name}=#{value}" }
+
+      param_name = "/#{@env_name}/#{name}"
+
+      options = {
+        name: param_name, # required
+        value: value, # required
+        type: type, # required, accepts String, StringList, SecureString
+        overwrite: true,
+        tier: "Standard", # accepts Standard, Advanced
+      }
+      response = client.put_parameter(options)
+
+      Rails.logger.info { "setting: #{options}" }
+      response
+    end
+  end
+end

data/lib/env_configuration/configuration.rb

@@ -0,0 +1,42 @@
+module EnvConfiguration
+
+  class Configuration
+    attr_accessor :dot_env, :aws_ssm_parameter_store, :yaml
+
+    # ------ :dot_env ---------
+    # :dot_env_file
+
+    def dot_env_file
+      dot_env && dot_env[:dot_env_file]
+    end
+
+    # ------ :yaml ---------
+    # :yaml_file, :section
+    def yaml_file
+      yaml && yaml[:yaml_file]
+    end
+
+    def yaml_section
+      yaml && yaml[:section]
+    end
+
+    # ------ :aws_ssm_paramer_store ---------
+    # :access_key_id, :secret_access_key, :region, :path
+    def aws_access_key_id
+      aws_ssm_parameter_store && aws_ssm_parameter_store[:access_key_id]
+    end
+
+    def aws_secret_access_key
+      aws_ssm_parameter_store && aws_ssm_parameter_store[:secret_access_key]
+    end
+
+    def aws_region
+      aws_ssm_parameter_store && aws_ssm_parameter_store[:region]
+    end
+
+    def aws_path
+      aws_ssm_parameter_store && aws_ssm_parameter_store[:path]
+    end
+  end
+
+end

data/lib/env_configuration/configurator.rb

@@ -0,0 +1,36 @@
+module EnvConfiguration
+
+  class Configurator
+    def self.load(adapter_name, options={})
+      if adapter_name.class == Symbol
+        loader = self.adapter(adapter_name, options)
+        loader.load
+      else
+        adapter_name.load
+      end
+    end
+
+    def self.adapter(adapter_name, options={})
+      case adapter_name
+      when :dot_env
+        require "env_configuration/adapter/base"
+        require "env_configuration/adapter/dot_env_adapter"
+        Adapter::DotEnvAdapter.new(options)
+      when :aws_ssm_parameter_store
+        require 'aws-sdk-ssm'
+        require "env_configuration/adapter/base"
+        require "env_configuration/adapter/aws_ssm_parameter_store_adapter"
+        require "env_configuration/aws_ssm_parameter_store_writer"
+        Adapter::AwsSsmParameterStoreAdapter.new(options)
+      when :yaml
+        require "env_configuration/adapter/base"
+        require "env_configuration/adapter/yaml_adapter"
+        Adapter::YamlAdapter.new(options)
+      else
+        existings = [:dot_env, :yaml, :aws_ssm_parameter_store]
+        raise "adapter :#{adapter_name} must be one of the following #{existings}"
+      end
+    end
+  end
+end
+

data/lib/env_configuration/version.rb

@@ -0,0 +1,3 @@
+module EnvConfiguration
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: env_configuration
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Channa Ly
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: aws-sdk-ssm
+  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: dotenv-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.7.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.7.4
+description: "\n    This gem aims to load config to ENV varaible easily. Currently
+  configuration can be done by a .env, a yaml file or by loading from \n    AWS System
+  Manager Parameter Store which is recommended for production deployment.\n\n  "
+email:
+- channa.info@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- env_configuration.gemspec
+- lib/env_configuration.rb
+- lib/env_configuration/adapter/aws_ssm_parameter_store_adapter.rb
+- lib/env_configuration/adapter/base.rb
+- lib/env_configuration/adapter/dot_env_adapter.rb
+- lib/env_configuration/adapter/yaml_adapter.rb
+- lib/env_configuration/aws_ssm_parameter_store_writer.rb
+- lib/env_configuration/configuration.rb
+- lib/env_configuration/configurator.rb
+- lib/env_configuration/version.rb
+homepage: https://github.com/channainfo/env_configuration
+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: A gem to config env variable in development in dotenv, yaml, aws ssm parameter
+  store, heroku in ruby and rails project.
+test_files: []