gds-api-adapters 24.4.0 → 24.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 917b62c21c23af44bb7bd701631407f93ad3e528
-  data.tar.gz: 5cfcbf49f3381b24011fbaddc4809c173267436e
+  metadata.gz: 1cdf38f1b222c05d8d81625b25b222de03f6f273
+  data.tar.gz: 41fb59bce925ffd63f782566ccb50beda983bf8f
 SHA512:
-  metadata.gz: d6febf466943aca5a5ccec8a099d88956d8bbbbfede4f527986ddfe4e8484799200bc99d06861c39fef999ffb367b450889ace42be7e0cc84788f4cac9f08a30
-  data.tar.gz: 59a64bbbe9fee9466c90b61760d09ef560159e398e7380e4902c17b56b4838ea06f78763ecde700ae2f28cdd12a0cdcc8e9c5ec213406a3cea561ac2a11e20c5
+  metadata.gz: 2a57d45ce36edc708d49082e6fc47a66094e1d6717cfb71b24acd142cd7c996188cf1c2d3b7c109284720fd14fe459e405b54e48f5d0ccf8b4a61264642ef1ff
+  data.tar.gz: 82494aeda400c32f9bdf66541d52c9e9a78a552dcd3ac606621e02f957ef92b5cdc08e55932dc97622cc8b15030d52e542165fd8985c82238183b7bfe4019032

data/lib/gds_api/publishing_api.rb

@@ -16,7 +16,9 @@ class GdsApi::PublishingApi < GdsApi::Base
   end
 
   def destroy_intent(base_path)
-    delete_json(intent_url(base_path))
+    delete_json!(intent_url(base_path))
+  rescue GdsApi::HTTPNotFound => e
+    e
   end
 
 

data/lib/gds_api/publishing_api_v2.rb

@@ -0,0 +1,37 @@
+require_relative 'base'
+
+class GdsApi::PublishingApiV2 < GdsApi::Base
+
+  def put_content(content_id, payload)
+    put_json!(content_url(content_id), payload)
+  end
+
+  def get_content(content_id)
+    get_json(content_url(content_id))
+  end
+
+  def publish(content_id, update_type)
+    post_json!(content_url(content_id) + "/publish", {
+      update_type: update_type,
+    })
+  end
+
+  def get_links(content_id)
+    get_json(links_url(content_id))
+  end
+
+  def put_links(content_id, payload)
+    links = payload.fetch(:links)
+    put_json!(links_url(content_id), links: links)
+  end
+
+private
+
+  def content_url(content_id)
+    "#{endpoint}/v2/content/#{content_id}"
+  end
+
+  def links_url(content_id)
+    "#{endpoint}/v2/links/#{content_id}"
+  end
+end

data/lib/gds_api/test_helpers/publishing_api.rb

@@ -17,18 +17,18 @@ module GdsApi
 
       def stub_publishing_api_put_item(base_path, body = content_item_for_base_path(base_path), resource_path = '/content')
         url = PUBLISHING_API_ENDPOINT + resource_path + base_path
-        stub_request(:put, url).with(body: body).to_return(status: 201, body: '{}', headers: {})
+        stub_request(:put, url).with(body: body).to_return(status: 200, body: '{}', headers: {"Content-Type" => "application/json; charset=utf-8"})
       end
 
       def stub_publishing_api_put_intent(base_path, body = intent_for_base_path(base_path))
         url = PUBLISHING_API_ENDPOINT + "/publish-intent" + base_path
         body = body.to_json unless body.is_a?(String)
-        stub_request(:put, url).with(body: body).to_return(status: 201, body: '{}', headers: {})
+        stub_request(:put, url).with(body: body).to_return(status: 200, body: '{}', headers: {"Content-Type" => "application/json; charset=utf-8"})
       end
 
       def stub_publishing_api_destroy_intent(base_path)
         url = PUBLISHING_API_ENDPOINT + "/publish-intent" + base_path
