vault-tools 0.3.11 → 0.4.0

data/lib/vault-tools.rb

@@ -4,6 +4,11 @@ require 'sinatra/base'
 require 'scrolls'
 require 'rack/ssl-enforcer'
 require 'heroku-api'
+require 'honeybadger'
+
+Honeybadger.configure do |config|
+  config.api_key = ENV['HONEYBADGER_API_KEY']
+end
 
 module Vault
   #require bundler and the proper gems for the ENV
@@ -27,19 +32,26 @@ module Vault
   end
 
   def self.hack_time_class
-    $stderr.puts "Modifying Time#to_s to use #iso8601"
+    $stderr.puts "Modifying Time#to_s to use #iso8601..."
     # use send to call private method
     Time.send(:define_method, :to_s) do
       self.iso8601
     end
   end
 
+  def self.override_global_config
+    $stderr.puts "Set Config to Vault::Config..."
+    Object.send(:remove_const, :Config)
+    Object.const_set(:Config, Vault::Config)
+  end
+
   # all in one go
   def self.setup
     self.require
     self.load_path
     self.set_timezones
     self.hack_time_class
+    self.override_global_config
   end
 end
 

data/lib/vault-tools/config.rb

@@ -1,62 +1,168 @@
 module Vault
   module Config
-    extend self
+    @@defaults = {}
 
-    def remote_env(app, env)
+    # An environment variable from another app.
+    #
+    # @param app [String] The name of the app to get the value from.
+    # @param name [String] The name of the environment variable to fetch a
+    #   value for.
+    # @return [String] The value of an environment variable from another
+    #   Heroku app or nil if no match is available.
+    def self.remote_env(app, name)
       heroku = Heroku::API.new
-      heroku.get_config_vars(app).body[env]
+      heroku.get_config_vars(app).body[name]
     end
 
-    def core_follower_url
-      remote_env('vault-core-follower', 'DATABASE_URL')
+    # An environment variable.
+    #
+    # @param name [String] The name of the environment variable to fetch a
+    #   value for.
+    # @return [String] The value of the environment variable or nil if no
+    #   match is available.
+    def self.env(name)
+      self[name]
     end
 
-    def env(key)
-      ENV[key]
+    # Set a default
+    # Defaults are supplied when accessing via Config[:varname]
+    #
+    # @param key [Symbol/String] The lower-case name of the default
+    # @return [String] The value of the default
+    def self.default(key, value)
+      @@defaults[key.to_sym] = value
     end
 
-    def env!(key)
-      env(key) || raise("missing #{key}")
+    # Get all the defaults
+    # @return [Hash] The current set of defaults
+    def self.defaults
+      @@defaults
     end
 
-    def production?
-      env('RACK_ENV') == 'production'
+    # 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
+      ENV[var_name] || @@defaults[name]
     end
 
-    def test?
-      env('RACK_ENV') == 'test'
+    # An environment variable.
+    #
+    # @param name [String] The name of the environment variable to fetch a
+    #   value for.
+    # @raise [RuntimeError] Raised if the environment variable is not defined.
+    # @return [String] The value of the environment variable.
+    def self.env!(name)
+      self[name] || raise("missing #{name}")
     end
 
-    def app_name
+    # The `RACK_ENV` environment variable is used to determine whether the
+    # service is in production mode or not.
+    #
+    # @return [Bool] True if the service is in production mode.
+    def self.production?
+      self['RACK_ENV'] == 'production'
+    end
+
+    # The `RACK_ENV` environment variable is used to determine whether the
+    # service is in test mode or not.
+    #
+    # @return [Bool] True if the service is in test mode.
+    def self.test?
+      self['RACK_ENV'] == 'test'
+    end
+
+    # The `APP_NAME` env var is used to identify which codebase is
+    # running in librato.  This usually matches the name of the repository.
+    #
+    # @return [String] The name of the app
+    def self.app_name
       env!("APP_NAME")
     end
 
-    def app_deploy
+    # The `APP_DEPLOY` env var is used to identify which deploy of the codebase is
+    # running in librato.  This usually matches the name of the environment such
+    # as local, production, staging, etc.
+    #
+    # @return [String] The deploy/environment of the app
+    def self.app_deploy
       env!("APP_DEPLOY")
     end
 
-    def port
+    # The port to listen on for web requests.
+    #
+    # @return [Fixnum] The port to listen on for web requests.
+    def self.port
       env!("PORT").to_i
     end
 
