remotenv 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bcb4805fa505506602db8674f1aad2e30f2b3416
+  data.tar.gz: b1f367d03d37e1787499ab39a9c7feb680c0474f
+SHA512:
+  metadata.gz: a4c319a4ff15015b4a2c8c83c79be5be5de1eddc33ba521ab297e68823e16e074398a1e4097e27bcbbac85ca1608285390b4f8ed82be390f302ce0179854f04d
+  data.tar.gz: 43f988fc4350247afb0a3889dda2d09eb5b8881a774c2a530f92a90aa1ca7d0a9efe1970d05336bd5087ebbf4ffdc8a0dda4da2e6f924e43ea8e716752994081

data/.gitignore

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

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/.simplecov

@@ -0,0 +1,12 @@
+require "codeclimate-test-reporter"
+require 'codecov'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
+  (CodeClimate::TestReporter::Formatter if ENV['CODECLIMATE_REPO_TOKEN']),
+  (SimpleCov::Formatter::Codecov if ENV['CODECOV_TOKEN']),
+  SimpleCov::Formatter::HTMLFormatter,
+].compact)
+SimpleCov.start do
+  add_filter "spec"
+  add_group "Adapters", "lib/remotenv/adapters/"
+end

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.4.1
+
+before_install: gem install bundler -v 1.14.6

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015-2017 Marc Qualie
+
+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,71 @@
+# Remotenv
+
+[![Gem Version](https://badge.fury.io/rb/remotenv.svg)](https://badge.fury.io/rb/remotenv)
+[![Circle CI](https://circleci.com/gh/signisto/remotenv-ruby/tree/master.svg?style=shield)](https://circleci.com/gh/signisto/remotenv-ruby/tree/master)
+[![Test Coverage](https://codeclimate.com/github/signisto/remotenv-ruby/badges/coverage.svg)](https://codeclimate.com/github/signisto/remotenv-ruby/coverage)
+[![Code Climate](https://codeclimate.com/github/signisto/remotenv-ruby/badges/gpa.svg)](https://codeclimate.com/github/signisto/remotenv-ruby)
+[![Issue Count](https://codeclimate.com/github/signisto/remotenv-ruby/badges/issue_count.svg)](https://codeclimate.com/github/signisto/remotenv-ruby)
+
+Securely store environment variables away from your application
+
+**WIP:** This gem is currently under active development. Until **1.0** version backwards-incompatible changes may be introduced with each **0.x** minor version.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+``` ruby
+gem 'remotenv'
+```
+
+And then execute:
+
+    $ bundle install
+
+
+## Usage
+
+When Remotenv is loaded it automatically uses Dotenv in the background to preload and other configuration mechanisms you may have to make transitioning seamless.
+
+
+### Rails
+
+Remotenv automatically pre-loads itself during `before_configuration` phase so no configuration is required.
+
+### Sinatra
+
+Use the plain ruby method as early as possible, before any `ENV` variables are accessed. Usually at the top of `app.rb`.
+
+
+### Plain ruby
+
+Run the following code before you need access to the environment variables
+
+``` ruby
+Remotenv.load
+```
+
+
+## Todo
+
+Below are the main features that will ideally be implemented before v1.0.
+Contributions welcome.
+
+- Local caching to protect against network errors
+- Ordered override behaviour for more fine grained control
+- Require/Desire to aid developer knowledge of configurations
+- Add `Remotenv.configure {}` functionality
+- Encrypted variables
+
+
+## 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/signisto/remotenv-ruby.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+load "#{__dir__}/lib/tasks/remotenv.rake"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

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/circle.yml

@@ -0,0 +1,9 @@
+machine:
+  ruby:
+    version: 2.4.1
+
+dependencies:
+  cache_directories:
+    - vendor/bundle
+  pre:
+    - gem install bundler:1.14.6

data/codecov.yml

@@ -0,0 +1,13 @@
+codecov:
+  notify:
+    require_ci_to_pass: true
+
+comment: off
+
+coverage:
+  precision: 2
+  range: "80...100"
+  round: down
+  status:
+    patch: auto
+    project: auto

data/lib/remotenv/adapters/base.rb

@@ -0,0 +1,54 @@
+require 'remotenv/adapters'
+
+module Remotenv
+  module Adapters
+    class Base
+      attr_reader :uri
+      attr_reader :data
+      attr_reader :options
+
+      def initialize(uri, options = {})
+        @uri = uri
+        @options = options
+        @data = {}
+        @content = nil
+      end
+
+      def load!
+        Remotenv.logger.debug("Adapter: #{self.class.name}")
+        before_load
+        load
+        after_load
+        apply_environment
+        set_refresh_timestamp
+      end
+
+      def before_load
+      end
+
+      def load
+        raise "Remotenv::Adapter::Base should not be used directly"
+      end
+
+      def after_load
+      end
+
+      def set_refresh_timestamp
+        ENV['REMOTENV_REFRESHED_AT'] = Time.now.to_s
+      end
+
+      def apply_environment
+        Remotenv.logger.debug("Applying environment variables")
+        @data = Dotenv::Parser.call(@content)
+        Remotenv.logger.debug("ENV: #{@data.keys.join(', ')}")
+        @data.each do |key, value|
+          ENV[key] ||= value
+        end
+      end
+
+      def get(key)
+        @data[key]
+      end
+    end
+  end
+end

data/lib/remotenv/adapters/http.rb

@@ -0,0 +1,31 @@
+require 'dotenv'
+require 'remotenv/adapters'
+require 'remotenv/adapters/base'
+require 'net/http'
+
+module Remotenv
+  module Adapters
+    class Http < Base
+      def load
+        Remotenv.logger.debug("Downloading HTTP File: #{remote_uri.to_s}")
+        download_file
+      end
+
+      private
+
+      def remote_uri
+        @uri
+      end
+
+      def download_file
+        @content = http_get_content
+        Remotenv.logger.error("Error Downloading HTTP File: #{remote_uri.to_s}") unless @content
+      end
+
+      def http_get_content
+        response = Net::HTTP.get_response(remote_uri) rescue nil
+        response.body if response.is_a?(Net::HTTPSuccess)
+      end
+    end
+  end
+end

data/lib/remotenv/adapters/s3.rb

@@ -0,0 +1,55 @@
+require 'cgi'
+require 'dotenv'
+require 'remotenv/adapters'
+require 'fileutils'
+require 'net/http'
+require 'openssl'
+require 'base64'
+
+module Remotenv
+  module Adapters
+    class S3 < Http
+
+      private
+
+      def config
+        @_config ||= begin
+          uri = Remotenv.uri
+          return {} unless uri && uri.host && uri.path
+          {
+            'filename' => uri.path[1..-1],
+            'bucket_name' => uri.host,
+            'access_key_id' => uri.user,
+            'secret_access_key' => uri.password ? ::URI.unescape(uri.password) : nil,
+          }.compact
+        end
+      end
+
+      def remote_uri
+         if config['access_key_id'] && config['secret_access_key']
+           URI(signed_s3_url)
+         else
+           URI(direct_s3_url)
+         end
+      end
+
+      def direct_s3_url
+        "https://#{config['bucket_name']}.s3.amazonaws.com/#{config['filename']}"
+      end
+
+      def signed_s3_url
+        s3_resource = "/#{config['bucket_name']}/#{config['filename']}"
+        s3_expires_at = Time.now + 300
+        signature_payload = "GET\n\n\n#{s3_expires_at.to_i}\n#{s3_resource}"
+        digest = OpenSSL::Digest.new('sha1')
+        hmac = OpenSSL::HMAC.digest(digest, config['secret_access_key'], signature_payload)
+        query_params = [
+          "AWSAccessKeyId=#{config['access_key_id']}",
+          "Expires=#{s3_expires_at.to_i}",
+          "Signature=#{CGI.escape Base64.encode64(hmac).strip}"
+        ]
+        "#{direct_s3_url}?#{query_params.join('&')}"
+      end
+    end
+  end
+end

data/lib/remotenv/adapters.rb

@@ -0,0 +1,15 @@
+module Remotenv
+  module Adapters
+    module_function
+
+    def for(uri)
+      if uri.scheme == 'http' || uri.scheme == 'https'
+        Remotenv::Adapters::Http.new(uri)
+      elsif uri.scheme == 's3'
+        Remotenv::Adapters::S3.new(uri)
+      else
+        raise "Could not find adapter for scheme - #{uri.scheme}"
+      end
+    end
+  end
+end

data/lib/remotenv/logger.rb

@@ -0,0 +1,23 @@
+require "logger"
+
+module Remotenv
+
+  module_function
+
+  def logger
+    @_logger ||= Remotenv::Logger.new(STDOUT)
+  end
+
+  def logger=(logger)
+    @_logger = logger
+  end
+
+  class Logger < ::Logger
+    def initialize(*args)
+      super
+      @progname = "remotenv"
+      log_level = (ENV["REMOTENV_LOG_LEVEL"] || ENV["LOG_LEVEL"] || "").upcase
+      @level = ["DEBUG", "INFO", "WARN", "ERROR", "FATAL", "UNKNOWN"].index(log_level) != nil ? Logger.const_get(log_level) : Logger::INFO
+    end
+  end
+end

data/lib/remotenv/rails.rb

@@ -0,0 +1,27 @@
+require "remotenv"
+
+module Remotenv
+  # Remotenv Railtie for using Remotenv to load environment before application is loaded
+  class Railtie < Rails::Railtie
+    config.before_configuration { load }
+
+    # Public: Load Remotenv
+    #
+    # This will get called during the `before_configuration` callback, but you
+    # can manually call `Remotenv::Railtie.load` if you needed it sooner.
+    def load
+      Remotenv.load
+    end
+
+    # Rails uses `#method_missing` to delegate all class methods to the
+    # instance, which means `Kernel#load` gets called here. We don't want that.
+    def self.load
+      instance.load
+    end
+
+    # Rake tasks
+    rake_tasks do
+      Rails::Railtie.instance_method(:load).bind(self).call("tasks/remotenv.rake")
+    end
+  end
+end

data/lib/remotenv/utils.rb

@@ -0,0 +1,27 @@
+require "uri"
+
+module Remotenv
+  module Utils
+
+    module_function
+
+    def parsed_url
+      return nil if ENV['REMOTENV_URL'] == nil || ENV['REMOTENV_URL'] == ""
+      ENV['REMOTENV_URL']
+    end
+
+    def parsed_uri
+      return nil unless parsed_url
+      parser = ::URI::RFC2396_Parser.new
+      uri = parser.parse(parsed_url)
+      uri
+    rescue Exception => error
+      Remotenv.logger.error("URI Parse Error: URL = #{parsed_url || '[not set]'}")
+      Remotenv.logger.error("  #{error.message}")
+      (0..2).each do |index|
+        Remotenv.logger.error("  #{error.backtrace[index]}")
+      end
+      nil
+    end
+  end
+end

data/lib/remotenv/version.rb

@@ -0,0 +1,3 @@
+module Remotenv
+  VERSION = "0.4.0"
+end

data/lib/remotenv.rb

@@ -0,0 +1,39 @@
+require "logger"
+
+require "remotenv/version"
+require "remotenv/adapters/base"
+require "remotenv/adapters/http"
+require "remotenv/adapters/s3"
+require "remotenv/logger"
+require "remotenv/utils"
+
+Dotenv.load("#{Dir.pwd}/.env") if defined?(Dotenv) && ENV['RAILS_ENV'] != "test"
+
+require "remotenv/rails" if defined?(Rails)
+
+module Remotenv
+  module_function
+
+  def url
+    @_url ||= Remotenv::Utils.parsed_url
+  end
+
+  def uri
+    @_uri ||= Remotenv::Utils.parsed_uri
+  end
+
+  def load(options = {})
+    adapter = Remotenv::Adapters.for(self.uri)
+    adapter.load!
+    @data = data.merge(adapter.data)
+  end
+
+  def data
+    @data || {}
+  end
+
+  def get(key)
+    return nil unless @data
+    @data[key]
+  end
+end

data/lib/tasks/remotenv.rake

@@ -0,0 +1,23 @@
+require 'remotenv'
+require 'yaml'
+
+namespace :remotenv do
+
+  desc "Load Remotenv variables"
+  task :load do
+    Remotenv.load
+  end
+
+  desc "Show Remotenv Info"
+  task :info => :load do
+    puts "URL: #{Remotenv.uri || '[not set]'}"
+    puts "URI: #{Remotenv.url.to_yaml}"
+  end
+
+  desc "List all keys"
+  task :list => :load do
+    Remotenv.data.each do |key, value|
+      puts "\e[33m#{key}\e[0m \e[90m=\e[0m #{value}"
+    end
+  end
+end

data/remotenv.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'remotenv/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "remotenv"
+  spec.version       = Remotenv::VERSION
+  spec.authors       = ["Marc Qualie"]
+  spec.email         = ["marc@marcqualie.com"]
+  spec.licenses      = ['MIT']
+
+  spec.summary       = "Securely store environment variables away from your application"
+  spec.homepage      = "https://github.com/signisto/remotenv"
+
+  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 "dotenv", "~> 2.2"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "codecov", "~> 0.1.10"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 1.0"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.6"
+  spec.add_development_dependency "rack", "~> 2.0"
+end

data/script/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "remotenv"
+
+# 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

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: remotenv
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Marc Qualie
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.10
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 
+email:
+- marc@marcqualie.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".simplecov"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/setup
+- circle.yml
+- codecov.yml
+- lib/remotenv.rb
+- lib/remotenv/adapters.rb
+- lib/remotenv/adapters/base.rb
+- lib/remotenv/adapters/http.rb
+- lib/remotenv/adapters/s3.rb
+- lib/remotenv/logger.rb
+- lib/remotenv/rails.rb
+- lib/remotenv/utils.rb
+- lib/remotenv/version.rb
+- lib/tasks/remotenv.rake
+- remotenv.gemspec
+- script/console
+homepage: https://github.com/signisto/remotenv
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Securely store environment variables away from your application
+test_files: []