gds-api-adapters 28.3.1 → 29.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63cab7dcaea123b42aceb6cc72c842f2e8d3a014
-  data.tar.gz: 4840e3ba7ba466c9c0bad2a056ccb777a92a93fb
+  metadata.gz: 71362128a4913b6fa7588f899cb6ec02ce1b9f8f
+  data.tar.gz: a401050ecf364fbc755e53d0abf0757e64ffbed7
 SHA512:
-  metadata.gz: 452d8c5f90aeb07acaf8b959581f8123b5d630f70a6a4883efdf1d6ae932a5610573e8f6add649e399a199f7cd24cc7e4841bf3894a99aac955a3582e641fa76
-  data.tar.gz: f962284419cfa753f5cfeee2c45a1faef51f53126663f8b8beb0976b0c86658baa95e629cd8c58cb885a676d1567438737cae2ebc7e5238f7ea7c87d3dd96163
+  metadata.gz: a095ca287ef2049fa280105ffa09f4cd03397261a3c1b8e92e34db4603a00d16952339058fc8d82ef492bf22f3c855dfc170089de18965381e3530f3bb613a3f
+  data.tar.gz: 8935835598a80361fbb7392b5f2b57bea283f463920a985e344f8418f846de6544218642216941115d1d61e97943f7b81dbde35c50473e08f75019e77ed32b70

data/lib/gds_api/base.rb

@@ -21,6 +21,7 @@ class GdsApi::Base
   def_delegators :client, :get_json, :get_json!,
                           :post_json, :post_json!,
                           :put_json, :put_json!,
+                          :patch_json, :patch_json!,
                           :delete_json, :delete_json!,
                           :get_raw, :get_raw!,
                           :put_multipart,

data/lib/gds_api/json_client.rb

@@ -78,7 +78,7 @@ module GdsApi
     # Each "bang method" tries to make a request, but raises an exception if
     # the response is not successful. These methods discard the HTTPNotFound
     # exceptions (and return nil), and pass through all other exceptions.
-    [:get, :post, :put, :delete].each do |http_method|
+    [:get, :post, :put, :patch, :delete].each do |http_method|
       method_name = "#{http_method}_json"
       define_method method_name do |url, *args, &block|
         ignoring_missing do
@@ -99,6 +99,10 @@ module GdsApi
       do_json_request(:put, url, params, additional_headers)
     end
 
+    def patch_json!(url, params, additional_headers = {})
+      do_json_request(:patch, url, params, additional_headers)
+    end
+
     def delete_json!(url, params = nil, additional_headers = {})
       do_json_request(:delete, url, params, additional_headers)
     end

data/lib/gds_api/publishing_api/special_route_publisher.rb

@@ -27,7 +27,7 @@ module GdsApi
           rendering_app: options.fetch(:rendering_app),
           public_updated_at: time.now.iso8601,
         })
-        publishing_api.put_links(options.fetch(:content_id), links: options[:links]) if options[:links]
+        publishing_api.patch_links(options.fetch(:content_id), links: options[:links]) if options[:links]
         publishing_api.publish(options.fetch(:content_id), 'major')
         put_content_response
       end

data/lib/gds_api/publishing_api_v2.rb

@@ -63,14 +63,14 @@ class GdsApi::PublishingApiV2 < GdsApi::Base
     get_json(links_url(content_id))
   end
 
-  def put_links(content_id, payload)
+  def patch_links(content_id, payload)
     params = {
       links: payload.fetch(:links)
     }
 
     params = merge_optional_keys(params, payload, [:previous_version])
 
-    put_json!(links_url(content_id), params)
+    patch_json!(links_url(content_id), params)
   end
 
   def get_content_items(params)

data/lib/gds_api/test_helpers/publishing_api_v2.rb

@@ -26,7 +26,7 @@ module GdsApi
         stub_publishing_api_put(content_id, body, '/content', response_hash)
       end
 
-      def stub_publishing_api_put_links(content_id, body)
+      def stub_publishing_api_patch_links(content_id, body)
         stub_publishing_api_put(content_id, body, '/links')
       end
 
@@ -48,7 +48,7 @@ module GdsApi
         end
         stubs = []
         stubs << stub_publishing_api_put_content(content_id, body.except(:links))
-        stubs << stub_publishing_api_put_links(content_id, body.slice(:links)) unless body.slice(:links).empty?
+        stubs << stub_publishing_api_patch_links(content_id, body.slice(:links)) unless body.slice(:links).empty?
         stubs << stub_publishing_api_publish(content_id, publish_body)
         stubs
       end
@@ -57,7 +57,7 @@ module GdsApi
         stub_request(:put, %r{\A#{PUBLISHING_API_V2_ENDPOINT}/content/})
       end
 
-      def stub_any_publishing_api_put_links
+      def stub_any_publishing_api_patch_links
         stub_request(:put, %r{\A#{PUBLISHING_API_V2_ENDPOINT}/links/})
       end
 
@@ -81,7 +81,7 @@ module GdsApi
           publish_body[:locale] = body[:locale] if body[:locale]
         end
         assert_publishing_api_put_content(content_id, body.except(:links))
-        assert_publishing_api_put_links(content_id, body.slice(:links)) unless body.slice(:links).empty?
+        assert_publishing_api_patch_links(content_id, body.slice(:links)) unless body.slice(:links).empty?
         assert_publishing_api_publish(content_id, publish_body)
       end
 
@@ -95,7 +95,7 @@ module GdsApi
         assert_publishing_api(:post, url, attributes_or_matcher, times)
       end
 
-      def assert_publishing_api_put_links(content_id, attributes_or_matcher = nil, times = 1)
+      def assert_publishing_api_patch_links(content_id, attributes_or_matcher = nil, times = 1)
         url = PUBLISHING_API_V2_ENDPOINT + "/links/" + content_id
         assert_publishing_api(:put, url, attributes_or_matcher, times)
       end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '28.3.1'
+  VERSION = '29.0.0'
 end

data/test/publishing_api/special_route_publisher_test.rb

@@ -60,7 +60,7 @@ describe GdsApi::PublishingApi::SpecialRoutePublisher do
 
       publisher.publish(special_route.merge(links))
 
-      assert_requested(:put, "#{endpoint}/v2/links/#{content_id}", body: links)
+      assert_requested(:patch, "#{endpoint}/v2/links/#{content_id}", body: links)
     end
 
     describe 'Timezone handling' do

data/test/publishing_api_v2_test.rb

@@ -615,14 +615,14 @@ describe GdsApi::PublishingApiV2 do
     end
   end
 
-  describe "#put_links" do
+  describe "#patch_links" do
     describe "when setting links of the same type" do
       before do
         publishing_api
           .given("organisation links exist for content_id #{@content_id}")
-          .upon_receiving("a put organisation links request")
+          .upon_receiving("a patch organisation links request")
           .with(
-            method: :put,
+            method: :patch,
             path: "/v2/links/#{@content_id}",
             body: {
               links: {
@@ -644,7 +644,7 @@ describe GdsApi::PublishingApiV2 do
       end
 
       it "replaces the links and responds with the new links" do
-        response = @api_client.put_links(@content_id, links: {
+        response = @api_client.patch_links(@content_id, links: {
           organisations: ["591436ab-c2ae-416f-a3c5-1901d633fbfb"],
         })
         assert_equal 200, response.code
@@ -656,9 +656,9 @@ describe GdsApi::PublishingApiV2 do
       before do
         publishing_api
           .given("organisation links exist for content_id #{@content_id}")
-          .upon_receiving("a put topic links request")
+          .upon_receiving("a patch topic links request")
           .with(
-            method: :put,
+            method: :patch,
             path: "/v2/links/#{@content_id}",
             body: {
               links: {
@@ -681,7 +681,7 @@ describe GdsApi::PublishingApiV2 do
       end
 
       it "adds the new type of links and responds with the whole link set" do
-        response = @api_client.put_links(@content_id, links: {
+        response = @api_client.patch_links(@content_id, links: {
           topics: ["225df4a8-2945-4e9b-8799-df7424a90b69"],
         })
 
@@ -697,9 +697,9 @@ describe GdsApi::PublishingApiV2 do
       before do
         publishing_api
           .given("organisation links exist for content_id #{@content_id}")
-          .upon_receiving("a put blank organisation links request")
+          .upon_receiving("a patch blank organisation links request")
           .with(
-            method: :put,
+            method: :patch,
             path: "/v2/links/#{@content_id}",
             body: {
               links: {
@@ -719,7 +719,7 @@ describe GdsApi::PublishingApiV2 do
       end
 
       it "responds with the links" do
-        response = @api_client.put_links(@content_id, links: {
+        response = @api_client.patch_links(@content_id, links: {
           organisations: [],
         })
 
@@ -732,9 +732,9 @@ describe GdsApi::PublishingApiV2 do
       before do
         publishing_api
           .given("no links exist for content_id #{@content_id}")
-          .upon_receiving("a put organisation links request")
+          .upon_receiving("a patch organisation links request")
           .with(
-            method: :put,
+            method: :patch,
             path: "/v2/links/#{@content_id}",
             body: {
               links: {
@@ -756,7 +756,7 @@ describe GdsApi::PublishingApiV2 do
       end
 
       it "responds with the links" do
-        response = @api_client.put_links(@content_id, links: {
+        response = @api_client.patch_links(@content_id, links: {
           organisations: ["591436ab-c2ae-416f-a3c5-1901d633fbfb"],
         })
 
@@ -774,7 +774,7 @@ describe GdsApi::PublishingApiV2 do
             .given("the linkset for #{@content_id} is at version 3")
             .upon_receiving("a request to update the linkset at version 3")
             .with(
-              method: :put,
+              method: :patch,
               path: "/v2/links/#{@content_id}",
               body: {
                 links: {
@@ -792,7 +792,7 @@ describe GdsApi::PublishingApiV2 do
         end
 
         it "responds with 200 OK" do
-          response = @api_client.put_links(@content_id,
+          response = @api_client.patch_links(@content_id,
             links: {
               organisations: ["591436ab-c2ae-416f-a3c5-1901d633fbfb"],
             },
@@ -809,7 +809,7 @@ describe GdsApi::PublishingApiV2 do
             .given("the linkset for #{@content_id} is at version 3")
             .upon_receiving("a request to update the linkset at version 2")
             .with(
-              method: :put,
+              method: :patch,
               path: "/v2/links/#{@content_id}",
               body: {
                 links: {
@@ -840,7 +840,7 @@ describe GdsApi::PublishingApiV2 do
 
         it "responds with 409 Conflict" do
           error = assert_raises GdsApi::HTTPClientError do
-            @api_client.put_links(@content_id,
+            @api_client.patch_links(@content_id,
               links: {
                 organisations: ["591436ab-c2ae-416f-a3c5-1901d633fbfb"],
               },
@@ -1210,8 +1210,8 @@ describe GdsApi::PublishingApiV2 do
       proc { @api_client.put_content(nil, {}) }.must_raise ArgumentError
     end
 
-    it "happens on put_links" do
-      proc { @api_client.put_links(nil, links: {}) }.must_raise ArgumentError
+    it "happens on patch_links" do
+      proc { @api_client.patch_links(nil, links: {}) }.must_raise ArgumentError
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 28.3.1
+  version: 29.0.0
 platform: ruby
 authors:
 - James Stewart
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-26 00:00:00.000000000 Z
+date: 2016-02-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plek
@@ -458,51 +458,51 @@ signing_key:
 specification_version: 4
 summary: Adapters to work with GDS APIs
 test_files:
-- test/support_api_test.rb
-- test/mapit_test.rb
+- test/content_api_test.rb
+- test/json_client_test.rb
+- test/content_store_test.rb
 - test/publishing_api_test.rb
+- test/business_support_api_test.rb
+- test/middleware/govuk_header_sniffer_test.rb
 - test/whitehall_admin_api_test.rb
-- test/pp_data_in_test.rb
-- test/publishing_api/special_route_publisher_test.rb
-- test/need_api_test.rb
+- test/list_response_test.rb
+- test/maslow_test.rb
+- test/panopticon_registerer_test.rb
+- test/support_test.rb
+- test/asset_manager_test.rb
+- test/helpers_test.rb
+- test/licence_application_api_test.rb
+- test/test_helper.rb
 - test/publisher_api_test.rb
+- test/mapit_test.rb
 - test/rummager_helpers_test.rb
-- test/support_test.rb
-- test/content_register_test.rb
+- test/publishing_api_v2_test.rb
+- test/support_api_test.rb
+- test/organisations_api_test.rb
+- test/gds_api_base_test.rb
+- test/router_test.rb
+- test/publishing_api/special_route_publisher_test.rb
+- test/external_link_tracker_test.rb
 - test/fact_cave_test.rb
-- test/test_helpers/publishing_api_test.rb
-- test/test_helpers/pact_helper.rb
-- test/test_helpers/panopticon_test.rb
-- test/test_helpers/email_alert_api_test.rb
-- test/licence_application_api_test.rb
-- test/gov_uk_delivery_test.rb
-- test/maslow_test.rb
-- test/helpers_test.rb
-- test/panopticon_registerer_test.rb
+- test/need_api_test.rb
+- test/content_register_test.rb
 - test/panopticon_test.rb
-- test/middleware/govuk_header_sniffer_test.rb
-- test/rummager_test.rb
-- test/json_client_test.rb
-- test/email_alert_api_test.rb
-- test/content_api_test.rb
-- test/response_test.rb
-- test/organisations_api_test.rb
-- test/imminence_api_test.rb
-- test/content_store_test.rb
-- test/asset_manager_test.rb
+- test/pp_data_in_test.rb
 - test/fixtures/hello.txt
 - test/fixtures/new_policies_for_dwp.json
-- test/fixtures/world_organisations_australia.json
 - test/fixtures/no_services_and_info_data_found_fixture.json
-- test/fixtures/old_policies_for_dwp.json
 - test/fixtures/services_and_info_fixture.json
+- test/fixtures/old_policies_for_dwp.json
+- test/fixtures/world_organisations_australia.json
 - test/fixtures/sub_sector_organisations.json
 - test/fixtures/finder_api/cma-case-schema.json
-- test/router_test.rb
-- test/list_response_test.rb
-- test/external_link_tracker_test.rb
-- test/gds_api_base_test.rb
 - test/worldwide_api_test.rb
-- test/test_helper.rb
-- test/publishing_api_v2_test.rb
-- test/business_support_api_test.rb
+- test/test_helpers/publishing_api_test.rb
+- test/test_helpers/pact_helper.rb
+- test/test_helpers/panopticon_test.rb
+- test/test_helpers/email_alert_api_test.rb
+- test/gov_uk_delivery_test.rb
+- test/imminence_api_test.rb
+- test/email_alert_api_test.rb
+- test/response_test.rb
+- test/rummager_test.rb