key-vault 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 816aa733f4ad496a11e4a094995ed4059d003908
+  data.tar.gz: e97281577ba360206d58691fb16a6a0b6c2438d2
+SHA512:
+  metadata.gz: 21f33769159bdb4b6a633688549bd077464855d858a4969f2b67a58ae17cc22ab7d7fb4efec603357db8986d3673b02edf6e9c25e6365a9a4e5112984231df78
+  data.tar.gz: c495ab1a4b221b4a418cdc72f3fdd3004add75a40af1ac6fe8f54e798e5867fd7abea26f90ad8be1e8ddbdf138b2948005f11ffe156aecd5550311959d769da9

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Redbubble Pty Ltd
+
+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,47 @@
+# KeyVault
+
+KeyVault manages all your secrets so they don't have to live in the repo.
+
+Currently only works with Rails 3+.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'key-vault', require: 'key_vault'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install key-vault
+
+## Usage
+
+Simply put all secrets that shouldn't be checked into your repo into
+
+    config/key_vault.yml
+
+in your rails app. Then use
+
+    KeyVault[:key]
+
+it. For example, with a file that contains
+
+    session_secret: this-is-super-secret
+
+you can use
+
+    AppName::Application.config.secret_token = KeyVault[:session_secret]
+
+to set your session secret token.
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/key-vault.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'key_vault/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "key-vault"
+  spec.version       = KeyVault::VERSION
+  spec.authors       = ["redbubble"]
+  spec.email         = ["developers@redbubble.com"]
+  spec.description   = %q{Put all your secrets in the vault}
+  spec.summary       = %q{KeyVault manages all your secrets so they don't have to live in the repo}
+  spec.homepage      = "https://github.com/redbubble/key-vault"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rails"
+  spec.add_development_dependency "rspec"
+end

data/lib/key_vault.rb

@@ -0,0 +1,24 @@
+require "yaml"
+
+require "key_vault/version"
+require "key_vault/railtie"
+
+module KeyVault
+  class << self
+    def [](key)
+      if values.has_key?(key)
+        values[key]
+      else
+        raise ArgumentError, "'#{key}' not found in key_vault.yml"
+      end
+    end
+
+    def keys
+      values.keys
+    end
+
+    def values
+      @values ||= YAML.load(IO.read(Rails.root + "config/key_vault.yml")).symbolize_keys
+    end
+  end
+end

data/lib/key_vault/railtie.rb

@@ -0,0 +1,11 @@
+require "rails"
+
+require "key_vault"
+
+module KeyVault
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load Pathname.new(__FILE__).dirname + '../../tasks/key_vault.rake'
+    end
+  end
+end

data/lib/key_vault/version.rb

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

data/spec/key_vault_spec.rb

@@ -0,0 +1,47 @@
+require './lib/key_vault'
+
+describe KeyVault do
+
+  describe '.[]' do
+    before do
+      KeyVault.stub values: { session_secret: "secret" }
+    end
+
+    it 'returns the value from key_vault.yml' do
+      KeyVault[:session_secret].should == "secret"
+    end
+
+    it 'raises an error if the key wasnt found' do
+      expect { KeyVault[:unknown] }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe '.keys' do
+    before do
+      KeyVault.stub values: { session_secret: "secret" }
+    end
+
+    it 'returns the list of keys' do
+      KeyVault.keys.should include(:session_secret)
+    end
+  end
+
+  describe '.values' do
+    before do
+      Rails.stub root: '/tmp/'
+      FileUtils.mkdir '/tmp/config'
+    end
+
+    after do
+      FileUtils.rm_rf '/tmp/config'
+    end
+
+    it 'reads key_vault.yml in the rails config folder' do
+      File.open('/tmp/config/key_vault.yml', 'w') do |f|
+        f.puts({ session_secret: 'super_secret' }.to_yaml)
+      end
+
+      KeyVault.values[:session_secret].should == 'super_secret'
+    end
+  end
+end

data/tasks/key_vault.rake

@@ -0,0 +1,18 @@
+namespace :key_vault do
+
+  desc "Check if the given set of keys matches the key vault keys on the local file system"
+  task check: :environment do
+    local_keys  = ENV['LOCAL_KEYS'].split(',').map(&:to_sym)
+    server_keys = KeyVault.keys
+
+    missing_local = server_keys - local_keys
+    if !missing_local.empty?
+      puts "\e[30m\e[43mWarning: The local key_vault.yml file is missing: #{missing_local.join(', ')}\e[39m\e[49m"
+    end
+
+    missing_server = local_keys - server_keys
+    if !missing_server.empty?
+      fail "The server key_vault.yml file is missing: #{missing_server.join(', ')}"
+    end
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: key-vault
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- redbubble
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: rails
+  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: 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: Put all your secrets in the vault
+email:
+- developers@redbubble.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- key-vault.gemspec
+- lib/key_vault.rb
+- lib/key_vault/railtie.rb
+- lib/key_vault/version.rb
+- spec/key_vault_spec.rb
+- tasks/key_vault.rake
+homepage: https://github.com/redbubble/key-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.1.11
+signing_key: 
+specification_version: 4
+summary: KeyVault manages all your secrets so they don't have to live in the repo
+test_files:
+- spec/key_vault_spec.rb