rack_heroku_meta 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+.rvmrc
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2012 Brendon Murphy
+
+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,61 @@
+Rack::HerokuMeta
+================
+
+Rack middleware for checking the process commit hash on Heroku
+
+Why
+---
+
+On Heroku deployments, a dyno ENV has PS and COMMIT_HASH values
+that are useful for viewing the state of the deploy.  The commit
+hash contains the short sha1 from the most recent deploy, while
+ps contains the process name of the dyno.
+
+Sometimes when deploying to Heroku, a dyno gets "stuck" and
+continues serving up the previous deploy.  This can cause
+problems.  The middleware provides one way of quickly checking.
+
+How
+---
+
+In your gemfile:
+
+```ruby
+gem "rack_heroku_meta", :require => "rack/heroku_meta"
+```
+
+In your rackup:
+
+```ruby
+use Rack::HerokuMeta # defaults to /heroku_meta
+```
+
+or with a configured route
+
+```ruby
+use Rack::HerokuMeta, :route => "/foo_bar"
+```
+
+You can then hit the route with an http client of your choice
+and parse the returned JSON data.
+
+Security
+--------
+
+The endpoint exposes information about your current Heroku deploy.
+While the information is probably benign, if you are concerned,
+either deploy authentication middleware to protect the route, or
+simply configure the route randomly like "/meta_6960VYT6vU0mK"
+
+Alternatives
+------------
+
+The Heroku PS API is a more detailed way to view process data
+about your entire application stack.  However, if you want quick
+and dirty, especially if you have minimal dynos running, this gem
+can be of help.
+
+#### Copyright
+
+Copyright (c) (2012) Brendon Murphy. See LICENSE for details.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => [:spec]

data/lib/rack/heroku_meta.rb

@@ -0,0 +1,40 @@
+require "rack/heroku_meta/version"
+
+module Rack
+  class HerokuMeta
+    DEFAULT_ROUTE = "/heroku_meta"
+
+    def initialize(app, options = {})
+      @app = app
+      @route = options.fetch(:route, DEFAULT_ROUTE)
+    end
+
+    def call(env)
+      dup._call(env)
+    end
+
+    def _call(env)
+      if env["PATH_INFO"] == @route
+        env["REQUEST_METHOD"] == "GET" ? serve_meta : not_found
+      else
+        @app.call(env)
+      end
+    end
+
+    private
+
+    def not_found
+      [404, { "Content-Type" => "plain/text" }, ["Not Found"]]
+    end
+
+    def meta
+      ps = ENV["PS"]
+      commit_hash = ENV["COMMIT_HASH"]
+      %Q({"ps":"#{ps}","commit_hash":"#{commit_hash}"})
+    end
+
+    def serve_meta
+      [200, { "Content-Type" => "application/json" }, [meta]]
+    end
+  end
+end

data/lib/rack/heroku_meta/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class HerokuMeta
+    VERSION = "0.0.1"
+  end
+end

data/rack_heroku_meta.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rack/heroku_meta/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rack_heroku_meta"
+  s.version     = Rack::HerokuMeta::VERSION
+  s.authors     = ["Brendon Murphy"]
+  s.email       = ["xternal1+github@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Rack middleware for checking the process commit hash on Heroku}
+  s.description = s.summary
+
+  s.rubyforge_project = "rack_heroku_meta"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_dependency "rack"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "json"
+end

data/spec/rack_heroku_meta_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe "Requests using Rack::HerokuMeta" do
+  let(:app) {
+    Rack::Builder.new do
+      use Rack::HerokuMeta
+      run lambda { |env| [200, { 'Content-Type' => "text/plain" }, ["bar"]]}
+    end
+  }
+
+  context "for a GET to the default /heroku_meta route" do
+    let(:response) {
+      Rack::MockRequest.new(app).get('/heroku_meta')
+    }
+
+    it "returns content-type of application/json" do
+      response.headers["Content-Type"].should == "application/json"
+    end
+
+    it "includes ENV['PS']" do
+      ENV["PS"] = "web.42"
+      JSON.parse(response.body)["ps"].should == "web.42"
+    end
+
+    it "includes ENV['COMMIT_HASH']" do
+      ENV["COMMIT_HASH"] = "ab123f"
+      JSON.parse(response.body)["commit_hash"].should == "ab123f"
+    end
+  end
+
+  context "for a POST to the default route" do
+    it "is status 404" do
+      response = Rack::MockRequest.new(app).post('/heroku_meta')
+      response.status.should == 404
+    end
+  end
+
+  context "for another route" do
+    it "passes it through the app stack" do
+      response = Rack::MockRequest.new(app).get('/foo')
+      response.status.should == 200
+      response.body.should == "bar"
+    end
+  end
+
+  context "for a configured meta route" do
+    let(:app) {
+      Rack::Builder.new do
+        use Rack::HerokuMeta, :route => "/foo_bar_321"
+        run lambda { |env| [200, { 'Content-Type' => "text/plain" }, ["bar"]]}
+      end
+    }
+
+    it "returns the meta info" do
+      ENV["PS"] = "web.77"
+      ENV["COMMIT_HASH"] = "123456"
+      response = Rack::MockRequest.new(app).get('/foo_bar_321')
+      meta = JSON.parse(response.body)
+      meta["ps"].should == "web.77"
+      meta["commit_hash"].should == "123456"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require File.expand_path("../../lib/rack/heroku_meta", __FILE__)
+require 'rack/mock'
+require 'json'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end
+

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: rack_heroku_meta
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Brendon Murphy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-07 00:00:00.000000000 -07:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: &2156434620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156434620
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2156433980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2156433980
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2156433460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2156433460
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &2156432680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2156432680
+description: Rack middleware for checking the process commit hash on Heroku
+email:
+- xternal1+github@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rack/heroku_meta.rb
+- lib/rack/heroku_meta/version.rb
+- rack_heroku_meta.gemspec
+- spec/rack_heroku_meta_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+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: -2478329712318999610
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2478329712318999610
+requirements: []
+rubyforge_project: rack_heroku_meta
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Rack middleware for checking the process commit hash on Heroku
+test_files: []