right_support 2.8.38 → 2.8.39

data/VERSION

@@ -1 +1 @@
-2.8.38
+2.8.39

data/lib/right_support/rack/request_logger.rb

@@ -41,10 +41,13 @@ module RightSupport::Rack
     #
     # @option options [Array] :only log for these path Regexps unless in debug mode
     # @option options [Array] :except log except for these path Regexps unless in debug mode
+    # @option options [Array] :include_query_string log the contents of the query string
     def initialize(app, options = {})
       @app = app
       @only = options[:only]
       @except = options[:except]
+      # by default we don't log the query string contents because it may have sensitive data.
+      @include_query_string = options[:include_query_string] || false
     end
 
     # Add a logger to the Rack environment and call the next middleware.
@@ -67,7 +70,6 @@ module RightSupport::Rack
       env["rack.logging.enabled"] = enabled = logging_enabled?(logger, env)
 
       began_at = Time.now
-
       log_request_begin(logger, env) if enabled
       status, header, body = @app.call(env)
       if env['sinatra.error'] && !env['sinatra.error.handled']
@@ -107,10 +109,10 @@ module RightSupport::Rack
       remote_addr = env['HTTP_X_FORWARDED_FOR'] || env["REMOTE_ADDR"] || "-"
       remote_addr = remote_addr.ljust(15)
 
-      # Log the fact that a query string was present, but do not log its contents
-      # because it may have sensitive data.
+      # If we're not logging the contents of the query string we only log the fact that a query
+      # string was present.
       if (query = env["QUERY_STRING"]) && !query.empty?
-        query_info = '?...'
+        query_info = @include_query_string ? "?#{CGI::escape(query)}" : '?...'
       else
         query_info = ''
       end

data/right_support.gemspec

@@ -2,16 +2,14 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: right_support 2.8.38 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "right_support"
-  s.version = "2.8.38"
+  s.version = "2.8.39"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.require_paths = ["lib"]
   s.authors = ["Tony Spataro", "Sergey Sergyenko", "Ryan Williamson", "Lee Kirchhoff", "Alexey Karpik", "Scott Messier"]
-  s.date = "2014-12-05"
+  s.date = "2015-01-21"
   s.description = "A toolkit of useful, reusable foundation code created by RightScale."
   s.email = "support@rightscale.com"
   s.extra_rdoc_files = [
@@ -148,11 +146,12 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "https://github.com/rightscale/right_support"
   s.licenses = ["MIT"]
-  s.rubygems_version = "2.2.2"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.15"
   s.summary = "Reusable foundation code."
 
   if s.respond_to? :specification_version then
-    s.specification_version = 4
+    s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<rake>, ["~> 10.0"])

data/spec/rack/request_logger_spec.rb

@@ -14,7 +14,7 @@ describe RightSupport::Rack::RequestLogger do
   context :initialize do
     context 'without :logger option' do
       it 'uses rack.logger' do
-        @logger.should_receive(:info)
+        @logger.should_receive(:info).at_least.once
         @middleware.call(@env).should == [200, {}, 'body']
       end
     end
@@ -27,9 +27,9 @@ describe RightSupport::Rack::RequestLogger do
       end
 
       it 'logs the exception' do
-        @logger.should_receive(:error)
+        @logger.should_receive(:error).at_least.once
         lambda {
-          @middleware.call({})
+          @middleware.call(@env)
         }.should raise_error
       end
     end
@@ -42,7 +42,7 @@ describe RightSupport::Rack::RequestLogger do
 
       it 'logs the exception' do
         @logger.should_receive(:info)
-        @logger.should_receive(:error)
+        @logger.should_receive(:error).at_least.once
         @middleware.call(@env)
       end
 
@@ -64,12 +64,12 @@ describe RightSupport::Rack::RequestLogger do
 
       it 'does not limit if logger in debug mode' do
         @logger.should_receive(:level).and_return(Logger::DEBUG)
-        @logger.should_receive(:info)
+        @logger.should_receive(:info).at_least.once
         @middleware.call(@env)
       end
 
       it 'does not limit if HTTP_X_DEBUG set' do
-        @logger.should_receive(:info)
+        @logger.should_receive(:info).at_least.once
         @middleware.call(@env.merge('HTTP_X_DEBUG' => true))
       end
 
