gds-api-adapters 30.3.0 → 30.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ea4fb424e88b660a8ecb6ea9a088abf135983aa
-  data.tar.gz: ff6e5fd6357f9078dbc63762f498e3c47fc4d0d8
+  metadata.gz: 45470b12b8841677669e769a1cda10981a25d5ad
+  data.tar.gz: 0c32f6ac9fca548e90072e70597d3227b9697a6f
 SHA512:
-  metadata.gz: 396bb7e3cddb5f262656439e1ef8c52795fa8b76f54e2339875e9d7d9ecd3e81843af9fdd8b1e050e9ca7293e22ee60b7af0078b7787235005f32fd972965ced
-  data.tar.gz: 173c4784e54d85ffdb1b6411572283a4082a5344cf0bb5b5ea87c6dabf500eef4b19963f6d26dc80109463bc9610d889eef7e5e757062de761f4c5f9810a2330
+  metadata.gz: e8340c617333eb1810e1e46ef72bed25ac8cc080c65325c2e375dc71790d1ad8781a3582ed4abca59508a1b940cdbe1a83e3c6966a2673ceb7c65fc81b29d504
+  data.tar.gz: 160d311984d37bfa2992313be1d240a898005b8063b95448ad420f3d0da40d2dfb03d73691ab75a6fa9f4f66735e2a1fe6429c123af95c2e65ad933bf995fda2

data/lib/gds_api/publishing_api_v2.rb

@@ -107,6 +107,32 @@ class GdsApi::PublishingApiV2 < GdsApi::Base
     post_json!(publish_url(content_id), params)
   end
 
+  # Unpublish a content item
+  #
+  # The publishing API will "unpublish" a live item, to remove it from the public
+  # site, or update an existing unpublishing.
+  #
+  # @param content_id [UUID]
+  # @param type [String] Either 'withdrawal', 'gone' or 'redirect'.
+  # @param explanation [String] (optional) Text to show on the page.
+  # @param alternative_path [String] (optional) Alternative path to show on the page or redirect to.
+  # @param discard_drafts [Boolean] (optional) Whether to discard drafts on that item.  Defaults to false.
+  # @param previous_version [Integer] (optional) A lock version number for optimistic locking.
+  #
+  # @see TODO
+  def unpublish(content_id, type:, explanation: nil, alternative_path: nil, discard_drafts: false, previous_version: nil)
+    params = {
+      type: type
+    }
+
+    params.merge!(explanation: explanation) if explanation
+    params.merge!(alternative_path: alternative_path) if alternative_path
+    params.merge!(previous_version: previous_version) if previous_version
+    params.merge!(discard_drafts: discard_drafts) if discard_drafts
+
+    post_json!(unpublish_url(content_id), params)
+  end
+
   # Discard a draft
   #
   # Deletes the draft content item.
@@ -213,6 +239,11 @@ private
     "#{endpoint}/v2/content/#{content_id}/publish"
   end
 
+  def unpublish_url(content_id)
+    validate_content_id(content_id)
+    "#{endpoint}/v2/content/#{content_id}/unpublish"
+  end
+
   def discard_url(content_id)
     validate_content_id(content_id)
     "#{endpoint}/v2/content/#{content_id}/discard-draft"

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '30.3.0'
+  VERSION = '30.4.0'
 end

data/test/publishing_api_v2_test.rb

@@ -141,7 +141,7 @@ describe GdsApi::PublishingApiV2 do
     end
 
     describe "optimistic locking" do
-      describe "if the content item has not change since it was requested" do
+      describe "if the content item has not changed since it was requested" do
         before do
           @content_item = content_item_for_content_id(@content_id, "previous_version" => 3)
 
@@ -471,7 +471,7 @@ describe GdsApi::PublishingApiV2 do
     end
 
     describe "optimistic locking" do
-      describe "if the content item has not change since it was requested" do
+      describe "if the content item has not changed since it was requested" do
         before do
           publishing_api
             .given("the content item #{@content_id} is at version 3")
@@ -542,6 +542,197 @@ describe GdsApi::PublishingApiV2 do
     end
   end
 
