gds-api-adapters 4.8.0 → 4.9.0

data/lib/gds_api/content_api.rb

@@ -1,10 +1,21 @@
 require_relative 'base'
 require_relative 'exceptions'
+require 'gds_api/content_api/response'
 require 'gds_api/content_api/list_response'
 
 class GdsApi::ContentApi < GdsApi::Base
   include GdsApi::ExceptionHandling
 
+  def initialize(endpoint_url, options = {})
+    # If the `web_urls_relative_to` option is given, the adapter will convert
+    # any `web_url` values to relative URLs if they are from the same host.
+    #
+    # For example: "https://www.gov.uk"
+
+    @web_urls_relative_to = options.delete(:web_urls_relative_to)
+    super
+  end
+
   def sections
     get_list!("#{base_url}/tags.json?type=section")
   end
@@ -86,11 +97,29 @@ class GdsApi::ContentApi < GdsApi::Base
   end
 
   def get_list!(url)
-    get_json!(url) { |r| ListResponse.new(r, self) }
+    get_json!(url) { |r|
+      ListResponse.new(r, self, web_urls_relative_to: @web_urls_relative_to)
+    }
   end
 
   def get_list(url)
-    get_json(url) { |r| ListResponse.new(r, self) }
+    get_json(url) { |r|
+      ListResponse.new(r, self, web_urls_relative_to: @web_urls_relative_to)
+    }
+  end
+
+  def get_json(url, &create_response)
+    create_response = create_response || Proc.new { |r|
+      GdsApi::ContentApi::Response.new(r, web_urls_relative_to: @web_urls_relative_to)
+    }
+    super(url, &create_response)
+  end
+
+  def get_json!(url, &create_response)
+    create_response = create_response || Proc.new { |r|
+      GdsApi::ContentApi::Response.new(r, web_urls_relative_to: @web_urls_relative_to)
+    }
+    super(url, &create_response)
   end
 
   def countries

data/lib/gds_api/content_api/list_response.rb

@@ -9,12 +9,12 @@ class GdsApi::ContentApi < GdsApi::Base
   # These responses are in a common format, with the list of results contained
   # under the `results` key. The response may also have previous and subsequent
   # pages, indicated by entries in the response's `Link` header.
-  class ListResponse < GdsApi::Response
+  class ListResponse < Response
 
     # The ListResponse is instantiated with a reference back to the API client,
     # so it can make requests for the subsequent pages
-    def initialize(response, api_client)
-      super(response)
+    def initialize(response, api_client, options = {})
+      super(response, options)
       @api_client = api_client
     end
 

data/lib/gds_api/content_api/response.rb

@@ -0,0 +1,56 @@
+module GdsApi
+  class ContentApi < GdsApi::Base
+    class Response < GdsApi::Response
+      # Responses from the content API can be configured to use relative URLs
+      # for `web_url` properties. This is useful on non-canonical frontends,
+      # such as those in staging environments.
+      #
+      # Example:
+      #
+      #   r = Response.new(response, web_urls_relative_to: "https://www.gov.uk")
+      #   r.results[0].web_url
+      #   => "/bank-holidays"
+
+      WEB_URL_KEYS = ["web_url"]
+
+      def initialize(http_response, options = {})
+        if options[:web_urls_relative_to]
+          @web_urls_relative_to = URI.parse(options[:web_urls_relative_to])
+        else
+          @web_urls_relative_to = nil
+        end
+
+        super(http_response)
+      end
+
+      def to_hash
+        @parsed ||= transform_parsed(JSON.parse(@http_response.body))
+      end
+
+    private
+      def transform_parsed(value)
+        case value
+        when Hash
+          Hash[value.map { |k, v|
+            # NOTE: Don't bother transforming if the value is nil
+            if @web_urls_relative_to && WEB_URL_KEYS.include?(k) && v
+              # Use relative URLs to route when the web_url value is on the
+              # same domain as the site root. Note that we can't just use the
+              # `route_to` method, as this would give us technically correct
+              # but potentially confusing `//host/path` URLs for URLs with the
+              # same scheme but different hosts.
+              relative_url = @web_urls_relative_to.route_to(v)
+              [k, relative_url.host ? v : relative_url.to_s]
+            else
+              [k, transform_parsed(v)]
+            end
+          }]
+        when Array
+          value.map { |v| transform_parsed(v) }
+        else
+          value
+        end
+      end
+    end
+  end
+end

