shield-vault 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5af3a26280b97eec4b33e45757c8cc64de631eba
+  data.tar.gz: f55630399e46aad9699c81136cbbbdec74e01ce4
+SHA512:
+  metadata.gz: be43e8b4670a77a8ec5bde116f29e4dbc8e700fe91b4d3db1f58ae5ea498c4878a42c258543174ebf72d4529cc7fa52ba0365b52ebeaf415978a8780851a1a8b
+  data.tar.gz: 361106453add57f88ecabf20b113099bd55a9ebc03e4ac2d20510239654f4076f5ad0e7c084927642864ac06b9d02efd6bbd332dab636ce0c14bfd9476144fda

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Adam Scott
+
+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,69 @@
+# Shield-Vault
+
+Shield-Vault is a tool for managing your application's environment variables in a [Vault](https://vaultproject.io/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'shield-vault'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shield
+
+## Setup
+This gem assumes that you've already setup [Vault](https://vaultproject.io/).  You can use this gem on local vaults or ones that have been deployed to a server.  If you are working with a local server you'll just need to start vault and then proceed to the steps below. If you are working on a deployed vault you'll need to create an auth token for your vault and unseal it before you can interact with it using this gem.  That setup is out of the scope of this gem but is covered in the official Vault [documentation](https://vaultproject.io/docs/index.html).
+
+1. `export VAULT_ADDR=YOUR_VAULT_SERVER_ADDRESS`
+2. `export VAULT_TOKEN=YOUR_VAULT_AUTH_TOKEN`
+
+## Usage
+Shield-Vault will store environment variables as a hash of values based on your environment and the name of your app.  By default the environment is "development" but can be overriden with the `--environment` flag.  The name of your app is taken from your current working directory or by specifying it with the `--app` flag.
+
+#### Add an environment variable
+`shield-vault add <key> <value>`
+
+#### Update an environment variable
+`shield-vault update <key> <value>`
+
+#### Remove an environment variable
+`shield-vault remove <key> <value>`
+
+#### Fetch all environment variables and update your .env file
+`shield-vault fetch`
+
+#### Environment Flag
+By default, all commands use the "development" environment.  You can specify another environment with the `--environment` flag.
+
+`shield-vault fetch --environment=production` will fetch your production environment variables and update your `.env.production` file.
+
+#### App flag
+By default, all commands use your current working directory as the app name.  If for some reason you need to override this, you can do so with the `--app` flag.
+
+`shield-vault fetch --app=seabiscuit` will fetch the environment variables namespaced under the seabiscuit app.
+
+#### .env files
+Shield-Vault assumes you are using a tool like [dotenv](https://github.com/bkeepers/dotenv) or [Ember-cli-dotenv](https://github.com/fivetanley/ember-cli-dotenv) to load environment variables in your app as the `fetch` command will create/update the appropriate .env file.  For example, if pass the `--environment=production` flag, it'll update the `.env.production` file.
+
+## 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/checkmateio/shield-vault.
+
+
+## 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 "shield-vault"
+
+# 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/shield-vault.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require 'shield-vault'
+require 'vault'
+
+# Vault config
+Vault.configure do |config|
+  # The address of the Vault server, also read as ENV["VAULT_ADDR"]
+  config.address = ENV['VAULT_ADDR'] || 'https://127.0.0.1:8200'
+
+  # The token to authenticate with Vault, also read as ENV["VAULT_TOKEN"]
+  config.token = ENV['VAULT_TOKEN'] || "abcd-1234"
+end
+
+ShieldVault::Commander.start(ARGV)

data/lib/shield-vault.rb

@@ -0,0 +1,114 @@
+require "shield-vault/version"
+require "thor"
+require 'vault'
+
+module ShieldVault
+  class Commander < Thor
+    class_option :app, desc: "specify which app this is for, default is current working directory"
+    class_option :environment, desc: "specify which environment this is for", default: "development"
+
+    desc "fetch", "Fetch all environment variables from Vault and write to .env file"
+    long_desc <<-ADD
+    `fetch` will fetch all environment variables from Vault and write to .env file.
+    ADD
+    def fetch
+      check_seal do
+        values = get_current_values
+        if values
+          File.open(file_name, 'w+') do |file|
+            file.truncate(0)
+            values.keys.each do |key|
+              file.puts "#{key}=#{values[key]}\n"
+            end
+          end
+          puts "Fetched environment variables and updated local #{file_name} file"
+        else
+          puts "No environment variables set for #{main_key} environment."
+        end
+      end
+    end
+
+    desc "add <key> <value>", "Add environment variable to Vault"
+    long_desc <<-ADD
+    `add <key> <value>` will add an environment variable to the Vault.
+    ADD
+    def add(key, value)
+      check_seal do
+        current_values = get_current_values
+        current_values[key.to_sym] = value
+        Vault.logical.write(main_key, current_values)
+        puts "Added/updated environment variable in #{main_key}: #{key}"
+      end
+    end
+
+    desc "update <key> <value>", "Update environment variable in Vault"
+    long_desc <<-UPDATE
+    `update <key> <value>` will update an environment variable to the Vault.
+    UPDATE
+    def update(key, value)
+      invoke :add
+    end
+
+    desc "remove <key>", "Remove environment variable from Vault"
+    long_desc <<-REMOVE
+    `remove <key>` will remove an environment variable from the Vault.
+    REMOVE
+    def remove(key)
+      check_seal do
+        current_values = get_current_values
+        if current_values[key.to_sym]
+          current_values.delete key.to_sym
+          if current_values.empty?
+            Vault.logical.delete(main_key)
+          else
+            Vault.logical.write(main_key, current_values)
+          end
+          puts "Removed environment variable from #{main_key}: #{key}"
+        else
+          puts "Environment variable on #{main_key} does not exist: #{key}"
+        end
+      end
+    end
+
+    private
+
+    def environment
+      options[:environment] || "development"
+    end
+
+    def app
+      #assume current directory is app name if option not passed in
+      options[:app] || Dir.pwd.split('/').last
+    end
+
+    def get_current_values
+      values = Vault.logical.read(main_key)
+      values ? values.data : {}
+    end
+
+    def main_key
+      "secret/#{app}_#{environment}_env_vars"
+    end
+
+    def file_name
+      @file_name ||= case environment
+      when 'development'
+        File.join(Dir.pwd, '.env')
+      when 'staging'
+        File.join(Dir.pwd, '.env.staging')
+      when 'production'
+        File.join(Dir.pwd, '.env.production')
+      else
+        nil
+      end
+    end
+
+    def check_seal(&block)
+      if Vault.sys.seal_status.sealed
+        puts "Vault is sealed.  You must unseal it to interact with it."
+        return
+      end
+      block.call
+    end
+  end
+end

data/lib/shield-vault/version.rb

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

data/shield-vault.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shield-vault/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "shield-vault"
+  spec.version       = ShieldVault::VERSION
+  spec.authors       = ["Adam Scott"]
+  spec.email         = ["ascot21@gmail.com"]
+
+  spec.summary       = %q{A tool for managing your application's environment variables in a Vault.}
+  spec.description   = %q{A tool for managing your application's environment variables in a Vault.}
+  spec.homepage      = "https://github.com/CheckMateIO/shield-vault"
+  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_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+
+  spec.add_dependency 'thor'
+  spec.add_dependency "vault", "~> 0.1"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: shield-vault
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Scott
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-05 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: vault
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: A tool for managing your application's environment variables in a Vault.
+email:
+- ascot21@gmail.com
+executables:
+- shield-vault.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/shield-vault.rb
+- lib/shield-vault.rb
+- lib/shield-vault/version.rb
+- shield-vault.gemspec
+homepage: https://github.com/CheckMateIO/shield-vault
+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.4.8
+signing_key: 
+specification_version: 4
+summary: A tool for managing your application's environment variables in a Vault.
+test_files: []