vault-tools 0.0.10 → 0.2.0

data/.yardopts

@@ -0,0 +1 @@
+-m markdown

data/Gemfile

@@ -3,6 +3,13 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in vault-tools.gemspec
 gemspec
 
+group :development do
+  gem 'rake'
+  gem 'ruby-debug19'
+  gem 'shotgun'
+  gem 'yard-sinatra'
+end
+
 group :test do
   gem 'vault-test-tools', :path => '../vault-test-tools'
 end

data/Rakefile

@@ -1 +1,11 @@
 require "bundler/gem_tasks"
+require 'yard'
+
+desc "Test the things"
+require 'vault-test-tools/rake_task'
+
+desc "Doc the things"
+YARD::Rake::YardocTask.new
+
+desc "Create test databases and run the test suite"
+task :default => [:test]

data/lib/vault-tools.rb

@@ -2,6 +2,7 @@ require "vault-tools/version"
 
 require 'sinatra/base'
 require 'scrolls'
+require 'rack/ssl-enforcer'
 
 module Vault
   def self.require

data/lib/vault-tools/app.rb

@@ -2,15 +2,15 @@ require 'uuidtools'
 
 module Vault
   module App
-    # Convert an app ID into a Heroku app ID.
+    # Convert a core app ID into a Heroku app ID.
     #
-    # @param app_id [Fixnum] An app ID.
+    # @param app_id [Fixnum] A core app ID.
     # @return [String] A Heroku ID that uniquely represents the app.
     def self.id_to_hid(app_id)
       "app#{app_id}@heroku.com"
     end
 
-    # Convert an app ID into a v5 UUID.
+    # Convert a core app ID into a v5 UUID.
     #
     # @param app_id [Fixnum] An app ID.
     # @return [String] A v5 UUID that uniquely represents the app.
@@ -19,6 +19,19 @@ module Vault
       UUIDTools::UUID.sha1_create(UUIDTools::UUID_URL_NAMESPACE, url).to_s
     end
 
+    # Convert a Heroku app ID into a core app ID.
+    #
+    # @param heroku_id [String] A Heroku app ID, such as `app1234@heroku.com`.
+    # @raise [ArgumentError] Raised if a malformed Heroku ID is provided.
+    # @return [Fixnum] The core app ID that uniquely represents the app.
+    def self.hid_to_id(heroku_id)
+      if app_id = heroku_id.slice(/^app(\d+)\@heroku\.com$/, 1)
+        app_id.to_i
+      else
+        raise ArgumentError,"#{heroku_id} is not a valid Heroku app ID."
+      end
+    end
+
     # Convert a Heroku app ID into a v5 UUID.
     #
     # @param heroku_id [String] A Heroku app ID, such as `app1234@heroku.com`.

data/lib/vault-tools/config.rb

@@ -10,6 +10,14 @@ module Vault
       env(key) || raise("missing #{key}")
     end
 
+    def production?
+      env('RACK_ENV') == 'production'
+    end
+
+    def test?
+      env('RACK_ENV') == 'test'
+    end
+
     def app_name; env("APP_NAME"); end
     def port; env!("PORT").to_i; end
 
@@ -17,5 +25,9 @@ module Vault
       kind = "#{kind}_".upcase unless kind.empty?
       env!("#{kind}DATABASE_URL")
     end
+
+    def enable_ssl?
+      !env('VAULT_TOOLS_DISABLE_SSL')
+    end
   end
 end

data/lib/vault-tools/core_db_tasks.rb

@@ -0,0 +1,29 @@
+# Rake tasks for Core DB
+#
+# include in Rakefile via:
+#
+# require 'vault-tools/core_db_tasks'
+
+desc "Pull db/structure.sql from core 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 << 'cd core'
+  steps << 'git checkout HEAD db/structure.sql'
+  sh steps.join(' && ')
+end
+
+desc "Drop and create vault-usage-test, core-test and shushu-test databases"
+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"
+task :drop_core_db do
+  sh 'dropdb core-test || true'
+end

