marlowe 1.0.3 → 2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e8fe217abd7b34e70a4816265d375e11a9200421
-  data.tar.gz: 036330895f4d6518ebcccfc63eaee3b806a0556a
+  metadata.gz: c9fe361f2fbf3bede39f63ffcd1a5ed43d530a1f
+  data.tar.gz: 518bc0e7bc871020ba7104d71cafd31ef3413fd0
 SHA512:
-  metadata.gz: 9c17b2a005ef985a3c8303911c921ffb32f898595855ad74ea90c1c182b658f86e352876c5f92f95da82294898789cc92e1bc04064616e7d2130d597c3f222ef
-  data.tar.gz: c748d8e49920eef7aa26e74ab90d824c43d2c258392dcb58e17a6a54afae500f29ac9922fd100f92dbea45b9fbbde84be0813c3dffec7a0a92f2c6f19461e738
+  metadata.gz: 9bb3bb37b9bbf674c727a6afa9c8d0911ec3a54a5b65c8fc66049727d9178ecd14380801dc8273860ada1d4d44782a06ec9bd959e450cb391ea9c6c2a00799a5
+  data.tar.gz: 672c0aedaf0b0c5fd9b8313bd9ed8d3e530c93906c17ce6bbfa307cddaf74d95dcd6d25a3a6eccd8146e57794146e6bfcdf676188ba57274656f887ff917b071

data/Contributing.md