-    def database_url(kind = '')
+    # The database URL from the environment.
+    #
+    # @param kind [String] Optionally, the leading name of `*_DATABASE_URL`
+    #   environment variable.  Defaults to `DATABASE_URL`.
+    # @raise [RuntimeError] Raised if the environment variable is not defined.
+    def self.database_url(kind = '')
       kind = "#{kind}_".upcase unless kind.empty?
       env!("#{kind}DATABASE_URL")
     end
 
-    def enable_ssl?
-      !env('VAULT_TOOLS_DISABLE_SSL')
+    # Enforce HTTPS connections in the web API?
+    #
+    # @return [Bool] True if SSL is enforced, otherwise false.
+    def self.enable_ssl?
+      !bool?('VAULT_TOOLS_DISABLE_SSL')
+    end
+
+    # An environment variable converted to a Fixnum.
+    #
+    # @param name [String] The name of the environment variable to fetch a
+    #   Fixnum for.
+    # @return [Fixnum] The number or nil if the value couldn't be coerced to a
+    #   Fixnum.
+    def self.int(name)
+      self[name] ? self[name].to_i : nil
+    end
+
+    # Comma-separated words converted to an array.
+    #
+    # @param name [String] The name of the environment variable to fetch an
+    #   array for.
+    # @raise [RuntimeError] Raised if the environment variable is not defined.
+    # @return [Array] An array of values.
+    def self.array(name)
+      env!(name).split(',')
     end
 
-    def int(key)
-      env(key) ? env(key).to_i : nil
+    # An environment variable converted to a bool.
+    #
+    # @param name [String] The name of the environment variable to fetch a
+    #   boolean for.
+    # @return [bool] True if the value is `true`, otherwise false.
+    def self.bool?(name)
+      self[name] == 'true'
     end
 
-    def bool?(key)
-      ENV[key] == 'true'
+    def self.time(name)
+      Time.parse(self[name])
     end
 
-    def sidekiq_concurrency
+    # The number of threads to use in Sidekiq workers.
+    #
+    # @return [Fixnum] The number of threads from the `SIDEKIQ_CONCURRENCY`
+    #   environment variable or 25 if no variable is defined.
+    def self.sidekiq_concurrency
       int('SIDEKIQ_CONCURRENCY') || 25
     end
   end

data/lib/vault-tools/core_db_tasks.rb

@@ -4,14 +4,14 @@
 #
 # require 'vault-tools/core_db_tasks'
 
-desc "Pull db/structure.sql from core HEAD"
+desc "Pull db/structure.sql from api HEAD"
 task :pull_core do
   steps = []
   steps << 'cd contrib/'
   if File.exists?('contrib/core')
     steps << 'rm -rf core'
   end
-  steps << 'git clone -n git@github.com:heroku/core --depth 1'
+  steps << 'git clone -n git@github.com:heroku/api --depth 1'
   steps << 'cd core'
   steps << 'git checkout HEAD db/structure.sql'
   # make sure we don't submodule it
@@ -19,13 +19,13 @@ task :pull_core do
   sh steps.join(' && ')
 end
 
-desc "Drop and create vault-usage-test, core-test and shushu-test databases"
+desc "Drop and recreate the core-test database"
 task :create_core_db => [:drop_core_db, :pull_core] do
   sh 'createdb core-test'
   sh 'psql core-test -f contrib/core/db/structure.sql'
 end
 
-desc "Drop the vault-usage-test, core-test and shushu-test databases"
+desc "Drop the core-test database"
 task :drop_core_db do
   sh 'dropdb core-test || true'
 end

data/lib/vault-tools/log.rb

@@ -42,10 +42,10 @@ module Vault
     # @param duration [Fixnum] The duration to record, in milliseconds.
     def self.time(name, duration)
       if name
-        name.gsub(/\/:\w+/, '').           # Remove param names from path.
-             gsub("/", "-").               # Replace slash with dash.
-             gsub(/[^A-Za-z0-9\-\_]/, ''). # Only keep subset of chars.
-             sub(/^-/, "").                # Strip the leading dash.
+        name.gsub(/\/:\w+/, '').            # Remove param names from path.
+             gsub(/[\/_]+/, "-").           # Replace slash with dash.
+             gsub(/[^A-Za-z0-9\-\_]/, '').  # Only keep subset of chars.
+             sub(/^-+/, "").                # Strip the leading dashes.
              tap { |name| measure(name, "#{duration}ms") }
       end
     end

