vault-tools 0.0.1

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Chris Continanza
+
+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,47 @@
+# Vault Tools
+
+Tooling for the Heroku Vault team to enable faster bootstrapping for Ruby projects.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'vault-tools'
+
+## Usage
+
+### Sinatra Base Class
+
+Includes request logging and health endpoints
+
+```ruby
+  class Web < Vault::Web
+    helpers Vault::SinatraHelpers::HtmlSerializer
+
+  end
+```
+
+### Test Base Classes
+
+Provides a Stock TestCase and Spec classes to customize.
+
+To extend your test classes uniformly, use the Vault::
+
+```ruby
+
+module MyTestHelperClass
+  def app; Vault::InvoiceBuilder::Web; end
+end
+
+Vault::TestHelpers.include_in_all Vault::InvoiceBuilderHelpers
+```
+
+Now you have an `#app` method in your `Vault::TestCase`s and your `Vault::Spec`s
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/vault-tools.rb

@@ -0,0 +1,15 @@
+require "vault-tools/version"
+
+module Vault
+  def self.require
+    Kernel.require 'bundler'
+    STDERR.puts "Loading #{ENV['RACK_ENV']} environment..."
+    Bundler.require :default, ENV['RACK_ENV'].to_sym
+  end
+end
+
+require 'sinatra/base'
+
+require 'vault-tools/sinatra_helpers/html_serializer'
+require 'vault-tools/log'
+require 'vault-tools/web'

data/lib/vault-tools/log.rb

@@ -0,0 +1,62 @@
+module Vault
+  module Log
+    extend self
+
+    # Public: logs a counter
+    #
+    # name - Name of the counter
+    #
+    # Examples
+    #   Log.count('foo')
+    #   => "measure=true at=foo"
+    #
+    # Logs via Scrolls
+    def count(name)
+      log(measure: true, at: name)
+    end
+
+    # Public: logs an HTTP status code
+    #
+    # status - HTTP status code
+    #
+    # Examples
+    #   Log.count_status(400)
+    #   => "measure=true at=web-40"
+    #
+    # Logs via Scrolls
+    def count_status(status)
+      if prefix = status.to_s.match(/\d\d/)[0]
+        log(measure: true, at: "web-#{prefix}")
+      end
+    end
+
+    # Public: logs the time of a web request
+    #
+    # name - a Sinatra-formatted route url
+    # t - time (integer seconds or milliseconds)
+    #
+    # Examples
+    #   Log.time()
+    #   => "measure=true at=web-40"
+    #
+    # Logs via Scrolls
+    def time(name, t)
+      if name
+        name.
+          gsub(/\/:\w+/,'').            #remove param names from path
+          gsub("/","-").                #remove slash from path
+          gsub(/[^A-Za-z0-9\-\_]/, ''). #only keep subset of chars
+          slice(1..-1).
+          tap {|res| log(measure: true, fn: res, elapsed: t)}
+      end
+    end
+
+    # Internal: log something
+    #
+    # Logs via Scrolls
+    def log(data, &blk)
+      Scrolls.log(data, &blk)
+    end
+  end
+end
+

data/lib/vault-tools/sinatra_helpers/html_serializer.rb

