request_context 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+script: bundle exec rake

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in request_context.gemspec
+gemspec

data/LICENSE.txt

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

data/README.md

@@ -0,0 +1,27 @@
+# RequestContext
+
+This is a gem that adds a hash containing request information to `Thread.current[:request_context]`
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'request_context'
+```
+
+## Usage
+
+Add the rack middleware:
+
+```ruby
+use Rack::RequestContext
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+task :default => [:spec]
+
+require 'rspec/core/rake_task'
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end

data/lib/rack/request_context.rb

@@ -0,0 +1,38 @@
+module Rack
+
+  # Public: Rack middleware that stores request data in a
+  # thread local variable.
+  #
+  # app - The Rack app.
+  #
+  # Examples
+  #
+  #   use Rack::RequestContext
+  #
+  #   puts "Thread.current[:request_context]"
+  #   # => {origo: nil, url: 'https...', user_agent: 'Mozilla...', referrer: 'http...', ip: '1.1.1.1'}
+  class RequestContext
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      ::RequestContext.with_request_context(request_context(env)) do
+        @app.call(env)
+      end
+    end
+
+  private
+
+    def request_context(env)
+      request = Rack::Request.new(env)
+      { origo:      request.cookies['origo'],
+        url:        request.url,
+        user_agent: request.user_agent,
+        referrer:   request.referer,
+        ip:         request.ip }
+    end
+
+  end
+end

data/lib/request_context.rb

@@ -0,0 +1,62 @@
+require 'request_context/version'
+
+module Rack
+  autoload :RequestContext, 'rack/request_context'
+end
+
+module RequestContext
+
+  class << self
+
+    # Public: Retrieve the current request_context, which is set by the Rack middleware.
+    #
+    # Examples
+    #
+    #   RequestContext.request_context
+    #   # => {:origo=>nil,
+    #   #     :url=>"http://localhost:5000/v2/groups/31419?group%5Bclass_name%5D=Spanish+6&auth_token=btVuzxrUYcaYJvnkVTbA",
+    #   #     :user_agent=>"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_8_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36",
+    #   #     :referrer=>"http://localhost:5000/",
+    #   #     :ip=>"127.0.0.1"}
+
+    #
+    # Returns the Hash request context.
+    def request_context
+      Thread.current[:request_context]
+    end
+
+    # Internal: Set the current request_context.
+    #
+    # Examples
+    #
+    #   RequestContext.request_context = {origo: nil, url: 'https://www.remind101.com'}
+    #   # => {origo: nil, url: 'https://www.remind101.com'}
+    #
+    # Returns the new Hash request context.
+    def request_context=(request_context)
+      Thread.current[:request_context] = request_context
+    end
+
+    # Public: Runs the block with the given request context set.
+    #
+    # Examples
+    #
+    #   RequestContext.request_context
+    #   # => {url: 'https://www.remind101.com'}
+    #
+    #   RequestContext.with_request_context({url: 'https://www.remind101.com/users/sign_in'}) do
+    #     RequestContext.request_context
+    #     # => {url: 'https://www.remind101.com/users/sign_in'}
+    #   end
+    #
+    #   RequestContext.request_context
+    #   # => {url: 'https://www.remind101.com'}
+    def with_request_context(request_context)
+      last_request_context = RequestContext.request_context
+      RequestContext.request_context = request_context
+      yield
+    ensure
+      RequestContext.request_context = last_request_context
+    end
+  end
+end

data/lib/request_context/version.rb

@@ -0,0 +1,3 @@
+module RequestContext
+  VERSION = '0.0.1'
+end

data/request_context.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'request_context/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'request_context'
+  spec.version       = RequestContext::VERSION
+  spec.authors       = ['David Kopf']
+  spec.email         = ['david@remind101.com']
+  spec.description   = %q{Classes for tracking request context}
+  spec.summary       = %q{Classes for tracking request context}
+  spec.homepage      = 'https://github.com/remind101/request_context'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rack-test'
+end

data/spec/rack/request_context_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'rack/test'
+
+describe Rack::RequestContext do
+  let(:app) { double('app', call: [200, {}, ['Body']]) }
+  let(:middleware) { described_class.new app }
+
+  describe '.call' do
+    let(:request_context) do
+      {origo: nil, url: '://::0', user_agent: 'hello', referrer: nil, ip: nil}
+    end
+
+    let(:env) { {'HTTP_USER_AGENT' => 'hello'} }
+
+    it 'stores the request_context in a thread local' do
+      Thread.current.should_receive(:[]=).with(:request_context, request_context)
+      app.should_receive(:call)
+      Thread.current.should_receive(:[]=).with(:request_context, nil)
+      middleware.call(env)
+    end
+
+  end
+
+end

data/spec/request_context_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe RequestContext do
+  let(:request_context) do
+    { origo:      nil,
+      url:        'https://www.remind101.com',
+      user_agent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_8_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/31.0.1650.57 Safari/537.36',
+      referrer:   'http://search.yahoo.com/search?p=remind101',
+      ip:         '127.0.0.1' }
+  end
+
+  describe '.request_context' do
+    subject { described_class.request_context }
+
+    context 'when Thread.current[:request_context] is set' do
+      before { Thread.current[:request_context] = request_context }
+      it { should eq Thread.current[:request_context] }
+    end
+  end
+
+  describe '.request_context=' do
+    it 'sets Thread.current[:request_context]' do
+      Thread.current.should_receive(:[]=).with(:request_context, request_context)
+      described_class.request_context = request_context
+    end
+  end
+
+  describe '.with_request_context' do
+    before { Thread.current[:request_context] = request_context }
+
+    it 'sets the request_context to the new request_context' do
+      described_class.with_request_context( {url: 'https://www.remind101.com', ip: '10.10.10.10'} ) do
+        expect(described_class.request_context).to eq({url: 'https://www.remind101.com', ip: '10.10.10.10'})
+      end
+      expect(described_class.request_context).to eq request_context
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'bundler/setup'
+Bundler.require :default, :test
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.join(File.dirname(__FILE__), "support/**/*.rb")].each {|f| require f}

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: request_context
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- David Kopf
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Classes for tracking request context
+email:
+- david@remind101.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack/request_context.rb
+- lib/request_context.rb
+- lib/request_context/version.rb
+- request_context.gemspec
+- spec/rack/request_context_spec.rb
+- spec/request_context_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/remind101/request_context
+licenses:
+- MIT
+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
+signing_key: 
+specification_version: 3
+summary: Classes for tracking request context
+test_files:
+- spec/rack/request_context_spec.rb
+- spec/request_context_spec.rb
+- spec/spec_helper.rb