data/lib/vault-tools/payments_db_tasks.rb

@@ -13,13 +13,13 @@ task :pull_payments do
   sh steps.join(' && ')
 end
 
-desc "Drop and create vault-usage-test, payments-test and shushu-test databases"
+desc "Drop and recreate payments-test database"
 task :create_payments_db => [:drop_payments_db, :pull_payments] do
   sh 'createdb payments-test'
   sh 'psql payments-test -f contrib/payments/db/structure.sql'
 end
 
-desc "Drop the vault-usage-test, payments-test and shushu-test databases"
+desc "Drop the payments-test database"
 task :drop_payments_db do
   sh 'dropdb payments-test || true'
 end

data/lib/vault-tools/version.rb

@@ -1,5 +1,5 @@
 module Vault
   module Tools
-    VERSION = '0.3.11'
+    VERSION = '0.4.0'
   end
 end

data/lib/vault-tools/web.rb

@@ -23,7 +23,7 @@ module Vault
       # Check request for HTTP Basic creds and
       # password matches settings.basic_password
       def authorized?
-        @auth ||=  Rack::Auth::Basic::Request.new(request.env)
+        @auth ||= Rack::Auth::Basic::Request.new(request.env)
         @auth.provided? && @auth.basic? && @auth.credentials &&
           @auth.credentials[1] == settings.basic_password
       end
@@ -51,6 +51,7 @@ module Vault
     # body for easy debugging of errors.
     error do
       e = env['sinatra.error']
+      Honeybadger.notify(e, rack_env: env)
       content = "#{e.class}: #{e.message}\n\n"
       content << e.backtrace.join("\n")
       [500, content]

data/test/config_test.rb

@@ -2,107 +2,180 @@ require 'helper'
 require 'minitest/mock'
 
 class ConfigTest < Vault::TestCase
-  # Config.production? is true when RACK_ENV=production
+  include Vault::Test::EnvironmentHelpers
+
+  # Config.remote_env uses the Heroku API to read config vars from
+  # other apps.
+  def test_remote_env
+    api_mock = MiniTest::Mock.new
+    api_response = OpenStruct.new(body: {'DATABASE_URL' => 'postgres:///foo'})
+    Heroku::API.stub(:new, api_mock) do
+      api_mock.expect(:get_config_vars, api_response, ['app'])
+      assert_equal('postgres:///foo',
+                   Config.remote_env('app', 'DATABASE_URL'))
+    end
+  end
+
+  # Config.env returns the value matching the specified environment
+  # variable name.
+  def test_env
+    set_env('VALUE', 'value')
+    assert_equal(Config.env('VALUE'), 'value')
+  end
+
+  # Config[] returns the value matching the specified environment
+  # variable name.
+  def test_brackets
+    set_env('VALUE', 'value')
+    assert_equal(Config[:value], 'value')
+  end
+
+  # Config.env return nil if an unknown environment variable is
+  # requested.
+  def test_env_with_unknown_name
+    assert_equal(Config.env('UNKNOWN'), nil)
+  end
+
+  # Config.env! returns the value matching the specified environment
+  # variable name.
+  def test_env!
+    set_env('VALUE', 'value')
+    assert_equal(Config.env!('VALUE'), 'value')
+  end
+
+  # Config.env! raises a RuntimeError if an unknown environment
+  # variable is requested.
+  def test_env_with_unknown_name!
+    error = assert_raises RuntimeError do
+      Config.env!('UNKNOWN')
+    end
+    assert_equal(error.message, 'missing UNKNOWN')
+  end
+
+  # Config.production? is true when RACK_ENV=production.
   def test_production_mode
     set_env 'RACK_ENV', nil
-    refute Vault::Config.production?
+    refute Config.production?
     set_env 'RACK_ENV', 'production'
-    assert Vault::Config.production?
+    assert Config.production?
   end
 
-  # Config.test? is true when RACK_ENV=test
+  # Config.test? is true when RACK_ENV=test.
   def test_test_mode
     set_env 'RACK_ENV', nil
-    refute Vault::Config.test?
+    refute Config.test?
     set_env 'RACK_ENV', 'test'
-    assert Vault::Config.test?
+    assert Config.test?
   end
 
