store_request_id 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 702a1513bf551bd5bbfe518ae97102264aced8ab
+  data.tar.gz: e44507d7f4a3cbf94e1066de1483048005071354
+SHA512:
+  metadata.gz: e993c38a997be8dba0b3457a29530467c2b8d790ecced914249dcc2a3a732fb1e1b4ae26a710fb92fdd81ab13f82138339d614f509b533a8774ed282b26a7c70
+  data.tar.gz: b94ddc115950f240e15410ad15909c78c8ea4ec0bcf56fdcb4189347ec124539f17cae0ec376fdeeed2fa662e0fa67c60a8fe53b2a08fb95acc3b53464a06808

data/.codeclimate.yml

@@ -0,0 +1,27 @@
+---
+engines:
+  reek:
+    enabled: true
+  duplication:
+    enabled: true
+    config:
+      languages:
+        ruby:
+          mass_threshold: 26
+  fixme:
+    enabled: true
+    checks:
+      TODO:
+        enabled: false
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - Gemfile.lock
+  - '**.erb'
+  - '**.rb'
+exclude_paths:
+- spec/
+- config/
+- db/
+- vendor/

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store
+# rspec failure tracking
+.rspec_status

data/.reek

@@ -0,0 +1,14 @@
+---
+TooManyStatements:
+  enabled: true
+  max_statements: 10
+
+# Directories below will not be scanned at all
+exclude_paths:
+  - spec
+
+LongParameterList:
+  max_params: 4
+
+IrresponsibleModule:
+  enabled: false

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,25 @@
+AllCops:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 15
+
+Metrics/BlockLength:
+  Exclude:
+    - '*.gemspec'
+
+Style/Documentation:
+  Enabled: false
+
+# fix for codeclimate
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    default: ()
+    '%i': '[]'
+    '%w': '[]'
+    '%W': '[]'

data/.travis.yml

@@ -0,0 +1,24 @@
+sudo: false
+language: ruby
+
+rvm:
+  - 2.0.0
+  - 2.1.2
+  - 2.2.3
+  - 2.3.1
+  - 2.4.1
+
+addons:
+  code_climate:
+    repo_token: 682975bb1f8c2c0c4b854034c70744758c50c832e28c563d8a7e7bdabf821e34
+
+before_install: gem install bundler -v 1.15.3
+
+cache:
+  - bundler
+
+script:
+  - bundle exec rake
+
+after_success:
+  - bundle exec codeclimate-test-reporter

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## [0.1.0](https://github.com/SparkHub/gs-store-reqeust-id/tree/v0.1.0) (2017-08-11)
+
+**Implemented enhancements:**
+- Initial version :tada: ([mchaisse](https://github.com/mchaisse))

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at sysadmin@guidespark.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in store_request_id.gemspec
+gemspec
+
+group :development, :test do
+  gem 'reek', RUBY_VERSION >= '2.1.0' ? '>= 4' : '< 4', require: false
+  gem 'rubocop', RUBY_VERSION >= '2.0.0' ? '>= 0.48.1' : '< 0.48.1', require: false
+end
+
+group :test do
+  gem 'codeclimate-test-reporter', require: false if RUBY_VERSION >= '2.0'
+  gem 'simplecov', require: false
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Maxime Chaisse-Leal
+
+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,66 @@
+[![Gem Version](https://badge.fury.io/rb/gs-store-request-id.svg)](http://badge.fury.io/rb/gs-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)
+[![Issue Count](https://codeclimate.com/github/SparkHub/gs-store-request-id/badges/issue_count.svg)](https://codeclimate.com/github/SparkHub/gs-store-request-id)
+[![Dependency Status](https://gemnasium.com/SparkHub/gs-store-request-id.svg)](https://gemnasium.com/SparkHub/gs-store-request-id)
+
+# 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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'store_request_id', '~> 0.1.0'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install store_request_id
+
+_**Using without rails:** If you're not using Rails, you need to insert `StoreRequestId::Middleware` into your middleware stack._
+
+## 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`.
+
+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
+# OR
+StoreRequestId.configure do |config|
+  config.request_store_key = :my_key
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Running CI tools
+
+To run rubocop:
+
+    $ rubocop
+
+To run reek:
+
+    $ reek
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/SparkHub/gs-store-request-id. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'store_request_id'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/store_request_id/configuration.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module StoreRequestId
+  class Configuration
+    # :reek:Attribute
+    attr_accessor :request_store_key
+
+    private
+
+    def initialize
+      self.request_store_key = store_key
+    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'
+    end
+
+    def store_key
+      header_key.downcase.tr('-', '_').to_sym
+    end
+  end
+end

data/lib/store_request_id/middleware.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module StoreRequestId
+  class Middleware
+    def call(env)
+      req = ::ActionDispatch::Request.new(env)
+      StoreRequestId.request_id = req.uuid
+      @app.call(env)
+    end
+
+    private
+
+    def initialize(app)
+      @app = app
+    end
+  end
+end

data/lib/store_request_id/rails.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'store_request_id/middleware'
+
+module StoreRequestId
+  class Railtie < Rails::Railtie
+    initializer 'store_request_id.configure_rails_initialization' do
+      Rails.application.middleware.insert_after ActionDispatch::RequestId,
+                                                StoreRequestId::Middleware
+    end
+  end
+end

data/lib/store_request_id/request_id.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module StoreRequestId
+  module RequestId
+    def request_id
+      RequestStore[configuration.request_store_key]
+    end
+
+    def request_id=(value)
+      RequestStore[configuration.request_store_key] = value
+    end
+  end
+end

data/lib/store_request_id/setup.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative 'configuration'
+
+module StoreRequestId
+  module Setup
+    def configuration
+      @configuration ||= self::Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    private
+
+    attr_writer :configuration
+  end
+end

data/lib/store_request_id/version.rb

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

data/lib/store_request_id.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'store_request_id/version'
+require 'store_request_id/setup'
+require 'store_request_id/request_id'
+
+module StoreRequestId
+  extend Setup
+  extend RequestId
+end
+
+require 'store_request_id/rails' if defined?(Rails::Railtie)

data/store_request_id.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'store_request_id/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'store_request_id'
+  spec.version       = StoreRequestId::VERSION
+  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.homepage      = 'https://github.com/SparkHub/gs-store-request-id'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  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'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: store_request_id
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Guidespark
+- Maxime Chaisse-Leal
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Store the unique request id within a global state (RequestStore).
+email:
+- sysadmin@guidespark.com
+- maxime.chaisseleal@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".reek"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/store_request_id.rb
+- lib/store_request_id/configuration.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/version.rb
+- store_request_id.gemspec
+homepage: https://github.com/SparkHub/gs-store-request-id
+licenses:
+- MIT
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Store the unique request id within a global state (RequestStore).
+test_files: []