data/lib/vault-tools/hid.rb

@@ -4,7 +4,7 @@ module Vault
   module HID
     # Convert a Heroku app ID or user ID into a v5 UUID.
     #
-    # @param heroku_id [String] A Heroku app ID over user ID
+    # @param heroku_id [String] A Heroku app ID or user ID.
     # @raise [ArgumentError] Raised if a malformed Heroku ID is provided.
     # @return [String] A v5 UUID that uniquely represents the app.
     def self.hid_to_uuid(heroku_id)

data/lib/vault-tools/user.rb

@@ -19,6 +19,20 @@ module Vault
       UUIDTools::UUID.sha1_create(UUIDTools::UUID_URL_NAMESPACE, url).to_s
     end
 
+    # Convert a Heroku user ID into a core user ID.
+    #
+    # @param heroku_id [String] A Heroku user ID, such as
+    #   `user1234@heroku.com`.
+    # @raise [ArgumentError] Raised if a malformed Heroku ID is provided.
+    # @return [Fixnum] The core user ID that uniquely represents the user.
+    def self.hid_to_id(heroku_id)
+      if user_id = heroku_id.slice(/^user(\d+)\@heroku\.com$/, 1)
+        user_id.to_i
+      else
+        raise ArgumentError,"#{heroku_id} is not a valid Heroku user ID."
+      end
+    end
+
     # Convert a Heroku user ID into a v5 UUID.
     #
     # @param heroku_id [String] A Heroku user ID, such as

data/lib/vault-tools/version.rb

@@ -1,5 +1,5 @@
 module Vault
   module Tools
-    VERSION = '0.0.10'
+    VERSION = '0.2.0'
   end
 end

data/lib/vault-tools/web.rb

@@ -1,28 +1,71 @@
 require 'vault-tools/log'
 
 module Vault
+  # Base class for HTTP API services.
   class Web < Sinatra::Base
+    # Store the action for logging purposes.
     def self.route(verb, action, *)
       condition { @action = action }
       super
     end
 
+    # Start timing the request.
     before do
       @start_request = Time.now
     end
 
+    # Log details about the request including how long it took.
     after do
       Log.count_status(response.status)
       Log.time(@action, Time.now - @start_request)
     end
 
-    # Health check on HEAD
-    head('/')      { status(200) }
+    # Make sure error handler blocks are invoked in tests.
+    set :show_exceptions, false
+    set :raise_errors, false
 
-    # Trigger a 500 to test live monitoring and paging
-    head('/boom')  { status(500) }
+    # Require HTTPS connections when production mode is enabled.
+    use Rack::SslEnforcer if (Config.enable_ssl? && Config.production?)
 
-    # Can do more than the head request
-    get('/health') { [200, 'OK'] }
+    # Return an *HTTP 500 Internal Server Error* with a traceback in the
+    # body for easy debugging of errors.
+    error do
+      e = env['sinatra.error']
+      content = "#{e.class}: #{e.message}\n\n"
+      content << e.backtrace.join("\n")
+      [500, content]
+    end
+
+    # Determine if the service is running and responding to requests.
+    #
+    # @method status-check
+    # @return The following responses may be returned by this method:
+    #
+    #   - *HTTP 200 OK*: Returned if the request was successful.
+    head '/' do
+      status(200)
+    end
+
+    # Determine if the service is running and responding to requests.
+    #
+    # @method health-check
+    # @return The following responses may be returned by this method:
+    #
+    #   - *HTTP 200 OK*: Returned if the request was successful with `OK` in
+    #     the body.
+    get '/health' do
+      [200, 'OK']
+    end
+
+    # Trigger an internal server error (to test monitoring and paging tools).
+    #
+    # @method boom
+    # @return The following responses may be returned by this method:
+    #
+    #   - *HTTP 500 Internal Server Error*: Returned with a traceback in the
+    #     body.
+    get '/boom' do
+      raise "An expected error occurred."
+    end
   end
 end

data/test/app_test.rb