-  # Returns DATABASE_URL with no params
+  # Returns DATABASE_URL with no params.
   def test_database_url
     set_env 'DATABASE_URL', "postgres:///foo"
-    Vault::Config.database_url.must_equal 'postgres:///foo'
+    assert_equal(Config.database_url, 'postgres:///foo')
   end
 
   # Returns #{kind}_DATABASE_URL with one param
   def test_database_url_takes_and_capitalizes_params
     set_env 'FOO_DATABASE_URL', "postgres:///foo"
-    Vault::Config.database_url('foo').must_equal 'postgres:///foo'
+    assert_equal(Config.database_url('foo'), 'postgres:///foo')
   end
 
+  # Config.database_url raises a RuntimeError if no DATABASE_URL
+  # environment variables is defined.
   def test_database_url_raises_when_not_found
     assert_raises RuntimeError do
-      Vault::Config.database_url('foo')
+      Config.database_url('foo')
     end
   end
 
-  # Vault::Config.app_name returns the value of the APP_NAME environment
+  # Config.app_name returns the value of the APP_NAME environment
   # variable.
   def test_app_name
     set_env 'APP_NAME', "my-app"
-    Vault::Config.app_name.must_equal 'my-app'
+    Config.app_name.must_equal 'my-app'
   end
 
+  # Config.app_deploy returns the value of the APP_DEPLOY environment
+  # variable.
   def test_app_deploy
     set_env 'APP_DEPLOY', "test"
-    Vault::Config.app_deploy.must_equal 'test'
+    Config.app_deploy.must_equal 'test'
   end
 
+  # Config.port raises a RuntimeError if no `PORT` environment variable
+  # is defined.
   def test_port_raises
     assert_raises RuntimeError do
-      Vault::Config.port
+      Config.port
     end
   end
 
+  # Config.port converts the value from the environment to a Fixnum
   def test_port_convert_to_int
     set_env 'PORT', "3000"
-    Vault::Config.port.must_equal 3000
+    assert_equal(3000, Config.port)
   end
 
-  # Config.int(VAR) returns nil or VAR as integer
+  # Config.enable_ssl? is true unless VAULT_TOOLS_DISABLE_SSL is set.
+  def test_enable_ssl
+    set_env 'VAULT_TOOLS_DISABLE_SSL', nil
+    assert Config.enable_ssl?
+    set_env 'VAULT_TOOLS_DISABLE_SSL', 'true'
+    refute Config.enable_ssl?
+    set_env 'VAULT_TOOLS_DISABLE_SSL', 'false'
+    assert Config.enable_ssl?
+  end
+
+  # Config.int(VAR) returns nil or VAR as integer.
   def test_int
-    assert_equal(nil, Vault::Config.int('FOO'))
+    assert_equal(nil, Config.int('FOO'))
     set_env 'FOO', "3000"
-    assert_equal(3000, Vault::Config.int('FOO'))
+    assert_equal(3000, Config.int('FOO'))
   end
 
-  # Config.enable_ssl? is true unless VAULT_TOOLS_DISABLE_SSL
-  # is set
-  def test_enable_ssl
-    set_env 'VAULT_TOOLS_DISABLE_SSL', nil
-    assert Vault::Config.enable_ssl?
-    set_env 'VAULT_TOOLS_DISABLE_SSL', '1'
-    refute Vault::Config.enable_ssl?
-    set_env 'VAULT_TOOLS_DISABLE_SSL', 'foo'
-    refute Vault::Config.enable_ssl?
+  # Config.array loads a comma-separated list of words into an array of
+  # strings.
+  def test_array
+    set_env 'ARRAY', ''
+    assert_equal([], Config.array('ARRAY'))
+    set_env 'ARRAY', 'apple'
+    assert_equal(['apple'], Config.array('ARRAY'))
+    set_env 'ARRAY', 'apple,orange,cherry'
+    assert_equal(['apple', 'orange', 'cherry'], Config.array('ARRAY'))
   end
 
-  # Config.remote_env uses Heroku API to read config
-  # vars from apps
-  def test_remote_env
-    api_mock = MiniTest::Mock.new
-    api_response = OpenStruct.new(body: {'DATABASE_URL' => 'postgres:///foo'})
-    Heroku::API.stub(:new, api_mock) do
-      api_mock.expect(:get_config_vars, api_response, ['app'])
-      assert_equal('postgres:///foo', Vault::Config.remote_env('app', 'DATABASE_URL'))
+  # Config.array raises a RuntimeError if the environment variable
+  # doesn't exist.
+  def test_array_with_unknown_environment_variable
+    assert_raises RuntimeError do
+      Config.array('UNKNOWN')
     end
   end
 
