rack-request-id 0.0.3 → 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: be032e96fd59cbc3453055028201c428fe7d923d
+  data.tar.gz: fc8581bede6f4e0d096ccc3b8818e296167266d6
+SHA512:
+  metadata.gz: 34e1986d41b481640ccb6a8eaafdce29c27387bd5014d22738cf0776e86430c6129c339b04948e01e501a3bb8f705e6613d8f6edf15eacba9e110e3ac7f2d065
+  data.tar.gz: f0d77d11f819298ae756377a6100fc46870739d27131bc23804e874383bc69c95bb2eeab174bd30ce0625d0886b92c0c1c0e43669117ce5b3cbb3695f945724d

data/Gemfile

@@ -2,3 +2,10 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rack-request-id.gemspec
 gemspec
+
+group :test do
+  gem 'rack'
+  gem 'rack-test'
+  gem 'rspec'
+  gem 'sinatra'
+end

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Brian Racer
+
+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

@@ -30,7 +30,23 @@ end
 
 ## Configuration
 
-TODO: proc option to override id format
+Optionally you can override the ID generation `proc`. By default it's `SecureRandom.hex(16)`.
+
+```ruby
+class MyApp < Sinatra::Base
+  use Rack::RequestId, id_generator: proc { SecureRandom.random_number(100) }
+end
+```
+
+Optionally you can also change storage. Storage objects must have `#[]` and `#[]=` method.
+
+```ruby
+require 'request_store'
+
+class MyApp < Sinatra::Base
+  use Rack::RequestId, storage: RequestStore
+end
+```
 
 ## Contributing
 
@@ -39,3 +55,4 @@ TODO: proc option to override id format
 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/lib/rack-request-id/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class RequestId
-    VERSION = "0.0.3"
+    VERSION = "0.0.4"
   end
 end

data/lib/rack/request_id.rb

@@ -2,14 +2,17 @@ require 'securerandom'
 
 module Rack
   class RequestId
-    def initialize(app)
+    def initialize(app, opts = {})
       @app = app
+      @storage = opts[:storage] || proc { Thread.current }
+      @id_generator = opts[:id_generator] || proc { SecureRandom.hex(16) }
     end
 
     def call(env)
-      Thread.current[:request_id] = env['HTTP_X_REQUEST_ID'] || SecureRandom.hex(16)
+      storage = @storage.respond_to?(:call) ? @storage.call : @storage
+      storage[:request_id] = env['HTTP_X_REQUEST_ID'] || @id_generator.call
       status, headers, body = @app.call(env)
-      headers['X-Request-Id'] ||= Thread.current[:request_id]
+      headers['X-Request-Id'] ||= storage[:request_id]
       [status, headers, body]
     end
   end

data/rack-request-id.gemspec

@@ -11,6 +11,7 @@ Gem::Specification.new do |gem|
   gem.description   = %q{Request ID Header}
   gem.summary       = %q{Adds a 16-digit hexidecimal X-Request-Id header if none exists.}
   gem.homepage      = "https://github.com/anveo/rack-request-id"
+  gem.license       = 'MIT'
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/spec/integration/sinatra_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+module SinatraSpec
+
+  class TestApp < Sinatra::Base
+    use Rack::RequestId
+    get('/') { status(200) }
+  end
+
+  class TestAppWithCustomId < Sinatra::Base
+    use Rack::RequestId, id_generator: proc { "foobar" }
+    get('/') { status(200) }
+  end
+
+  class TestAppWithMyStorage < Sinatra::Base
+    use Rack::RequestId, storage: MyStorage
+    get('/') { status(200) }
+  end
+
+  describe Rack::RequestId do
+    include Rack::Test::Methods
+
+    context 'default storage' do
+      let(:app) { TestApp.new }
+
+      it 'adds an X-Request-Id header to the response' do
+        get '/'
+        expect(last_response["X-Request-Id"]).to_not be_nil
+      end
+    end
+
+    context 'with other storage' do
+      let(:app) { TestAppWithMyStorage.new }
+
+      it 'adds an X-Request-Id header to the response' do
+        get '/'
+        expect(last_response["X-Request-Id"]).to_not be_nil
+      end
+    end
+
+    context 'with custom id generator' do
+      let(:app) { TestAppWithCustomId.new }
+
+      it 'matches the custom id' do
+        get '/'
+        expect(last_response["X-Request-Id"]).to eq("foobar")
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'rspec'
+require 'rack'
+require 'rack/test'
+require 'sinatra/base'
+
+$:.push(File.expand_path(File.dirname(__FILE__)))
+$:.push(File.expand_path(File.dirname(__FILE__)) + '/../lib')
+
+require 'rack-request-id'
+
+class MyStorage
+  class << self
+    def [](k)
+      storage[k]
+    end
+
+    def []=(k, v)
+      storage[k] =v
+    end
+
+    private
+
+    def storage
+      Thread.current[:my_storage] ||= {}
+    end
+  end
+end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-request-id
 version: !ruby/object:Gem::Version
-  prerelease: 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Brian Racer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-19 00:00:00.000000000 Z
+date: 2016-03-24 00:00:00.000000000 Z
 dependencies: []
 description: Request ID Header
 email:
@@ -18,37 +17,41 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
 - lib/rack-request-id.rb
 - lib/rack-request-id/version.rb
 - lib/rack/request_id.rb
 - rack-request-id.gemspec
+- spec/integration/sinatra_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/anveo/rack-request-id
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Adds a 16-digit hexidecimal X-Request-Id header if none exists.
-test_files: []
+test_files:
+- spec/integration/sinatra_spec.rb
+- spec/spec_helper.rb

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2013 Brian Racer
-
-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.