@@ -14,6 +14,21 @@ class AppTest < Vault::TestCase
     assert_equal(uuid, Vault::App.id_to_uuid(1234))
   end
 
+  # App.hid_to_id converts a Heroku app ID into a core integer app ID.
+  def test_hid_to_id
+    assert_equal(1234, Vault::App.hid_to_id('app1234@heroku.com'))
+  end
+
+  # App.hid_to_id raises an ArgumentError if the specified ID doesn't match
+  # the expected format.
+  def test_hid_to_id_with_invalid_heroku_id
+    error = assert_raises(ArgumentError) do
+      Vault::App.hid_to_id('invalid1234@heroku.com')
+    end
+    assert_equal('invalid1234@heroku.com is not a valid Heroku app ID.',
+                 error.message)
+  end
+
   # App.hid_to_uuid converts a Heroku app ID to a v5 UUID based on a URL
   # scheme.
   def test_hid_to_uuid
@@ -22,7 +37,7 @@ class AppTest < Vault::TestCase
     assert_equal(uuid, Vault::App.hid_to_uuid('app1234@heroku.com'))
   end
 
-  # App.hid_to_uuid raises a ArgumentError if the specified ID doesn't match
+  # App.hid_to_uuid raises an ArgumentError if the specified ID doesn't match
   # the expected format.
   def test_hid_to_uuid_with_invalid_heroku_id
     error = assert_raises(ArgumentError) do

data/test/config_test.rb

@@ -2,6 +2,22 @@ require 'helper'
 
 class ConfigTest < Vault::TestCase
 
+  # Config.production? is true when RACK_ENV=production
+  def test_production_mode
+    set_env 'RACK_ENV', nil
+    refute Vault::Config.production?
+    set_env 'RACK_ENV', 'production'
+    assert Vault::Config.production?
+  end
+
+  # Config.test? is true when RACK_ENV=test
+  def test_test_mode
+    set_env 'RACK_ENV', nil
+    refute Vault::Config.test?
+    set_env 'RACK_ENV', 'test'
+    assert Vault::Config.test?
+  end
+
   # Returns DATABASE_URL with no params
   def test_database_url
     set_env 'DATABASE_URL', "postgres:///foo"
@@ -36,4 +52,15 @@ class ConfigTest < Vault::TestCase
     set_env 'PORT', "3000"
     Vault::Config.port.must_equal 3000
   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?
+  end
 end

data/test/helper.rb

@@ -1,6 +1,6 @@
 require 'vault-test-tools'
 require 'vault-tools'
 
-module Vault::Test
-  include_in_all EnvironmentHelpers
+class Vault::TestCase
+  include Vault::Test::EnvironmentHelpers
 end

data/test/user_test.rb

@@ -14,6 +14,21 @@ class UserTest < Vault::TestCase
     assert_equal(uuid, Vault::User.id_to_uuid(1234))
   end
 
+  # User.hid_to_id converts a Heroku user ID into a core integer user ID.
+  def test_hid_to_id
+    assert_equal(1234, Vault::User.hid_to_id('user1234@heroku.com'))
+  end
+
+  # User.hid_to_id raises an ArgumentError if the specified ID doesn't match
+  # the expected format.
+  def test_hid_to_id_with_invalid_heroku_id
+    error = assert_raises(ArgumentError) do
+      Vault::User.hid_to_id('invalid1234@heroku.com')
+    end
+    assert_equal('invalid1234@heroku.com is not a valid Heroku user ID.',
+                 error.message)
+  end
+
   # User.hid_to_uuid converts a Heroku user ID to a v5 UUID based on a URL
   # scheme.
   def test_hid_to_uuid
@@ -22,7 +37,7 @@ class UserTest < Vault::TestCase
     assert_equal(uuid, Vault::User.hid_to_uuid('user1234@heroku.com'))
   end
 
-  # User.hid_to_uuid raises a ArgumentError if the specified ID doesn't match
+  # User.hid_to_uuid raises an ArgumentError if the specified ID doesn't match
   # the expected format.
   def test_hid_to_uuid_with_invalid_heroku_id
     error = assert_raises(ArgumentError) do

