store_request_id 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 702a1513bf551bd5bbfe518ae97102264aced8ab
-  data.tar.gz: e44507d7f4a3cbf94e1066de1483048005071354
+  metadata.gz: f80dbf0c478751acf453336292f7386c18da2834
+  data.tar.gz: '088b0d5427e897848c1c3a2186059fd4f6af6135'
 SHA512:
-  metadata.gz: e993c38a997be8dba0b3457a29530467c2b8d790ecced914249dcc2a3a732fb1e1b4ae26a710fb92fdd81ab13f82138339d614f509b533a8774ed282b26a7c70
-  data.tar.gz: b94ddc115950f240e15410ad15909c78c8ea4ec0bcf56fdcb4189347ec124539f17cae0ec376fdeeed2fa662e0fa67c60a8fe53b2a08fb95acc3b53464a06808
+  metadata.gz: 709a4e192b30035d64d51682410962eea2e38a4d5fc182f8cad91684b54f2c92722746b44fa6c5ee1d928599001b4e39c1c735886e0f99c8456dc9f5251e1516
+  data.tar.gz: 63fca3c31a7aed76ce5ca68397f38b8c735f6e7921c397a5a05f85b7c0a481d4a11fdc0c982f810cd47909d4461b9ed57c5f2d60b63f88755988c41f493c41a9

data/CHANGELOG.md

@@ -1,4 +1,13 @@
-## [0.1.0](https://github.com/SparkHub/gs-store-reqeust-id/tree/v0.1.0) (2017-08-11)
+# Change Log
+
+## [0.2.0](https://github.com/SparkHub/gs-store-request-id/tree/v0.2.0) (2017-08-14)
+[Full Changelog](https://github.com/SparkHub/gs-store-request-id/compare/v0.1.0...v0.2.0)
+
+**Implemented enhancements:**
+- Data storage is now configurable ([mchaisse](https://github.com/mchaisse))
+- Remove `RequestStore` dependency ([mchaisse](https://github.com/mchaisse))
+
+## [0.1.0](https://github.com/SparkHub/gs-store-request-id/tree/v0.1.0) (2017-08-11)
 
 **Implemented enhancements:**
 - Initial version :tada: ([mchaisse](https://github.com/mchaisse))

data/Gemfile

@@ -10,5 +10,6 @@ end
 
 group :test do
   gem 'codeclimate-test-reporter', require: false if RUBY_VERSION >= '2.0'
+  gem 'request_store', '>= 1.1'
   gem 'simplecov', require: false
 end

data/README.md

@@ -1,4 +1,4 @@
-[![Gem Version](https://badge.fury.io/rb/gs-store-request-id.svg)](http://badge.fury.io/rb/gs-store-request-id)
+[![Gem Version](https://badge.fury.io/rb/store_request_id.svg)](http://badge.fury.io/rb/store_request_id)
 [![Build Status](https://travis-ci.org/SparkHub/gs-store-request-id.svg?branch=master)](https://travis-ci.org/SparkHub/gs-store-request-id)
 [![Code Climate](https://codeclimate.com/github/SparkHub/gs-store-request-id/badges/gpa.svg)](https://codeclimate.com/github/SparkHub/gs-store-request-id)
 [![Test Coverage](https://codeclimate.com/github/SparkHub/gs-store-request-id/badges/coverage.svg)](https://codeclimate.com/github/SparkHub/gs-store-request-id/coverage)
@@ -7,14 +7,14 @@
 
 # StoreRequestId
 
-Middleware storing the unique [requestId](https://github.com/rails/rails/blob/master/actionpack/lib/action_dispatch/middleware/request_id.rb) into a [RequestStore](https://github.com/steveklabnik/request_store) in order to access it anytime.
+Middleware storing the unique [requestId](https://github.com/rails/rails/blob/master/actionpack/lib/action_dispatch/middleware/request_id.rb) into a global value in order to access it anytime.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'store_request_id', '~> 0.1.0'
+gem 'store_request_id', '~> 0.2.0'
 ```
 
 And then execute:
@@ -29,15 +29,36 @@ _**Using without rails:** If you're not using Rails, you need to insert `StoreRe
 
 ## Usage
 
-By default, `RequestStore` will be used as a data store. The `request_id` will be stored within a `:x_request_id` key. This value can be accessed wherever in the code with `StoreRequestId.request_id`.
+By default, `Thread.current` will be used as a data store. The `request_id` will be stored within a `:x_request_id` key. This value can be accessed wherever in the code with `StoreRequestId.request_id`.
+
+## Configuration
+
+- **Storage object**
+
+The storage can be changed. Storage objects must have `[]` and `[]=` methods. A proc should be sent to the configuration.
+Here is an example with the [RequestStore gem](https://github.com/steveklabnik/request_store).
+```ruby
+# RequestStore needs to be installed prior
+# Gemfile
+gem 'request_store', '~> 1.1'
+
+# config/initializers/store_request_id.rb
+StoreRequestId.configuration.storage = proc { RequestStore }
+# OR
+StoreRequestId.configure do |config|
+  config.storage = proc { RequestStore }
+end
+```
+
+- **Storage key**
 
 If for some reason you want to personalize that key (collision for example), you can do so with:
 ```ruby
 # config/initializers/store_request_id.rb
-StoreRequestId.configuration.request_store_key = :my_key
+StoreRequestId.configuration.storage_key = :my_key
 # OR
 StoreRequestId.configure do |config|
-  config.request_store_key = :my_key
+  config.storage_key = :my_key
 end
 ```
 

data/lib/store_request_id/configuration.rb

@@ -1,23 +1,26 @@
 # frozen_string_literal: true
 
+require_relative 'defaults/storage'
+
 module StoreRequestId
+  # :reek:Attribute
+  # :reek:InstanceVariableAssumption
   class Configuration
-    # :reek:Attribute
-    attr_accessor :request_store_key
-
-    private
+    attr_accessor :storage_key
 
-    def initialize
-      self.request_store_key = store_key
+    def storage
+      @storage.caller
     end
 
-    def header_key
-      request_id_class = ::ActionDispatch::RequestId
-      defined?(request_id_class::X_REQUEST_ID) ? request_id_class::X_REQUEST_ID : 'X-Request-Id'
+    def storage=(store)
+      @storage = Store.new(store)
     end
 
-    def store_key
-      header_key.downcase.tr('-', '_').to_sym
+    private
+
+    def initialize
+      self.storage_key = Defaults::Storage.generate_key
+      self.storage     = proc { Thread.current }
     end
   end
 end

data/lib/store_request_id/defaults/storage.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module StoreRequestId
+  module Defaults
+    module Storage
+      DEFAULT_KEY = 'X-Request-Id'.freeze
+      private_constant :DEFAULT_KEY
+
+      class << self
+        def generate_key
+          header_key.downcase.tr('-', '_').to_sym
+        end
+
+        private
+
+        def header_key
+          request_id_class = ::ActionDispatch::RequestId
+          defined?(request_id_class::X_REQUEST_ID) ? request_id_class::X_REQUEST_ID : DEFAULT_KEY
+        end
+      end
+    end
+  end
+end

data/lib/store_request_id/request_id.rb

@@ -3,11 +3,21 @@
 module StoreRequestId
   module RequestId
     def request_id
-      RequestStore[configuration.request_store_key]
+      storage[storage_key]
     end
 
     def request_id=(value)
-      RequestStore[configuration.request_store_key] = value
+      storage[storage_key] = value
+    end
+
+    private
+
+    def storage
+      configuration.storage
+    end
+
+    def storage_key
+      configuration.storage_key
     end
   end
 end

data/lib/store_request_id/store.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'delegate'
+
+module StoreRequestId
+  class Store < SimpleDelegator
+    # :reek:ManualDispatch
+    def caller
+      respond_to?(:call) ? call : self
+    end
+  end
+end

data/lib/store_request_id/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StoreRequestId
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/lib/store_request_id.rb

@@ -2,6 +2,7 @@
 
 require 'store_request_id/version'
 require 'store_request_id/setup'
+require 'store_request_id/store'
 require 'store_request_id/request_id'
 
 module StoreRequestId

data/store_request_id.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Guidespark', 'Maxime Chaisse-Leal']
   spec.email         = ['sysadmin@guidespark.com', 'maxime.chaisseleal@gmail.com']
 
-  spec.summary       = 'Store the unique request id within a global state (RequestStore).'
-  spec.description   = 'Store the unique request id within a global state (RequestStore).'
+  spec.summary       = 'Store the unique request id within a global state.'
+  spec.description   = 'Store the unique request id within a global state.'
   spec.homepage      = 'https://github.com/SparkHub/gs-store-request-id'
   spec.license       = 'MIT'
 
@@ -24,7 +24,6 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'actionpack', '>= 3.0.2'
   spec.add_dependency 'activesupport', RUBY_VERSION >= '2.2.2' ? '>= 3.0.2' : '< 5.1.3'
-  spec.add_dependency 'request_store', '>= 1.1'
 
   spec.add_development_dependency 'bundler', '~> 1.14'
   spec.add_development_dependency 'rake', '~> 10.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: store_request_id
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Guidespark
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-11 00:00:00.000000000 Z
+date: 2017-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -39,20 +39,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.2
-- !ruby/object:Gem::Dependency
-  name: request_store
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -95,7 +81,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Store the unique request id within a global state (RequestStore).
+description: Store the unique request id within a global state.
 email:
 - sysadmin@guidespark.com
 - maxime.chaisseleal@gmail.com
@@ -119,10 +105,12 @@ files:
 - bin/setup
 - lib/store_request_id.rb
 - lib/store_request_id/configuration.rb
+- lib/store_request_id/defaults/storage.rb
 - lib/store_request_id/middleware.rb
 - lib/store_request_id/rails.rb
 - lib/store_request_id/request_id.rb
 - lib/store_request_id/setup.rb
+- lib/store_request_id/store.rb
 - lib/store_request_id/version.rb
 - store_request_id.gemspec
 homepage: https://github.com/SparkHub/gs-store-request-id
@@ -148,5 +136,5 @@ rubyforge_project:
 rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: Store the unique request id within a global state (RequestStore).
+summary: Store the unique request id within a global state.
 test_files: []