vault-tools 0.0.5 → 0.0.7

data/.gitignore

@@ -6,6 +6,7 @@
 Gemfile.lock
 InstalledFiles
 _yardoc
+bin/*
 coverage
 doc/
 lib/bundler/man
@@ -16,5 +17,5 @@ test/tmp
 test/version_tmp
 tmp
 test.profile*
-bin/*
 test/.test.profile*
+vendor

data/README.md

@@ -1,6 +1,23 @@
-# Vault Tools
+# Vault::Tools
+
+Tooling for the Heroku Vault team to enable faster bootstrapping for
+Ruby projects.
+
+## Setting up a development environment
+
+Install the dependencies:
+
+    bundle install --binstubs vendor/bin
+    rbenv rehash
+
+Run the tests:
+
+    vendor/bin/t
+
+Generate the API documentation:
+
+    vendor/bin/d
 
-Tooling for the Heroku Vault team to enable faster bootstrapping for Ruby projects.
 
 ## Installation
 
@@ -8,6 +25,7 @@ Add this line to your application's Gemfile:
 
     gem 'vault-tools'
 
+
 ## Usage
 
 ### Logging
@@ -20,7 +38,7 @@ Add this line to your application's Gemfile:
   #  => "measure=true at=foo"
 ```
 
-### Sinatra Base Class
+### Sinatra base class
 
 Includes request logging and health endpoints
 

data/lib/vault-tools.rb

@@ -11,7 +11,11 @@ module Vault
   end
 end
 
-require 'vault-tools/sinatra_helpers/html_serializer'
+require 'vault-tools/app'
+require 'vault-tools/config'
+require 'vault-tools/hid'
 require 'vault-tools/log'
+require 'vault-tools/product'
+require 'vault-tools/sinatra_helpers/html_serializer'
+require 'vault-tools/user'
 require 'vault-tools/web'
-require 'vault-tools/config'

data/lib/vault-tools/app.rb

@@ -0,0 +1,35 @@
+require 'uuidtools'
+
+module Vault
+  module App
+    # Convert an app ID into a Heroku app ID.
+    #
+    # @param app_id [Fixnum] An 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.
+    #
+    # @param app_id [Fixnum] An app ID.
+    # @return [String] A v5 UUID that uniquely represents the app.
+    def self.id_to_uuid(app_id)
+      url = "https://vault.heroku.com/apps/#{app_id}"
+      UUIDTools::UUID.sha1_create(UUIDTools::UUID_URL_NAMESPACE, url).to_s
+    end
+
+    # Convert a Heroku app ID into a v5 UUID.
+    #
+    # @param heroku_id [String] A Heroku app ID, such as `app1234@heroku.com`.
+    # @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)
+      if app_id = heroku_id.slice(/^app(\d+)\@heroku\.com$/, 1)
+        id_to_uuid(app_id)
+      else
+        raise ArgumentError, "#{heroku_id} is not a valid Heroku app ID."
+      end
+    end
+  end
+end

data/lib/vault-tools/hid.rb

@@ -0,0 +1,21 @@
+require 'uuidtools'
+
+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
+    # @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(string)
+      case string
+      when /^user/
+        User.hid_to_uuid(string)
+      when /^app/
+        App.hid_to_uuid(string)
+      else
+        raise ArgumentError, "#{string} is not a valid Heroku app or user ID."
+      end
+    end
+  end
+end

data/lib/vault-tools/product.rb

@@ -0,0 +1,20 @@
+require 'uuidtools'
+
+module Vault
+  module Product
+    # Convert a product name into a v5 UUID.
+    #
+    # @param name [String] A product name.
+    # @raise [RuntimeError] Raised if the product name is empty or contains
+    #   illegal characters.  A product name may only contain 'a-z', '0-9' and
+    #   ':' characters.
+    # @return [String] A v5 UUID that uniquely represents the product.
+    def self.name_to_uuid(name)
+      unless name =~ /[a-z,0-9,:]+/
+        raise "Product name empty or contains illegal characters."
+      end
+      url = "https://vault.heroku.com/products/#{name}"
+      UUIDTools::UUID.sha1_create(UUIDTools::UUID_URL_NAMESPACE, url).to_s
+    end
+  end
+end

data/lib/vault-tools/user.rb

@@ -0,0 +1,36 @@
+require 'uuidtools'
+
+module Vault
+  module User
+    # Convert a user ID into a Heroku user ID.
+    #
+    # @param user_id [Fixnum] A user ID.
+    # @return [String] A Heroku ID that uniquely represents the user.
+    def self.id_to_hid(user_id)
+      "user#{user_id}@heroku.com"
+    end
+
+    # Convert a user ID into a v5 UUID.
+    #
+    # @param user_id [Fixnum] A user ID.
+    # @return [String] A v5 UUID that uniquely represents the user.
+    def self.id_to_uuid(user_id)
+      url = "https://vault.heroku.com/users/#{user_id}"
+      UUIDTools::UUID.sha1_create(UUIDTools::UUID_URL_NAMESPACE, url).to_s
+    end
+
+    # Convert a Heroku user ID into a v5 UUID.
+    #
+    # @param heroku_id [String] A Heroku user ID, such as
+    #   `user1234@heroku.com`.
+    # @raise [ArgumentError] Raised if a malformed Heroku ID is provided.
+    # @return [String] A v5 UUID that uniquely represents the user.
+    def self.hid_to_uuid(heroku_id)
+      if user_id = heroku_id.slice(/^user(\d+)\@heroku\.com$/, 1)
+        id_to_uuid(user_id)
+      else
+        raise ArgumentError,"#{heroku_id} is not a valid Heroku user ID."
+      end
+    end
+  end
+end

data/lib/vault-tools/version.rb

@@ -1,5 +1,5 @@
 module Vault
   module Tools
-    VERSION = "0.0.5"
+    VERSION = "0.0.7"
   end
 end

data/test/app_test.rb

@@ -0,0 +1,34 @@
+require 'helper'
+require 'uuidtools'
+
+class AppTest < Vault::TestCase
+  # App.id_to_hid converts an app ID to a Heroku app ID.
+  def test_id_to_hid
+    assert_equal('app1234@heroku.com', Vault::App.id_to_hid(1234))
+  end
+
+  # App.id_to_uuid converts an app ID to a v5 UUID based on a URL scheme.
+  def test_id_to_uuid
+    url = "https://vault.heroku.com/apps/1234"
+    uuid = UUIDTools::UUID.sha1_create(UUIDTools::UUID_URL_NAMESPACE, url).to_s
+    assert_equal(uuid, Vault::App.id_to_uuid(1234))
+  end
+
+  # App.hid_to_uuid converts a Heroku app ID to a v5 UUID based on a URL
+  # scheme.
+  def test_hid_to_uuid
+    url = "https://vault.heroku.com/apps/1234"
+    uuid = UUIDTools::UUID.sha1_create(UUIDTools::UUID_URL_NAMESPACE, url).to_s
+    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
+  # the expected format.
+  def test_hid_to_uuid_with_invalid_heroku_id
+    error = assert_raises(ArgumentError) do
+      Vault::App.hid_to_uuid('invalid1234@heroku.com')
+    end
+    assert_equal('invalid1234@heroku.com is not a valid Heroku app ID.',
+                 error.message)
+  end
+end

data/test/hid_test.rb

@@ -0,0 +1,40 @@
+require 'helper'
+require 'uuidtools'
+
+class HIDTest < Vault::TestCase
+
+  # HID.hid_to_uuid converts an app ID to a v5 UUID based on a URL scheme.
+  def test_app_id_to_uuid
+    url = "https://vault.heroku.com/apps/1234"
+    uuid = UUIDTools::UUID.sha1_create(UUIDTools::UUID_URL_NAMESPACE, url).to_s
+    assert_equal(uuid, Vault::HID.hid_to_uuid('app1234@heroku.com'))
+  end
+
+  # HID.hid_to_uuid converts a Heroku app ID to a v5 UUID based on a URL
+  # scheme.
+  def test_user_id_to_uuid
+    url = "https://vault.heroku.com/users/1234"
+    uuid = UUIDTools::UUID.sha1_create(UUIDTools::UUID_URL_NAMESPACE, url).to_s
+    assert_equal(uuid, Vault::HID.hid_to_uuid('user1234@heroku.com'))
+  end
+
+  # HID.hid_to_uuid raises a 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
+      Vault::HID.hid_to_uuid('invalid1234@heroku.com')
+    end
+    assert_equal('invalid1234@heroku.com is not a valid Heroku app or user ID.',
+                 error.message)
+  end
+
+  # HID.hid_to_uuid raises a ArgumentError if the specified ID doesn't match
+  # the expected format.
+  def test_hid_to_uuid_with_subtly_invalid_heroku_id
+    error = assert_raises(ArgumentError) do
+      Vault::HID.hid_to_uuid('app1234--afasd-afas')
+    end
+    assert_equal('app1234--afasd-afas is not a valid Heroku app ID.',
+                 error.message)
+  end
+end

data/test/product_test.rb

@@ -0,0 +1,29 @@
+require 'helper'
+require 'uuidtools'
+
+class ProductTest < Vault::TestCase
+  # Product.name_to_uuid converts a product name to a v5 UUID based on a URL
+  # scheme.
+  def test_name_to_uuid
+    url = 'https://vault.heroku.com/products/platform:dyno:logical'
+    uuid = UUIDTools::UUID.sha1_create(UUIDTools::UUID_URL_NAMESPACE, url).to_s
+    assert_equal(uuid, Vault::Product.name_to_uuid('platform:dyno:logical'))
+  end
+
+  # Product.name_to_uuid raises a RuntimeError if an empty name is provided.
+  def test_name_to_uuid_with_empty_name
+    error = assert_raises(RuntimeError) do
+      Vault::Product.name_to_uuid('')
+    end
+    assert_equal("Product name empty or contains illegal characters.",
+                 error.message)
+  end
+
+  # Product.name_to_uuid raises a RuntimeError if the product name contains
+  # illegal characters.
+  def test_name_to_uuid_with_illegal_characters
+    assert_raises(RuntimeError) { Vault::Product.name_to_uuid('!') }
+    assert_raises(RuntimeError) { Vault::Product.name_to_uuid(' ') }
+    assert_raises(RuntimeError) { Vault::Product.name_to_uuid('A') }
+  end
+end

data/test/user_test.rb

@@ -0,0 +1,34 @@
+require 'helper'
+require 'uuidtools'
+
+class UserTest < Vault::TestCase
+  # User.id_to_hid converts a user ID to a Heroku user ID.
+  def test_id_to_hid
+    assert_equal('user1234@heroku.com', Vault::User.id_to_hid(1234))
+  end
+
+  # User.id_to_uuid converts a user ID to a v5 UUID based on a URL scheme.
+  def test_id_to_uuid
+    url = "https://vault.heroku.com/users/1234"
+    uuid = UUIDTools::UUID.sha1_create(UUIDTools::UUID_URL_NAMESPACE, url).to_s
+    assert_equal(uuid, Vault::User.id_to_uuid(1234))
+  end
+
+  # User.hid_to_uuid converts a Heroku user ID to a v5 UUID based on a URL
+  # scheme.
+  def test_hid_to_uuid
+    url = "https://vault.heroku.com/users/1234"
+    uuid = UUIDTools::UUID.sha1_create(UUIDTools::UUID_URL_NAMESPACE, url).to_s
+    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
+  # the expected format.
+  def test_hid_to_uuid_with_invalid_heroku_id
+    error = assert_raises(ArgumentError) do
+      Vault::User.hid_to_uuid('invalid1234@heroku.com')
+    end
+    assert_equal('invalid1234@heroku.com is not a valid Heroku user ID.',
+                 error.message)
+  end
+end

data/vault-tools.gemspec

@@ -1,4 +1,5 @@
 # -*- encoding: utf-8 -*-
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'vault-tools/version'
@@ -7,15 +8,17 @@ Gem::Specification.new do |gem|
   gem.name          = "vault-tools"
   gem.version       = Vault::Tools::VERSION
   gem.authors       = ["Chris Continanza", "Jamu Kakar"]
-  gem.email         = ["chriscontinanza@gmail.com", "csquared@heroku.com", "jkakar@heroku.com"]
-  gem.description   = %q{Basic tools for Heroku Vault's Ruby projects}
-  gem.summary       = %q{Test classes, base web classes, and helpers - oh my!}
+  gem.email         = ["chriscontinanza@gmail.com", "csquared@heroku.com",
+                       "jkakar@heroku.com"]
+  gem.description   = "Basic tools for Heroku Vault's Ruby projects"
+  gem.summary       = "Test classes, base web classes, and helpers - oh my!"
   gem.homepage      = ""
 
   gem.files         = `git ls-files`.split($/)
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.test_files    = gem.files.grep('^(test|spec|features)/')
   gem.require_paths = ["lib"]
 
-  gem.add_dependency 'sinatra'
   gem.add_dependency 'scrolls'
+  gem.add_dependency 'sinatra'
+  gem.add_dependency 'uuidtools'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vault-tools
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -10,8 +10,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-13 00:00:00.000000000 Z
+date: 2013-01-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: scrolls
+  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'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -29,7 +45,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: scrolls
+  name: uuidtools
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -68,14 +84,22 @@ files:
 - bin/turn
 - bin/vault-tools
 - lib/vault-tools.rb
+- lib/vault-tools/app.rb
 - lib/vault-tools/config.rb
+- lib/vault-tools/hid.rb
 - lib/vault-tools/log.rb
+- lib/vault-tools/product.rb
 - lib/vault-tools/sinatra_helpers/html_serializer.rb
+- lib/vault-tools/user.rb
 - lib/vault-tools/version.rb
 - lib/vault-tools/web.rb
+- test/app_test.rb
 - test/config_test.rb
 - test/helper.rb
+- test/hid_test.rb
+- test/product_test.rb
 - test/test_spec.rb
+- test/user_test.rb
 - vault-tools.gemspec
 homepage: ''
 licenses: []
@@ -91,7 +115,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3663262642643653617
+      hash: 233434446101266212
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -100,15 +124,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3663262642643653617
+      hash: 233434446101266212
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Test classes, base web classes, and helpers - oh my!
-test_files:
-- test/config_test.rb
-- test/helper.rb
-- test/test_spec.rb
+test_files: []
 has_rdoc: