gds-api-adapters 28.1.1 → 28.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e902ac4880261bd833cfaaf435bb6c6887337f7f
-  data.tar.gz: 078679c8c239e9f431da180ebf87a205a8683f9b
+  metadata.gz: b9723069f15e906994434db9e846a9d312f7bdb1
+  data.tar.gz: 04a3f4851097ca03fbb130f14f32380fa9ee9d0e
 SHA512:
-  metadata.gz: eca01f58f14c1e86a7c947480ede2b024fd5e8d179442388b9f3336d3d18e34f207c897740a40a5f1f566ab079c4150bb61b531115a9ce8a99607063b132d7e6
-  data.tar.gz: b02e5d2a3f9696d48d7ca587b86ea132a4186ecf5b74029bf4a9487b0681c389ccd999546c7924bda4c38932d369c22401294e2e2a595bec2501567c97ffb5bf
+  metadata.gz: da34eae72d2c0fcf451b4db6376aaa74ac268bd1fee74ef6ad541727e626855a7497e34934f77345c09875a9ff873c06b4de6fbc58c4d4c5ac5d0772230c0fbc
+  data.tar.gz: 7fb8ebf8449dc9eeb9c63f26d8eb19bc4203d2056ceffca321d776e64ad0b06d371ab262cacc4bca683c3b16c3e1345efbbcbfb6cd3c51e914582a8fadbd66e1

data/README.md

@@ -31,15 +31,19 @@ something that actually logs:
 
 ## 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.
+We set a unique header at the cache level called `Govuk-Request-Id`, and also
+set a header called `Govuk-Original-Url` to identify the original URL
+requested.  If apps make API requests in order to server a user's request, they
+should pass on these headers, so that we can trace requests across the entire
+GOV.UK stack.
 
-`GdsApi::GovukHeaderSniffer` 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`:
+The `GdsApi::GovukHeaderSniffer` 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 these lines to your
+`config.ru`:
 
     use GdsApi::GovukHeaderSniffer, 'HTTP_GOVUK_REQUEST_ID'
+    use GdsApi::GovukHeaderSniffer, 'HTTP_GOVUK_ORIGINAL_URL'
 
 ## Middleware for identifying authenticated users
 

data/lib/gds_api/railtie.rb

@@ -7,6 +7,11 @@ module GdsApi
       app.middleware.use GdsApi::GovukHeaderSniffer, 'HTTP_GOVUK_REQUEST_ID'
     end
 
+    initializer "gds_api.initialize_govuk_original_url_sniffer" do |app|
+      Rails.logger.info "Using middleware GdsApi::GovukHeaderSniffer to sniff for GOVUK-Original-Url header"
+      app.middleware.use GdsApi::GovukHeaderSniffer, 'HTTP_GOVUK_ORIGINAL_URL'
+    end
+
     initializer "gds_api.initialize_govuk_authenticated_user_sniffer" do |app|
       Rails.logger.info "Using middleware GdsApi::GovukHeaderSniffer to sniff for X-GOVUK-Authenticated-User header"
       app.middleware.use GdsApi::GovukHeaderSniffer, 'HTTP_X_GOVUK_AUTHENTICATED_USER'

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '28.1.1'
+  VERSION = '28.2.0'
 end

data/test/json_client_test.rb

@@ -702,13 +702,17 @@ class JsonClientTest < MiniTest::Spec
   end
 
   def test_govuk_headers_are_included_in_requests_if_present
-    GdsApi::GovukHeaders.set_header(:govuk_request_id, "12345") # set by middleware GovukHeaderSniffer
+    # set headers which would be set by middleware GovukHeaderSniffer
+    GdsApi::GovukHeaders.set_header(:govuk_request_id, "12345")
+    GdsApi::GovukHeaders.set_header(:govuk_original_url, "http://example.com")
+
     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'
+      request.headers['Govuk-Request-Id'] == '12345' &&
+      request.headers['Govuk-Original-Url'] == 'http://example.com'
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 28.1.1
+  version: 28.2.0
 platform: ruby
 authors:
 - James Stewart
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-18 00:00:00.000000000 Z
+date: 2016-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plek