vault-tools 0.5.4 → 0.5.5

data/lib/vault-tools.rb

@@ -10,6 +10,12 @@ Honeybadger.configure do |config|
   config.api_key = ENV['HONEYBADGER_API_KEY']
 end
 
+# Yes, there's a lot of stuff on STDERR.  But its on
+# stderr and not stdout so you can pipe to /dev/null if
+# you hate it.  These methods do some pretty heavy-handed
+# environment munging and could lead to some hair-pulling
+# errors if you're not aware of whats going on.
+
 module Vault
   #require bundler and the proper gems for the ENV
   def self.require
@@ -45,6 +51,14 @@ module Vault
     Object.const_set(:Config, Vault::Config)
   end
 
+  def self.load_shared_config
+    return unless Config.production?
+    if Config[:config_app]
+      $stderr.puts "Loading shared config from app: #{Config[:config_app]}..."
+      Config.load_shared!(Config[:config_app])
+    end
+  end
+
   # all in one go
   def self.setup
     self.require
@@ -52,6 +66,7 @@ module Vault
     self.set_timezones
     self.hack_time_class
     self.override_global_config
+    self.load_shared_config
   end
 end
 

data/lib/vault-tools/config.rb

@@ -1,6 +1,48 @@
 module Vault
   module Config
     @@defaults = {}
+    @@shared   = {}
+
+    # Get a Config value
+    #
+    # This is the preferred and uniform way to access config vars because
+    # defaults and shared config are included in the lookup
+    #
+    # Uses defaults and shared if available.  Converts upper-case ENV var names
+    # to lower-case default names.
+    #
+    # Order of precedence is:
+    # 1) app's local ENV
+    # 2) shared config vars
+    # 3) default values
+    #
+    # Config[:foo] == nil
+    #
+    # Config.default(:foo, 'bar')
+    # Config[:foo] == 'bar'
+    #
+    # ENV['FOO'] = 'baz'
+    # Config[:foo] == 'baz'
+    #
+    # @param key [Symbol] The lower-case name of the ENV value
+    # @return [String] The value of the ENV value or default.
+    def self.[](name)
+      var_name = name.to_s.upcase
+      default_name = name.to_s.downcase.to_sym
+      ENV[var_name] || @@shared[var_name] || @@defaults[default_name]
+    end
+
+    # Loads config from another app.
+    def self.load_shared!(app = nil)
+      heroku   = Heroku::API.new
+      @@shared = heroku.get_config_vars(app).body
+    end
+
+    # Reset defaults and shared values
+    def self.reset!
+      @@defaults = {}
+      @@shared   = {}
+    end
 
     # An environment variable from another app.
     #
@@ -39,26 +81,6 @@ module Vault
       @@defaults
     end
 
-    # Get a Config value
-    # Uses defaults if available.  Converts upper-case ENV var names
-    # to lower-case default names.
-    #
-    # Config[:foo] == nil
-    #
-    # Config.default(:foo, 'bar')
-    # Config[:foo] == 'bar'
-    #
-    # ENV['FOO'] = 'baz'
-    # Config[:foo] == 'baz'
-    #
-    # @param key [Symbol] The lower-case name of the ENV value
-    # @return [String] The value of the ENV value or default.
-    def self.[](name)
-      var_name = name.to_s.upcase
-      default_name = name.to_s.downcase.to_sym
-      ENV[var_name] || @@defaults[default_name]
-    end
-
     # An environment variable.
     #
     # @param name [String] The name of the environment variable to fetch a

data/lib/vault-tools/doc_tasks.rb

