secretive 0.0.7

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/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Reade Harris
+
+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,100 @@
+# Secretive
+### Secrets, secrets, are now fun. *(Exposed secrets hurt someone.)*
+
+Secretive is a way to configure your application's ENV variables using a .yml file.
+
+It includes Rails integration, including a generator and a task for sharing secrets with Heroku.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'secretive'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install secretive
+
+## Usage
+
+### Setting Up (With Rails)
+
+Simply run `rails g secrets` to create and automatically .gitignore the required .yml files.
+
+When starting your Rails application, top-level variables and any variables in a group with the same name as your Rails environment will become ENV variables.
+
+For example, take following YAML file:
+
+    TOP_SECRET: "This will self-destruct."
+
+    development:
+      SUPER_SECRET: "Jeremiah was a bullfrog."`
+    production:
+      SUPER_SECRET: "He was a good friend of mine."
+
+In development:
+
+    $ rails console -e development
+      > ENV["SUPER_SECRET"]
+      => "Jeremiah was a bullfrog."
+
+      > ENV["TOP_SECRET"]
+      => "This will self-destruct."
+
+In production:
+
+    $ rails console -e production
+      > ENV["SUPER_SECRET"]
+      => "He was a good friend of mine."
+
+      > ENV["TOP_SECRET"]
+      => "This will self-destruct."
+
+### Setting Up (Without Rails)
+
+If not using Rails, create a `config/secrets.yml` file (or whatever you want to call it) and call `Secretive.environmentalize!` somewhere in your application.
+
+### Customizing
+
+You can choose which file to use as your secrets file by setting `Secretive.file = "../path/to/myfile"` before calling `Secretive.environmentalize!`.
+
+You can also pass `Secretive.environmentalize!` a scope. Top-level variables will always be loaded.
+
+For example, take following YAML file:
+
+    TOP_SECRET: "This will self-destruct."
+
+    superheroes:
+      BEST_HERO: "Harvey Birdman"`
+    supervillains:
+      BEST_VILLAIN: "Mentok, Mind-Taker"
+
+After calling `Secretive.environmentalize!("superheroes")`:
+
+    $ irb
+      > ENV["BEST_HERO"]
+      => "Harvey Birdman"
+
+      > ENV["TOP_SECRET"]
+      => "This will self-destruct."
+
+      > ENV["BEST_VILLAIN"]
+      => nil
+
+## Sharing with Heroku
+
+Secretive comes with a rake task for sharing secrets with Heroku.
+
+Run `rake secretive:share_with[yourapp]` to convert all values in the `production` scope of your .yml file into ENV variables in the Heroku app.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/generators/secrets_generator.rb

@@ -0,0 +1,18 @@
+class SecretsGenerator < ::Rails::Generators::Base
+  def create_secrets_file
+    create_file("#{Rails.root}/config/secrets.yml")
+  end
+  
+  def create_example_file
+    create_file("#{Rails.root}/config/secrets.yml.example")
+  end
+  
+  def gitignore_secrets_file
+    append_to_file("#{Rails.root}/.gitignore") do
+      "\n\n" + 
+      "# Sensitive API and password information.\n" +
+      "# Keep it secret. Keep it safe.\n" +
+      "config/secrets.yml"
+    end
+  end
+end

data/lib/secretive/loader.rb

@@ -0,0 +1,45 @@
+module Secretive
+  class Loader
+    class << self
+      def environmentalize!(yaml_file, scope=nil)
+        unless File.exists?(yaml_file)
+          warn "secretive attempted to initialize, but #{yaml_file} does not exist."
+          return
+        end
+
+        vars = YAML.load(File.open(yaml_file))
+
+        convert_to_env_vars(vars)
+        convert_to_env_vars(vars.fetch(scope)) if scope.present?
+      end
+
+      def for_heroku(yaml_file, scope=nil)
+        vars = YAML.load(File.open(yaml_file))
+
+        heroku_string = convert_vars_to_string(vars)
+        heroku_string += convert_vars_to_string(vars.fetch(scope)) if scope.present?
+        heroku_string
+      end
+
+      private
+
+      def convert_to_env_vars(vars)
+        return unless vars.present?
+
+        vars.each do |key, value|
+          ENV[key] = value unless value.respond_to?(:each) || value.nil?
+        end
+      end
+
+      def convert_vars_to_string(vars)
+        return unless vars.present?
+
+        string = ""
+        vars.each do |key, value|
+          string.concat("#{key}=#{value} ") unless value.respond_to?(:each) || value.nil?
+        end
+        string
+      end
+    end
+  end
+end