@@ -0,0 +1,71 @@
+## Contributing
+
+We value any contribution to Marlowe you can provide: a bug report,
+a feature request, or code contributions. Marlowe is reasonably complex
+code, so there are a few contribution guidelines:
+
+*   Changes *will not* be accepted without tests. The test suite is written
+    with [Minitest][].
+*   Match our coding style.
+*   Use a thoughtfully-named topic branch that contains your change. Rebase
+    your commits into logical chunks as necessary.
+*   Use [quality commit messages][].
+*   Do not change the version number; when your patch is accepted and a release
+    is made, the version will be updated at that point.
+*   Submit a GitHub pull request with your changes.
+
+### Test Dependencies
+
+Marlowe uses Ryan Davis’s [Hoe][] to manage the release process, which
+adds a number of rake tasks. You will mostly be interested in:
+
+    $ rake
+
+which runs the tests the same way that:
+
+    $ rake test
+    $ rake travis
+
+will do.
+
+To assist with the installation of the development dependencies for
+Marlowe, I have provided the simplest possible Gemfile pointing to the
+(generated) `marlowe.gemspec` file. This will permit you to do:
+
+    $ bundle install
+
+to get the development dependencies. If you aleady have `hoe` installed, you
+can accomplish the same thing with:
+
+    $ rake newb
+
+This task will install any missing dependencies, run the tests/specs, and
+generate the RDoc.
+
+### Workflow
+
+Here's the most direct way to get your work merged into the project:
+
+*   Fork the project.
+*   Clone down your fork (`git clone
+    git://github.com/KineticCafe/marlowe.git`).
+*   Create a topic branch to contain your change (`git checkout -b
+    my_awesome_feature`).
+*   Hack away, add tests. Not necessarily in that order.
+*   Make sure everything still passes by running `rake`.
+*   If necessary, rebase your commits into logical chunks, without errors.
+*   Push the branch up (`git push origin my_awesome_feature`).
+*   Create a pull request against KineticCafe/marlowe and describe
+    what your change does and the why you think it should be merged.
+
+### Contributors
+
+*   Trevor Oke [@thefury](https://github.com/thefury) created marlowe.
+*   Austin Ziegler [@halostatue](https://github.com/halostatue)
+*   Adam Solove [@asolove](https://github.com/asolove)
+*   Tim Morton [@tmorton](https://github.com/tmorton)
+
+[Minitest]: https://github.com/seattlerb/minitest
+[quality commit messages]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+[Hoe]: https://github.com/seattlerb/hoe
+[kccoc]: https://github.com/KineticCafe/code-of-conduct

data/History.md

@@ -0,0 +1,31 @@
+### 2.0 / 2016-11-16
+
+*   Breaking change: the correlation header defaults to `X-Request-Id` instead
+    of `Correlation-Id`.
+*   Breaking change: by default, the `correlation_id` is sanitized in the same
+    way as `ActionDispatch::RequestId` when provided from an upstream
+    source (only alphanumerics with dashes up to 255 characters in
+    length).
+*   Breaking change: by default, the `correlation_id` is returned to the client
+    as part of the response.
+*   Marlowe is more configurable now.
+
+### 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][].
+
+### 1.0.1 / 2015-10-20
+
+*   Update gemspec with homepage
+*   Update Rakefile
+
+### 1.0.0 / 2015-10-16
+
+*   Initial Commit
+
+[lograge]: https://github.com/roidrage/lograge

data/{Licence.rdoc → Licence.md}

@@ -1,8 +1,8 @@
-cence
+## Licence
 
 This software is available under an MIT-style licence.
 
-* Copyright 2015 Kinetic Cafe
+*   Copyright 2015–2016 Kinetic Cafe
 
 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
@@ -11,9 +11,9 @@ 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 names of its contributors may not be used to endorse or promote
-  products derived from this software without specific prior written
-  permission.
+*   The names of its contributors may not be used to endorse or promote
+    products derived from this software without specific prior written
+    permission.
 
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.

data/Manifest.txt

@@ -1,7 +1,6 @@
-.autotest
-Gemfile
-History.rdoc
-Licence.rdoc
+Contributing.md
+History.md
+Licence.md
 Manifest.txt
 README.rdoc
 Rakefile

data/README.rdoc

@@ -1,37 +1,104 @@
-= marlowe
+= Marlowe, Your Request Sleuth
+
+code :: https://github.com/KineticCafe/marlowe/
+issues :: https://github.com/KineticCafe/marlowe/issues
+docs :: http://www.rubydoc.info/github/KineticCafe/marlowe/master
+continuous integration :: {<img src="https://travis-ci.org/KineticCafe/marlowe.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/KineticCafe/marlowe]
 
 == Description
 
-{marlowe}[https://github.com/KineticCafe/marlowe] provides a correlation id 
-header for Rails and Rack applications to correlate logs for a single request 
-across multiple services.
+{Marlowe}[https://github.com/KineticCafe/marlowe] is a Rack middleware that
+extracts or creates a request ID using a pre-defined header, permitting request
+correlation across multiple services.
 
-== Install
+When using Rails, Marlowe automatically adds itself to the middleware before
+<tt>Rails::Rack::Logger</tt>.
 
-You can install it as a gem:
+=== Upgrading from Marlowe 1.x
 
-  $ gem install marlowe
+In Marlowe 1.0, the correlation header was called <tt>Correlation-Id</tt>;
+since then, Rails 5 and other tools and frameworks (such as Phoenix) have
+standardized on the header <tt>X-Request-Id</tt>. Marlowe 2.0 changes to this
+header by default.
+
+To keep complete compatibility with Marlowe 1.0, the following should be used:
 
-or add it into a Gemfile:
+  # Rails
+  config.marlowe_header = 'Correlation-Id'
+  config.marlowe_handler = :simple
+  config.marlowe_return = false
 
-  gem 'marlowe'
+  # Rack
+  use Marlowe::Middleware, header: 'Correlation-Id', handler: :simple, return: false
 
 == Configuration
 
-To configure the header where Marlowe looks for and puts the correlation id:
+Marlowe has three main configuration options: the request ID header, the
+request ID handler, and the request ID return. The options may be provided to
+the Rack +use+ command as a keyword option, or set in a corresponding
+<tt>marlowe_<em>option</em></tt> configuration variable in Rails.
+
+=== Request ID Header
+
+Specifies the header to be used for the request correlation ID. Defaults to
+<tt>X-Request-Id</tt>.
+
+    # Rails
+    config.marlowe_header = 'Correlation-Id'
+    # OR: config.marlowe_correlation_header = 'Correlation-Id'
+
+    # Rack
+    use Marlowe::Middleware, header: 'Correlation-Id'
+    # OR: use Marlowe::Middleware, correlation_header: 'Correlation-Id'
+
+Marlowe will convert this to an appropriate HTTP header (in the Rack +env+
+parameter, the above header would be represented as
+<tt>env['HTTP_CORRELATION_ID']</tt>).
+
+=== Request ID Handler
+
+Specifies the method for sanitizing or generating the request correlation ID.
+Values can be <tt>:clean</tt> (the default, which limits incoming correlation
+IDs to 255 alphanumeric-or-dash characters), <tt>:simple</tt> (does not limit
+incoming correlation IDs), or a proc to transform or generate a correlation ID.
+
+In all cases, if a correlation request ID is not handled, a UUID will be
+generated.
+
+    # Rails
+    config.marlowe_handler = :simple
+    config.marlowe_handler = ->(req_id) {
+      req_id.try(:reverse) || SecureRandom.uuid
+    }
+
+    # Rack
+    use Marlowe::Middleware, handler: :simple
+    use Marlowe::Middleware, handler: ->(req_id) {
+      req_id.try(:reverse) || SecureRandom.uuid
+    }
 
-- In Rails, specify the header in your environment configuration:
+=== Request ID Return
 
-  config.marlowe_correlation_header = "My-Correlation-Id"
+If +true+ (the default), the request correlation ID will be returned to the
+client in the same header that it was provided in.
 
-- If you are adding the middleware to a Rack application directly, pass it as an option:
+    # Rails
+    config.marlowe_return = false
 
-  use Marlowe::Middleware, correlation_header: "My-Correlation-Id"
+    # Rack
+    use Marlowe::Middleware, return: false
 
-(Note that HTTP headers are case insensitive. In the Rack `env`, this header name is actually
-represented as `env['HTTP_MY_CORRELATION_ID']`.)
+=== Using Marlowe with Rails 5
 
-== Accesing the Correlation ID
+Rails 5 includes the <tt>ActionDispatch::RequestId</tt> middleware, reducing
+the need for Marlowe. Marlowe is more configurable than the Rails 5 default, so
+set +marlowe_replace_action_dispatch_request_id+ to true to have
+<tt>Marlowe::Middleware</tt> will replace <tt>ActionDispatch::RequestId</tt>:
+
+  # Rails only
+  config.marlowe_replace_action_dispatch_request_id = true
+
+== Accessing the Correlation ID
 
 The correlation id can be accessed throughout the application by accessing the
 {RequestStore}[https://github.com/steveklabnik/request_store] storage.
@@ -40,16 +107,15 @@ The correlation id can be accessed throughout the application by accessing the
 
 == Logging
 
-For a rails application, you simply need to change the log formatter to one of
-the provided ones. Correlated versions of both the SimpleFormatter and Formatter 
-are included. 
+For a Rails application, you simply need to change the log formatter to one of
+the provided ones. Correlated versions of both the SimpleFormatter and
+Formatter are included. 
 
   # config/environments/development.rb
   Rails.application.configure do
     config.log_formatter = Marlowe::SimpleFormatter.new
   end
 
-
 To create your own formatter, you'll need to access the RequestStore storage.
 You can use this pattern if you've rolled your own logger/formatter:
 
@@ -64,7 +130,7 @@ You can use this pattern if you've rolled your own logger/formatter:
 
 === Lograge
 
-As {lograge}[https://github.com/roidrage/lograge] supplies it's own formatter,
+As {lograge}[https://github.com/roidrage/lograge] supplies its own formatter,
 you will need to do something a little different:
 
   # config/application.rb
@@ -84,7 +150,7 @@ you will need to do something a little different:
 
 Catching and creating the correlation ID is a great all on its own, but to
 really take advantage of the correlation in a service based architecture you'll
-need to pass the id to the next service in the change.
+need to pass the request ID to the next service in the change.
 
 Here's an example of a {Hurley}[https://github.com/lostisland/hurley] client:
 
@@ -96,16 +162,16 @@ Here's an example of a {Hurley}[https://github.com/lostisland/hurley] client:
   class Hurley::CorrelatedClient < Hurley::Client
     def initialize(*args, &block)
       super
-      header['Correlation-Id'] = ::RequestStore.store[:correlation_id]
+      header['X-Request-Id'] = ::RequestStore.store[:correlation_id]
     end
   end
 
-If you have long-lived Hurley clients, it is also possible to use the Hurley {callback
-machanism}[https://github.com/lostisland/hurley#client-callbacks] to add the
-outgoing headers:
+If you have long-lived Hurley clients, it is also possible to use the Hurley
+{callback machanism}[https://github.com/lostisland/hurley#client-callbacks] to
+add the outgoing headers:
 
   client.before_call do |request|
-    request.header['Correlation-Id'] = ::RequestStore.store[:correlation_id]
+    request.header['X-Request-Id'] = ::RequestStore.store[:correlation_id]
   end
 
 or 
@@ -116,10 +182,36 @@ or
     end
 
     def call(request)
-      request.header['Correlation-Id'] = ::RequestStore.store[:correlation_id]
+      request.header['X-Request-Id'] = ::RequestStore.store[:correlation_id]
     end
   end
 
   client.before_call(Correlator.new)
 
+== Install
+
+Add Marlowe to your Gemfile:
+
+    gem 'marlowe', '~> 2.0'
+
+Or manually install:
+
+  $ gem install marlowe
+
+== Marlowe Semantic Versioning
+
+Marlowe uses a {Semantic Versioning}[http://semver.org/] scheme with one
+significant change:
+
+* When PATCH is zero (+0+), it will be omitted from version references.
+
+Additionally, the major version will generally be reserved for plug-in
+infrastructure changes.
+
+== Community and Contributing
 
+Marlowe welcomes your contributions as described in
+{Contributing.md}[https://github.com/KineticCafe/marlowe/blob/master/Contributing.md].
+This project, like all Kinetic Cafe {open source
+projects}[https://github.com/KineticCafe], is under the Kinetic Cafe Open
+Source {Code of Conduct}[https://github.com/KineticCafe/code-of-conduct].

data/Rakefile

@@ -1,61 +1,75 @@
-# -*- ruby -*-
+# frozen_string_literal: true
 
 require 'rubygems'
 require 'hoe'
+require 'rake/clean'
 
 Hoe.plugin :doofus
-Hoe.plugin :email unless ENV['CI'] or ENV['TRAVIS']
+Hoe.plugin :email unless ENV['CI'] || ENV['TRAVIS']
 Hoe.plugin :gemspec2
 Hoe.plugin :git
 Hoe.plugin :minitest
 Hoe.plugin :rubygems
 Hoe.plugin :travis
 
-Hoe.spec 'marlowe' do
+spec = Hoe.spec 'marlowe' do
   developer('Trevor Oke', 'toke@kineticcafe.com')
   developer('Kinetic Cafe', 'dev@kineticcafe.com')
 
-  self.history_file = 'History.rdoc'
+  self.history_file = 'History.md'
   self.readme_file = 'README.rdoc'
 
   license 'MIT'
 
+  ruby20!
+
   extra_deps << ['request_store', '~> 1.2']
-  extra_deps << ['rack',  '>= 0.9', '< 2']
+  extra_deps << ['rack',  '>= 0.9', '< 3']
 
+  extra_dev_deps << ['appraisal', '~> 2.1']
+  extra_dev_deps << ['hoe-doofus', '~> 1.0']
+  extra_dev_deps << ['hoe-gemspec2', '~> 1.1']
+  extra_dev_deps << ['hoe-git', '~> 1.6']
+  extra_dev_deps << ['hoe-rubygems', '~> 1.0']
+  extra_dev_deps << ['hoe-travis', '~> 1.2']
+  extra_dev_deps << ['minitest', '~> 5.4']
+  extra_dev_deps << ['minitest-autotest', '~> 1.0']
+  extra_dev_deps << ['minitest-bonus-assertions', '~> 2.0']
+  extra_dev_deps << ['minitest-focus', '~> 1.1']
+  extra_dev_deps << ['minitest-moar', '~> 0.0']
   extra_dev_deps << ['rack-test', '~> 0.6']
-  self.extra_dev_deps << ['rake', '~> 10.0']
-  self.extra_dev_deps << ['hoe-doofus', '~> 1.0']
-  self.extra_dev_deps << ['hoe-gemspec2', '~> 1.1']
-  self.extra_dev_deps << ['hoe-git', '~> 1.5']
-  self.extra_dev_deps << ['hoe-travis', '~> 1.2']
-  self.extra_dev_deps << ['minitest', '~> 5.4']
-  self.extra_dev_deps << ['minitest-autotest', '~> 1.0']
-  self.extra_dev_deps << ['minitest-bisect', '~> 1.2']
-  self.extra_dev_deps << ['minitest-focus', '~> 1.1']
-  self.extra_dev_deps << ['minitest-moar', '~> 0.0']
-  self.extra_dev_deps << ['simplecov', '~> 0.7']
+  extra_dev_deps << ['rake', '>= 10.0', '< 12']
+  extra_dev_deps << ['rdoc', '~> 4.2']
+  extra_dev_deps << ['rubocop', '~> 0.32']
+  extra_dev_deps << ['coveralls', '~> 0.8']
+  extra_dev_deps << ['simplecov', '~> 0.7']
 end
 
-module Hoe::Publish
-  alias_method :original_make_rdoc_cmd, :make_rdoc_cmd
+ENV['RUBYOPT'] = '-W0'
+
+module Hoe::Publish #:nodoc:
+  alias __make_rdoc_cmd__marlowe__ make_rdoc_cmd
 
   def make_rdoc_cmd(*extra_args) # :nodoc:
     spec.extra_rdoc_files.reject! { |f| f == 'Manifest.txt' }
-    original_make_rdoc_cmd(*extra_args)
+    __make_rdoc_cmd__marlowe__(*extra_args)
   end
 end
 
-namespace :test do
-  task :coverage do
-    prelude = <<-EOS
-require 'simplecov'
-SimpleCov.start('test_frameworks') { command_name 'Minitest' }
-gem 'minitest'
-    EOS
-    spec.test_prelude = prelude.split($/).join('; ')
-    Rake::Task['test'].execute
+if File.exist?('.simplecov-prelude.rb')
+  namespace :test do
+    task :coverage do
+      spec.test_prelude = 'load ".simplecov-prelude.rb"'
+      Rake::Task['test'].execute
+    end
+
+    task :coveralls do
+      ENV['coveralls'] = '1'
+      Rake::Task['test:coverage'].execute
+    end
+
+    CLOBBER << 'coverage'
   end
 end
 
-# vim: syntax=ruby
+CLOBBER << 'tmp'

data/lib/marlowe.rb

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

data/lib/marlowe/formatter.rb

@@ -1,13 +1,13 @@
+# frozen_string_literal: true
+
 require 'request_store'
 
 module Marlowe
-
   # Marlowe::Formatter is a subclass of +ActiveSupport::Logger::Formatter+
   # that adds a correlation id string to a rails log.
   class Formatter < ActiveSupport::Logger::Formatter
-
     # Overrides the formatter return to add the correlation id.
-    def call(severity, timestamp, progname, msg)
+    def call(_severity, _timestamp, _progname, _msg)
       "[#{RequestStore.store[:correlation_id]}] #{super}"
     end
   end

data/lib/marlowe/middleware.rb

@@ -1,36 +1,97 @@
+# frozen_string_literal: true
+
 require 'rack'
 require 'request_store'
 require 'securerandom'
 
 module Marlowe
-  # Marlowe correlation id middleware. Including this into your
-  # 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
-
+  # Marlowe correlation id middleware. Including this into your middleware
+  # stack will add a correlation id header as an incoming request, and save
+  # that id in a request session variable.
   class Middleware
-    # Sets the the rack application to +app+
-    def initialize(app, opts={})
+    # The name of the default header to look for and put the correlation id in.
+    CORRELATION_HEADER = 'X-Request-Id' #:nodoc:
+
+    # Configure the Marlowe middleware to call +app+ with options +opts+.
+    #
+    # === Options
+    #
+    # <tt>:header</tt>:: The name of the header to inspect. Defaults to
+    #                    'X-Request-Id'. Also available as
+    #                    <tt>:correlation_header</tt>.
+    # <tt>:handler</tt>:: The handler for request correlation IDs. Defaults to
+    #                     sanitizing provided request IDs or generating a UUID.
+    #                     If <tt>:simple</tt> is provided, provided request IDs
+    #                     will not be sanitized. A callable (expecting a single
+    #                     input of any possible existing request ID) may be
+    #                     provided to introduce more complex request ID
+    #                     handling.
+    # <tt>:return</tt>:: If +true+ (the default), the request correlation ID
+    #                    will be returned as part of the response headers.
+    # <tt>:action_dispatch</tt>:: If +true+, Marlowe will add code to behave
+    #                             like <tt>ActionDispatch::RequestId</tt>.
+    #                             Depends on <tt>ActionDispatch::Request</tt>.
+    def initialize(app, opts = {})
       @app = app
-      @correlation_header = format_http_header(opts[:correlation_header] || Marlowe::CORRELATION_HEADER)
+      @header, @http_header = format_header_name(
+        opts[:header] || opts[:correlation_header] || CORRELATION_HEADER
+      )
+      @handler = opts.fetch(:handler, :clean)
+      @return = opts.fetch(:return, true)
+      @action_dispatch = opts.fetch(:action_dispatch, false)
     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[@correlation_header] ||= SecureRandom.uuid
-      RequestStore.store[:correlation_id] = env[@correlation_header]
+      req_id = make_request_id(env[@http_header])
+      RequestStore.store[:correlation_id] = env[@http_header] = req_id
+
+      if @action_dispatch
+        req = ActionDispatch::Request.new(env)
+        req.request_id = req_id
+      end
 
-      @status, @headers, @response = @app.call(env)
-      [@status, @headers, @response]
+      @app.call(env).tap { |_status, headers, _body|
+        if @return
+          headers[@header] = if @action_dispatch
+                               req.request_id
+                             else
+                               RequestStore.store[:correlation_id]
+                             end
+        end
+      }
     end
 
     private
 
-    def format_http_header(header)
-      ("HTTP_" + header.gsub(/-/, '_').upcase).freeze
+    def format_header_name(header)
+      [
+        header.to_s.tr('_', '-').freeze,
+        "HTTP_#{header.to_s.tr('-', '_').upcase}"
+      ]
+    end
+
+    def make_request_id(request_id)
+      if @handler == :simple
+        simple(request_id)
+      elsif @handler.kind_of?(Proc)
+        simple(@handler.call(request_id))
+      else
+        clean(request_id)
+      end
+    end
+
+    def clean(request_id)
+      simple(request_id).gsub(/[^\w\-]/, '')[0, 255]
+    end
+
+    def simple(request_id)
+      if request_id && !request_id.empty? && request_id !~ /\A[[:space]]*\z/
+        request_id
+      else
+        SecureRandom.uuid
+      end
     end
   end
 end

data/lib/marlowe/rails.rb

@@ -1,11 +1,28 @@
+# frozen_string_literal: true
+
 module Marlowe
-  class Railtie < Rails::Railtie
+  class Railtie < Rails::Railtie # :nodoc:
     initializer 'marlowe.configure_rails_initialization' do
-      app.middleware.insert_before Rails::Rack::Logger, Marlowe::Middleware, correlation_header: Rails.application.config.try(:marlowe_correlation_header)
+      config = app.config
+
+      opts = {
+        header: config.try(:marlowe_header) || config.try(:marlowe_correlation_header),
+        handler: config.try(:marlowe_request_id_handler),
+        return: config.try(:marlowe_return_request_id),
+        action_dispatch: config.try(:marlowe_replace_action_dispatch_request_id)
+      }.compact
+
+      if opts[:action_dispatch]
+        app.middleware.insert_before ActionDispatch::RequestId,
+          Marlowe::Middleware, opts
+        app.middleware.delete ActionDispatch::RequestId
+      else
+        app.middleware.insert_before Rails::Rack::Logger, Marlowe::Middleware,
+          opts
+      end
     end
 
-    #:nodoc:
-    def app
+    def app #:nodoc:
       Rails.application
     end
   end

data/lib/marlowe/simple_formatter.rb

@@ -12,5 +12,3 @@ module Marlowe
     end
   end
 end
-
-

data/test/minitest_config.rb

@@ -1,4 +1,4 @@
-# -*- ruby encoding: utf-8 -*-
+# frozen_string_literal: true
 
 gem 'minitest'
 
@@ -7,16 +7,5 @@ require 'rack/mock'
 require 'minitest/autorun'
 require 'minitest/focus'
 require 'minitest/moar'
-require 'minitest/bisect'
 
-require 'request_store'
 require 'marlowe'
-
-class RackApp
-  def call(env)
-  end
-
-  def coordination_id
-    RequestStore[:correlation_id]
-  end
-end

data/test/test_marlowe.rb

@@ -1,32 +1,102 @@
+# frozen_string_literal: true
+
 require 'minitest_config'
 
 class TestMarlowe < Minitest::Test
+  include Rack::Test::Methods
+
+  attr_reader :marlowe_options
+
   def setup
-    @app = RackApp.new
-    @middleware = Marlowe::Middleware.new(@app)
+    @marlowe_options = {}
+  end
+
+  def app
+    options = marlowe_options
+    Rack::Builder.new do
+      use Marlowe::Middleware, options
+
+      run lambda { |_env|
+        [
+          200,
+          { 'Content-Type' => 'text/plain' },
+          [ RequestStore[:correlation_id] ]
+        ]
+      }
+    end
+  end
+
+  def test_default_config_no_header_value
+    get '/'
+    assert last_response.header.key?('X-Request-Id')
+    refute_empty last_response.header['X-Request-Id']
+    assert_equal last_response.header['X-Request-Id'], last_response.body
+  end
+
+  def test_default_config_with_header_value
+    get '/', {}, { 'HTTP_X_REQUEST_ID' => 'testvalue' }
+    assert last_response.header.key?('X-Request-Id')
+    refute_empty last_response.header['X-Request-Id']
+    assert_equal last_response.header['X-Request-Id'], last_response.body
+    assert_equal 'testvalue', last_response.header['X-Request-Id']
+  end
+
+  def test_header_config_no_header_value
+    marlowe_options[:header] = 'Correlation-Id'
+    get '/'
+    assert last_response.header.key?('Correlation-Id')
+    refute_empty last_response.header['Correlation-Id']
+    assert_equal last_response.header['Correlation-Id'], last_response.body
+  end
+
+  def test_header_config_no_header_with_header_value
+    marlowe_options[:header] = 'Correlation-Id'
+    get '/', {}, { 'HTTP_CORRELATION_ID' => 'testvalue' }
+    assert last_response.header.key?('Correlation-Id')
+    refute_empty last_response.header['Correlation-Id']
+    assert_equal last_response.header['Correlation-Id'], last_response.body
+    assert_equal 'testvalue', last_response.header['Correlation-Id']
+  end
+
+  def test_handler_config_default_handler
+    get '/', {}, { 'HTTP_X_REQUEST_ID' => 'test+value' }
+    assert last_response.header.key?('X-Request-Id')
+    refute_empty last_response.header['X-Request-Id']
+    assert_equal last_response.header['X-Request-Id'], last_response.body
+    assert_equal 'testvalue', last_response.header['X-Request-Id']
   end
 
-  def test_no_header
-    @middleware.call({})
-    refute_empty @app.coordination_id
+  def test_handler_config_with_simple_handler
+    marlowe_options[:handler] = :simple
+    get '/', {}, { 'HTTP_X_REQUEST_ID' => 'test+value' }
+    assert last_response.header.key?('X-Request-Id')
+    refute_empty last_response.header['X-Request-Id']
+    assert_equal last_response.header['X-Request-Id'], last_response.body
+    assert_equal 'test+value', last_response.header['X-Request-Id']
   end
 
-  def test_with_header
-    @middleware.call({'HTTP_CORRELATION_ID' => 'testvalue'})
-    refute_empty @app.coordination_id
-    assert_equal 'testvalue', @app.coordination_id
+  def test_handler_config_with_proc_handler
+    marlowe_options[:handler] = ->(item) { item && item.reverse || SecureRandom.uuid }
+    get '/', {}, { 'HTTP_X_REQUEST_ID' => 'test+value' }
+    assert last_response.header.key?('X-Request-Id')
+    refute_empty last_response.header['X-Request-Id']
+    assert_equal last_response.header['X-Request-Id'], last_response.body
+    assert_equal 'eulav+tset', last_response.header['X-Request-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
+  def test_handler_config_with_proc_handler_returning_nil
+    marlowe_options[:handler] = ->(item) { nil }
+    get '/', {}, { 'HTTP_X_REQUEST_ID' => 'test+value' }
+    assert last_response.header.key?('X-Request-Id')
+    refute_empty last_response.header['X-Request-Id']
+    assert_equal last_response.header['X-Request-Id'], last_response.body
+    assert_match(/\A[-\w]+\z/, last_response.header['X-Request-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
+  def test_return_config_false
+    marlowe_options[:return] = false
+    get '/'
+    refute last_response.header.key?('X-Request-Id')
+    assert_equal RequestStore[:correlation_id], last_response.body
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: marlowe
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: '2.0'
 platform: ruby
 authors:
 - Trevor Oke
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-15 00:00:00.000000000 Z
+date: 2016-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: request_store
@@ -34,7 +34,7 @@ dependencies:
         version: '0.9'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -44,65 +44,79 @@ dependencies:
         version: '0.9'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.8'
+        version: '5.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.8'
+        version: '5.9'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: rack-test
+  name: hoe-doofus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: hoe-gemspec2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: hoe-doofus
+  name: hoe-git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: hoe-rubygems
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -116,103 +130,151 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: hoe-gemspec2
+  name: hoe-travis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: hoe-git
+  name: minitest-autotest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: hoe-travis
+  name: minitest-bonus-assertions
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: minitest-autotest
+  name: minitest-focus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: minitest-bisect
+  name: minitest-moar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0.0'
 - !ruby/object:Gem::Dependency
-  name: minitest-focus
+  name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
-  name: minitest-moar
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '12'
+- !ruby/object:Gem::Dependency
+  name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '4.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.32'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.32'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -233,32 +295,36 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.14'
+        version: '3.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.14'
-description: "{marlowe}[https://github.com/KineticCafe/marlowe] provides a correlation
-  id \nheader for Rails and Rack applications to correlate logs for a single request
-  \nacross multiple services."
+        version: '3.15'
+description: |-
+  {Marlowe}[https://github.com/KineticCafe/marlowe] is a Rack middleware that
+  extracts or creates a request ID using a pre-defined header, permitting request
+  correlation across multiple services.
+
+  When using Rails, Marlowe automatically adds itself to the middleware before
+  <tt>Rails::Rack::Logger</tt>.
 email:
 - toke@kineticcafe.com
 - dev@kineticcafe.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- History.rdoc
-- Licence.rdoc
+- Contributing.md
+- History.md
+- Licence.md
 - Manifest.txt
 - README.rdoc
 files:
-- ".autotest"
-- Gemfile
-- History.rdoc
-- Licence.rdoc
+- Contributing.md
+- History.md
+- Licence.md
 - Manifest.txt
 - README.rdoc
 - Rakefile
@@ -269,7 +335,7 @@ files:
 - lib/marlowe/simple_formatter.rb
 - test/minitest_config.rb
 - test/test_marlowe.rb
-homepage: 
+homepage: https://github.com/KineticCafe/marlowe/
 licenses:
 - MIT
 metadata: {}
@@ -281,9 +347,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -291,10 +357,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: "{marlowe}[https://github.com/KineticCafe/marlowe] provides a correlation
-  id  header for Rails and Rack applications to correlate logs for a single request
-  \ across multiple services."
+summary: "{Marlowe}[https://github.com/KineticCafe/marlowe] is a Rack middleware that
+  extracts or creates a request ID using a pre-defined header, permitting request
+  correlation across multiple services"
 test_files: []

data/.autotest

@@ -1,25 +0,0 @@
-# -*- ruby -*-
-
-require "autotest/restart"
-
-# Autotest.add_hook :initialize do |at|
-#   at.testlib = "minitest/unit"
-#
-#   at.extra_files << "../some/external/dependency.rb"
-#
-#   at.libs << ":../some/external"
-#
-#   at.add_exception "vendor"
-#
-#   at.add_mapping(/dependency.rb/) do |f, _|
-#     at.files_matching(/test_.*rb$/)
-#   end
-#
-#   %w(TestA TestB).each do |klass|
-#     at.extra_class_map[klass] = "test/test_misc.rb"
-#   end
-# end
-
-# Autotest.add_hook :run_command do |at|
-#   system "rake build"
-# end

data/Gemfile

@@ -1,9 +0,0 @@
-# -*- ruby -*-
-
-# NOTE: This file is present to keep Travis CI happy. Edits to it will not
-# be accepted.
-
-source 'https://rubygems.org/'
-gemspec
-
-# vim: filetype=ruby

data/History.rdoc

@@ -1,17 +0,0 @@
-=== 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]
-
-=== 1.0.1 / 2015-10-20
-
-* Update gemspec with homepage
-* Update Rakefile
-
-=== 1.0.0 / 2015-10-16
-
-* Initial Commit