request_store 1.3.2 → 1.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 057f28c37dcfc7b49f7443c8440af572892672ee
+  data.tar.gz: b5d14983640d8e012ca2c153e2b8dddaa6ace337
+SHA512:
+  metadata.gz: cea24b9f63fa74fc0b0235d155133932fc018934b64dae3256266a320f060e2f10b004b48735926caaeacf64d28f5fcad336f3df4c5c436994a9c02ac5651994
+  data.tar.gz: 502ed5cb5807e7066fc3d2a0ac7d7f0d768af7f53c88f96e43c384ca57cfb9a371230f09c98692a8441c74e87c2402d68f09e48dc6aa8ba461892efc6af415c2

data/.travis.yml

@@ -9,7 +9,6 @@ rvm:
   - 2.2.3
   - jruby-18mode
   - jruby-19mode
-  - rbx-2
   - ruby-head
   - jruby-head
   - ree

data/README.md

@@ -27,7 +27,7 @@ our controller:
 def index
   Thread.current[:counter] ||= 0
   Thread.current[:counter] += 1
-  
+
   render :text => Thread.current[:counter]
 end
 ```
@@ -97,6 +97,17 @@ def app
 end
 ```
 
+## Using with Sidekiq
+
+This gem uses a Rack middleware to clear the store object after every request,
+but that doesn't translate well to background processing with
+[Sidekiq](https://github.com/mperham/sidekiq).
+
+A companion library,
+[request_store-sidekiq](https://rubygems.org/gems/request_store-sidekiq)
+creates a Sidekiq middleware that will ensure the store is cleared after each
+job is processed, for security and consistency with how this is done in Rack.
+
 ## Semantic Versioning
 
 This project conforms to [semver](http://semver.org/). As a result of this

data/lib/request_store/middleware.rb

@@ -1,3 +1,12 @@
+require 'rack/body_proxy'
+
+# A middleware that ensures the RequestStore stays around until
+# the last part of the body is rendered. This is useful when
+# using streaming.
+#
+# Uses Rack::BodyProxy, adapted from Rack::Lock's usage of the
+# same pattern.
+
 module RequestStore
   class Middleware
     def initialize(app)
@@ -6,10 +15,18 @@ module RequestStore
 
     def call(env)
       RequestStore.begin!
-      @app.call(env)
+
+      response = @app.call(env)
+
+      returned = response << Rack::BodyProxy.new(response.pop) do
+        RequestStore.end!
+        RequestStore.clear!
+      end
     ensure
-      RequestStore.end!
-      RequestStore.clear!
+      unless returned
+        RequestStore.end!
+        RequestStore.clear!
+      end
     end
   end
 end

data/lib/request_store/version.rb

@@ -1,3 +1,3 @@
 module RequestStore
-  VERSION = "1.3.2"
+  VERSION = "1.4.0"
 end

data/request_store.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
+  gem.add_dependency "rack", ">= 1.4"
+
   gem.add_development_dependency "rake", "~> 10.5"
   gem.add_development_dependency "minitest", "~> 5.0"
 end

data/test/middleware_test.rb

@@ -9,8 +9,15 @@ class MiddlewareTest < Minitest::Test
     @middleware = RequestStore::Middleware.new(@app)
   end
 
+  def call_middleware(opts = {})
+    _, _, proxy = @middleware.call(opts)
+    proxy.close
+  end
+
   def test_middleware_resets_store
-    2.times { @middleware.call({}) }
+    2.times do
+      call_middleware
+    end
 
     assert_equal 1, @app.last_value
     assert_equal({}, RequestStore.store)
@@ -18,7 +25,7 @@ class MiddlewareTest < Minitest::Test
 
   def test_middleware_resets_store_on_error
     e = assert_raises RuntimeError do
-      @middleware.call({:error => true})
+      call_middleware({:error => true})
     end
 
     assert_equal 'FAIL', e.message
@@ -26,20 +33,33 @@ class MiddlewareTest < Minitest::Test
   end
 
   def test_middleware_begins_store
-    @middleware.call({})
+    call_middleware
     assert_equal true, @app.store_active
   end
 
   def test_middleware_ends_store
-    @middleware.call({})
+    call_middleware
+
     assert_equal false, RequestStore.active?
   end
 
   def test_middleware_ends_store_on_error
     assert_raises RuntimeError do
-      @middleware.call({:error => true})
+      call_middleware({:error => true})
     end
 
     assert_equal false, RequestStore.active?
   end
+
+  def test_middleware_stores_until_proxy_closes
+    _, _, proxy = @middleware.call({})
+
+    assert_equal 1, @app.last_value
+    assert RequestStore.active?
+
+    proxy.close
+
+    refute RequestStore.active?
+    refute RequestStore.store[:foo]
+  end
 end

data/test/request_store_test.rb

@@ -7,6 +7,10 @@ class RequestStoreTest < Minitest::Test
     RequestStore.clear!
   end
 
+  def teardown
+    RequestStore.clear!
+  end
+
   def test_initial_state
     Thread.current[:request_store] = nil
     assert_equal RequestStore.store, Hash.new

data/test/test_helper.rb

@@ -7,5 +7,7 @@ class RackApp
     @last_value = RequestStore.store[:foo]
     @store_active = RequestStore.active?
     raise 'FAIL' if env[:error]
+
+    [200, {}, ["response"]]
   end
 end

metadata

@@ -1,46 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: request_store
 version: !ruby/object:Gem::Version
-  version: 1.3.2
-  prerelease: 
+  version: 1.4.0
 platform: ruby
 authors:
 - Steve Klabnik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-05 00:00:00.000000000 Z
+date: 2018-01-01 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.5'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
 description: RequestStore gives you per-request global storage.
@@ -50,8 +59,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -67,33 +76,26 @@ files:
 homepage: http://github.com/steveklabnik/request_store
 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'
-      segments:
-      - 0
-      hash: 431099191289644974
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 431099191289644974
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.5.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: RequestStore gives you per-request global storage.
 test_files:
 - test/middleware_test.rb