data/lib/gds_api/json_client.rb

@@ -49,15 +49,15 @@ module GdsApi
     # and return nil.
     [:get, :post, :put, :delete].each do |http_method|
       method_name = "#{http_method}_json"
-      define_method method_name do |url, *args|
+      define_method method_name do |url, *args, &block|
         ignoring GdsApi::HTTPNotFound do
-          send (method_name + "!"), url, *args
+          send (method_name + "!"), url, *args, &block
         end
       end
     end
 
     def get_json!(url, &create_response)
-      @cache[url] ||= do_json_request(:get, url, nil, &create_response)
+      do_json_request(:get, url, nil, &create_response)
     end
 
     def post_json!(url, params)
@@ -92,7 +92,7 @@ module GdsApi
     def do_json_request(method, url, params = nil, &create_response)
 
       begin
-        response = do_request(method, url, params)
+        response = do_request_with_cache(method, url, params)
 
       rescue RestClient::ResourceNotFound => e
         raise GdsApi::HTTPNotFound.new(e.http_code)
@@ -149,6 +149,16 @@ module GdsApi
       )
     end
 
+    def do_request_with_cache(method, url, params = nil)
+      # Only read GET requests from the cache: any other request methods should
+      # always be passed through
+      if method == :get
+        @cache[url] ||= do_request(method, url, params)
+      else
+        do_request(method, url, params)
+      end
+    end
+
     def do_request(method, url, params = nil)
       loggable = {request_uri: url, start_time: Time.now.to_f}
       start_logging = loggable.merge(action: 'start')

data/lib/gds_api/test_helpers/content_api.rb

@@ -220,6 +220,7 @@ module GdsApi
           "details" => {
             "type" => tag_type
           },
