gds-api-adapters 8.0.0 → 8.1.0

data/README.md

@@ -43,12 +43,25 @@ the form:
     PANOPTICON_API_CREDENTIALS = { bearer_token: 'MY_BEARER_TOKEN' }
 
 
+## Middleware for request tracing
+
+We set a unique header at the cache level called `GOVUK-Request-Id`. In order
+to serve a user's request, if apps make API requests they should pass on this
+header, so that we can trace a request across the entire GOV.UK stack.
+
+`GdsApi::GovukRequestIdSniffer` middleware takes care of this. This gem contains
+a railtie that configures this middleware for Rails apps without extra effort.
+Other Rack-based apps should opt-in by adding this line to your `config.ru`:
+
+```use GdsApi::GovukRequestIdSniffer```
+
+
 ## Test Helpers
 
 There are also test helpers for stubbing various requests in other apps.
 Example usage of the panopticon helper:
 
-In test_helper.rb:
+In `test_helper.rb`:
 
     require 'gds_api/test_helpers/panopticon'
 
@@ -63,7 +76,7 @@ In the test:
 
 ### Dependencies
 
-Some of the helpers come with additional dependencies that you'll need to 
+Some of the helpers come with additional dependencies that you'll need to
 have installed and configured in your consuming app/lib.
 
 At time of writing, these are:

data/lib/gds-api-adapters.rb

@@ -0,0 +1 @@
+require 'gds_api/railtie' if defined?(Rails)

data/lib/gds_api/govuk_request_id.rb

@@ -0,0 +1,15 @@
+class GdsApi::GovukRequestId
+  class << self
+    def set?
+      !(value.nil? || value.empty?)
+    end
+
+    def value
+      Thread.current[:govuk_request_id]
+    end
+
+    def value=(new_id)
+      Thread.current[:govuk_request_id] = new_id
+    end
+  end
+end

data/lib/gds_api/json_client.rb

@@ -2,6 +2,7 @@ require_relative 'response'
 require_relative 'exceptions'
 require_relative 'version'
 require_relative 'null_cache'
+require_relative 'govuk_request_id'
 require 'lrucache'
 require 'rest-client'
 
@@ -165,6 +166,7 @@ module GdsApi
     end
 
     def with_headers(method_params, headers)
+      headers = headers.merge(govuk_request_id: GdsApi::GovukRequestId.value) if GdsApi::GovukRequestId.set?
       method_params.merge(
         headers: method_params[:headers].merge(headers)
       )

data/lib/gds_api/middleware/govuk_request_id_sniffer.rb

@@ -0,0 +1,14 @@
+require_relative '../govuk_request_id'
+
+module GdsApi
+  class GovukRequestIdSniffer
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      GdsApi::GovukRequestId.value = env['HTTP_GOVUK_REQUEST_ID']
+      @app.call(env)
+    end
+  end
+end

data/lib/gds_api/railtie.rb

@@ -0,0 +1,10 @@
+require_relative 'middleware/govuk_request_id_sniffer'
+
+module GdsApi
+  class Railtie < Rails::Railtie
+    initializer "gds_api.initialize_govuk_request_id_sniffer" do |app|
+      Rails.logger.info "Using middleware GdsApi::GovukRequestIdSniffer to sniff for GOVUK-Request-Id header"
+      app.middleware.use GdsApi::GovukRequestIdSniffer
+    end
+  end
+end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '8.0.0'
+  VERSION = '8.1.0'
 end

data/test/json_client_test.rb

@@ -579,7 +579,7 @@ class JsonClientTest < MiniTest::Spec
   def test_client_can_set_custom_headers_on_gets
     stub_request(:get, "http://some.other.endpoint/some.json").to_return(:status => 200)
 
