marlowe 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a7fdda3d50c8438774a6685320096f240248134
-  data.tar.gz: c15b495dd3826cf26c1ee626cc203e61a84f2576
+  metadata.gz: e8fe217abd7b34e70a4816265d375e11a9200421
+  data.tar.gz: 036330895f4d6518ebcccfc63eaee3b806a0556a
 SHA512:
-  metadata.gz: 4d902634019be7e55e40ce4078477a78dc6fd9c78867f2b1c78f562a72170ee989adc1e6d64273b5f23cc18685530007e89a88991f66a8b39947146f88e90ecd
-  data.tar.gz: 24a7328086863aa5b74f77e2213a3a149519613e858bce9716fa7dd4999eed30c324b44758d63ff458b4fb249335e71751d86d2becd96e322d6351944a7787b8
+  metadata.gz: 9c17b2a005ef985a3c8303911c921ffb32f898595855ad74ea90c1c182b658f86e352876c5f92f95da82294898789cc92e1bc04064616e7d2130d597c3f222ef
+  data.tar.gz: c748d8e49920eef7aa26e74ab90d824c43d2c258392dcb58e17a6a54afae500f29ac9922fd100f92dbea45b9fbbde84be0813c3dffec7a0a92f2c6f19461e738

data/History.rdoc

@@ -1,3 +1,8 @@
+=== 1.0.3 / 2016-01-15
+
+* Update Readme example of using available formatted subclass
+* Make the correlation header name configurable
+
 === 1.0.2 / 2015-11-24
 
 * Add documentation for using Marlowe with {lograge}[https://github.com/roidrage/lograge]

data/README.rdoc

@@ -18,8 +18,18 @@ or add it into a Gemfile:
 
 == Configuration
 
-There is no configuration as of yet. Future plans include configuring the name
-of the correlation id header.
+To configure the header where Marlowe looks for and puts the correlation id:
+
+- In Rails, specify the header in your environment configuration:
+
+  config.marlowe_correlation_header = "My-Correlation-Id"
+
+- If you are adding the middleware to a Rack application directly, pass it as an option:
+
+  use Marlowe::Middleware, correlation_header: "My-Correlation-Id"
+
+(Note that HTTP headers are case insensitive. In the Rack `env`, this header name is actually
+represented as `env['HTTP_MY_CORRELATION_ID']`.)
 
 == Accesing the Correlation ID
 
@@ -36,7 +46,7 @@ are included.
 
   # config/environments/development.rb
   Rails.application.configure do
-    config.log_formatter = CorrelatedSimpleFormatter.new
+    config.log_formatter = Marlowe::SimpleFormatter.new
   end
 
 

data/lib/marlowe.rb

@@ -1,6 +1,6 @@
 # Marlowe, a correlation id injector.
 module Marlowe
-  VERSION = '1.0.2' #:nodoc:
+  VERSION = '1.0.3' #:nodoc:
 
   require 'marlowe/middleware'
   require 'marlowe/rails' if defined? Rails::Railtie

data/lib/marlowe/middleware.rb

@@ -4,23 +4,33 @@ require 'securerandom'
 
 module Marlowe
   # Marlowe correlation id middleware. Including this into your
-  # middleware stack will add a 'Correlation-Id' header as an incoming
+  # middleware stack will add a correlation id header as an incoming
   # request, and save that id in a request session variable.
 
+  # Name of the default header to look for and put the correlation id in.
+  CORRELATION_HEADER = 'Correlation-Id'.freeze
+
   class Middleware
     # Sets the the rack application to +app+
-    def initialize(app)
+    def initialize(app, opts={})
       @app = app
+      @correlation_header = format_http_header(opts[:correlation_header] || Marlowe::CORRELATION_HEADER)
     end
 
     # Stores the incoming correlation id from the +env+ hash. If the correlation
     # id has not been sent, a new UUID is generated and the +env+ is modified.
     def call(env)
-      env['HTTP_CORRELATION_ID'] ||= SecureRandom.uuid
-      RequestStore.store[:correlation_id] = env['HTTP_CORRELATION_ID']
+      env[@correlation_header] ||= SecureRandom.uuid
+      RequestStore.store[:correlation_id] = env[@correlation_header]
 
       @status, @headers, @response = @app.call(env)
       [@status, @headers, @response]
     end
+
+    private
+
+    def format_http_header(header)
+      ("HTTP_" + header.gsub(/-/, '_').upcase).freeze
+    end
   end
 end

data/lib/marlowe/rails.rb

@@ -1,7 +1,7 @@
 module Marlowe
   class Railtie < Rails::Railtie
     initializer 'marlowe.configure_rails_initialization' do
-      app.middleware.insert_before Rails::Rack::Logger, Marlowe::Middleware
+      app.middleware.insert_before Rails::Rack::Logger, Marlowe::Middleware, correlation_header: Rails.application.config.try(:marlowe_correlation_header)
     end
 
     #:nodoc:

data/test/minitest_config.rb

@@ -4,9 +4,7 @@ gem 'minitest'
 
 require 'rack/test'
 require 'rack/mock'
-require 'pry'
 require 'minitest/autorun'
-require 'minitest/pretty_diff'
 require 'minitest/focus'
 require 'minitest/moar'
 require 'minitest/bisect'

data/test/test_marlowe.rb

@@ -16,4 +16,17 @@ class TestMarlowe < Minitest::Test
     refute_empty @app.coordination_id
     assert_equal 'testvalue', @app.coordination_id
   end
+
+  def test_with_custom_no_header
+    @customized_middleware = Marlowe::Middleware.new(@app, correlation_header: "Custom-Header")
+    @customized_middleware.call({})
+    refute_empty @app.coordination_id
+  end
+
+  def test_with_custom_header
+    @customized_middleware = Marlowe::Middleware.new(@app, correlation_header: "Custom-Header")
+    @customized_middleware.call({'HTTP_CUSTOM_HEADER' => 'testvalue'})
+    refute_empty @app.coordination_id
+    assert_equal 'testvalue', @app.coordination_id
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: marlowe
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Trevor Oke
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-25 00:00:00.000000000 Z
+date: 2016-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: request_store