@@ -86,13 +86,44 @@ describe RightSupport::Rack::RequestLogger do
       end
 
       it 'sets rack.logging.enabled in Rack environment' do
-        @logger.should_receive(:info)
+        @logger.should_receive(:info).at_least.once
         @env.merge!('PATH_INFO' => '/my/app')
         @middleware.call(@env)
         @env['rack.logging.enabled'].should be_true
       end
     end
 
+    context 'when logging the query string' do
+      before(:each) do
+        @options = {}
+        @env.merge!('PATH_INFO' => '/my/app', 'QUERY_STRING' => 'foo=bar')
+        @middleware = RightSupport::Rack::RequestLogger.new(@app, @options)
+      end
+
+      it 'does not log the query string by default' do
+        @logger.should_receive(:info).with(FlexMock.on { |arg| arg.should =~ /\/my\/app\?\.{3}/ } )
+        @middleware.send(:log_request_begin, @logger, @env)
+      end
+
+      context 'when the include_query_string option is true' do
+        it 'logs the query string' do
+          @options[:include_query_string] = true
+          @middleware = RightSupport::Rack::RequestLogger.new(@app, @options)
+          @logger.should_receive(:info).with(FlexMock.on { |arg| arg.should =~ /\/my\/app\?foo%3Dbar/ } )
+          @middleware.send(:log_request_begin, @logger, @env)
+        end
+      end
+
+      context 'when the include_query_string option is false' do
+        it 'does not log the query string' do
+          @options[:include_query_string] = false
+          @middleware = RightSupport::Rack::RequestLogger.new(@app, @options)
+          @logger.should_receive(:info).with(FlexMock.on { |arg| arg.should =~ /\/my\/app\?\.{3}/ } )
+          @middleware.send(:log_request_begin, @logger, @env)
+        end
+      end
+    end
+
     context 'Shard ID logging' do
       before(:each) do
         @logger = mock_logger

metadata

@@ -1,9 +1,15 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: right_support
-version: !ruby/object:Gem::Version
-  version: 2.8.38
+version: !ruby/object:Gem::Version 
+  hash: 97
+  prerelease: 
+  segments: 
+  - 2
+  - 8
+  - 39
+  version: 2.8.39
 platform: ruby
-authors:
+authors: 
 - Tony Spataro
 - Sergey Sergyenko
 - Ryan Williamson
@@ -13,90 +19,95 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-05 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2015-01-21 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
   name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
   type: :development
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 35
+        segments: 
+        - 10
+        - 0
+        version: "10.0"
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
   type: :development
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
   name: ruby-debug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
   type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
     - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
   name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
   type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
     - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  prerelease: false
   name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
   type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
     - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id005
 description: A toolkit of useful, reusable foundation code created by RightScale.
 email: support@rightscale.com
 executables: []
+
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - LICENSE
 - README.md
-files:
-- ".coveralls.yml"
-- ".rspec"
-- ".simplecov"
-- ".travis.yml"
+files: 
+- .coveralls.yml
+- .rspec
+- .simplecov
+- .travis.yml
 - CHANGELOG.rdoc
 - Gemfile
 - Gemfile.lock
@@ -220,27 +231,37 @@ files:
 - spec/validation/openssl_spec.rb
 - spec/validation/ssh_spec.rb
 homepage: https://github.com/rightscale/right_support
-licenses:
+licenses: 
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
-  requirements:
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
   - - ">="
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
-  requirements:
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
   - - ">="
-    - !ruby/object:Gem::Version
-      version: '0'
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 1.8.15
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Reusable foundation code.
 test_files: []
+

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: e0cb72f5d96896f6a249867296e5a6ee14021caa
-  data.tar.gz: 930f29d6b579d374ddadf6636c3687aeb12f394e
-SHA512:
-  metadata.gz: 9bc745e71199150c1c3097efe6ba4ec77549e6c5d34ae7fdd899710f5122adde38e77b01a56f4e826e8e49a297eed2534fc1be78cf72ffb924e79beb6335b064
-  data.tar.gz: e823929462c375b3bb12f51c91fd39780de10eec2194232d32c5ea649166709f523bc2cad31f4030d588a9f95eebd38ba84d969c6f4aa9a195f223d188fbac28