marlowe 1.0.1 → 2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 138fa6a06399a2de3f1728a7d22c6e30c2911f27
-  data.tar.gz: ca42fe17d9f5463c905845d99a12bec35acfd96b
+SHA256:
+  metadata.gz: 942139256c91a7b04a4549271e176b8dab519dd566df088dc818198e8d285065
+  data.tar.gz: 00a699c0d9ce21ada8c453ea638a0f972f64307e7572be8aa3dca7629922f598
 SHA512:
-  metadata.gz: 40aa66da8708cecb902f47d682f73340b3e4d91421e5ec5862fb306d493b3e2440e006ff97d350373677450fc09669815ceb833c4b12e4c0ee88ec6d19f01232
-  data.tar.gz: 25c2d9a63f75ed0de4a9d09cd8d90a5739ccf0fc7bdcddaa95b8742ca10fde6b328089d9abf2c51229576605c62743b75f2608770b8b035255d831d02fd4029c
+  metadata.gz: 6dfa8bd46ddc990b643db1d01925da2a694fba37466c4dfacaab2dd36c776aa8f6f26e8fa64b5e35f5e52d91095e8ad1cf368a382f5c2188defc62596be1a63d
+  data.tar.gz: ee94d6e57c9dc02ae7690977281dc9a62051465ef45330474aac3e2284f68d438099409736a32806ecff61da2f9191d8eaf9869300f48e6464c943ee6caf608a

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,36 @@
+### 2.1 / 2021-09-08
+
+- Allow the use of Ruby 3.
+- Switch to standardruby instead of rubocop.
+- Switch from Travis to Github Actions.
+
+### 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,6 +1,6 @@
-.autotest
-History.rdoc
-Licence.rdoc
+Contributing.md
+History.md
+Licence.md
 Manifest.txt
 README.rdoc
 Rakefile
@@ -9,3 +9,5 @@ lib/marlowe/formatter.rb
 lib/marlowe/middleware.rb
 lib/marlowe/rails.rb
 lib/marlowe/simple_formatter.rb
+test/minitest_config.rb
+test/test_marlowe.rb

data/README.rdoc

@@ -1,27 +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.
 
-or add it into a Gemfile:
+To keep complete compatibility with Marlowe 1.0, the following should be used:
 
-  gem 'marlowe'
+  # Rails
+  config.marlowe_header = 'Correlation-Id'
+  config.marlowe_handler = :simple
+  config.marlowe_return = false
+
+  # Rack
+  use Marlowe::Middleware, header: 'Correlation-Id', handler: :simple, return: false
 
 == Configuration
 
-There is no configuration as of yet. Future plans include configuring the name
-of the correlation id header.
+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
+    }
+
+=== Request ID Return
+
+If +true+ (the default), the request correlation ID will be returned to the
+client in the same header that it was provided in.
+
+    # Rails
+    config.marlowe_return = false
+
+    # Rack
+    use Marlowe::Middleware, return: false
+
+=== 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.
@@ -30,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 = CorrelatedSimpleFormatter.new
+    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:
 
@@ -52,12 +128,29 @@ You can use this pattern if you've rolled your own logger/formatter:
     end
   end
 