-  def test_sidekiq_concurrency
-    assert_equal(25, Vault::Config.sidekiq_concurrency)
-    set_env 'SIDEKIQ_CONCURRENCY', '10'
-    assert_equal(10, Vault::Config.sidekiq_concurrency)
-  end
-
-  # Config.bool?(var) is only true if the value of var is the string 'true'.
-  # If the var is absent or any other value, it evaluates to false.
+  # Config.bool?(var) is only true if the value of var is the string
+  # 'true'.  If the var is absent or any other value, it evaluates to false.
   def test_bool_returns_true
-    assert_equal(false, Vault::Config.bool?('VAULT_BOOLEAN_VAR'))
+    assert_equal(false, Config.bool?('VAULT_BOOLEAN_VAR'))
     set_env 'VAULT_BOOLEAN_VAR', 'true'
-    assert_equal(true, Vault::Config.bool?('VAULT_BOOLEAN_VAR'))
+    assert_equal(true, Config.bool?('VAULT_BOOLEAN_VAR'))
+  end
+
+  # Config.bool?(var) is false if the value of var is anything other
+  # than the string 'true'.
+  def test_bool_returns_false
     set_env 'VAULT_BOOLEAN_VAR', 'false'
-    assert_equal(false, Vault::Config.bool?('VAULT_BOOLEAN_VAR'))
+    assert_equal(false, Config.bool?('VAULT_BOOLEAN_VAR'))
     set_env 'VAULT_BOOLEAN_VAR', 'foo'
-    assert_equal(false, Vault::Config.bool?('VAULT_BOOLEAN_VAR'))
+    assert_equal(false, Config.bool?('VAULT_BOOLEAN_VAR'))
+    set_env 'VAULT_BOOLEAN_VAR', '1'
+    assert_equal(false, Config.bool?('VAULT_BOOLEAN_VAR'))
+  end
+
+  # Config.sidekiq_concurrency returns the value of the
+  # `SIDEKIQ_CONCURRENCY` environment variable or 25 if one isn't defined.
+  def test_sidekiq_concurrency
+    assert_equal(25, Config.sidekiq_concurrency)
+    set_env 'SIDEKIQ_CONCURRENCY', '10'
+    assert_equal(10, Config.sidekiq_concurrency)
   end
 end

data/test/defaults_test.rb

@@ -0,0 +1,47 @@
+require 'helper'
+
+class DefaultsTest < Vault::TestCase
+  include Vault::Test::EnvironmentHelpers
+
+  def setup
+    Config.defaults.clear
+  end
+
+  def test_default_when_no_value
+    assert_equal(Config[:max_connections], nil)
+    Config.default(:max_connections, 10)
+    assert_equal(Config[:max_connections], 10)
+  end
+
+  def test_default_with_int
+    assert_equal(Config[:max_connections], nil)
+    Config.default(:max_connections, '10')
+    assert_equal('10', Config[:max_connections])
+    assert_equal(10, Config.int(:max_connections))
+    set_env 'MAX_CONNECTIONS', '100'
+    assert_equal(100, Config.int(:max_connections))
+  end
+
+  def test_default_with_time
+    assert_equal(Config[:date], nil)
+    Config.default(:date, '2013-01-01')
+    assert_equal('2013-01-01', Config[:date])
+    assert_equal(Time.utc(2013), Config.time(:date))
+    set_env 'DATE', '2014-01-01'
+    assert_equal('2014-01-01', Config[:date])
+    assert_equal(Time.utc(2014), Config.time(:date))
+  end
+
+  def test_default_with_array
+    assert_equal(Config[:array], nil)
+    Config.default(:array, '10')
+    assert_equal('10', Config[:array])
+    assert_equal(['10'], Config.array(:array))
+    Config.default(:array, '1,0')
+    assert_equal('1,0', Config[:array])
+    assert_equal(['1','0'], Config.array(:array))
+    set_env 'ARRAY', '1,2'
+    assert_equal('1,2', Config[:array])
+    assert_equal(['1','2'], Config.array(:array))
+  end
+end

data/test/helper.rb