-        stub_request(:delete, url).to_return(status: 201, body: '{}')
+        stub_request(:delete, url).to_return(status: 200, body: '{}', headers: {"Content-Type" => "application/json; charset=utf-8"})
       end
 
       def stub_default_publishing_api_put()

data/lib/gds_api/test_helpers/rummager.rb

@@ -31,10 +31,9 @@ module GdsApi
         if id =~ %r{^/}
           raise ArgumentError, 'Rummager id must not start with a slash'
         end
-        stub_request(:delete, %r{#{Plek.new.find('search')}/documents/#{id}})
+        assert_requested(:delete, %r{#{Plek.new.find('search')}/documents/#{id}})
       end
 
-
       def rummager_has_services_and_info_data_for_organisation
         stub_request_for(search_results_found)
         run_example_query

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '24.4.0'
+  VERSION = '24.5.0'
 end

data/test/publishing_api_test.rb

@@ -4,44 +4,147 @@ require 'gds_api/test_helpers/publishing_api'
 
 describe GdsApi::PublishingApi do
   include GdsApi::TestHelpers::PublishingApi
+  include PactTest
 
   before do
     @base_api_url = Plek.current.find("publishing-api")
-    @api = GdsApi::PublishingApi.new(@base_api_url)
+    @api_client = GdsApi::PublishingApi.new('http://localhost:3093')
   end
 
-  describe "item" do
-    it "should create the item" do
+  describe "#put_content_item" do
+    it "responds with 200 OK if the entry is valid" do
       base_path = "/test-content-item"
-      stub_publishing_api_put_item(base_path)
-      response = @api.put_content_item(base_path, content_item_for_base_path(base_path))
-      assert_equal 201, response.code
+      content_item = content_item_for_base_path(base_path).merge("update_type" => "major")
+
+      publishing_api
+        .given("both content stores and the url-arbiter are empty")
+        .upon_receiving("a request to create a content item")
+        .with(
+          method: :put,
+          path: "/content#{base_path}",
+          body: content_item,
+          headers: {
+            "Content-Type" => "application/json"
+          },
+        )
+        .will_respond_with(
+          status: 200,
+          body: content_item,
+          headers: {
+            "Content-Type" => "application/json; charset=utf-8"
+          },
+        )
+
+      response = @api_client.put_content_item(base_path, content_item)
+      assert_equal 200, response.code
     end
   end
 
-  describe "draft item" do
-    it "should create the draft item" do
+  describe "#put_draft_content_item" do
+    it "responds with 200 OK if the entry is valid" do
       base_path = "/test-draft-content-item"
-      stub_publishing_api_put_draft_item(base_path)
+      content_item = content_item_for_base_path(base_path).merge("update_type" => "major")
 
-      response = @api.put_draft_content_item(base_path, content_item_for_base_path(base_path))
-      assert_equal 201, response.code
+      publishing_api
+        .given("both content stores and the url-arbiter are empty")
+        .upon_receiving("a request to create a draft content item")
+        .with(
+          method: :put,
+          path: "/draft-content#{base_path}",
+          body: content_item,
+          headers: {
+            "Content-Type" => "application/json"
+          },
+        )
+        .will_respond_with(
+          status: 200,
+          body: content_item,
+          headers: {
+            "Content-Type" => "application/json; charset=utf-8"
+          },
+        )
+
+      response = @api_client.put_draft_content_item(base_path, content_item)
+      assert_equal 200, response.code
     end
   end
 
-  describe "intent" do
-    it "should create the intent" do
+  describe "#put_intent" do
+    it "responds with 200 OK if publish intent is valid" do
       base_path = "/test-intent"
-      stub_publishing_api_put_intent(base_path)
-      response = @api.put_intent(base_path, intent_for_base_path(base_path))
-      assert_equal 201, response.code
+      publish_intent = intent_for_base_path(base_path)
+
+      publishing_api
+        .given("both content stores and the url-arbiter are empty")
+        .upon_receiving("a request to create a publish intent")
+        .with(
+          method: :put,
+          path: "/publish-intent#{base_path}",
+          body: publish_intent,
+          headers: {
+            "Content-Type" => "application/json"
+          },
+        )
+        .will_respond_with(
+          status: 200,
+          body: {},
+          headers: {
+            "Content-Type" => "application/json; charset=utf-8"
+          },
+        )
+
+      response = @api_client.put_intent(base_path, publish_intent)
+      assert_equal 200, response.code
     end
+  end
 
-    it "should delete an intent" do
+  describe "#delete_intent" do
+    it "returns 200 OK if intent existed and was deleted" do
       base_path = "/test-intent"
-      stub_publishing_api_destroy_intent(base_path)
-      response = @api.destroy_intent(base_path)
-      assert_equal 201, response.code
+
+      publish_intent = intent_for_base_path(base_path)
+
+      publishing_api
+        .given("a publish intent exists at /test-intent in the live content store")
+        .upon_receiving("a request to delete a publish intent")
+        .with(
+          method: :delete,
+          path: "/publish-intent#{base_path}",
+        )
+        .will_respond_with(
+          status: 200,
+          body: {},
+          headers: {
+            "Content-Type" => "application/json; charset=utf-8"
+          }
+        )
+
+      response = @api_client.destroy_intent(base_path)
+      assert_equal 200, response.code
+    end
+
+    it "returns 404 Not found if the intent does not exist" do
+      base_path = "/test-intent"
+
+      publish_intent = intent_for_base_path(base_path)
+
+      publishing_api
+        .given("both content stores and the url-arbiter are empty")
+        .upon_receiving("a request to delete a publish intent")
+        .with(
+          method: :delete,
+          path: "/publish-intent#{base_path}",
+        )
+        .will_respond_with(
+          status: 404,
+          body: {},
+          headers: {
+            "Content-Type" => "application/json; charset=utf-8"
+          }
+        )
+
+      response = @api_client.destroy_intent(base_path)
+      assert_equal 404, response.code
     end
   end
 end

data/test/publishing_api_v2_test.rb

@@ -0,0 +1,604 @@
+require 'test_helper'
+require 'gds_api/publishing_api_v2'
+require 'json'
+
+describe GdsApi::PublishingApiV2 do
+  include PactTest
+
+  def content_item_for_content_id(content_id, attrs = {})
+    {
+      "base_path" => "/robots.txt",
+      "content_id" => content_id,
+      "title" => "Instructions for crawler robots",
+      "description" => "robots.txt provides rules for which parts of GOV.UK are permitted to be crawled by different bots.",
+      "format" => "special_route",
+      "public_updated_at" => "2015-07-30T13:58:11.000Z",
+      "publishing_app" => "static",
+      "rendering_app" => "static",
+      "routes" => [
+        {
+          "path" => attrs["base_path"] || "/robots.txt",
+          "type" => "exact"
+        }
+      ],
+      "update_type" => "major"
+    }.merge(attrs)
+  end
+
+  before do
+    @base_api_url = Plek.current.find("publishing-api")
+    @api_client = GdsApi::PublishingApiV2.new('http://localhost:3093')
+
+    @content_id = "bed722e6-db68-43e5-9079-063f623335a7"
+  end
+
+  describe "#put_content" do
+    describe "if the entry is valid" do
+      before do
+        @content_item = content_item_for_content_id(@content_id)
+
+        publishing_api
+          .given("both content stores and the url-arbiter are empty")
+          .upon_receiving("a request to create a content item without links")
+          .with(
+            method: :put,
+            path: "/v2/content/#{@content_id}",
+            body: @content_item,
+            headers: {
+              "Content-Type" => "application/json",
+            },
+          )
+          .will_respond_with(
+            status: 200,
+          )
+      end
+
+      it "responds with 200 OK" do
+        response = @api_client.put_content(@content_id, @content_item)
+        assert_equal 200, response.code
+      end
+    end
+
+    describe "if the path is reserved by a different app" do
+      before do
+        @content_item = content_item_for_content_id(@content_id, "base_path" => "/test-item", "publishing_app" => "whitehall")
+
+        publishing_api
+          .given("/test-item has been reserved in url-arbiter by the Publisher application")
+          .upon_receiving("a request from the Whitehall application to create a content item at /test-item")
+          .with(
+            method: :put,
+            path: "/v2/content/#{@content_id}",
+            body: @content_item,
+            headers: {
+              "Content-Type" => "application/json",
+            }
+          )
+          .will_respond_with(
+            status: 409,
+            body: {
+              "error" => {
+                "code" => 409,
+                "message" => Pact.term(generate: "Conflict", matcher:/\S+/),
+                "fields" => {
+                  "base_path" => Pact.each_like("is already in use by the 'publisher' app", :min => 1),
+                },
+              },
+            },
+            headers: {
+              "Content-Type" => "application/json; charset=utf-8"
+            }
+          )
+      end
+
+      it "responds with 409 Conflict" do
+        error = assert_raises GdsApi::HTTPConflict do
+          @api_client.put_content(@content_id, @content_item)
+        end
+        assert_equal "Conflict", error.error_details["error"]["message"]
+      end
+    end
+
+    describe "with an invalid item" do
+      before do
+        @content_item = content_item_for_content_id(@content_id, "base_path" => "not a url path")
+
+        publishing_api
+          .given("both content stores and the url-arbiter are empty")
+          .upon_receiving("a request to create an invalid content-item")
+          .with(
+            method: :put,
+            path: "/v2/content/#{@content_id}",
+            body: @content_item,
+            headers: {
+              "Content-Type" => "application/json",
+            },
+          )
+          .will_respond_with(
+            status: 422,
+            body: {
+              "error" => {
+                "code" => 422,
+                "message" => Pact.term(generate: "Unprocessable entity", matcher:/\S+/),
+                "fields" => {
+                  "base_path" => Pact.each_like("is invalid", :min => 1),
+                },
+              },
+            },
+            headers: {
+              "Content-Type" => "application/json; charset=utf-8"
+            }
+          )
+      end
+
+      it "responds with 422 Unprocessable Entity" do
+        error = assert_raises GdsApi::HTTPClientError do
+          @api_client.put_content(@content_id, @content_item)
+        end
+        assert_equal 422, error.code
+        assert_equal "Unprocessable entity", error.error_details["error"]["message"]
+      end
+    end
+  end
+
+  describe "#get_content" do
+    describe "when the content item exists" do
+      before do
+        @content_item = content_item_for_content_id(@content_id)
+
+        publishing_api
+          .given("a content item exists with content_id: #{@content_id}")
+          .upon_receiving("a request to return the content item")
+          .with(
+            method: :get,
+            path: "/v2/content/#{@content_id}",
+          )
+          .will_respond_with(
+            status: 200,
+            body: {
+              "content_id" => @content_id,
+              "format" => Pact.like("special_route"),
+              "publishing_app" => Pact.like("publisher"),
+              "rendering_app" => Pact.like("frontend"),
+              "locale" => Pact.like("en"),
+              "routes" => Pact.like([{}]),
+              "public_updated_at" => Pact.like("2015-07-30T13:58:11.000Z"),
+              "details" => Pact.like({})
+            },
+            headers: {
+              "Content-Type" => "application/json; charset=utf-8",
+            },
+          )
+      end
+
+      it "responds with 200 and the content item" do
+        response = @api_client.get_content(@content_id)
+        assert_equal 200, response.code
+        assert_equal @content_item["format"], response["format"]
+      end
+    end
+
+    describe "a non-existent item" do
+      before do
+        publishing_api
+          .given("both content stores and the url-arbiter are empty")
+          .upon_receiving("a request for a non-existent content item")
+          .with(
+            method: :get,
+            path: "/v2/content/#{@content_id}",
+          )
+          .will_respond_with(
+            status: 404,
+            body: {
+              "error" => {
+                "code" => 404,
+                "message" => Pact.term(generate: "not found", matcher:/\S+/)
+              },
+            },
+            headers: {
+              "Content-Type" => "application/json; charset=utf-8",
+            },
+          )
+      end
+
+      it "responds with 404" do
+        assert_nil @api_client.get_content(@content_id)
+      end
+    end
+  end
+
+  describe "#publish" do
+    describe "if the publish command succeeds" do
+      before do
+        publishing_api
+          .given("a draft content item exists with content_id: #{@content_id}")
+          .upon_receiving("a publish request")
+          .with(
+            method: :post,
+            path: "/v2/content/#{@content_id}/publish",
+            body: {
+              update_type: "major",
+            },
+            headers: {
+              "Content-Type" => "application/json",
+            },
+          )
+          .will_respond_with(
+            status: 200
+          )
+      end
+
+      it "responds with 200 if the publish command succeeds" do
+        response = @api_client.publish(@content_id, "major")
+        assert_equal 200, response.code
+      end
+    end
+
+    describe "if the content item does not exist" do
+      before do
+        publishing_api
+          .given("both content stores and url-arbiter empty")
+          .upon_receiving("a publish request")
+          .with(
+            method: :post,
+            path: "/v2/content/#{@content_id}/publish",
+            body: {
+              update_type: "major",
+            },
+            headers: {
+              "Content-Type" => "application/json",
+            },
+          )
+          .will_respond_with(
+            status: 404
+          )
+      end
+
+      it "responds with 404" do
+        error = assert_raises GdsApi::HTTPClientError do
+          @api_client.publish(@content_id, "major")
+        end
+
+        assert_equal 404, error.code
+      end
+    end
+
+    describe "if the content item is not publishable" do
+      before do
+        publishing_api
+          .given("a draft content item exists with content_id: #{@content_id} which does not have a publishing_app")
+          .upon_receiving("a publish request")
+          .with(
+            method: :post,
+            path: "/v2/content/#{@content_id}/publish",
+            body: {
+              update_type: "major",
+            },
+            headers: {
+              "Content-Type" => "application/json",
+            },
+          )
+          .will_respond_with(
+            status: 422,
+            body: {
+              "error" => {
+                "code" => 422,
+                "fields" => {
+                  "publishing_app"=>["can't be blank"],
+                },
+              },
+            }
+          )
+      end
+
+      it "responds with 422" do
+        error = assert_raises GdsApi::HTTPClientError do
+          @api_client.publish(@content_id, "major")
+        end
+
+        assert_equal 422, error.code
+        assert_equal ["can't be blank"], error.error_details["error"]["fields"]["publishing_app"]
+      end
+    end
+
+    describe "if the update information is invalid" do
+      before do
+        publishing_api
+          .given("a draft content item exists with content_id: #{@content_id}")
+          .upon_receiving("an invalid publish request")
+          .with(
+            method: :post,
+            path: "/v2/content/#{@content_id}/publish",
+            body: {
+              "update_type" => ""
+            },
+            headers: {
+              "Content-Type" => "application/json",
+            },
+          )
+          .will_respond_with(
+            status: 422,
+            body: {
+              "error" => {
+                "code" => 422,
+                "message" => Pact.term(generate: "Unprocessable entity", matcher:/\S+/),
+                "fields" => {
+                  "update_type" => Pact.each_like("is required", :min => 1),
+                },
+              },
+            }
+          )
+      end
+
+      it "responds with 422" do
+        error = assert_raises GdsApi::HTTPClientError do
+          @api_client.publish(@content_id, "")
+        end
+
+        assert_equal 422, error.code
+        assert_equal "Unprocessable entity", error.error_details["error"]["message"]
+      end
+    end
+
+    describe "if the content item is already published" do
+      before do
+        publishing_api
+          .given("a published content item exists with content_id: #{@content_id}")
+          .upon_receiving("a publish request")
+          .with(
+            method: :post,
+            path: "/v2/content/#{@content_id}/publish",
+            body: {
+              update_type: "major",
+            },
+            headers: {
+              "Content-Type" => "application/json",
+            },
+          )
+          .will_respond_with(
+            status: 400,
+            body: {
+              "error" => {
+                "code" => 400, "message" => Pact.term(generate: "Cannot publish an already published content item", matcher:/\S+/),
+              },
+            }
+          )
+      end
+
+      it "responds with 400" do
+        error = assert_raises GdsApi::HTTPClientError do
+          @api_client.publish(@content_id, "major")
+        end
+
+        assert_equal 400, error.code
+        assert_equal "Cannot publish an already published content item", error.error_details["error"]["message"]
+      end
+    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 "#put_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")
+          .with(
+            method: :put,
+            path: "/v2/links/#{@content_id}",
+            body: {
+              links: {
+                organisations: ["591436ab-c2ae-416f-a3c5-1901d633fbfb"],
+              }
+            },
+            headers: {
+              "Content-Type" => "application/json",
+            },
+          )
+          .will_respond_with(
+            status: 200,
+            body: {
+              links: {
+                organisations: ["591436ab-c2ae-416f-a3c5-1901d633fbfb"],
+              }
+            }
+          )
+      end
+
+      it "replaces the links and responds with the new links" do
+        response = @api_client.put_links(@content_id, links: {
+          organisations: ["591436ab-c2ae-416f-a3c5-1901d633fbfb"],
+        })
+        assert_equal 200, response.code
+        assert_equal ["591436ab-c2ae-416f-a3c5-1901d633fbfb"], response.links.organisations
+      end
+    end
+
+    describe "when setting links of a different type" do
+      before do
+        publishing_api
+          .given("organisation links exist for content_id #{@content_id}")
+          .upon_receiving("a put topic links request")
+          .with(
+            method: :put,
+            path: "/v2/links/#{@content_id}",
+            body: {
+              links: {
+                topics: ["225df4a8-2945-4e9b-8799-df7424a90b69"],
+              }
+            },
+            headers: {
+              "Content-Type" => "application/json",
+            },
+          )
+          .will_respond_with(
+            status: 200,
+            body: {
+              links: {
+                topics: ["225df4a8-2945-4e9b-8799-df7424a90b69"],
+                organisations: ["20583132-1619-4c68-af24-77583172c070"]
+              }
+            }
+          )
+      end
+
+      it "adds the new type of links and responds with the whole link set" do
+        response = @api_client.put_links(@content_id, links: {
+          topics: ["225df4a8-2945-4e9b-8799-df7424a90b69"],
+        })
+
+        assert_equal 200, response.code
+        assert_equal(OpenStruct.new(
+          topics: ["225df4a8-2945-4e9b-8799-df7424a90b69"],
+          organisations: ["20583132-1619-4c68-af24-77583172c070"],
+        ), response.links)
+      end
+    end
+
+    describe "when deleting links of a specific type" do
+      before do
+        publishing_api
+          .given("organisation links exist for content_id #{@content_id}")
+          .upon_receiving("a put blank organisation links request")
+          .with(
+            method: :put,
+            path: "/v2/links/#{@content_id}",
+            body: {
+              links: {
+                organisations: [],
+              }
+            },
+            headers: {
+              "Content-Type" => "application/json",
+            },
+          )
+          .will_respond_with(
+            status: 200,
+            body: {
+              links: {}
+            }
+          )
+      end
+
+      it "responds with the links" do
+        response = @api_client.put_links(@content_id, links: {
+          organisations: [],
+        })
+
+        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 put organisation links request")
+          .with(
+            method: :put,
+            path: "/v2/links/#{@content_id}",
+            body: {
+              links: {
+                organisations: ["591436ab-c2ae-416f-a3c5-1901d633fbfb"],
+              }
+            },
+            headers: {
+              "Content-Type" => "application/json",
+            },
+          )
+          .will_respond_with(
+            status: 200,
+            body: {
+              links: {
+                organisations: ["591436ab-c2ae-416f-a3c5-1901d633fbfb"],
+              }
+            },
+          )
+      end
+
+      it "responds with the links" do
+        response = @api_client.put_links(@content_id, links: {
+          organisations: ["591436ab-c2ae-416f-a3c5-1901d633fbfb"],
+        })
+
+        assert_equal 200, response.code
+        assert_equal(OpenStruct.new(
+          organisations: ["591436ab-c2ae-416f-a3c5-1901d633fbfb"],
+        ), response.links)
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -11,7 +11,7 @@ require 'rack/utils'
 require 'rack/test'
 require 'simplecov'
 require 'simplecov-rcov'
-require 'mocha'
+require 'mocha/mini_test'
 require 'timecop'
 
 SimpleCov.start do
@@ -26,6 +26,23 @@ class MiniTest::Unit::TestCase
   end
 end
 
+require 'pact/consumer/minitest'
+module PactTest
+  include Pact::Consumer::Minitest
+
+  def before_suite
+    # Pact does its own stubbing of network connections, so we want to
+    # prevent WebMock interfering when pact is being used.
+    ::WebMock.allow_net_connect!
+    super
+  end
+
+  def after_suite
+    super
+    ::WebMock.disable_net_connect!
+  end
+end
+
 def load_fixture_file(filename)
   File.open( File.join( File.dirname(__FILE__), "fixtures", filename ), :encoding => 'utf-8' )
 end
@@ -34,3 +51,4 @@ require 'webmock/minitest'
 WebMock.disable_net_connect!
 
 require 'gds_api/test_helpers/json_client_helper'
+require 'test_helpers/pact_helper'

data/test/test_helpers/pact_helper.rb

@@ -0,0 +1,7 @@
+Pact.service_consumer "GDS API Adapters" do
+  has_pact_with "Publishing API" do
+    mock_service :publishing_api do
+      port 3093
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 24.4.0
+  version: 24.5.0
 platform: ruby
 authors:
 - James Stewart
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-17 00:00:00.000000000 Z
+date: 2015-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plek
@@ -95,75 +95,89 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: gem_publisher
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: 1.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: 0.9.2.2
+        version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: 0.9.2.2
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '1.19'
+        version: 5.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '1.19'
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: pact
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.12.4
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.12.4
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: pact-consumer-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -193,47 +207,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.4
+        version: 0.9.2.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.4
+        version: 0.9.2.2
 - !ruby/object:Gem::Dependency
-  name: simplecov-rcov
+  name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
-  name: gem_publisher
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 0.5.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 0.5.4
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -249,19 +277,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.5.1
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.19'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.19'
 description: A set of adapters providing easy access to the GDS GOV.UK APIs
 email:
 - jystewart@gmail.com
@@ -304,6 +332,7 @@ files:
 - lib/gds_api/publisher.rb
 - lib/gds_api/publishing_api.rb
 - lib/gds_api/publishing_api/special_route_publisher.rb
+- lib/gds_api/publishing_api_v2.rb
 - lib/gds_api/railtie.rb
 - lib/gds_api/response.rb
 - lib/gds_api/router.rb
@@ -376,6 +405,7 @@ files:
 - test/publisher_api_test.rb
 - test/publishing_api/special_route_publisher_test.rb
 - test/publishing_api_test.rb
+- test/publishing_api_v2_test.rb
 - test/response_test.rb
 - test/router_test.rb
 - test/rummager_helpers_test.rb
@@ -383,6 +413,7 @@ files:
 - test/support_api_test.rb
 - test/support_test.rb
 - test/test_helper.rb
+- test/test_helpers/pact_helper.rb
 - test/test_helpers/panopticon_test.rb
 - test/test_helpers/publishing_api_test.rb
 - test/whitehall_admin_api_test.rb
@@ -424,6 +455,7 @@ test_files:
 - test/content_register_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/licence_application_api_test.rb
 - test/gov_uk_delivery_test.rb
@@ -455,4 +487,5 @@ test_files:
 - 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