data/lib/secretive/railtie.rb

@@ -0,0 +1,15 @@
+module Secretive
+  class Railtie < ::Rails::Railtie
+    config.before_initialize do
+      Secretive.environmentalize!(Rails.env) unless Rails.env.production?
+    end
+
+    rake_tasks do
+      load File.expand_path('../../tasks/share.rake', __FILE__)
+    end
+
+    generators do
+      require File.expand_path('../../generators/secrets_generator', __FILE__)
+    end
+  end
+end

data/lib/secretive/version.rb

@@ -0,0 +1,3 @@
+module Secretive
+  VERSION = "0.0.7"
+end

data/lib/secretive.rb

@@ -0,0 +1,29 @@
+require 'active_support/all'
+require 'secretive/version'
+require 'secretive/loader'
+require 'secretive/railtie' if defined?(Rails)
+
+module Secretive
+  class << self
+    def file
+      @@file ||= 'config/secrets.yml'
+    end
+
+    def file=(file)
+      @@file = file
+    end
+
+    def configure
+      yield self
+    end
+
+    def environmentalize!(scope=nil)
+      Loader.environmentalize!(self.file, scope)
+    end
+
+    def for_heroku(scope=nil)
+      Loader.for_heroku(self.file, scope)
+    end
+  end
+end
+

data/lib/tasks/share.rake

@@ -0,0 +1,21 @@
+require 'heroku'
+
+namespace :secretive do
+  desc 'Set environment vars defined in the production group of config/secrets.yml on the specified Heroku app.'
+  task :share_with, :heroku_app do |task, args|
+    raise "This task requires the heroku gem and it could not be found." unless defined?(Heroku)
+    raise "Which heroku app do you want to share secrets with? Format is rake secretive:share[heroku_app]" unless args[:heroku_app].present?
+
+    @heroku_app = args[:heroku_app]
+
+    msg  = "This task will sync ALL ENVIRONMENT VARIABLES in the `#{@heroku_app}` app "
+    msg += "with the values defined in the `production` group of config/secrets.yml. "
+    msg += "Are you sure you want to proceed? (y/n)"
+    puts msg
+
+    confirmation = $stdin.gets.chomp
+    raise unless confirmation == "y"
+
+    sh "heroku config:add #{Secrets.for_heroku('production')} --app #{@heroku_app}"
+  end
+end

