s3_config 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 734b33901f2445ab19eb93ff9b4f0a2d239e7943
+  data.tar.gz: 02ba0c8af0aa15bc60e6ae6762cea54a20f1c27b
+SHA512:
+  metadata.gz: 2d89be2db1e4c40ad3fedebcf733023d17d62c232f6a6477fc6b269bb96beadeeb9151574d55dc4a096349489efe49f11234c2bef93f8e1aece09c74c08b7152
+  data.tar.gz: dc2fabcaa2ed139e7f249856e1862bd9619241f46c33d14b0d467824ed862a0fecd250cb18573935810889d62313d0fb1cdc4030b7149c8c5addf1eeb27bba35

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.rbenv-vars

data/.rbenv-vars.example

@@ -0,0 +1,3 @@
+AWS_ACCESS_KEY_ID=FILL_ME_IN
+AWS_ACCESS_KEY_SECRET=FILL_ME_IN
+S3_CONFIG_BUCKET=FILL_ME_IN

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+rails2017_s3_config

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Zane Shannon
+
+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,66 @@
+# S3Config
+
+S3Config adopts Heroku-style config management for any Rails application using AWS S3 to store, and Rack middleware to inject environment variables.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 's3_config'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install s3_config
+
+## Setup
+
+`AWS_ACCESS_KEY_ID`, `AWS_ACCESS_KEY_SECRET`, and `S3_CONFIG_BUCKET` must be defined in your ENV.
+
+## Usage
+
+### In Rails
+
+S3Config adds a railtie callback `before_configuration` that pulls stored configuration variables from S3 just before the Rails application is configured (eg. `config/application.rb` executes).
+
+We're using the same commands as the Heroku CLI. More here: [Heroku Config Vars](https://devcenter.heroku.com/articles/config-vars).
+
+### List Environments
+
+`config environments`
+
+### List Environment Variables (aka `heroku config`)
+
+`config list ENVIRONMENT`
+
+### Write Environment Variable (aka `heroku config:set`)
+
+`config set ENVIRONMENT FOO=BAR`
+
+### Read Environment Variable (aka `heroku config:get`)
+
+`config get ENVIRONMENT FOO`
+
+### Delete Environment Variable (aka `heroku config:unset`)
+
+`config unset ENVIRONMENT FOO`
+
+## 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/rails2017/s3_config. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://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 "s3_config"
+
+# 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/exe/config

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "s3_config"
+require "s3_config/cli"
+
+S3Config::CLI.start

data/lib/s3_config/application.rb

@@ -0,0 +1,144 @@
+require "aws-sdk"
+require "erb"
+require "yaml"
+
+module S3Config
+  class Application
+
+    include Enumerable
+
+    def initialize(options = {})
+      @options = options.inject({}) { |m, (k, v)| m[k.to_sym] = v; m }
+    end
+
+    def environments
+      bucket.objects.map(&:key).map{|key| key.split('/').first }.uniq
+    end
+
+    def environment
+      environment = @options.fetch(:environment) { default_environment }
+      environment.nil? ? nil : environment.to_s
+    end
+
+    def environment=(environment)
+      @options[:environment] = environment
+    end
+
+    def version
+      version = @options.fetch(:version) { default_version }
+      version
+    end
+
+    def version=(version)
+      @options[:version] = version
+    end
+
+    def configuration
+      @configuration ||= read_configuration
+    end
+
+    def load
+      each do |key, value|
+        skip?(key) ? key_skipped!(key) : graduate_to_env(key, value)
+      end
+    end
+
+    def each(&block)
+      configuration.each(&block)
+    end
+
+    def valid?
+      !client.nil? and !bucket.nil?
+    end
+
+    def latest_version
+      [(bucket.objects({prefix: "#{environment}/"}).count - 1), 0].max
+    end
+
+    def read(key)
+      config = read_configuration
+      config[key]
+    end
+
+    def write(key, value)
+      config = read_configuration
+      unless config[key] == value
+        config[key] = value
+        write_configuration config
+      end
+    end
+
+    def delete(key)
+      config = read_configuration
+      unless config[key].nil?
+        config.delete key
+        write_configuration config
+      end
+    end
+
+    private
+
+    def client
+      @s3 ||= Aws::S3::Client.new(access_key_id: ::ENV.fetch("AWS_ACCESS_KEY_ID"), secret_access_key: ::ENV.fetch("AWS_ACCESS_KEY_SECRET"), region: ::ENV.fetch("AWS_REGION", "us-east-1"))
+    end
+
+    def bucket
+      @bucket ||= Aws::S3::Bucket.new(::ENV.fetch("S3_CONFIG_BUCKET"), client: client)
+    end
+
+    def default_environment
+      nil
+    end
+
+    def default_version
+      @default_version ||= ::ENV.fetch("S3_CONFIG_REVISION"){ latest_version }
+    end
+
+    def read_configuration
+      if e = environment and v = version
+        begin
+          serialized_config = bucket.object("#{e}/#{v}.yml").get.body
+          config = YAML.load serialized_config
+          return config
+        rescue Aws::S3::Errors::NoSuchKey
+          raise ConfigNotDefinedError.new(e, v)
+        end
+      else
+        throw NotImplementedError
+      end
+      {}
+    end
+
+    def write_configuration(config)
+      if e = environment and next_version = (latest_version + 1)
+        serialized_config = YAML.dump(config)
+        bucket.put_object({
+          body: serialized_config,
+          key: "#{e}/#{next_version}.yml",
+          server_side_encryption: "AES256"
+        })
+      else
+        throw NotImplementedError
+      end
+    end
+
+    def graduate_to_env(key, value)
+      non_string_configuration!(key) unless key.is_a?(String)
+      non_string_configuration!(value) unless value.is_a?(String) || value.nil?
+
+      ::ENV[key.to_s] = value.nil? ? nil : value.to_s
+    end
+
+    def skip?(key)
+      ::ENV.key?(key.to_s)
+    end
+
+    def non_string_configuration!(value)
+      warn "WARNING: Use strings for S3Config configuration. #{value.inspect} was converted to #{value.to_s.inspect}."
+    end
+
+    def key_skipped!(key)
+      warn "WARNING: Skipping key #{key.inspect}. Already set in ENV."
+    end
+  end
+end

