rack_heroku 0.1.0

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    rack_heroku (0.1.0)
+      rack
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.3)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rake (10.0.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  rack-test
+  rack_heroku!
+  rake
+  rspec

data/README.rdoc

@@ -0,0 +1,43 @@
+= Rack Middleware for Heroku
+
+This Gem contains Heroku specific middleware:
+
+* Rack::Heroku::Profiler - Profiles Heroku HTTP Routing Queue Wait
+  and attaches a X-Heroku-Queue-Wait header to the response
+* Rack::Heroku::Info - Returns stats and information about the
+  Heroku dyno
+
+=== Use
+
+  gem install rack_heroku
+
+In your app:
+
+  require 'rack'
+  require 'rack/heroku'
+
+  use Rack::Heroku::Profiler
+  run MyApp
+
+=== Licence
+
+Copyright (c) 2013 Black Square Media
+
+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/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/setup'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Default: run specs.'
+task :default => :spec

data/lib/rack/heroku.rb

@@ -0,0 +1,10 @@
+require 'rack'
+
+module Rack::Heroku
+end
+
+%w|profiler info|.each do |name|
+  require "rack/heroku/#{name}"
+end
+
+require 'rack/heroku/railtie' if defined?(Rails)

data/lib/rack/heroku/info.rb

@@ -0,0 +1,19 @@
+# Responds with 204 on :path
+class Rack::Heroku::Info
+  HEADERS = { "Content-Type" => "text/plain" }.freeze
+
+  def initialize(app, path = "/_heroku/info")
+    @app  = app
+    @path = path
+  end
+
+  def call(env)
+    case env["PATH_INFO"]
+    when @path
+      [200, HEADERS, [""]] # TODO: Return something interesting
+    else
+      @app.call(env)
+    end
+  end
+
+end

data/lib/rack/heroku/profiler.rb

@@ -0,0 +1,25 @@
+# Appends a X-Heroku-Queue-Wait header to the response
+class Rack::Heroku::Profiler
+  VALS_RANGE = (0..120_000).freeze
+  REQ_HEADER = "HTTP_X_REQUEST_START".freeze
+  RES_HEADER = "X-Heroku-Queue-Wait".freeze
+
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    ms = time_since env[REQ_HEADER]
+    status, headers, body = @app.call(env)
+    headers.update RES_HEADER => ms.to_s if ms && VALS_RANGE.include?(ms)
+
+    [status, headers, body]
+  end
+
+  private
+
+    def time_since(start)
+      (Time.now.to_f * 1_000).to_i - start.to_i if start
+    end
+
+end

data/lib/rack/heroku/railtie.rb

@@ -0,0 +1,8 @@
+class Rack::Heroku::Railtie < Rails::Railtie
+
+  initializer "rack_heroku.middleware" do |app|
+    app.config.middleware.insert_before ActionDispatch::Static, Rack::Heroku::Profiler
+    app.config.middleware.insert_after ActionDispatch::DebugExceptions, Rack::Heroku::Info
+  end
+
+end

data/lib/rack_heroku.rb

@@ -0,0 +1 @@
+require 'rack/heroku'

data/rack_heroku.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |s|
+  s.platform = Gem::Platform::RUBY
+  s.required_ruby_version = '>= 1.9.0'
+  s.required_rubygems_version = ">= 1.3.6"
+
+  s.name        = "rack_heroku"
+  s.summary     = "Rack middleware for Heroku"
+  s.version     = "0.1.0"
+  s.license     = "MIT"
+
+  s.authors     = ["Dimitrij Denissenko"]
+  s.email       = "dimitrij@blacksquaremedia.com"
+  s.homepage    = "https://github.com/bsm/rack_heroku"
+
+  s.require_path = 'lib'
+  s.files        = `git ls-files`.split("\n")
+  s.test_files   = `git ls-files -- spec/*`.split("\n")
+
+  s.add_dependency "rack"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "bundler"
+  s.add_development_dependency "rack-test"
+  s.add_development_dependency "rspec"
+end

data/spec/rack/heroku/info_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Rack::Heroku::Info do
+
+  it 'should ignore non-matching paths' do
+    get "/"
+    last_response.body.should == "OK"
+
+    get "/other"
+    last_response.body.should == "OK"
+  end
+
+  it 'should return info' do
+    get "/_heroku/info"
+    last_response.status.should == 200
+    last_response.body.should == ""
+  end
+
+end

data/spec/rack/heroku/profiler_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Rack::Heroku::Profiler do
+
+  it 'should skip when header not set' do
+    get "/"
+    last_response.headers["X-Heroku-Queue-Wait"].should be_nil
+  end
+
+  it 'should skip when header is invalid' do
+    get "/", {}, "HTTP_X_REQUEST_START" => (Time.now.to_f * 1000 + 21).floor
+    last_response.headers["X-Heroku-Queue-Wait"].should be_nil
+  end
+
+  it 'should calculate queue delay' do
+    get "/", {}, "HTTP_X_REQUEST_START" => (Time.now.to_f * 1000 - 21).floor
+    last_response.headers["X-Heroku-Queue-Wait"].to_i.should be_within(1).of(21)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'rspec'
+require 'rack/test'
+require 'rack/heroku'
+
+module Rack::Heroku::TestMethods
+
+  def inner_app
+    @inner_app ||= ->env { [200, {'Content-Type' => 'text/plain'}, ['OK']] }
+  end
+
+  def app
+    described_class.new inner_app
+  end
+
+end
+
+RSpec.configure do |c|
+  c.include Rack::Test::Methods
+  c.include Rack::Heroku::TestMethods
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: rack_heroku
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors:
+- Dimitrij Denissenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  type: :runtime
+  name: rack
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  type: :development
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  type: :development
+  name: bundler
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  type: :development
+  name: rack-test
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  type: :development
+  name: rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: dimitrij@blacksquaremedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- Rakefile
+- lib/rack/heroku.rb
+- lib/rack/heroku/info.rb
+- lib/rack/heroku/profiler.rb
+- lib/rack/heroku/railtie.rb
+- lib/rack_heroku.rb
+- rack_heroku.gemspec
+- spec/rack/heroku/info_spec.rb
+- spec/rack/heroku/profiler_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bsm/rack_heroku
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Rack middleware for Heroku
+test_files:
+- spec/rack/heroku/info_spec.rb
+- spec/rack/heroku/profiler_spec.rb
+- spec/spec_helper.rb
+has_rdoc: