gds-api-adapters 5.5.0 → 6.0.0

data/lib/gds_api/content_api/response.rb

@@ -1,56 +0,0 @@
-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/test/content_api_response_test.rb

@@ -1,97 +0,0 @@
-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