@@ -0,0 +1,44 @@
+# Documentation Tasks
+#
+#
+require 'vault-tools/s3'
+
+namespace :docs do
+  desc "Publish Docs to S3"
+  task :publish do
+    DOC_BUCKET = "heroku-vault-docs2"
+    DOC_DIR_NAME = Dir.pwd.split("/").last
+
+    # Check for s3cmd CLI
+    response = system('s3cmd --version')
+    raise "\n\n\033[1;31m Install s3cmd through 'brew install s3cmd' if you are on a Mac or from 'http://s3tools.org/s3cmd' to use this feature.\033[0m\n\n\n" unless response
+
+    # Configure your docs amazon creds if you haven't already
+    unless File.exist?("#{Dir.home}/.s3cfg_docs")
+      puts "Configuring S3 Doc Creds - make sure you answer 'y' when asked to save ..."
+      sh 's3cmd --configure --config ~/.s3cfg_docs'
+    end
+
+    # Build Docs
+    Rake::Task["yard"].invoke
+
+    # Copy
+    sh 'mkdir -p ~/tmp'
+    sh "cp -R doc ~/tmp/#{DOC_DIR_NAME}"
+
+    system  "s3cmd mb s3://#{DOC_BUCKET} --config ~/.s3cfg_docs"
+    res = system("s3cmd -P put -r ~/tmp/#{DOC_DIR_NAME} s3://#{DOC_BUCKET}/ --config ~/.s3cfg_docs")
+
+    unless res
+      puts "\n\033[1;31m Make sure you put the doc credentials in .s3cfg_docs file. If you don't have them talk to the S3 doc administrator.\033[0m\n\n"
+      exit
+    end
+
+    # Cleanup
+    sh "rm -r ~/tmp/#{DOC_DIR_NAME}"
+
+    # Restart Vault Docs
+    sh "hk restart -a vault-docs"
+    puts "\n\033[1;32m Make sure to restart the vault-docs app to see NEW docs ( If hk restart fails )! \033[0m\n"
+  end
+end

data/lib/vault-tools/tasks.rb

@@ -3,11 +3,11 @@
 # include in Rakefile via:
 #
 # require 'vault-tools/tasks'
-
 require 'vault-tools/core_db_tasks'
 require 'vault-tools/vault_db_tasks'
 require 'vault-tools/usage_db_tasks'
 require 'vault-tools/analytics_db_tasks'
+require 'vault-tools/doc_tasks'
 
 desc "Run all pull schema tasks (all tasks that match pull_.*_schema)"
 task :pull_schemas do

data/lib/vault-tools/version.rb

@@ -1,5 +1,5 @@
 module Vault
   module Tools
-    VERSION = '0.5.4'
+    VERSION = '0.5.5'
   end
 end

data/test/config_test.rb

@@ -4,6 +4,11 @@ require 'minitest/mock'
 class ConfigTest < Vault::TestCase
   include Vault::Test::EnvironmentHelpers
 
+  def teardown
+    super
+    Config.reset!
+  end
+
   # Config.remote_env uses the Heroku API to read config vars from
   # other apps.
   def test_remote_env
@@ -16,6 +21,23 @@ class ConfigTest < Vault::TestCase
     end
   end
 
+  # Config.remote_env uses the Heroku API to read config vars from
+  # other apps.
+  def test_shared_config_loads_shared_with_correct_precedence
+    set_env('CONFIG_APP', 'vault-config')
+    api_mock = MiniTest::Mock.new
+    api_response = OpenStruct.new(body: {'HELLO' => 'world'})
+    Heroku::API.stub(:new, api_mock) do
+      api_mock.expect(:get_config_vars, api_response, ['vault-config'])
+      assert_equal(nil, Config[:hello])
+      Config.default(:hello, 'foo')
+      assert_equal('foo', Config[:hello])
+      # this is how we'll call it in the code
+      Config.load_shared!(Config[:config_app])
+      assert_equal('world', Config[:hello])
+    end
+  end
+
   # Config.env returns the value matching the specified environment
   # variable name.
   def test_env

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vault-tools
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.5
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-19 00:00:00.000000000 Z
+date: 2014-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: scrolls
@@ -197,6 +197,7 @@ files:
 - lib/vault-tools/app.rb
 - lib/vault-tools/config.rb
 - lib/vault-tools/core_db_tasks.rb
+- lib/vault-tools/doc_tasks.rb
 - lib/vault-tools/hid.rb
 - lib/vault-tools/log.rb
 - lib/vault-tools/pipeline.rb
@@ -239,7 +240,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 229862795146143839
+      hash: 915007437591633538
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -248,7 +249,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 229862795146143839
+      hash: 915007437591633538
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23