+          "web_url" => nil,
           "content_with_tag" => {
             "id" => "#{CONTENT_API_ENDPOINT}/with_tag.json?tag=#{CGI.escape(slug)}",
             "web_url" => "https://www.test.gov.uk/browse/#{slug}",

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '4.8.0'
+  VERSION = '4.9.0'
 end

data/test/content_api_response_test.rb

@@ -0,0 +1,97 @@
+require "test_helper"
+require "gds_api/content_api"
+
+describe "GdsApi::ContentApi::Response" do
+
+  DummyNetResponse = Struct.new(:body)
+
+  def response_for(net_response)
+    root = "https://www.gov.uk"
+    GdsApi::ContentApi::Response.new(net_response, web_urls_relative_to: root)
+  end
+
+  it "should map web URLs" do
+    body = {
+      "web_url" => "https://www.gov.uk/test"
+    }.to_json
+    assert_equal "/test", response_for(DummyNetResponse.new(body)).web_url
+  end
+
+  it "should leave other properties alone" do
+    body = {
+      "title" => "Title",
+      "description" => "Description"
+    }.to_json
+    response = response_for(DummyNetResponse.new(body))
+    assert_equal "Title", response.title
+    assert_equal "Description", response.description
+  end
+
+  it "should traverse into arrays" do
+    body = {
+      "other_urls" => [
+        { "title" => "Pies", "web_url" => "https://www.gov.uk/pies" },
+        { "title" => "Cheese", "web_url" => "https://www.gov.uk/cheese" }
+      ]
+    }.to_json
+
+    response = response_for(DummyNetResponse.new(body))
+    assert_equal "/pies", response.other_urls[0].web_url
+    assert_equal "/cheese", response.other_urls[1].web_url
+  end
+
+  it "should traverse into hashes" do
+    body = {
+      "details" => {
+        "chirality" => "widdershins",
+        "web_url" => "https://www.gov.uk/left"
+      }
+    }.to_json
+
+    response = response_for(DummyNetResponse.new(body))
+    assert_equal "/left", response.details.web_url
+  end
+
+  it "should handle nil values" do
+    body = {"web_url" => nil}.to_json
+
+    response = response_for(DummyNetResponse.new(body))
+    assert_nil response.web_url
+  end
+
+  it "should handle query parameters" do
+    body = {
+      "web_url" => "https://www.gov.uk/thing?does=stuff"
+    }.to_json
+
+    response = response_for(DummyNetResponse.new(body))
+    assert_equal "/thing?does=stuff", response.web_url
+  end
+
+  it "should handle fragments" do
+    body = {
+      "web_url" => "https://www.gov.uk/thing#part-2"
+    }.to_json
+
+    response = response_for(DummyNetResponse.new(body))
+    assert_equal "/thing#part-2", response.web_url
+  end
+
+  it "should keep URLs from other domains absolute" do
+    body = {
+      "web_url" => "https://www.example.com/example"
+    }.to_json
+
+    response = response_for(DummyNetResponse.new(body))
+    assert_equal "https://www.example.com/example", response.web_url
+  end
+
+  it "should keep URLs with other schemes absolute" do
+    body = {
+      "web_url" => "http://www.example.com/example"
+    }.to_json
+
+    response = response_for(DummyNetResponse.new(body))
+    assert_equal "http://www.example.com/example", response.web_url
+  end
+end

data/test/content_api_test.rb

@@ -10,6 +10,70 @@ describe GdsApi::ContentApi do
     @api = GdsApi::ContentApi.new(@base_api_url)
   end
 
+  describe "when asked for relative web URLs" do
+    before do
+      @api = GdsApi::ContentApi.new(
+        @base_api_url,
+        web_urls_relative_to: "http://www.test.gov.uk"
+      )
+    end
+
+    it "should use relative URLs for an artefact" do
+      artefact_response = artefact_for_slug_in_a_section("bank-holidays", "cheese")
+
+      # Rewrite the web_url fields to have a common prefix
+      # The helper's default is to point the web_url for an artefact at the
+      # frontend app, and the web_url for a tag's content to www: to test the
+      # rewriting properly, they need to be the same
+      artefact_response["web_url"] = "http://www.test.gov.uk/bank-holidays"
+      section_tag_content = artefact_response["tags"][0]["content_with_tag"]
+      section_tag_content["web_url"] = "http://www.test.gov.uk/browse/cheese"
+
+      content_api_has_an_artefact("bank-holidays", artefact_response)
+      artefact = @api.artefact("bank-holidays")
+
+      assert_equal "Bank holidays", artefact.title
+      assert_equal "/bank-holidays", artefact.web_url
+
+      assert_equal "/browse/cheese", artefact.tags[0].content_with_tag.web_url
+    end
+
+    it "should use relative URLs for tag listings" do
+      content_api_has_root_sections %w(housing benefits tax)
+      tags = @api.root_sections
+
+      assert_equal 3, tags.count
+      tags.each do |tag|
+        web_url = tag.content_with_tag.web_url
+        assert web_url.start_with?("/browse/"), web_url
+      end
+    end
+
+    describe "with caching enabled" do
+      before do
+        @original_cache = GdsApi::JsonClient.cache
+        GdsApi::JsonClient.cache = LRUCache.new(max_size: 10, ttl: 10)
+      end
+
+      it "should not pollute the cache with relative URLs" do
+        artefact_response = artefact_for_slug("bank-holidays")
+        artefact_response["web_url"] = "http://www.test.gov.uk/bank-holidays"
+        content_api_has_an_artefact("bank-holidays", artefact_response)
+
+        assert_equal "/bank-holidays", @api.artefact("bank-holidays").web_url
+
+        clean_api = GdsApi::ContentApi.new(@base_api_url)
+        clean_artefact = clean_api.artefact("bank-holidays")
+
+        assert_equal "http://www.test.gov.uk/bank-holidays", clean_artefact.web_url
+      end
+
+      after do
+        GdsApi::JsonClient.cache = @original_cache
+      end
+    end
+  end
+
   describe "sections" do
     it "should show a list of sections" do
       content_api_has_root_sections(["crime"])

data/test/json_client_test.rb

@@ -73,7 +73,7 @@ class JsonClientTest < MiniTest::Spec
     stub_request(:get, url).to_return(:body => JSON.dump(result), :status => 200)
     response_a = GdsApi::JsonClient.new.get_json(url)
     response_b = GdsApi::JsonClient.new.get_json(url)
-    assert_equal response_a.object_id, response_b.object_id
+    assert_equal response_a.to_hash, response_b.to_hash
     assert_requested :get, url, times: 1
   end
 
@@ -131,13 +131,13 @@ class JsonClientTest < MiniTest::Spec
     response_b = GdsApi::JsonClient.new.get_json(url)
 
     assert_requested :get, url, times: 1
-    assert_equal response_a.object_id, response_b.object_id
+    assert_equal response_a.to_hash, response_b.to_hash
 
     Timecop.travel( 15 * 60 - 30) do # now + 14 mins 30 secs
       response_c = GdsApi::JsonClient.new.get_json(url)
 
       assert_requested :get, url, times: 1
-      assert_same response_a, response_c
+      assert_equal response_a.to_hash, response_c.to_hash
     end
 
     Timecop.travel( 15 * 60 + 30) do # now + 15 mins 30 secs
@@ -158,13 +158,13 @@ class JsonClientTest < MiniTest::Spec
     response_b = GdsApi::JsonClient.new.get_json(url)
 
     assert_requested :get, url, times: 1
-    assert_equal response_a.object_id, response_b.object_id
+    assert_equal response_a.to_hash, response_b.to_hash
 
     Timecop.travel( 5 * 60 - 30) do # now + 4 mins 30 secs
       response_c = GdsApi::JsonClient.new.get_json(url)
 
       assert_requested :get, url, times: 1
-      assert_same response_a, response_c
+      assert_equal response_a.to_hash, response_c.to_hash
     end
 
     Timecop.travel( 5 * 60 + 30) do # now + 5 mins 30 secs
@@ -347,6 +347,32 @@ class JsonClientTest < MiniTest::Spec
     assert_equal({}, @client.put_json(url, payload).to_hash)
   end
 
+  def test_can_build_custom_response_object
+    url = "http://some.endpoint/some.json"
+    stub_request(:get, url).to_return(:body => "Hello there!")
+
+    response = @client.get_json(url) { |http_response| http_response.body }
+    assert response.is_a? String
+    assert_equal "Hello there!", response
+  end
+
+  def test_responds_with_nil_on_custom_response_404
+    url = "http://some.endpoint/some.json"
+    stub_request(:get, url).to_return(:body => "", :status => 404)
+
+    response = @client.get_json(url) { |http_response| http_response.body }
+    assert_nil response
+  end
+
+  def test_can_build_custom_response_object_in_bang_method
+    url = "http://some.endpoint/some.json"
+    stub_request(:get, url).to_return(:body => "Hello there!")
+
+    response = @client.get_json!(url) { |http_response| http_response.body }
+    assert response.is_a? String
+    assert_equal "Hello there!", response
+  end
+
   def test_can_convert_response_to_ostruct
     url = "http://some.endpoint/some.json"
     payload = {a: 1}

metadata

@@ -2,7 +2,7 @@
 name: gds-api-adapters
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 4.8.0
+  version: 4.9.0
 platform: ruby
 authors: 
 - James Stewart
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-02-14 00:00:00 Z
+date: 2013-02-18 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: plek
@@ -201,6 +201,7 @@ files:
 - lib/gds_api/core-ext/openstruct.rb
 - lib/gds_api/response.rb
 - lib/gds_api/content_api/list_response.rb
+- lib/gds_api/content_api/response.rb
 - lib/gds_api/publisher.rb
 - lib/gds_api/test_helpers/licence_application.rb
 - lib/gds_api/test_helpers/imminence.rb
@@ -217,6 +218,7 @@ files:
 - Rakefile
 - test/rummager_test.rb
 - test/publisher_api_test.rb
+- test/content_api_response_test.rb
 - test/licence_application_api_test.rb
 - test/mapit_test.rb
 - test/panopticon_api_test.rb
@@ -239,7 +241,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 1465373721783648305
+      hash: -2287437040986270059
       segments: 
       - 0
       version: "0"
@@ -248,7 +250,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 1465373721783648305
+      hash: -2287437040986270059
       segments: 
       - 0
       version: "0"
@@ -262,6 +264,7 @@ summary: Adapters to work with GDS APIs
 test_files: 
 - test/rummager_test.rb
 - test/publisher_api_test.rb
+- test/content_api_response_test.rb
 - test/licence_application_api_test.rb
 - test/mapit_test.rb
 - test/panopticon_api_test.rb