renv 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e26c29836717d549fdf77aeb14b7532b0dc36f8c
+  data.tar.gz: 0e2ec7d01003e5582aec6d90d2c1cce9ff508e19
+SHA512:
+  metadata.gz: 7b68c0ecca614b4c6e088a78e17d9f3e3343ad00d7b52711cfa83143b97c15eb53161cb2dc6ab16d2fb67215d77f55daf42fe5844acfc5b90079ef134bdf6c7e
+  data.tar.gz: 9aa845d58d33b6700b4b1180e9d1e8e1b139a31a7b308d4afc1e186d1e989eb3bb6b0cf3c7514b2ea596c9edbb6c20be7160f3e34e58f324fd70b6eb163f4f92

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 HouseTrip
+
+MIT License
+
+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,88 @@
+# Renv
+
+The name stands for "Remote ENVironment" (thanks, captain obvious).
+
+`renv` manages your `.env` (envrionment variables) files so they are never stored on your local machine.
+
+It can be used to provide a replacement to Heroku's superb `config:get` /
+`config:set` in Capistrano-land.
+
+
+## Installation
+
+You know the dance:
+
+    $ gem install renv
+
+You may need in your application's Gemfile, of course.
+
+## Configuration
+
+You will need to set at least two variables in your environment:
+
+    RENV_AWS_KEY_myapp=...
+    RENV_AWS_SECRET_myapp=...
+
+Plus a few optional ones (can be overriden on the command-line):
+
+    RENV_APP=myapp
+    RENV_BUCKET_myapp=...
+
+## Usage
+
+    Commands:
+      renv del KEY...        # deletes KEY and its value
+      renv dump              # dumps all key-value pairs in .env format
+      renv get KEY           # returns the value of KEY
+      renv help [COMMAND]    # Describe available commands or one specific command
+      renv load              # set keys from standard input in .env format
+      renv set KEY=VALUE...  # sets the value of KEY to VALUE
+
+    Options:
+      -a, [--app=APP]        # Application name, defaults to RENV_APP
+      -b, [--bucket=BUCKET]  # S3 bucket storing environment(s), defaults to RENV_BUCKET_<app>
+      -n, [--name=NAME]      # Environment name, e.g. for staging apps, defaults to app name
+
+## How it works
+
+Simply enough:
+
+- `get` and `dump` will read a `.env`-formatted file from S3 (and parse it, in
+  the case of `get`)
+- `set`, `load`, and `del` will write them back.
+
+Every time a write to S3 occurs, two files get written: one named `latest` (all
+read operations look at this file), and one named with the current ISO timestamp
+(for backup purposes... in case you delete a needed key!)
+
+**Caveat:** No effort is made to be safeguard against multiple users writing at
+the same time.
+
+
+## Hooking to Capistrano
+
+Here's an example, assuming you use the multistage extensions:
+
+```ruby
+after 'deploy:finalize_update' do
+  environment = %x(bundle exec renv dump -a my_app -b my_bucket -n #{stage})
+  unless $?.success?
+    warn "Failed to obtain environment variables"
+    exit 1
+  end
+  put environment, "#{release_path}/.env"
+end
+```
+
+The environment variables will briefly live in Capistrano's memory, but will not
+be saved to your disk.
+
+## Contributing
+
+Yes, please!
+
+1. Fork it ( https://github.com/HouseTrip/renv/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/renv

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'renv'
+require 'renv/cli'
+
+Renv::CLI.start(ARGV)

data/lib/renv.rb

@@ -0,0 +1,3 @@
+require "renv/version"
+
+module Renv ; end

data/lib/renv/cli.rb

@@ -0,0 +1,59 @@
+require 'renv'
+require 'thor'
+require 'renv/engine'
+
+module Renv
+  class CLI < Thor
+    class_option :app,     aliases: '-a', desc: 'Application name, defaults to RENV_APP'
+    class_option :bucket,  aliases: '-b', desc: 'S3 bucket storing environment(s), defaults to RENV_BUCKET_<app>'
+    class_option :name,    aliases: '-n', desc: 'Environment name, e.g. for staging apps, defaults to app name'
+
+    desc 'get KEY', 'returns the value of KEY'
+    def get(key)
+      puts _engine.get(key)
+    end
+
+    desc 'set KEY=VALUE...', 'sets the value of KEY to VALUE'
+    def set(*pairs)
+      hash = _parse_pairs(pairs)
+      _engine.set(hash)
+    end
+
+    desc 'del KEY...', 'deletes KEY and its value'
+    def del(*keys)
+      _engine.del(keys)
+    end
+
+    desc 'dump', 'dumps all key-value pairs in .env format'
+    def dump
+      puts _engine.dump
+    end
+
+    desc 'load', 'set keys from standard input in .env format'
+    def load
+      _engine.load(STDIN.read)
+    end
+
+    private
+
+    def _engine
+      Engine.new(
+        app:    options[:app],
+        name:   options[:name],
+        bucket: options[:bucket])
+    end
+
+    def _parse_pairs(pairs)
+      Hash.new.tap do |h|
+        pairs.each do |p|
+          if p !~ /^([^=]+)=(.*)$/
+            $stderr.puts "Not a valid key-value: '#{p}'"
+            exit 1
+          end
+          h[$1] = $2
+        end
+      end
+    end
+  end
+end
+

data/lib/renv/data.rb

@@ -0,0 +1,46 @@
+require 'renv'
+require 'delegate'
+
+module Renv
+  class Data
+    extend Forwardable
+
+    def initialize(payload)
+      @data = _parse(payload)
+    end
+
+    delegate [:[], :delete] => :@data
+
+    def []=(key, value)
+      _assert(key =~ /^[A-Z0-9_]+$/, 'Key must be uppercase letters, digits, and underscores')
+      @data[key] = value
+    end
+
+    def dump
+      result = []
+      @data.map { |k,v| "#{k}=#{v}\n" }.join
+    end
+
+    def load(payload)
+      @data = _parse(payload).merge(@data)
+    end
+
+    private
+
+    def _assert(condition, message)
+      return if condition
+      $stderr.puts message
+      exit 1
+    end
+
+    def _parse(payload)
+      Hash.new.tap do |result|
+        payload.strip.split(/[\n\r]+/).each do |line|
+          next if line.strip.empty? || line =~ /^#/
+          _assert(line.strip =~ /^([^=]+)=(.*)$/, "Cannot parse '#{line}'")
+          result[$1] = $2
+        end
+      end
+    end
+  end
+end

data/lib/renv/engine.rb

@@ -0,0 +1,93 @@
+require 'renv'
+require 'fog'
+require 'renv/data'
+
+module Renv
+  class Engine
+    def initialize(app: nil, name: nil, bucket: nil)
+      @_app    = app
+      @_name   = name
+      @_bucket = bucket
+    end
+
+    def get(key)
+      _data[key]
+    end
+
+    def set(hash)
+      hash.each_pair do |key, value|
+        _data[key] = value
+      end
+      _save
+    end
+
+    def del(keys)
+      keys.each { |key| _data.delete(key) }
+      _save
+    end
+
+    def dump
+      _data.dump
+    end
+
+    def load(payload)
+      _data.load(payload)
+      _save
+    end
+
+    private
+
+    def _data
+      @_data ||= begin
+        s3file = _directory.files.get(_path_current)
+        payload = s3file ? s3file.body : ''
+        Data.new(payload)
+      end
+    end
+
+    def _save
+      [_path_new, _path_current].each do |path|
+        _directory.files.create(key: path, body: _data.dump, public: false)
+      end
+    end
+
+    def _path_current
+      @_path_current ||= "#{_name}/current"
+    end
+
+    def _path_new
+      @_path_new ||= "#{_name}/#{Time.now.strftime('%FT%T')}"
+    end
+
+    def _directory
+      @_directory ||= _connection.directories.get(_bucket).tap do |dir|
+        if dir.nil?
+          $stderr.puts "Bucket '#{_bucket}' does not seem to exist"
+          exit 1
+        end
+      end
+    end
+    
+    def _connection
+      @_connection ||= Fog::Storage.new(
+        provider:              'AWS',
+        aws_access_key_id:     ENV.fetch("RENV_AWS_KEY_#{_app}"),
+        aws_secret_access_key: ENV.fetch("RENV_AWS_SECRET_#{_app}"),
+        region:                ENV.fetch("RENV_AWS_REGION_#{_app}", 'eu-west-1')
+      )
+    end
+
+    def _bucket
+      @_bucket ||= ENV.fetch("RENV_BUCKET_#{_app}")
+    end
+
+    def _name
+      @_name ||= _app
+    end
+
+    def _app
+      @_app ||= ENV.fetch('RENV_APP')
+    end
+    
+  end
+end

data/lib/renv/version.rb

@@ -0,0 +1,3 @@
+module Renv
+  VERSION = "0.0.1"
+end

data/renv.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'renv/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'renv'
+  spec.version       = Renv::VERSION
+  spec.authors       = ['Julien Letessier']
+  spec.email         = ['julien.letessier@gmail.com']
+  spec.summary       = %q{Manages out-of-repository .env file}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'pry'
+
+  spec.add_runtime_dependency 'fog'
+  spec.add_runtime_dependency 'thor'
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: renv
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Julien Letessier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: pry
+  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: fog
+  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: thor
+  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'
+description: 
+email:
+- julien.letessier@gmail.com
+executables:
+- renv
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/renv
+- lib/renv.rb
+- lib/renv/cli.rb
+- lib/renv/data.rb
+- lib/renv/engine.rb
+- lib/renv/version.rb
+- renv.gemspec
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Manages out-of-repository .env file
+test_files: []