data/secretive.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/secretive/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Singlebrook Technology"]
+  gem.email         = ["info@singlebrook.com"]
+  gem.description   = %q{Secretive converts variables in a YAML file into ENV vars. It's useful for storing API keys and other sensitive information.}
+  gem.summary       = %q{Convert variables in a YAML file into ENV vars.}
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "secretive"
+  gem.require_paths = ["lib"]
+  gem.version       = Secretive::VERSION
+
+  gem.add_dependency 'activesupport', '~> 3.2.0'
+  gem.add_dependency 'heroku', '~> 2.0'
+  gem.add_development_dependency 'rspec', '~> 2.9.0'
+end

data/spec/fixtures/test_secrets.yml

@@ -0,0 +1,18 @@
+FAVORITE_COLOR: "Rainbow"
+MOST_AWESOME_NINJA_TURTLE: "Donatello"
+EMPTY_VAR: 
+  
+fools:
+  FIRST_FOOL: "Feste"
+  SECOND_FOOL: "Patchface"
+
+heroes:
+  FIRST_HERO: "Lancelot"
+  SECOND_HERO: "Bilbo"
+
+filled_with_empty:
+  EMPTY_VAR:
+  EMPTY_VAR:
+  EMPTY_VAR:
+
+empty_scope:

data/spec/loader_spec.rb

@@ -0,0 +1,81 @@
+require_relative '../lib/secretive/loader'
+
+describe Secretive::Loader do
+  subject { Secretive::Loader }
+
+  let(:test_secrets)        { File.expand_path("../fixtures/test_secrets.yml", __FILE__) }
+  let(:empty_secrets)       { File.expand_path("../fixtures/empty_secrets.yml", __FILE__) }
+  let(:nonexistent_secrets) { File.expand_path("../fixtures/nonexistent_secrets.yml", __FILE__) }
+
+  describe "environmentalizing" do
+    it "environmentalizes all top-level variables" do
+      subject.environmentalize!(test_secrets)
+
+      ENV["FAVORITE_COLOR"].should == "Rainbow"
+      ENV["MOST_AWESOME_NINJA_TURTLE"].should == "Donatello"
+    end
+
+    it "doesn't barf when given an empty variable" do
+      expect { subject.environmentalize!(test_secrets) }.not_to raise_error
+    end
+
+    it "doesn't barf when given an empty file" do
+      expect { subject.environmentalize!(empty_secrets) }.not_to raise_error
+    end
+
+    context "without a secrets file" do
+      it "doesn't barf" do
+        expect { subject.environmentalize!(nonexistent_secrets) }.not_to raise_error
+      end
+
+      it "gives a warning" do
+        subject.should_receive(:warn).with("secretive attempted to initialize, but #{nonexistent_secrets} does not exist.")
+        subject.environmentalize!(nonexistent_secrets)
+      end
+    end
+
+    context "when given a scope" do
+      it "environmentalizes variables in the scope" do
+        subject.environmentalize!(test_secrets, "fools")
+
+        ENV["FIRST_FOOL"].should == "Feste"
+        ENV["SECOND_FOOL"].should == "Patchface"
+      end
+
+      it "doesn't barf when given a scope filled with empty variables" do
+        expect { subject.environmentalize!(test_secrets, "filled_with_empty") }.not_to raise_error
+      end
+
+      it "doesn't barf when given an empty scope" do
+        expect { subject.environmentalize!(test_secrets, "empty_scope") }.not_to raise_error
+      end
+
+      it "still environmentalizes top-level variables" do
+        ENV["FAVORITE_COLOR"] = nil
+
+        subject.environmentalize!(test_secrets, "fools")
+        ENV["FAVORITE_COLOR"].should be_present
+      end
+
+      it "does not environmentalize other scopes" do
+        ENV["FIRST_FOOL"] = nil
+
+        subject.environmentalize!(test_secrets, "heroes")
+        ENV["FIRST_FOOL"].should_not be_present
+      end
+    end
+
+  end
+
+  describe "Heroku string:" do
+    it "can return a string suitable for adding vars to Heroku" do
+      heroku_string = subject.for_heroku(test_secrets, "fools")
+      heroku_string.should == "FAVORITE_COLOR=Rainbow MOST_AWESOME_NINJA_TURTLE=Donatello FIRST_FOOL=Feste SECOND_FOOL=Patchface "
+    end
+
+    it "does not include empty scopes in the string" do
+      heroku_string = subject.for_heroku(test_secrets, "fools")
+      heroku_string.should_not include "empty_scope"
+    end
+  end
+end

data/spec/secrets_spec.rb

@@ -0,0 +1,22 @@
+require_relative '../lib/secretive'
+
+describe Secretive do
+  subject { Secretive }
+
+  it "supports reading and writing a file" do
+    subject.file = "myfile"
+    subject.file.should == "myfile"
+  end
+
+  it "can be configured using a block" do
+    subject.should_receive(:file=).with("stuff")
+    subject.configure do |config|
+      config.file = "stuff"
+    end
+  end
+
+  it "delegates #environmentalize! to the Loader" do
+    subject::Loader.should_receive(:environmentalize!)
+    subject.environmentalize!
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: secretive
+version: !ruby/object:Gem::Version
+  version: 0.0.7
+  prerelease: 
+platform: ruby
+authors:
+- Singlebrook Technology
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: heroku
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+description: Secretive converts variables in a YAML file into ENV vars. It's useful
+  for storing API keys and other sensitive information.
+email:
+- info@singlebrook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/generators/secrets_generator.rb
+- lib/secretive.rb
+- lib/secretive/loader.rb
+- lib/secretive/railtie.rb
+- lib/secretive/version.rb
+- lib/tasks/share.rake
+- secretive.gemspec
+- spec/fixtures/empty_secrets.yml
+- spec/fixtures/test_secrets.yml
+- spec/loader_spec.rb
+- spec/secrets_spec.rb
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Convert variables in a YAML file into ENV vars.
+test_files:
+- spec/fixtures/empty_secrets.yml
+- spec/fixtures/test_secrets.yml
+- spec/loader_spec.rb
+- spec/secrets_spec.rb
+has_rdoc: