rails_request_id 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 79d78b84ba0c49ca76b10e4449d7c5c0ad9b6d6f
+  data.tar.gz: 2c2bfb3b9ec906329690033587668a89d4b661c9
+SHA512:
+  metadata.gz: 4680da2ee7e29d305359a6307af125a6c7af42867b8ab9e24552fb456a9323fb9c0d10b7eaf5edd273c4eb83e05450b7955cdd8c018e0c30d4c5dee860a52d6c
+  data.tar.gz: 943b3114d41f87e52c2523dc12470367d3c276bd0141611f5968c70010d7a6750caecbe95c1482f325717b1c0e762084def7260d335040c4fcaf92e445a4e966

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+rails_request_id

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p353

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+cache:
+  - bundler
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0

data/Gemfile

@@ -0,0 +1,11 @@
+source 'http://rubygems.org'
+gem 'activesupport', '~> 4.1.1'
+
+group :development do
+  gem 'rspec',      '~> 3.0.0'
+  gem 'rspec-its',  '~> 1.0.1'
+  gem 'rdoc',       '~> 3.12'
+  gem 'bundler',    '~> 1.0'
+  gem 'jeweler',    '~> 2.0.1'
+  gem 'simplecov',  '>= 0'
+end

data/Gemfile.lock

@@ -0,0 +1,92 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.1.1)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    addressable (2.3.6)
+    builder (3.2.2)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.7)
+    github_api (0.11.3)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.1)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 1.2)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.0)
+      oauth2
+    hashie (3.0.0)
+    highline (1.6.21)
+    i18n (0.6.9)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (1.0.0)
+    mini_portile (0.6.0)
+    minitest (5.3.5)
+    multi_json (1.10.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.2.1)
+      mini_portile (= 0.6.0)
+    oauth2 (0.9.4)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.3.2)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.2)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-its (1.0.1)
+      rspec-core (>= 2.99.0.beta1)
+      rspec-expectations (>= 2.99.0.beta1)
+    rspec-mocks (3.0.2)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.2)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    thread_safe (0.3.4)
+    tzinfo (1.2.1)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 4.1.1)
+  bundler (~> 1.0)
+  jeweler (~> 2.0.1)
+  rdoc (~> 3.12)
+  rspec (~> 3.0.0)
+  rspec-its (~> 1.0.1)
+  simplecov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Kunal Parikh
+
+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,19 @@
+#RailsRequestId [![Build Status](https://travis-ci.org/techthumb/rails_request_id.svg)](https://travis-ci.org/techthumb/rails_request_id)
+
+Web requests in Rails get assigned a unique request id.
+To access this id in a threadsafe manner, you can simply
+```
+::RailsRequestId.get
+```
+
+## Installation
+Add this to your Gemfile
+```ruby
+gem 'rails_request_id'
+```
+
+## Get in touch!
+If you're using ```rails_request_id```, I'd love to hear from you. Drop me a line and tell me what you think at: ```kunal+rails_request_id@techthumb.in```
+
+## Contributing
+It's on GitHub, you know what to do!

data/Rakefile

@@ -0,0 +1,42 @@
+# encoding: utf-8
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name        = "rails_request_id"
+  gem.homepage    = "http://github.com/techthumb/rails_request_id"
+  gem.license     = "MIT"
+  gem.summary     = %Q{Allows access to Rails' request_id from global scope in a threadsafe manner}
+  gem.description = %Q{Web requests in Rails get assigned a unique request id. To access this id in a threadsafe manner, you can simply call ```RailsRequestId.get```}
+  gem.email       = "kunal@techthumb.in"
+  gem.authors     = ["Kunal Parikh"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rails_request_id #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/rails_request_id.rb

@@ -0,0 +1,12 @@
+require 'active_support'
+require 'active_support/per_thread_registry'
+module RailsRequestId
+  def self.get
+    RailsRequestId::Registry.request_id
+  end
+end
+
+require 'rails_request_id/registry'
+require 'rails_request_id/middleware'
+require 'rails_request_id/initializer'
+require 'rails_request_id/railtie' if defined?(Rails)

data/lib/rails_request_id/initializer.rb

@@ -0,0 +1,5 @@
+class ::RailsRequestId::Initializer
+  def self.initialize(config)
+    config.app_middleware.insert_after ActionDispatch::RequestId, 'RailsRequestId::Middleware'
+  end
+end

data/lib/rails_request_id/middleware.rb

@@ -0,0 +1,13 @@
+class ::RailsRequestId::Middleware
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    ::RailsRequestId::Registry.request_id = env['action_dispatch.request_id']
+    puts ::RailsRequestId::Registry.request_id
+    @app.call(env)
+  ensure
+    ::RailsRequestId::Registry.request_id = nil
+  end
+end

data/lib/rails_request_id/railtie.rb

@@ -0,0 +1,5 @@
+class ::RailsRequestId::Railtie < ::Rails::Railtie
+  initializer :rails_request_id do
+    ::RailsRequestId::Initializer.initialize(config)
+  end
+end

data/lib/rails_request_id/registry.rb

@@ -0,0 +1,4 @@
+class ::RailsRequestId::Registry
+  extend ActiveSupport::PerThreadRegistry
+  attr_accessor :request_id
+end

data/rails_request_id.gemspec

@@ -0,0 +1,77 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: rails_request_id 0.1.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "rails_request_id"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Kunal Parikh"]
+  s.date = "2014-06-21"
+  s.description = "Web requests in Rails get assigned a unique request id. To access this id in a threadsafe manner, you can simply call ```RailsRequestId.get```"
+  s.email = "kunal@techthumb.in"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".ruby-gemset",
+    ".ruby-version",
+    ".travis.yml",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/rails_request_id.rb",
+    "lib/rails_request_id/initializer.rb",
+    "lib/rails_request_id/middleware.rb",
+    "lib/rails_request_id/railtie.rb",
+    "lib/rails_request_id/registry.rb",
+    "rails_request_id.gemspec",
+    "spec/middleware_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/techthumb/rails_request_id"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.3.0"
+  s.summary = "Allows access to Rails' request_id from global scope in a threadsafe manner"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, ["~> 4.1.1"])
+      s.add_development_dependency(%q<rspec>, ["~> 3.0.0"])
+      s.add_development_dependency(%q<rspec-its>, ["~> 1.0.1"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<activesupport>, ["~> 4.1.1"])
+      s.add_dependency(%q<rspec>, ["~> 3.0.0"])
+      s.add_dependency(%q<rspec-its>, ["~> 1.0.1"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, ["~> 4.1.1"])
+    s.add_dependency(%q<rspec>, ["~> 3.0.0"])
+    s.add_dependency(%q<rspec-its>, ["~> 1.0.1"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

data/spec/middleware_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe ::RailsRequestId::Middleware do
+  let(:request_id)  { SecureRandom.uuid }
+  let(:env)         { { 'action_dispatch.request_id' => request_id } }
+  subject           { ::RailsRequestId::Middleware.new(app).call(env) }
+
+  context 'happy days' do
+    let(:app)         { double('app', call: nil) }
+    it 'sets and clears request_id in registry' do
+      expect(::RailsRequestId::Registry).to receive(:request_id=).with(request_id).ordered
+      expect(::RailsRequestId::Registry).to receive(:request_id=).with(nil).ordered
+      subject
+    end
+  end
+
+  context 'when an exception is raised' do
+    let(:app)         { double('app') }
+    before :each do
+      allow(app).to receive(:call).and_raise('a test exception')
+    end
+    it 'sets and clears request_id in registry' do
+      expect(::RailsRequestId::Registry).to receive(:request_id=).with(request_id).ordered
+      expect(::RailsRequestId::Registry).to receive(:request_id=).with(nil).ordered
+      begin
+        subject
+      rescue
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rspec'
+require 'rspec/its'
+require 'rails_request_id'
+
+RSpec.configure do |config|
+  config.raise_errors_for_deprecations!
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: rails_request_id
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kunal Parikh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: Web requests in Rails get assigned a unique request id. To access this
+  id in a threadsafe manner, you can simply call ```RailsRequestId.get```
+email: kunal@techthumb.in
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/rails_request_id.rb
+- lib/rails_request_id/initializer.rb
+- lib/rails_request_id/middleware.rb
+- lib/rails_request_id/railtie.rb
+- lib/rails_request_id/registry.rb
+- rails_request_id.gemspec
+- spec/middleware_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/techthumb/rails_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.3.0
+signing_key: 
+specification_version: 4
+summary: Allows access to Rails' request_id from global scope in a threadsafe manner
+test_files: []