@@ -1,12 +1,40 @@
 require 'vault-test-tools'
 require 'vault-tools'
-ENV['RACK_ENV'] = 'test'
-Vault.setup
 
-class Vault::TestCase
-  include Vault::Test::EnvironmentHelpers
+ENV['RACK_ENV'] = 'test'
 
+module LoggedDataHelper
   def logged_data
     Hash[Scrolls.stream.string.split(/\s+/).map {|p| p.split('=') }]
   end
 end
+
+# Overwrite the Honeybadger module
+module Honeybadger
+  # A place to store the exceptions
+  def self.exceptions
+    @exceptions ||= []
+  end
+
+  # Store calls to notify in an array instead
+  # of calling out to the Honeybadger service
+  def self.notify(exception, opts = {})
+    self.exceptions << [exception, opts]
+  end
+end
+
+# Clear the stored exceptions in Honeybadger
+# so each test starts w. a clean slate
+module HoneybadgerHelper
+  def setup
+    super
+    Honeybadger.exceptions.clear
+  end
+end
+
+class Vault::TestCase
+  include Vault::Test::EnvironmentHelpers
+  include HoneybadgerHelper
+end
+
+Vault.setup

data/test/log_test.rb

@@ -1,6 +1,9 @@
 require 'helper'
 
 class LogTest < Vault::TestCase
+  include Vault::Test::EnvironmentHelpers
+  include LoggedDataHelper
+
   def setup
     super
     set_env('APP_NAME', 'test-app')
@@ -64,6 +67,11 @@ class LogTest < Vault::TestCase
     assert_equal '123.4ms', logged_data['measure#test-app.some-web-path']
   end
 
+  def test_time_replaces_underscore_with_dash
+    Vault::Log.time('/some/web_path', 123.4)
+    assert_equal '123.4ms', logged_data['measure#test-app.some-web-path']
+  end
+
   # Vault::Log.time removes parameters.
   def test_time_removes_parameters
     Vault::Log.time('/some/:web/path', 123.4)

data/test/text_processor_test.rb

@@ -1,6 +1,8 @@
 require 'helper'
 
 class TextProcessorTest < Vault::TestCase
+  include Vault::Test::EnvironmentHelpers
+
   def setup
     set_env 'FERNET_SECRET', 'Mcdej7RFV/yHDrs1P8mrYP9zcw4JxSyReqYyELDrRPY='
   end

data/test/web_test.rb

@@ -2,6 +2,8 @@ require 'helper'
 
 class WebTest < Vault::TestCase
   include Rack::Test::Methods
+  include Vault::Test::EnvironmentHelpers
+  include LoggedDataHelper
 
   # Anonymous Web Frontend
   def app
@@ -20,7 +22,7 @@ class WebTest < Vault::TestCase
     app.set :basic_password, 'password'
     app.get '/protected' do
       protected!
-      'OKIE'
+      'You may pass'
     end
 
     get '/protected'
@@ -28,7 +30,7 @@ class WebTest < Vault::TestCase
     authorize('','password')
     get '/protected'
     assert_equal 200, last_response.status
-    assert_equal 'OKIE', last_response.body
+    assert_equal 'You may pass', last_response.body
   end
 
   # Middleware is attached at load time, so we have to delete the Vault::Web
@@ -68,8 +70,9 @@ class WebTest < Vault::TestCase
     assert_equal(404, last_response.status)
   end
 
-  # An internal server error causes a `web-50` log entry to be written.  A
-  # traceback is also written to the response body to ease debugging.
+  # An `http_500` and an `http_5xx` log metric is written when an internal
+  # server error occurs.  A traceback is written to the response body to ease
+  # debugging.
   def test_error_logs_500
     get '/boom'
     assert_equal '1', logged_data['count#test-app.http.500']
@@ -79,6 +82,15 @@ class WebTest < Vault::TestCase
     assert_equal(500, last_response.status)
   end
 
+  # Test we register errors with Honeybadger when they happen
+  def test_error_with_honeybadger
+    assert_equal(0, Honeybadger.exceptions.size)
+    get '/boom'
+    assert_equal(1, Honeybadger.exceptions.size)
+    error, opts = Honeybadger.exceptions.first
+    assert_equal(RuntimeError, error.class)
+  end
+
   # SSL is enforced when we are in production mode
   def test_ssl_enforced_in_production_mode
     set_env 'RACK_ENV', 'production'
