gds-api-adapters 29.2.0 → 29.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dcbcf83df995ff4cdd0002f989cc9e4032cd7470
-  data.tar.gz: 8eaabd463ed9176934ea0adb6bb67bf4b7ec1947
+  metadata.gz: f9b62c3d717ced2cf4a1606042f7a30d2671b1b5
+  data.tar.gz: 9a40bc142cc071a324b834347f8410f221a14140
 SHA512:
-  metadata.gz: 1020031ea15ed8ac360b783f1ad57b765c1ed4aefa521ce65c2a5b0f4eed014cf19468f039e07a3f8a7e3c71e5bee4e56eab63af91a80d362a441be2dbf2c638
-  data.tar.gz: 844a5785f27a1e5168c65bf5d5fa4acd9b5640b42982896203178ff2c4e1758edf11f0d5e036cbdcf8ffb0bfd95679bfa1f60fd072d2984a024e9339665c8b59
+  metadata.gz: 0dfbf18074c8c8116668b3d1e42d5e566794de5fdd76f4fcdf15a3540be8758c3e8e059285e31f71e2802c403cac17fc5ad2e45da17070af256da21771398be1
+  data.tar.gz: 681f7782f9ca6e2753a4ea5165233b8f3d504861ce60c5989860fce7978b0db75e0255bbd62b3ee0d6cc62328eefee9664124cbe45c720f4c07967cd04aa96c1

data/lib/gds_api/publishing_api_v2.rb

@@ -78,8 +78,20 @@ class GdsApi::PublishingApiV2 < GdsApi::Base
     get_json("#{endpoint}/v2/content#{query}")
   end
 
-  def get_linkables(format:)
-    get_json("#{endpoint}/v2/linkables?format=#{format}")
+  def get_linkables(document_type: nil, format: nil)
+    if document_type.nil?
+      if format.nil?
+        raise ArgumentError.new("Please provide a `document_type`")
+      else
+        self.class.logger.warn(
+          "Providing `format` to the `get_linkables` method is deprecated and will be removed in a " +
+          "future release.  Please use `document_type` instead."
+        )
+        document_type = format
+      end
+    end
+
+    get_json("#{endpoint}/v2/linkables?document_type=#{document_type}")
   end
 
   def get_linked_items(content_id, params = {})

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '29.2.0'
+  VERSION = '29.3.0'
 end

data/test/publishing_api_v2_test.rb

@@ -875,14 +875,14 @@ describe GdsApi::PublishingApiV2 do
       ]
     }
 
-    it "returns the content items of a given format" do
+    it "returns the content items of a given document_type" do
       publishing_api
         .given("there is content with format 'topic'")
         .upon_receiving("a get linkables request")
         .with(
           method: :get,
           path: "/v2/linkables",
-          query: "format=topic",
+          query: "document_type=topic",
           headers: {
             "Content-Type" => "application/json",
           },
@@ -892,8 +892,12 @@ describe GdsApi::PublishingApiV2 do
           body: linkables,
         )
 
-      response = @api_client.get_linkables(format: "topic")
+      response = @api_client.get_linkables(document_type: "topic")
+      assert_equal 200, response.code
+      assert_equal linkables, response.to_a
 
+      # `format` is supported but deprecated for backwards compatibility
+      response = @api_client.get_linkables(format: "topic")
       assert_equal 200, response.code
       assert_equal linkables, response.to_a
     end
@@ -1174,7 +1178,7 @@ describe GdsApi::PublishingApiV2 do
       end
     end
 
-    describe "there are two documents that link to the wantend document" do
+    describe "there are two documents that link to the wanted document" do
       before do
         content_id2 = "08dfd5c3-d935-4e81-88fd-cfe65b78893d"
         content_id3 = "e2961462-bc37-48e9-bb98-c981ef1a2d59"

metadata

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