+=== Lograge
+
+As {lograge}[https://github.com/roidrage/lograge] supplies its own formatter,
+you will need to do something a little different:
+
+  # config/application.rb
+  
+  class Application < Rails::Application
+    config.before_initialize do
+      ...
+      # use lograge for all request logs
+      config.lograge.enabled = true
+      config.lograge.custom_options = lambda do |event|
+        { correlation_id: RequestStore[:correlation_id] }
+      end
+    end
+  end
 
 == Clients
 
 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:
 
@@ -69,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 
@@ -89,11 +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,14 +1,68 @@
-# -*- ruby -*-
+# frozen_string_literal: true
 
 require "rubygems"
 require "hoe"
+require "rake/clean"
 
-Hoe.plugin :minitest
+Hoe.plugin :doofus
+Hoe.plugin :email unless ENV["CI"]
+Hoe.plugin :gemspec2
 Hoe.plugin :git
+Hoe.plugin :minitest
+Hoe.plugin :rubygems
 
-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.md"
+  self.readme_file = "README.rdoc"
+
   license "MIT"
+
+  require_ruby_version ">= 2.0", "< 4"
+
+  extra_deps << ["request_store", "~> 1.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 << ["minitest", "~> 5.4"]
+  extra_dev_deps << ["minitest-autotest", "~> 1.0"]
+  extra_dev_deps << ["minitest-bonus-assertions", "~> 3.0"]
+  extra_dev_deps << ["minitest-focus", "~> 1.1"]
+  extra_dev_deps << ["minitest-moar", "~> 0.0"]
+  extra_dev_deps << ["rack-test", "~> 1.0"]
+  extra_dev_deps << ["rake", ">= 10.0", "< 14"]
+  extra_dev_deps << ["rdoc", ">= 4.2"]
+  extra_dev_deps << ["standard", "~> 1.0"]
+  extra_dev_deps << ["simplecov", "~> 0.21"]
+  extra_dev_deps << ["psych", "~> 3.1"]
+end
+
+ENV["RUBYOPT"] = "-W0"
+
+module Hoe::Publish #:nodoc:
+  alias_method :__make_rdoc_cmd__marlowe__, :make_rdoc_cmd
+
+  def make_rdoc_cmd(*extra_args) # :nodoc:
+    spec.extra_rdoc_files.reject! { |f| f == "Manifest.txt" }
+    __make_rdoc_cmd__marlowe__(*extra_args)
+  end
+end
+
+if File.exist?(".simplecov-prelude.rb")
+  namespace :test do
+    task :coverage do
+      spec.test_prelude = 'load ".simplecov-prelude.rb"'
+      Rake::Task["test"].execute
+    end
+
+    CLOBBER << "coverage"
+  end
 end
 
-# vim: syntax=ruby
+CLOBBER << "tmp"

data/lib/marlowe/formatter.rb

@@ -1,13 +1,13 @@
-require 'request_store'
+# frozen_string_literal: true
 
-module Marlowe
+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,26 +1,97 @@
-require 'rack'
-require 'request_store'
-require 'securerandom'
+# frozen_string_literal: true
 
-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.
+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.
   class Middleware
-    # Sets the the rack application to +app+
-    def initialize(app)
+    # 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
+      @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['HTTP_CORRELATION_ID'] ||= SecureRandom.uuid
-      RequestStore.store[:correlation_id] = env['HTTP_CORRELATION_ID']
+      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
+
+      @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_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.is_a?(Proc)
+        simple(@handler.call(request_id))
+      else
+        clean(request_id)
+      end
+    end
+
+    def clean(request_id)
+      simple(request_id).gsub(/[^\w\-]/, "")[0, 255]
+    end
 
-      @status, @headers, @response = @app.call(env)
-      [@status, @headers, @response]
+    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
-    initializer 'marlowe.configure_rails_initialization' do
-      app.middleware.insert_before Rails::Rack::Logger, Marlowe::Middleware
+  class Railtie < Rails::Railtie # :nodoc:
+    initializer "marlowe.configure_rails_initialization" do
+      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

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

data/lib/marlowe.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 # Marlowe, a correlation id injector.
 module Marlowe
-  VERSION = '1.0.1' #:nodoc:
+  VERSION = "2.1" #:nodoc:
 
-  require 'marlowe/middleware'
-  require 'marlowe/rails' if defined? Rails::Railtie
+  require "marlowe/middleware"
+  require "marlowe/rails" if defined? Rails::Railtie
 
-  autoload :Formatter, 'marlowe/formatter'
-  autoload :SimpleFormatter, 'marlowe/simple_formatter'
+  autoload :Formatter, "marlowe/formatter"
+  autoload :SimpleFormatter, "marlowe/simple_formatter"
 end

data/test/minitest_config.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+gem "minitest"
+
+require "rack/test"
+require "rack/mock"
+require "minitest/autorun"
+require "minitest/focus"
+require "minitest/moar"
+
+require "marlowe"

data/test/test_marlowe.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require "minitest_config"
+
+class TestMarlowe < Minitest::Test
+  include Rack::Test::Methods
+
+  attr_reader :marlowe_options
+
+  def setup
+    @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_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_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_handler_config_with_proc_handler_returning_nil
+    marlowe_options[:handler] = ->(item) {}
+    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_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,73 +1,316 @@
 --- !ruby/object:Gem::Specification
 name: marlowe
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: '2.1'
 platform: ruby
 authors:
 - Trevor Oke
-autorequire: 
+- Kinetic Cafe
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-10-20 00:00:00.000000000 Z
+date: 2021-09-09 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: request_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.8'
+        version: '5.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: hoe-doofus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: hoe-gemspec2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  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:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-autotest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-bonus-assertions
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-focus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: minitest-moar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.8'
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '14'
 - !ruby/object:Gem::Dependency
   name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: psych
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: hoe
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.14'
+        version: '3.23'
   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.23'
+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"
-- History.rdoc
-- Licence.rdoc
+- Contributing.md
+- History.md
+- Licence.md
 - Manifest.txt
 - README.rdoc
 - Rakefile
@@ -76,11 +319,15 @@ files:
 - lib/marlowe/middleware.rb
 - lib/marlowe/rails.rb
 - lib/marlowe/simple_formatter.rb
-homepage: 
+- test/minitest_config.rb
+- test/test_marlowe.rb
+homepage: https://github.com/KineticCafe/marlowe/
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  source_code_uri: https://github.com/KineticCafe/marlowe/
+  documentation_uri: http://www.rubydoc.info/github/KineticCafe/marlowe/master
+post_install_message:
 rdoc_options:
 - "--main"
 - README.rdoc
@@ -90,18 +337,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
-signing_key: 
+rubygems_version: 3.1.6
+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/History.rdoc

@@ -1,8 +0,0 @@
-=== 1.0.1 / 2015-10-20
-
-* Update gemspec with homepage
-* Update Rakefile
-
-=== 1.0.0 / 2015-10-16
-
-* Initial Commit