rack-requestid 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 05cb5461dd64235e8c10705dfff1a7f029769f7b
+  data.tar.gz: 0fcbb9da47dbfad13a2362748b674e240110beb3
+SHA512:
+  metadata.gz: 95860cc5316b6f625e762f127f13c432747b18734ec531c776cf3f7d7ae3a3925b523a93605287b28dca145026a563ecc0f368f4b103d62a2a7f6277e4e5a75b
+  data.tar.gz: 06cdf2688ce0351d92189d7b46a6eccb2a8d354b15bba90387ef8dbcff2ccf52a091ab9c4c628f09a87800548c8514d3b59d7ea747daac20949e911e9bbf2214

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/README.md

@@ -0,0 +1,33 @@
+# Rack::RequestID, a Rack middleware for generating request IDs
+
+This is a simple middleware that will generate a request GUID if one was not 
+already provided by the client or platform. 
+
+A request ID can be specified in the request (by the client or platform) by
+setting the `X-Request-Id` header, and it will be available to other middleware
+via the `HTTP_X_REQUEST_ID` key in the Rack environment hash. If a request ID
+was not provided, Rack::RequestID will generate one and insert it into the Rack
+environment. It will also insert the request ID into the `X-Request-Id` header
+of the response. 
+
+## Configuration
+
+To use Rack::RequestID, add the following to your Gemfile:
+
+	gem 'rack-requestid', :github => 'dancavallaro/rack-requestid'
+
+Then in `config.ru`:
+
+	use Rack::RequestID
+
+Use Rack::RequestID before any middleware that needs a request ID. 
+
+There are a few options you can pass in:
+
+  * `:include_response_header` determines whether to include the request ID in a response header.
+  * `:overwrite` can be enabled to overwrite any request ID provided by the platform or client.
+  * `:generator` can be specified to provide a custom request ID generator.
+
+If you want to modify the options used, simply do:
+
+    use Rack::RequestID, :include_response_header => false, :generator => lambda { "#{Time.now.getutc.to_i}" }

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/lib/rack/request_id.rb

@@ -0,0 +1,33 @@
+require 'securerandom'
+
+module Rack
+  class RequestID
+
+    REQUEST_ID_HEADER = 'X-Request-Id'
+    REQUEST_ID_KEY = 'HTTP_X_REQUEST_ID'
+
+    def initialize(app, options={})
+      @app = app
+
+      @include_response_header = options.fetch(:include_response_header, true)
+      @overwrite = options.fetch(:overwrite, false)
+      @generator = options[:generator] || lambda { SecureRandom.uuid }
+    end
+
+    def call(env)
+      if !env.key?(REQUEST_ID_KEY) || @overwrite
+        request_id = @generator.call
+        env[REQUEST_ID_KEY] = request_id
+      end
+
+      status, headers, body = @app.call(env)
+
+      if @include_response_header
+        headers[REQUEST_ID_HEADER] = env[REQUEST_ID_KEY]
+      end
+
+      [status, headers, body]
+    end
+
+  end
+end

data/rack-requestid.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name = 'rack-requestid'
+  s.version = '0.1'
+  s.summary = 'Middleware for generating request IDs.'
+  s.description = 'Rack::RequestID is a Rack middleware for generating request IDs. It generates a request GUID for every request (if one was not already provided) and inserts the request ID as a response header.'
+  s.author = 'Dan Cavallaro'
+  s.email = 'dan.t.cavallaro@gmail.com'
+  s.homepage = 'https://github.com/dancavallaro/rack-requestid'
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- spec/*`.split("\n")
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rack'
+  s.add_development_dependency 'rake'
+end

data/spec/requestid_spec.rb

@@ -0,0 +1,68 @@
+require 'yaml'
+
+REQUEST_ID_HEADER = 'X-Request-Id'
+REQUEST_ID_KEY = 'HTTP_X_REQUEST_ID'
+
+TEST_REQUEST_ID = '00000000-0000-0000-0000-000000000000'
+
+describe Rack::RequestID do
+
+  let(:app) { lambda { |env| [200, {}, [env.to_yaml]] } }
+  let(:stack) { Rack::RequestID.new app }
+  let(:request) { Rack::MockRequest.new stack }
+
+  it "should generate random request IDs" do
+    first_requestid = get_id_from_response request.get('/')
+    second_requestid = get_id_from_response request.get('/')
+
+    expect(first_requestid).not_to eq(second_requestid)
+  end
+
+  it "should return the request ID in the response headers" do
+    response = request.get '/'
+    requestid = get_id_from_response(response)
+
+    expect(response.headers[REQUEST_ID_HEADER]).to eq(requestid)
+  end
+
+  it "should not overwrite existing request ID" do
+    response = request.get '/', REQUEST_ID_KEY => TEST_REQUEST_ID
+
+    expect(get_id_from_response(response)).to eq(TEST_REQUEST_ID)
+  end
+
+  context "when header disabled" do
+    let(:stack) { Rack::RequestID.new app, :include_response_header => false }
+
+    it "should not insert response header" do
+      response = request.get '/'
+
+      expect(response.headers).not_to have_key(REQUEST_ID_HEADER)
+    end
+  end
+
+  context "when using custom generator" do
+    let(:stack) { Rack::RequestID.new app, :generator => lambda { TEST_REQUEST_ID } }
+
+    it "should use correct request ID" do
+      requestid = get_id_from_response request.get('/')
+
+      expect(requestid).to eq(TEST_REQUEST_ID)
+    end
+  end
+
+  context "when overwriting request ID" do
+    let(:stack) { Rack::RequestID.new app, :overwrite => true }
+    
+    it "should overwrite request ID" do
+      response = request.get '/', REQUEST_ID_KEY => TEST_REQUEST_ID
+
+      expect(get_id_from_response(response)).not_to eq(TEST_REQUEST_ID)
+    end
+  end
+
+  def get_id_from_response(response)
+    YAML.load(response.body)[REQUEST_ID_KEY]
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'rack/mock'
+require 'rack/request_id'

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: rack-requestid
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Dan Cavallaro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rack::RequestID is a Rack middleware for generating request IDs. It generates
+  a request GUID for every request (if one was not already provided) and inserts the
+  request ID as a response header.
+email: dan.t.cavallaro@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- README.md
+- Rakefile
+- lib/rack/request_id.rb
+- rack-requestid.gemspec
+- spec/requestid_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/dancavallaro/rack-requestid
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.4
+signing_key: 
+specification_version: 4
+summary: Middleware for generating request IDs.
+test_files:
+- spec/requestid_spec.rb
+- spec/spec_helper.rb