gds-api-adapters 30.5.0 → 30.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73f4ec1858d59e35d24b807bc1563ef99425a246
-  data.tar.gz: 2bf51592ac65dc4aad37e5bcfc517c1a9d27df07
+  metadata.gz: a4e28b623478c809c5e960c46012dc514ff8205e
+  data.tar.gz: 7945f3261866b017b6765f057dca650585761f81
 SHA512:
-  metadata.gz: c98b6e0f62db2002483a65c405d8d428ec66870fbee80f0bc76a148dbd204f2222c594ff3f1afc2ba53a2008728cc4707db7fd20bada1240026b47a91d0bd0b8
-  data.tar.gz: dbac2675ea0da5641190d1fd904822cecdc2c4a0e06bf2d8b9593c2e0c4cb6a5a36f61ca6e2dd46e3d20077f854ec20abb694d0f3cb77ec19c1a476ccbe7e7a2
+  metadata.gz: 7226bc20099596193ef8e9b3c414a4a075fc45f28d8464ec15b4ab683f820d8715f117c5bb8930d34b970b62194fdb5650523cd026e11a86d8d7eec6b9fd9ad5
+  data.tar.gz: ceeb159b50485e441b1db84076b582bbb080a570637ced31fdb2931d1c0ffb4237257e3f22884cc5591771df7eb84aa9b4be8b7e27ab6c40607539b6fc6d5a67

data/lib/gds_api/base.rb

@@ -41,7 +41,8 @@ class GdsApi::Base
   def initialize(endpoint_url, options={})
     options[:endpoint_url] = endpoint_url
     raise InvalidAPIURL unless endpoint_url =~ URI::regexp
-    default_options = GdsApi::Base.default_options || {}
+    base_options = { logger: self.class.logger }
+    default_options = base_options.merge(GdsApi::Base.default_options || {})
     @options = default_options.merge(options)
     self.endpoint = options[:endpoint_url]
   end

data/lib/gds_api/json_client.rb

@@ -5,6 +5,7 @@ require_relative 'null_cache'
 require_relative 'govuk_headers'
 require 'lrucache'
 require 'rest-client'
+require 'null_logger'
 
 module GdsApi
   class JsonClient
@@ -38,7 +39,7 @@ module GdsApi
         raise "It is no longer possible to disable the timeout."
       end
 
-      @logger = options[:logger] || GdsApi::Base.logger
+      @logger = options[:logger] || NullLogger.instance
 
       if options[:disable_cache] || (options[:cache_size] == 0)
         @cache = NullCache.new

data/lib/gds_api/publishing_api/special_route_publisher.rb