+  describe "#unpublish" do
+    describe "if the unpublish command succeeds" do
+      before do
+        publishing_api
+          .given("a published content item exists with content_id: #{@content_id}")
+          .upon_receiving("an unpublish request")
+          .with(
+            method: :post,
+            path: "/v2/content/#{@content_id}/unpublish",
+            body: {
+              type: "gone",
+            },
+            headers: {
+              "Content-Type" => "application/json",
+            },
+          )
+          .will_respond_with(
+            status: 200
+          )
+      end
+
+      it "responds with 200" do
+        response = @api_client.unpublish(@content_id, type: "gone")
+        assert_equal 200, response.code
+      end
+    end
+
+    describe "if the content item does not exist" do
+      before do
+        publishing_api
+          .given("no content exists")
+          .upon_receiving("an unpublish request")
+          .with(
+            method: :post,
+            path: "/v2/content/#{@content_id}/unpublish",
+            body: {
+              type: "gone",
+            },
+            headers: {
+              "Content-Type" => "application/json",
+            },
+          )
+          .will_respond_with(
+            status: 404
+          )
+      end
+
+      it "responds with 404" do
+        error = assert_raises GdsApi::HTTPClientError do
+          @api_client.unpublish(@content_id, type: "gone")
+        end
+
+        assert_equal 404, error.code
+      end
+    end
+
+    describe "if the type is incorrect" do
+      before do
+        publishing_api
+          .given("a published content item exists with content_id: #{@content_id}")
+          .upon_receiving("an invalid unpublish request")
+          .with(
+            method: :post,
+            path: "/v2/content/#{@content_id}/unpublish",
+            body: {
+              type: "not-a-valid-type",
+            },
+            headers: {
+              "Content-Type" => "application/json",
+            },
+          )
+          .will_respond_with(
+            status: 422,
+            body: {
+              "error" => {
+                "code" => 422,
+                "message" => Pact.term(generate: "not-a-valid-type is not a valid unpublishing type", matcher:/\S+/),
+                "fields" => {},
+              },
+            }
+          )
+      end
+
+      it "responds with 422" do
+        error = assert_raises GdsApi::HTTPClientError do
+          @api_client.unpublish(@content_id, type: "not-a-valid-type")
+        end
+
+        assert_equal 422, error.code
+        assert_equal "not-a-valid-type is not a valid unpublishing type", error.error_details["error"]["message"]
+      end
+    end
+
+    describe "if the content item is already unpublished" do
+      before do
+        publishing_api
+          .given("an unpublished content item exists with content_id: #{@content_id}")
+          .upon_receiving("an unpublish request")
+          .with(
+            method: :post,
+            path: "/v2/content/#{@content_id}/unpublish",
+            body: {
+              type: "gone",
+            },
+            headers: {
+              "Content-Type" => "application/json",
+            },
+          )
+          .will_respond_with(
+            status: 200
+          )
+      end
+
+      it "responds with 200 and updates the unpublishing" do
+        response = @api_client.unpublish(@content_id, type: "gone")
+        assert_equal 200, response.code
+      end
+    end
+
+    describe "optimistic locking" do
+      describe "if the content item has not changed since it was requested" do
+        before do
+          publishing_api
+            .given("the published content item #{@content_id} is at version 3")
+            .upon_receiving("an unpublish request for version 3")
+            .with(
+              method: :post,
+              path: "/v2/content/#{@content_id}/unpublish",
+              body: {
+                type: "gone",
+                previous_version: 3,
+              },
+              headers: {
+                "Content-Type" => "application/json",
+              },
+            )
+            .will_respond_with(
+              status: 200,
+            )
+        end
+
+        it "responds with 200 OK" do
+          response = @api_client.unpublish(@content_id, type: "gone", previous_version: 3)
+          assert_equal 200, response.code
+        end
+      end
+
+      describe "if the content item has changed in the meantime" do
+        before do
+          publishing_api
+            .given("the published content item #{@content_id} is at version 3")
+            .upon_receiving("an unpublish request for version 2")
+            .with(
+              method: :post,
+              path: "/v2/content/#{@content_id}/unpublish",
+              body: {
+                type: "gone",
+                previous_version: 2,
+              },
+              headers: {
+                "Content-Type" => "application/json",
+              },
+            )
+            .will_respond_with(
+              status: 409,
+              body: {
+                "error" => {
+                  "code" => 409,
+                  "message" => Pact.term(generate: "Conflict", matcher:/\S+/),
+                  "fields" => {
+                    "previous_version" => Pact.each_like("does not match", :min => 1),
+                  },
+                },
+              },
+              headers: {
+                "Content-Type" => "application/json; charset=utf-8"
+              }
+            )
+        end
+
+        it "responds with 409 Conflict" do
+          error = assert_raises GdsApi::HTTPClientError do
+            @api_client.unpublish(@content_id, type: "gone", previous_version: 2)
+          end
+          assert_equal 409, error.code
+          assert_equal "Conflict", error.error_details["error"]["message"]
+        end
+      end
+    end
+  end
+
   describe "#get_links" do
     describe "when there's a links entry with links" do
       before do
@@ -768,7 +959,7 @@ describe GdsApi::PublishingApiV2 do
     end
 
     describe "optimistic locking" do
-      describe "if the linkset has not change since it was requested" do
+      describe "if the linkset has not changed since it was requested" do
         before do
           publishing_api
             .given("the linkset for #{@content_id} is at version 3")

metadata

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