heroku-request-id 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jeremy Green
+
+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,29 @@
+# Heroku::Request::Id
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'heroku-request-id'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install heroku-request-id
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/heroku-request-id.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'heroku-request-id/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "heroku-request-id"
+  spec.version       = HerokuRequestId::VERSION
+  spec.authors       = ["Jeremy Green"]
+  spec.email         = ["jeremy@octolabs.com"]
+  spec.description   = %q{Simple Rack middleware to log the heroku request id and write it to the end of html requests. Both optionally, of course.}
+  spec.summary       = %q{Simple Rack middleware to log the heroku request id and write it to the end of html requests. Both optionally, of course.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rack-test"
+end

data/lib/heroku-request-id.rb

@@ -0,0 +1,7 @@
+require "heroku-request-id/version"
+require "heroku-request-id/middleware"
+require "heroku-request-id/railtie" if defined?(Rails::Railtie)
+
+module HerokuRequestId
+
+end

data/lib/heroku-request-id/middleware.rb

@@ -0,0 +1,50 @@
+module HerokuRequestId
+  class Middleware
+
+    def initialize(app)
+        @app = app
+        html_comment = true
+    end
+
+    @@html_comment = true
+
+    def self.html_comment
+      @@html_comment
+    end
+
+    def self.html_comment= hc
+      @@html_comment = hc
+    end
+
+    @@log_line = false
+
+    def self.log_line
+      @@log_line
+    end
+
+    def self.log_line= hc
+      @@log_line = hc
+    end
+
+    def call(env)
+      @start = Time.now
+      @request_id = env['HTTP_HEROKU_REQUEST_ID']
+      @status, @headers, @response = @app.call(env)
+      @stop = Time.now
+      @elapsed = @stop - @start
+      if self.class.log_line
+        $stdout.puts("heroku-request-id=#{env['HTTP_HEROKU_REQUEST_ID']} measure=\"rack-request\" elapsed=#{@elapsed}")
+      end
+      [@status, @headers, self]
+    end
+
+    def each(&block)
+      puts "html_comment = #{self.class.html_comment}"
+      if self.class.html_comment && @headers["Content-Type"].include?("text/html")
+        block.call("<!-- Heroku request id : #{@request_id} - Elapsed time : #{@elapsed} -->\n")
+      end
+      @response.each(&block)
+    end
+
+  end
+end

data/lib/heroku-request-id/railtie.rb

@@ -0,0 +1,7 @@
+module HerokuRequestId
+  class Railtie < Rails::Railtie
+    initializer 'heroku_request_id.add_middleware' do |app|
+      app.config.middleware.insert_after 'Rack::Lock', "HerokuRequestId::Middleware"
+    end
+  end
+end

data/lib/heroku-request-id/version.rb

@@ -0,0 +1,3 @@
+module HerokuRequestId
+  VERSION = "0.0.1"
+end

data/spec/heroku-request-id/middleware_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe HerokuRequestId::Middleware do
+
+  include Rack::Test::Methods
+
+  let(:inner_app) do
+      lambda { |env| [200, {'Content-Type' => 'text/html'}, ['<body>All good!</body>']] }
+  end
+
+  let(:app) { HerokuRequestId::Middleware.new(inner_app) }
+
+  it "prints the request id to stdout if log_line == true" do
+    HerokuRequestId::Middleware.log_line = true
+    output = capture_stdout { get "/" }
+    output.should match("heroku-request-id")
+    # reset html_comment so that random test order works
+    HerokuRequestId::Middleware.log_line = false
+  end
+
+  it "does not print the request id to stdout by default" do
+    output = capture_stdout { get "/" }
+    output.should_not match("heroku-request-id")
+  end
+
+  it "adds a comment with the Heroku request id" do
+    capture_stdout { get "/" }
+    last_response.body.should match("Heroku request id")
+  end
+
+  it "does not add a comment with the Heroku request id if html_comment == false" do
+    HerokuRequestId::Middleware.html_comment = false
+    capture_stdout { get "/" }
+    last_response.body.should_not match("Heroku request id")
+    # reset html_comment so that random test order works
+    HerokuRequestId::Middleware.html_comment = true
+  end
+
+  it "makes no change to response status" do
+    capture_stdout { get "/" }
+    last_response.should be_ok
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require "#{File.dirname(__FILE__)}/../lib/heroku-request-id"
+require "#{File.dirname(__FILE__)}/support/capture_stdout"
+require 'rack/test'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/support/capture_stdout.rb

@@ -0,0 +1,10 @@
+def capture_stdout(&block)
+  original_stdout = $stdout
+  $stdout = fake = StringIO.new
+  begin
+    yield
+  ensure
+    $stdout = original_stdout
+  end
+  fake.string
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: heroku-request-id
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jeremy Green
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  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: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple Rack middleware to log the heroku request id and write it to the
+  end of html requests. Both optionally, of course.
+email:
+- jeremy@octolabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- heroku-request-id.gemspec
+- lib/heroku-request-id.rb
+- lib/heroku-request-id/middleware.rb
+- lib/heroku-request-id/railtie.rb
+- lib/heroku-request-id/version.rb
+- spec/heroku-request-id/middleware_spec.rb
+- spec/spec_helper.rb
+- spec/support/capture_stdout.rb
+homepage: ''
+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: '0'
+      segments:
+      - 0
+      hash: 1702138710006759316
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1702138710006759316
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Simple Rack middleware to log the heroku request id and write it to the end
+  of html requests. Both optionally, of course.
+test_files:
+- spec/heroku-request-id/middleware_spec.rb
+- spec/spec_helper.rb
+- spec/support/capture_stdout.rb