@@ -14,7 +14,8 @@ module GdsApi
 
         put_content_response = publishing_api.put_content(options.fetch(:content_id), {
           base_path: options.fetch(:base_path),
-          format: "special_route",
+          document_type: "special_route",
+          schema_name: "special_route",
           title: options.fetch(:title),
           description: options[:description] || "",
           routes: [

data/lib/gds_api/publishing_api_v2.rb

@@ -162,6 +162,36 @@ class GdsApi::PublishingApiV2 < GdsApi::Base
     get_json(links_url(content_id))
   end
 
+  # Get expanded links
+  #
+  # Return the expanded links of the item.
+  #
+  # @param content_id [UUID]
+  #
+  # @example
+  #
+  #   publishing_api.get_expanded_links("8157589b-65e2-4df6-92ba-2c91d80006c0").to_h
+  #
+  #   #=> {
+  #     "content_id" => "8157589b-65e2-4df6-92ba-2c91d80006c0",
+  #     "version" => 10,
+  #     "expanded_links" => {
+  #       "organisations" => [
+  #         {
+  #           "content_id" => "21aa83a2-a47f-4189-a252-b02f8c322012",
+  #           ... (and more attributes)
+  #         }
+  #       ]
+  #     }
+  #   }
+  #
+  # @see https://github.com/alphagov/publishing-api/blob/master/doc/publishing-api-syntactic-usage.md#get-v2expanded-linkscontent_id
+  def get_expanded_links(content_id)
+    validate_content_id(content_id)
+    url = "#{endpoint}/v2/expanded-links/#{content_id}"
+    get_json(url)
+  end
+
   # Patch the links of a content item
   #
   # @param content_id [UUID]

data/lib/gds_api/test_helpers/publishing_api_v2.rb

@@ -201,6 +201,11 @@ module GdsApi
         stub_request(:get, url).to_return(status: 200, body: links.to_json, headers: {})
       end
 
+      def publishing_api_has_expanded_links(links)
+        url = PUBLISHING_API_V2_ENDPOINT + "/expanded-links/" + links[:content_id]
+        stub_request(:get, url).to_return(status: 200, body: links.to_json, headers: {})
+      end
+
       def publishing_api_does_not_have_links(content_id)
         url = PUBLISHING_API_V2_ENDPOINT + "/links/" + content_id
         stub_request(:get, url).to_return(status: 404, body: resource_not_found(content_id, "link set").to_json, headers: {})

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '30.5.0'
+  VERSION = '30.6.0'
 end

data/test/gds_api_base_test.rb

@@ -15,6 +15,7 @@ class GdsApiBaseTest < Minitest::Test
   end
 
   def teardown
+    GdsApi::Base.default_options = nil
     GdsApi::JsonClient.cache = @orig_cache
   end
 
@@ -87,4 +88,24 @@ class GdsApiBaseTest < Minitest::Test
       ConcreteApi.new('invalid-url')
     end.must_raise GdsApi::Base::InvalidAPIURL
   end
+
+  def test_should_set_json_client_logger_to_own_logger_by_default
+    api = ConcreteApi.new("http://bar")
+    assert_same GdsApi::Base.logger, api.client.logger
+  end
+
+  def test_should_set_json_client_logger_to_logger_in_default_options
+    custom_logger = stub('custom-logger')
+    GdsApi::Base.default_options = { logger: custom_logger }
+    api = ConcreteApi.new("http://bar")
+    assert_same custom_logger, api.client.logger
+  end
+
+  def test_should_set_json_client_logger_to_logger_in_options
+    custom_logger = stub('custom-logger')
+    GdsApi::Base.default_options = { logger: custom_logger }
+    another_logger = stub('another-logger')
+    api = ConcreteApi.new("http://bar", logger: another_logger)
+    assert_same another_logger, api.client.logger
+  end
 end

data/test/json_client_test.rb

@@ -2,6 +2,7 @@ require_relative 'test_helper'
 require 'gds_api/base'
 require 'gds_api/json_client'
 require 'base64'
+require 'null_logger'
 
 class JsonClientTest < MiniTest::Spec
   def setup
@@ -826,4 +827,14 @@ class JsonClientTest < MiniTest::Spec
   ensure
     ENV['GOVUK_APP_NAME'] = previous_govuk_app_name
   end
+
+  def test_should_default_to_using_null_logger
+    assert_same @client.logger, NullLogger.instance
+  end
+
+  def test_should_use_custom_logger_specified_in_options
+    custom_logger = stub('custom-logger')
+    client = GdsApi::JsonClient.new(logger: custom_logger)
+    assert_same client.logger, custom_logger
+  end
 end

data/test/publishing_api/special_route_publisher_test.rb

@@ -32,7 +32,8 @@ describe GdsApi::PublishingApi::SpecialRoutePublisher do
 
         expected_payload = {
           base_path: special_route[:base_path],
-          format: "special_route",
+          document_type: "special_route",
+          schema_name: "special_route",
           title: special_route[:title],
           description: special_route[:description],
           routes: [

data/test/publishing_api_v2/get_expanded_links_test.rb

@@ -0,0 +1,85 @@
+require 'test_helper'
+require 'gds_api/publishing_api_v2'
+require 'json'
+
+describe GdsApi::PublishingApiV2 do
+  include PactTest
+
+  before do
+    @api_client = GdsApi::PublishingApiV2.new('http://localhost:3093')
+    @content_id = "bed722e6-db68-43e5-9079-063f623335a7"
+  end
+
+  describe "#get_expanded_links" do
+    it "responds with the links when there's a links entry with links" do
+      publishing_api
+        .given("organisation links exist for content_id #{@content_id}")
+        .upon_receiving("a get-expanded-links request")
+        .with(
+          method: :get,
+          path: "/v2/expanded-links/#{@content_id}",
+        )
+        .will_respond_with(
+          status: 200,
+          body: {
+            expanded_links: {
+              organisations: [
+                { content_id: "20583132-1619-4c68-af24-77583172c070" }
+              ]
+            }
+          }
+        )
+
+      response = @api_client.get_expanded_links(@content_id)
+
+      expected_body = {
+        "expanded_links" => {
+          "organisations" => [
+            { "content_id" => "20583132-1619-4c68-af24-77583172c070" }
+          ]
+        }
+      }
+      assert_equal 200, response.code
+      assert_equal expected_body, response.to_h
+    end
+
+    it "responds with the empty thing set if there's an empty link set" do
+      publishing_api
+        .given("empty links exist for content_id #{@content_id}")
+        .upon_receiving("a get-expanded-links request")
+        .with(
+          method: :get,
+          path: "/v2/expanded-links/#{@content_id}",
+        )
+        .will_respond_with(
+          status: 200,
+          body: {
+            expanded_links: {
+            }
+          }
+        )
+
+      response = @api_client.get_expanded_links(@content_id)
+
+      assert_equal 200, response.code
+      assert_equal({}, response.to_h['expanded_links'])
+    end
+
+    it "responds with 404 if there's no link set entry" do
+      publishing_api
+        .given("no links exist for content_id #{@content_id}")
+        .upon_receiving("a get-expanded-links request")
+        .with(
+          method: :get,
+          path: "/v2/expanded-links/#{@content_id}",
+        )
+        .will_respond_with(
+          status: 404
+        )
+
+      response = @api_client.get_expanded_links(@content_id)
+
+      assert_nil response
+    end
+  end
+end

data/test/publishing_api_v2/get_links_test.rb

@@ -0,0 +1,85 @@
+require 'test_helper'
+require 'gds_api/publishing_api_v2'
+require 'json'
+
+describe GdsApi::PublishingApiV2 do
+  include PactTest
+
+  before do
+    @api_client = GdsApi::PublishingApiV2.new('http://localhost:3093')
+    @content_id = "bed722e6-db68-43e5-9079-063f623335a7"
+  end
+
+  describe "#get_links" do
+    describe "when there's a links entry with links" do
+      before do
+        publishing_api
+          .given("organisation links exist for content_id #{@content_id}")
+          .upon_receiving("a get-links request")
+          .with(
+            method: :get,
+            path: "/v2/links/#{@content_id}",
+          )
+          .will_respond_with(
+            status: 200,
+            body: {
+              links: {
+                organisations: ["20583132-1619-4c68-af24-77583172c070"]
+              }
+            }
+          )
+      end
+
+      it "responds with the links" do
+        response = @api_client.get_links(@content_id)
+        assert_equal 200, response.code
+        assert_equal ["20583132-1619-4c68-af24-77583172c070"], response.links.organisations
+      end
+    end
+
+    describe "when there's an empty links entry" do
+      before do
+        publishing_api
+          .given("empty links exist for content_id #{@content_id}")
+          .upon_receiving("a get-links request")
+          .with(
+            method: :get,
+            path: "/v2/links/#{@content_id}",
+          )
+          .will_respond_with(
+            status: 200,
+            body: {
+              links: {
+              }
+            }
+          )
+      end
+
+      it "responds with the empty link set" do
+        response = @api_client.get_links(@content_id)
+        assert_equal 200, response.code
+        assert_equal OpenStruct.new({}), response.links
+      end
+    end
+
+    describe "when there's no links entry" do
+      before do
+        publishing_api
+          .given("no links exist for content_id #{@content_id}")
+          .upon_receiving("a get-links request")
+          .with(
+            method: :get,
+            path: "/v2/links/#{@content_id}",
+          )
+          .will_respond_with(
+            status: 404
+          )
+      end
+
+      it "responds with 404" do
+        response = @api_client.get_links(@content_id)
+        assert_nil response
+      end
+    end
+  end
+end

data/test/publishing_api_v2_test.rb

@@ -733,79 +733,6 @@ describe GdsApi::PublishingApiV2 do
     end
   end
 
-  describe "#get_links" do
-    describe "when there's a links entry with links" do
-      before do
-        publishing_api
-          .given("organisation links exist for content_id #{@content_id}")
-          .upon_receiving("a get-links request")
-          .with(
-            method: :get,
-            path: "/v2/links/#{@content_id}",
-          )
-          .will_respond_with(
-            status: 200,
-            body: {
-              links: {
-                organisations: ["20583132-1619-4c68-af24-77583172c070"]
-              }
-            }
-          )
-      end
-
-      it "responds with the links" do
-        response = @api_client.get_links(@content_id)
-        assert_equal 200, response.code
-        assert_equal ["20583132-1619-4c68-af24-77583172c070"], response.links.organisations
-      end
-    end
-
-    describe "when there's an empty links entry" do
-      before do
-        publishing_api
-          .given("empty links exist for content_id #{@content_id}")
-          .upon_receiving("a get-links request")
-          .with(
-            method: :get,
-            path: "/v2/links/#{@content_id}",
-          )
-          .will_respond_with(
-            status: 200,
-            body: {
-              links: {
-              }
-            }
-          )
-      end
-
-      it "responds with the empty link set" do
-        response = @api_client.get_links(@content_id)
-        assert_equal 200, response.code
-        assert_equal OpenStruct.new({}), response.links
-      end
-    end
-
-    describe "when there's no links entry" do
-      before do
-        publishing_api
-          .given("no links exist for content_id #{@content_id}")
-          .upon_receiving("a get-links request")
-          .with(
-            method: :get,
-            path: "/v2/links/#{@content_id}",
-          )
-          .will_respond_with(
-            status: 404
-          )
-      end
-
-      it "responds with 404" do
-        response = @api_client.get_links(@content_id)
-        assert_nil response
-      end
-    end
-  end
-
   describe "#patch_links" do
     describe "when setting links of the same type" do
       before do

data/test/test_helpers/publishing_api_v2_test.rb

@@ -26,4 +26,29 @@ describe GdsApi::TestHelpers::PublishingApiV2 do
       assert_equal([{ "content_id" => "2878337b-bed9-4e7f-85b6-10ed2cbcd504" }], response)
     end
   end
+
+  describe "#publishing_api_has_expanded_links" do
+    it "stubs the call to get expanded links" do
+      payload = {
+        content_id: "2e20294a-d694-4083-985e-d8bedefc2354",
+        organisations: [
+          {
+            content_id: ["a8a09822-1729-48a7-8a68-d08300de9d1e"]
+          }
+        ]
+      }
+
+      publishing_api_has_expanded_links(payload)
+      response = publishing_api.get_expanded_links("2e20294a-d694-4083-985e-d8bedefc2354")
+
+      assert_equal({
+        "content_id" => "2e20294a-d694-4083-985e-d8bedefc2354",
+        "organisations" => [
+          {
+            "content_id" => ["a8a09822-1729-48a7-8a68-d08300de9d1e"]
+          }
+        ]
+      }, response.to_h)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 30.5.0
+  version: 30.6.0
 platform: ruby
 authors:
 - James Stewart
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-17 00:00:00.000000000 Z
+date: 2016-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plek
@@ -429,6 +429,8 @@ files:
 - test/publisher_api_test.rb
 - test/publishing_api/special_route_publisher_test.rb
 - test/publishing_api_test.rb
+- test/publishing_api_v2/get_expanded_links_test.rb
+- test/publishing_api_v2/get_links_test.rb
 - test/publishing_api_v2/lookup_test.rb
 - test/publishing_api_v2_test.rb
 - test/response_test.rb
@@ -473,6 +475,8 @@ test_files:
 - test/mapit_test.rb
 - test/publishing_api_test.rb
 - test/publishing_api_v2/lookup_test.rb
+- test/publishing_api_v2/get_links_test.rb
+- test/publishing_api_v2/get_expanded_links_test.rb
 - test/whitehall_admin_api_test.rb
 - test/pp_data_in_test.rb
 - test/publishing_api/special_route_publisher_test.rb