@@ -0,0 +1,87 @@
+require 'base64'
+
+module Vault
+  module SinatraHelpers
+    # Public: Methods for including and serializing javascript and css files for HTML
+    #
+    # Examples
+    #
+    #   # = js 'foo'
+    #   # <%= js 'foo', 'bar', 'foo/bar' %>
+    #
+    #   # = css 'foo'
+    #   # <%= cssjs 'foo', 'bar', 'foo/bar' %>
+    module HtmlSerializer
+
+      # Public: create js markup by concatenating all javascript files
+      #
+      # files - one or many file names assuming settings.public_folder/js/ is the root
+      #
+      # Examples
+      #
+      #  # given: settings.public_folder/js/hello.js
+      #
+      #  js('hello')
+      #  # => "
+      #  #  <script type='text/javascript'>
+      #  #  //<![CDATA[
+      #  #    alert("hello, world")
+      #  #  //]]>
+      #  #  </script>"
+      #
+      # Returns the HTML String
+      def js(*files)
+        files.inject('') do |string, filename|
+          filename = File.join('/js', filename) + '.js'
+          string + %{
+            <script type='text/javascript'>
+            //<![CDATA[
+              #{slurp(filename)}
+            //]]>
+            </script>
+          }
+        end
+      end
+
+      # Public: create css markup with file references replaced by data-urls
+      #
+      # files - one or many file names assuming settings.public_folder/css/ is the root
+      #
+      # Examples
+      #
+      #   # given: settings.public_folder/css/invoice.css
+      #
+      #   css('invoice')
+      #   # => "
+      #   # <style>
+      #   #   h1{background:url(data:image/png;base64;DEADBEEF)}
+      #   # </style>"
+      #
+      # Returns the HTML String
+      def css(*files)
+        files.inject('') do |string, filename|
+          filename = File.join('/css', filename) + '.css'
+          string + "<style>\n#{inject_data_urls(slurp(filename))}\n</style>"
+        end
+      end
+
+      private
+      def inject_data_urls(css_text)
+        css_text.gsub(/url\('\/[^\)]+\)/) do |url|
+          filename = url.sub(/^url\(["']*/,'').sub(/["']*\)$/,'')
+          data = Base64.encode64(slurp(filename)).gsub(/\n/, '')
+          if filename =~ /font/
+            "url(data:font/opentype;base64,#{data})"
+          else
+            type = File.extname(filename)[1..-1]
+            "url(data:image/#{type};base64,#{data})"
+          end
+        end
+      end
+
+      def slurp(file)
+        File.read(File.join(settings.public_folder, file))
+      end
+    end
+  end
+end

data/lib/vault-tools/test.rb

@@ -0,0 +1,71 @@
+require 'minitest/unit'
+require 'minitest/spec'
+
+# Base class for Vault test cases.
+class Vault::TestCase < MiniTest::Unit::TestCase
+  def setup
+    super
+    Scrolls.stream = StringIO.new
+  end
+
+  def teardown
+    super
+  end
+end
+
+class Vault::Spec < MiniTest::Spec
+  before do
+    Scrolls.stream = StringIO.new
+  end
+end
+
+# Register our Spec class as the default
+MiniTest::Spec.register_spec_type //, Vault::Spec
+
+module Vault::TestHelpers
+  def self.include_in_all(_module)
+    Vault::TestCase.send(:include, _module)
+    Vault::Spec.send(:include, _module)
+  end
+
+  def save_and_open_page(html = nil, name = 'page.html', i = 1)
+    html ||= last_response.body
+    name = "page_#{i=i+1}.html" while File.exist? name
+    File.open(name, 'w') { |f| f << html }
+    system "open #{name}"
+  end
+
+  def set_doc(body)
+    @doc = Nokogiri::HTML(body)
+  end
+
+  def doc
+    @doc || Nokogiri::HTML(last_response.body)
+  end
+
+  def css(string)
+    doc.css(string)
+  end
+
+  def assert_includes_css(css_string)
+    exists = doc.css(css_string).first
+    assert exists, "Last response must include #{css_string}"
+  end
+
+  def assert_css(css_string, content)
+    e = css(css_string).first
+    assert e, "Element not found: #{css_string}"
+    assert_includes e.content, content
+  end
+
+  def with_env(key, value)
+    old_env = ENV[key]
+    ENV[key] = value
+    yield
+  ensure
+    ENV[key] = old_env
+  end
+end
+
+Vault::TestHelpers.include_in_all Rack::Test::Methods
+Vault::TestHelpers.include_in_all Vault::TestHelpers

data/lib/vault-tools/version.rb

@@ -0,0 +1,5 @@
+module Vault
+  module Tools
+    VERSION = "0.0.1"
+  end
+end

data/lib/vault-tools/web.rb

@@ -0,0 +1,28 @@
+require 'vault-tools/log'
+
+module Vault
+  class Web < Sinatra::Base
+    def self.route(verb, action, *)
+      condition { @action = action }
+      super
+    end
+
+    before do
+      @start_request = Time.now
+    end
+
+    after do
+      Log.count_status(response.status)
+      Log.time(@action, Time.now - @start_request)
+    end
+
+    # Health check on HEAD
+    head('/')      { status(200) }
+
+    # Trigger a 500 to test live monitoring and paging
+    head('/boom')  { status(500) }
+
+    # Can do more than the head request
+    get('/health') { [200, 'OK'] }
+  end
+end

data/vault-tools.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vault-tools/version'
+
+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.homepage      = ""
+
+  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.require_paths = ["lib"]
+
+  gem.add_dependency 'sinatra'
+  gem.add_dependency 'rack-test'
+  gem.add_dependency 'scrolls'
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: vault-tools
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Chris Continanza
+- Jamu Kakar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  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: rack-test
+  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: 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'
+description: Basic tools for Heroku Vault's Ruby projects
+email:
+- chriscontinanza@gmail.com
+- csquared@heroku.com
+- jkakar@heroku.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vault-tools.rb
+- lib/vault-tools/log.rb
+- lib/vault-tools/sinatra_helpers/html_serializer.rb
+- lib/vault-tools/test.rb
+- lib/vault-tools/version.rb
+- lib/vault-tools/web.rb
+- vault-tools.gemspec
+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'
+      segments:
+      - 0
+      hash: -2653287850415797196
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2653287850415797196
+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: []