data/lib/s3_config/cli.rb

@@ -0,0 +1,88 @@
+require "aws-sdk"
+require "thor"
+require "yaml"
+
+module S3Config
+  class CLI < Thor
+
+    no_commands {
+      def validate_installed!
+        unless S3Config.adapter.new.valid?
+          error "Not installed!"
+          error "`AWS_ACCESS_KEY_ID`, `AWS_ACCESS_KEY_SECRET`, and `S3_CONFIG_BUCKET` must be defined in your ENV."
+          false
+        else
+          true
+        end
+      end
+    }
+
+    desc "list", "List S3Config variables for environment. eg: config list production"
+    def list(environment=nil)
+      return unless validate_installed!
+      return error "Environment required. eg: config list production" if environment.nil?
+      @application = S3Config.adapter.new environment: environment
+      version = @application.latest_version
+      say "#{environment} (v#{version})"
+      say "====="
+      @application.each do |k,v|
+        say "#{k}=#{v}"
+      end
+    end
+
+    desc "set", "Set S3Config variable for environment. eg: config set production KEY=value"
+    def set(environment=nil, key_value="")
+      return unless validate_installed!
+      return error "Environment required. eg: config set production KEY=value" if environment.nil?
+      key, value = key_value.split '='
+      return error "Key required. eg: config set production KEY=value" if key.nil?
+      key.upcase!
+      if value.nil?
+        error "Value required. eg: config set production KEY=value"
+        say "Use `config unset` to delete a key"
+        return
+      end
+      @application = S3Config.adapter.new environment: environment
+      @application.write key, value
+      say "Set #{key}=#{value} (#{environment})"
+      say "====="
+      say "Use version: v#{@application.latest_version}"
+    end
+
+    desc "get", "Get S3Config variable for environment. eg: config get production KEY"
+    def get(environment=nil, key=nil)
+      return unless validate_installed!
+      return error "Environment required. eg: config get production KEY" if environment.nil?
+      return error "Key required. eg: config get production KEY" if key.nil?
+      key = key.upcase
+      @application = S3Config.adapter.new environment: environment
+      value = @application.read key
+      say "#{key} (#{environment})"
+      say "====="
+      say value
+    end
+
+    desc "unset", "Remove S3Config variable for environment. eg: config unset production KEY"
+    def unset(environment=nil, key=nil)
+      return unless validate_installed!
+      return error "Environment required. eg: config unset production KEY" if environment.nil?
+      return error "Key required. eg: config unset production KEY" if key.nil?
+      key = key.upcase
+      @application = S3Config.adapter.new environment: environment
+      @application.delete key
+      say "Removed #{key} (#{environment})"
+      say "====="
+      say "Use version: v#{@application.latest_version}"
+    end
+
+    desc "environments", "List S3Config environments. eg: config environments"
+    def environments
+      return unless validate_installed!
+      @application = S3Config.adapter.new
+      say "Configured Environments"
+      say "====="
+      @application.environments.each{ |e| puts "- #{e}" }
+    end
+
+  end
+end

data/lib/s3_config/env.rb

@@ -0,0 +1,45 @@
+module S3Config
+  module ENV
+    extend self
+
+    def respond_to?(method, *)
+      key, punctuation = extract_key_from_method(method)
+
+      case punctuation
+      when "!" then has_key?(key) || super
+      when "?", nil then true
+      else super
+      end
+    end
+
+    private
+
+    def method_missing(method, *)
+      key, punctuation = extract_key_from_method(method)
+
+      case punctuation
+      when "!" then send(key) || missing_key!(key)
+      when "?" then !!send(key)
+      when nil then get_value(key)
+      else super
+      end
+    end
+
+    def extract_key_from_method(method)
+      method.to_s.downcase.match(/^(.+?)([!?=])?$/).captures
+    end
+
+    def has_key?(key)
+      ::ENV.any? { |k, _| k.downcase == key }
+    end
+
+    def missing_key!(key)
+      raise MissingKey.new(key)
+    end
+
+    def get_value(key)
+      _, value = ::ENV.detect { |k, _| k.downcase == key }
+      value
+    end
+  end
+end

data/lib/s3_config/error.rb

@@ -0,0 +1,23 @@
+module S3Config
+  class Error < StandardError; end
+
+  class RailsNotInitialized < Error; end
+
+  class MissingKey < Error
+    def initialize(key)
+      super("Missing required configuration key: #{key.inspect}")
+    end
+  end
+
+  class MissingKeys < Error
+    def initialize(keys)
+      super("Missing required configuration keys: #{keys.inspect}")
+    end
+  end
+
+  class ConfigNotDefinedError < Error
+    def initialize(environment, version)
+      super("No version '#{version}' defined for environment '#{environment}'!")
+    end
+  end
+end

data/lib/s3_config/rails/application.rb

@@ -0,0 +1,15 @@
+module S3Config
+  module Rails
+    class Application < S3Config::Application
+      private
+
+      def default_environment
+        ::Rails.env
+      end
+
+      def rails_not_initialized!
+        raise RailsNotInitialized
+      end
+    end
+  end
+end

data/lib/s3_config/rails/railtie.rb

@@ -0,0 +1,17 @@
+module S3Config
+  module Rails
+    class Railtie < ::Rails::Railtie
+      config.before_configuration do
+        begin
+          S3Config.load
+        rescue S3Config::ConfigNotDefinedError => e
+          if ::Rails.env.development?
+            warn "S3Config not defined. Ignoring for development environment."
+          else
+            raise e
+          end
+        end
+      end
+    end
+  end
+end

data/lib/s3_config/rails.rb

@@ -0,0 +1,9 @@
+begin
+  require "rails"
+rescue LoadError
+else
+  require "s3_config/rails/application"
+  require "s3_config/rails/railtie"
+
+  S3Config.adapter = S3Config::Rails::Application
+end

data/lib/s3_config/version.rb

@@ -0,0 +1,3 @@
+module S3Config
+  VERSION = "0.1.0"
+end

data/lib/s3_config.rb

@@ -0,0 +1,33 @@
+require "s3_config/version"
+require "s3_config/error"
+require "s3_config/env"
+require "s3_config/application"
+
+module S3Config
+  extend self
+
+  attr_writer :adapter, :application
+
+  def env
+    S3Config::ENV
+  end
+
+  def adapter
+    @adapter ||= S3Config::Application
+  end
+
+  def application
+    @application ||= adapter.new
+  end
+
+  def load
+    application.load
+  end
+
+  def require_keys(*keys)
+    missing_keys = keys.flatten - ::ENV.keys
+    raise MissingKeys.new(missing_keys) if missing_keys.any?
+  end
+end
+
+require "s3_config/rails"

data/s3_config.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 's3_config/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "s3_config"
+  spec.version       = S3Config::VERSION
+  spec.authors       = ["Zane Shannon"]
+  spec.email         = ["zcs@smileslaughs.com"]
+
+  spec.summary       = %q{S3Config uses AWS S3 to configure a Rails application.}
+  spec.description   = %q{S3Config adopts Heroku-style config management for any Rails application using AWS S3 to store, and Rack middleware to inject environment variables.}
+  spec.homepage      = "https://github.com/rails2017/s3_config"
+  spec.license       = "MIT"
+
+  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 "aws-sdk", "~> 2"
+  spec.add_dependency "thor", "~> 0.14"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+
+  spec.executables << "config"
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: s3_config
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Zane Shannon
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        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: S3Config adopts Heroku-style config management for any Rails application
+  using AWS S3 to store, and Rack middleware to inject environment variables.
+email:
+- zcs@smileslaughs.com
+executables:
+- config
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rbenv-vars.example"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/config
+- lib/s3_config.rb
+- lib/s3_config/application.rb
+- lib/s3_config/cli.rb
+- lib/s3_config/env.rb
+- lib/s3_config/error.rb
+- lib/s3_config/rails.rb
+- lib/s3_config/rails/application.rb
+- lib/s3_config/rails/railtie.rb
+- lib/s3_config/version.rb
+- s3_config.gemspec
+homepage: https://github.com/rails2017/s3_config
+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: S3Config uses AWS S3 to configure a Rails application.
+test_files: []