low 0.0.7 → 0.0.8

data/.gitignore

@@ -11,6 +11,7 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+log/*
 
 # YARD artifacts
 .yardoc

data/lib/low/middleware/request_id.rb

@@ -0,0 +1,39 @@
+module Low
+  module Middleware
+    # `RequestId` adds a value for env["request_id"]. `RequestLogger`, for one,
+    # uses this value to scope the logger it instantiates.
+    class RequestId
+      @@request_id = 0
+
+      VALID_REQUEST_ID_REGEX = /^[a-zA-Z0-9\s\-_]*$/
+
+      def self.is_valid?(id)
+        id =~ VALID_REQUEST_ID_REGEX
+      end
+
+      def initialize(app)
+        @app = app
+
+        #generate a request ID (not too worried about uniqueness here).
+        @current_request_id = (@@request_id += 1)
+      end
+
+      def call(env)
+        # If there is a request_id parameter,
+        req = Rack::Request.new(env)
+
+        # and it's valid, use it;
+        if req['request_id'] and RequestId.is_valid?(req['request_id'])
+          env['useless.request_id'] = req['request_id']
+
+        # otherwise, use the generated one
+        else
+          env['useless.request_id'] = @current_request_id.to_s
+        end
+
+        # and call the app.
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/low/middleware/request_logger.rb

@@ -7,7 +7,7 @@ module Low
     #   the log directory, otherwise use STDOUT (as Heroku likes).
     # * _log_level_: If set, use the LOG_LEVEL environment variable value;
     #   otherwise, use INFO.
-    # * _group_key_: Use request_id env value.
+    # * _group_key_: Use request_id env value (see the RequestId middleware).
     class RequestLogger
       def self.level
         # If `LOG_LEVEL` is a valid level other than INFO,

data/lib/low/version.rb

@@ -1,3 +1,3 @@
 module Low
-  VERSION = '0.0.7'
+  VERSION = '0.0.8'
 end

data/lib/low.rb

@@ -5,6 +5,7 @@ module Low
   autoload :Mongo,        'low/mongo'
 
   module Middleware
+    autoload :RequestId,      'low/middleware/request_id'
     autoload :RequestLogger,  'low/middleware/request_logger'
     autoload :SubdomainMap,   'low/middleware/subdomain_map'
   end

data/spec/low/middleware/request_id_spec.rb

@@ -0,0 +1,29 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Low::Middleware::RequestId do
+  def app
+    app = lambda do |env|
+      [200, {'Content-Type' => 'text/plain'}, ['Request Id: ' + env['useless.request_id']]]
+    end
+
+    Low::Middleware::RequestId.new(app)
+  end
+
+  it 'should add a request ID to the env while proxying transparently' do
+    res = Rack::MockRequest.new(app).get('http://useless.info')
+    res.should be_ok
+    res.body.should =~ /Request Id: [a-z0-9]{1,}/
+  end
+
+  it 'should use the ID specified in the query parameter' do
+    res = Rack::MockRequest.new(app).get('http://useless.info?request_id=jah')
+    res.should be_ok
+    res.body.should == 'Request Id: jah'
+  end
+
+  it 'should not use the ID specified it does not have "simple" characters' do
+    res = Rack::MockRequest.new(app).get('http://useless.info?request_id=(jah)')
+    res.should be_ok
+    res.body.should_not == 'Request Id: (jah)'
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: low
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -105,6 +105,7 @@ files:
 - README.md
 - Rakefile
 - lib/low.rb
+- lib/low/middleware/request_id.rb
 - lib/low/middleware/request_logger.rb
 - lib/low/middleware/subdomain_map.rb
 - lib/low/mongo.rb
@@ -113,6 +114,7 @@ files:
 - lib/low/scoped_logger.rb
 - lib/low/version.rb
 - low.gemspec
+- spec/low/middleware/request_id_spec.rb
 - spec/low/middleware/request_logger_spec.rb
 - spec/low/middleware/subdomain_map_spec.rb
 - spec/low/mongo/util_spec.rb
@@ -144,6 +146,7 @@ signing_key:
 specification_version: 3
 summary: A low-level utility library.
 test_files:
+- spec/low/middleware/request_id_spec.rb
 - spec/low/middleware/request_logger_spec.rb
 - spec/low/middleware/subdomain_map_spec.rb
 - spec/low/mongo/util_spec.rb