-    response = GdsApi::JsonClient.new.get_json("http://some.other.endpoint/some.json", 
+    response = GdsApi::JsonClient.new.get_json("http://some.other.endpoint/some.json",
                                                { "HEADER-A" => "B", "HEADER-C" => "D" })
 
     assert_requested(:get, %r{/some.json}) do |request|
@@ -591,7 +591,7 @@ class JsonClientTest < MiniTest::Spec
   def test_client_can_set_custom_headers_on_posts
     stub_request(:post, "http://some.other.endpoint/some.json").to_return(:status => 200)
 
-    response = GdsApi::JsonClient.new.post_json("http://some.other.endpoint/some.json", {}, 
+    response = GdsApi::JsonClient.new.post_json("http://some.other.endpoint/some.json", {},
                                                 { "HEADER-A" => "B", "HEADER-C" => "D" })
 
     assert_requested(:post, %r{/some.json}) do |request|
@@ -603,7 +603,7 @@ class JsonClientTest < MiniTest::Spec
   def test_client_can_set_custom_headers_on_puts
     stub_request(:put, "http://some.other.endpoint/some.json").to_return(:status => 200)
 
-    response = GdsApi::JsonClient.new.put_json("http://some.other.endpoint/some.json", {}, 
+    response = GdsApi::JsonClient.new.put_json("http://some.other.endpoint/some.json", {},
                                                { "HEADER-A" => "B", "HEADER-C" => "D" })
 
     assert_requested(:put, %r{/some.json}) do |request|
@@ -615,7 +615,7 @@ class JsonClientTest < MiniTest::Spec
   def test_client_can_set_custom_headers_on_deletes
     stub_request(:delete, "http://some.other.endpoint/some.json").to_return(:status => 200)
 
-    response = GdsApi::JsonClient.new.delete_json("http://some.other.endpoint/some.json", {}, 
+    response = GdsApi::JsonClient.new.delete_json("http://some.other.endpoint/some.json", {},
                                                   { "HEADER-A" => "B", "HEADER-C" => "D" })
 
     assert_requested(:delete, %r{/some.json}) do |request|
@@ -624,6 +624,26 @@ class JsonClientTest < MiniTest::Spec
     end
   end
 
+  def test_govuk_request_id_gets_set_if_present
+    GdsApi::GovukRequestId.value = "12345" # set by middleware GovukRequestIdSniffer
+    stub_request(:get, "http://some.other.endpoint/some.json").to_return(:status => 200)
+
+    GdsApi::JsonClient.new.get_json("http://some.other.endpoint/some.json")
+
+    assert_requested(:get, %r{/some.json}) do |request|
+      request.headers['Govuk-Request-Id'] == '12345'
+    end
+  end
+
+  def test_additional_headers_passed_in_do_not_get_modified
+    stub_request(:get, "http://some.other.endpoint/some.json").to_return(:status => 200)
+
+    headers = { 'HEADER-A' => 'A' }
+    GdsApi::JsonClient.new.get_json("http://some.other.endpoint/some.json", headers)
+
+    assert_equal({ 'HEADER-A' => 'A' }, headers)
+  end
+
   def test_client_can_decompress_gzip_responses
     url = "http://some.endpoint/some.json"
     # {"test": "hello"}

data/test/middleware/govuk_request_id_sniffer_test.rb

@@ -0,0 +1,18 @@
+require 'test_helper'
+require 'gds_api/middleware/govuk_request_id_sniffer'
+
+describe GdsApi::GovukRequestIdSniffer do
+  include Rack::Test::Methods
+
+  let(:inner_app) do
+    lambda { |env| [200, {'Content-Type' => 'text/plain'}, ['All good!']] }
+  end
+
+  let(:app) { GdsApi::GovukRequestIdSniffer.new(inner_app) }
+
+  it "sniffs the govuk request id from request headers" do
+    header "Govuk-Request-Id", "12345"
+    get "/"
+    assert_equal '12345', GdsApi::GovukRequestId.value
+  end
+end

data/test/test_helper.rb

@@ -8,6 +8,7 @@ Bundler.setup :default, :development, :test
 
 require 'minitest/autorun'
 require 'rack/utils'
+require 'rack/test'
 require 'simplecov'
 require 'simplecov-rcov'
 require 'mocha'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 8.0.0
+  version: 8.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -187,6 +187,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -258,10 +274,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/gds-api-adapters.rb
 - lib/gds_api/support.rb
 - lib/gds_api/rummager.rb
 - lib/gds_api/part_methods.rb
 - lib/gds_api/need_api.rb
+- lib/gds_api/railtie.rb
 - lib/gds_api/exceptions.rb
 - lib/gds_api/json_client.rb
 - lib/gds_api/base.rb
@@ -290,9 +308,11 @@ files:
 - lib/gds_api/needotron.rb
 - lib/gds_api/null_cache.rb
 - lib/gds_api/imminence.rb
+- lib/gds_api/govuk_request_id.rb
 - lib/gds_api/worldwide.rb
 - lib/gds_api/mapit.rb
 - lib/gds_api/helpers.rb
+- lib/gds_api/middleware/govuk_request_id_sniffer.rb
 - lib/gds_api/panopticon.rb
 - lib/gds_api/asset_manager.rb
 - lib/gds_api/gov_uk_delivery.rb
@@ -314,6 +334,7 @@ files:
 - test/gov_uk_delivery_test.rb
 - test/panopticon_api_test.rb
 - test/panopticon_registerer_test.rb
+- test/middleware/govuk_request_id_sniffer_test.rb
 - test/rummager_test.rb
 - test/json_client_test.rb
 - test/content_api_test.rb
@@ -343,7 +364,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2067444062740093796
+      hash: -1483996754784440811
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -352,7 +373,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2067444062740093796
+      hash: -1483996754784440811
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -369,6 +390,7 @@ test_files:
 - test/gov_uk_delivery_test.rb
 - test/panopticon_api_test.rb
 - test/panopticon_registerer_test.rb
+- test/middleware/govuk_request_id_sniffer_test.rb
 - test/rummager_test.rb
 - test/json_client_test.rb
 - test/content_api_test.rb