data/test/web_test.rb

@@ -0,0 +1,80 @@
+require 'helper'
+
+class WebTest < Vault::TestCase
+  include Rack::Test::Methods
+
+  # Anonymous Web Frontend
+  def app
+    Class.new(Vault::Web)
+  end
+
+  # Always reload the web class to eliminate test leakage
+  def setup
+    super
+    reload_web!
+  end
+
+  # middleware is attached at load time, so we have to
+  # delete the web class and reload it to simulate being
+  # loaded with a given ENV
+  def reload_web!
+    # remove the constant to force a clean reload
+    Vault.send(:remove_const, 'Web')
+    load 'lib/vault-tools/web.rb'
+  end
+
+  # A successful request causes a `web-20` log entry to be written.
+  def test_head_status_check
+    head '/'
+    assert_match(/measure=true/, Scrolls.stream.string)
+    assert_match(/at=web-20/, Scrolls.stream.string)
+    assert_equal(200, last_response.status)
+  end
+
+  # A successful request causes `web-20` log entry to be written and `OK`
+  # content is returned in the response body.
+  def test_get_health_check
+    get '/health'
+    assert_match(/measure=true/, Scrolls.stream.string)
+    assert_match(/at=web-20/, Scrolls.stream.string)
+    assert_equal(200, last_response.status)
+    assert_equal('OK', last_response.body)
+  end
+
+  # A validation error causes a `web-40` log entry to be written.
+  def test_head_with_unknown_endpoint
+    head '/unknown'
+    assert_match(/measure=true/, Scrolls.stream.string)
+    assert_match(/at=web-40/, Scrolls.stream.string)
+    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.
+  def test_error_logs_500
+    get '/boom'
+    assert_match(/measure=true/, Scrolls.stream.string)
+    assert_match(/at=web-50/, Scrolls.stream.string)
+    assert_match(/^RuntimeError: An expected error occurred.$/m,
+                 last_response.body)
+    assert_equal(500, last_response.status)
+  end
+
+
+  # SSL is enforced when we are in production mode
+  def test_ssl_enforced_in_production_mode
+    set_env 'RACK_ENV', 'production'
+    reload_web!
+    get '/health'
+    assert_equal(301, last_response.status)
+    assert_match(/^https/, last_response.headers['Location'])
+  end
+
+  def test_ssl_can_be_disabled
+    set_env 'RACK_ENV', 'production'
+    set_env 'VAULT_TOOLS_DISABLE_SSL', 'anything'
+    reload_web!
+    get '/health'
+    assert_equal(200, last_response.status)
+  end
+end

data/vault-tools.gemspec

@@ -20,4 +20,5 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'scrolls'
   gem.add_dependency 'sinatra'
   gem.add_dependency 'uuidtools'
+  gem.add_dependency 'rack-ssl-enforcer'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vault-tools
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-03 00:00:00.000000000 Z
+date: 2013-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: scrolls
@@ -60,6 +60,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-ssl-enforcer
+  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
@@ -71,22 +87,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .yardopts
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/d
-- bin/nokogiri
-- bin/pprof.rb
-- bin/rackup
-- bin/ri
-- bin/t
-- bin/tilt
-- bin/turn
-- bin/vault-tools
 - lib/vault-tools.rb
 - lib/vault-tools/app.rb
 - lib/vault-tools/config.rb
+- lib/vault-tools/core_db_tasks.rb
 - lib/vault-tools/hid.rb
 - lib/vault-tools/log.rb
 - lib/vault-tools/pipeline.rb
@@ -103,6 +112,7 @@ files:
 - test/product_test.rb
 - test/test_spec.rb
 - test/user_test.rb
+- test/web_test.rb
 - vault-tools.gemspec
 homepage: ''
 licenses: []
@@ -118,7 +128,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2764314088517499753
+      hash: 29653798075093968
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -127,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2764314088517499753
+      hash: 29653798075093968
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23