@@ -89,11 +101,22 @@ class WebTest < Vault::TestCase
     assert_match(/^https/, last_response.headers['Location'])
   end
 
-  # SSL isn't enforced when the VAULT_TOOLS_DISABLE_SSL environment variable
-  # has a true value.
-  def test_ssl_can_be_disabled
+  # SSL is explicitly enforced when we're in production mode and the
+  # `VAULT_TOOLS_DISABLE_SSL` environment variable is set to `false`.
+  def test_ssl_explicitly_enforced_in_production_mode
+    set_env 'RACK_ENV', 'production'
+    set_env 'VAULT_TOOLS_DISABLE_SSL', 'false'
+    reload_web!
+    get '/health'
+    assert_equal(301, last_response.status)
+    assert_match(/^https/, last_response.headers['Location'])
+  end
+
+  # SSL isn't enforced when the `VAULT_TOOLS_DISABLE_SSL` environment variable
+  # is set to `true`.
+  def test_ssl_can_be_disabled_in_production_mode
     set_env 'RACK_ENV', 'production'
-    set_env 'VAULT_TOOLS_DISABLE_SSL', '1'
+    set_env 'VAULT_TOOLS_DISABLE_SSL', 'true'
     reload_web!
     get '/health'
     assert_equal(200, last_response.status)

data/vault-tools.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'rack-ssl-enforcer'
   gem.add_dependency 'heroku-api'
   gem.add_dependency 'fernet', '2.0.rc2'
+  gem.add_dependency 'honeybadger'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vault-tools
 version: !ruby/object:Gem::Version
-  version: 0.3.11
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-24 00:00:00.000000000Z
+date: 2013-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: scrolls
-  requirement: &2156169280 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156169280
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &2156168860 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +38,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156168860
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: uuidtools
-  requirement: &2156168440 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +54,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156168440
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-ssl-enforcer
-  requirement: &2156168020 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +70,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156168020
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: heroku-api
-  requirement: &2156167600 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,18 +86,44 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156167600
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: fernet
-  requirement: &2156167100 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 2.0.rc2
   type: :runtime
   prerelease: false
-  version_requirements: *2156167100
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.rc2
+- !ruby/object:Gem::Dependency
+  name: honeybadger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Basic tools for Heroku Vault's Ruby projects
 email:
 - christopher.continanza@gmail.com
@@ -104,7 +150,6 @@ files:
 - lib/vault-tools/payments_db_tasks.rb
 - lib/vault-tools/pipeline.rb
 - lib/vault-tools/product.rb
-- lib/vault-tools/shushu_db_tasks.rb
 - lib/vault-tools/sinatra_helpers/html_serializer.rb
 - lib/vault-tools/text_processor.rb
 - lib/vault-tools/user.rb
@@ -112,6 +157,7 @@ files:
 - lib/vault-tools/web.rb
 - test/app_test.rb
 - test/config_test.rb
+- test/defaults_test.rb
 - test/helper.rb
 - test/hid_test.rb
 - test/log_test.rb
@@ -134,15 +180,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 24233614407525305
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 24233614407525305
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.9
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Test classes, base web classes, and helpers - oh my!

data/lib/vault-tools/shushu_db_tasks.rb

@@ -1,31 +0,0 @@
-# Rake tasks for Shushu DB
-#
-# include in Rakefile via:
-#
-# require 'vault-tools/shushu_db_tasks'
-
-desc "Pull db/structure.sql from shushu HEAD"
-task :pull_shushu do
-  steps = []
-  steps << 'cd contrib/'
-  if File.exists?('contrib/shushu')
-    steps << 'rm -rf shushu'
-  end
-  steps << 'git clone -n git@github.com:heroku/shushud shushu --depth 1'
-  steps << 'cd shushu'
-  steps << 'git checkout HEAD db/*'
-  # make sure we don't submodule it
-  steps << 'rm -rf .git'
-  sh steps.join(' && ')
-end
-
-desc "Drop and create shushu-test database"
-task :create_shushu_db => [:drop_shushu_db, :pull_shushu] do
-  sh 'createdb shushu-test'
-  sh 'cd contrib/shushu && ../../vendor/bin/sequel postgres:///shushu-test -m db/migrations'
-end
-
-desc "Drop the vault-usage-test, core-test and shushu-test databases"
-task :drop_shushu_db do
-  sh 'dropdb shushu-test || true'
-end