gds-api-adapters 25.0.0 → 25.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e7e6dd6ee7232cd76f967088448461c8b572f56d
-  data.tar.gz: 12338e6a3ca65715876c502dfc81d4ca519f2c5f
+  metadata.gz: 8afbe2d34bba51917e28dd3f85e89d6e734c35af
+  data.tar.gz: da4fdfd37ae75f002f6dc163a039856672bd40eb
 SHA512:
-  metadata.gz: 760651cf21cbdaa624527b5f2b9442ac7cf522ac3345aa551235ef28579826ab9e7b39cebffdf514f23658f8099f27b20428622cc951da31fd3d2e7761e63180
-  data.tar.gz: 8fbdf293064d55223de66030d1b47525501f5a48a8f93226fffd6a844ebe873b80736d8ceefd3174e466b95b1c282629016aabfcf631ddefd75378b8d0b2c7a4
+  metadata.gz: 2b31b1493c90363a24080b9d8bb0864ecf400dd52ae23d44b15bc5f59ba539f55bcdfcaf97b7923307dd27510299dd880e79af29b2cfbad6d8820c34219edd10
+  data.tar.gz: 61cace3dd9782add1a8814776db7643054734766f72f3545954cd87a1356a12836860f489e2589b4cfa744caaa76c6486dd3249bcbc8f1dd6ce416ec7c42673c

data/lib/gds_api/publishing_api_v2.rb

@@ -14,8 +14,16 @@ class GdsApi::PublishingApiV2 < GdsApi::Base
   end
 
   def publish(content_id, update_type, options = {})
-    params = { update_type: update_type }
-    params = params.merge(locale: options[:locale]) if options[:locale]
+    params = {
+      update_type: update_type
+    }
+
+    optional_keys = [
+      :locale,
+      :previous_version,
+    ]
+
+    params = merge_optional_keys(params, options, optional_keys)
 
     post_json!(publish_url(content_id), params)
   end
@@ -25,8 +33,13 @@ class GdsApi::PublishingApiV2 < GdsApi::Base
   end
 
   def put_links(content_id, payload)
-    links = payload.fetch(:links)
-    put_json!(links_url(content_id), links: links)
+    params = {
+      links: payload.fetch(:links)
+    }
+
+    params = merge_optional_keys(params, payload, [:previous_version])
+
+    put_json!(links_url(content_id), params)
   end
 
 private
@@ -43,4 +56,10 @@ private
   def publish_url(content_id)
     "#{endpoint}/v2/content/#{content_id}/publish"
   end
+
+  def merge_optional_keys(params, options, optional_keys)
+    optional_keys.each_with_object(params) do |optional_key, hash|
+      hash.merge!(optional_key => options[optional_key]) if options[optional_key]
+    end
+  end
 end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '25.0.0'
+  VERSION = '25.1.0'
 end

data/test/publishing_api_test.rb

@@ -17,7 +17,7 @@ describe GdsApi::PublishingApi do
       content_item = content_item_for_publishing_api(base_path).merge("update_type" => "major")
 
       publishing_api
-        .given("both content stores and the url-arbiter are empty")
+        .given("no content exists")
         .upon_receiving("a request to create a content item")
         .with(
           method: :put,
@@ -46,7 +46,7 @@ describe GdsApi::PublishingApi do
       content_item = content_item_for_publishing_api(base_path).merge("update_type" => "major")
 
       publishing_api
-        .given("both content stores and the url-arbiter are empty")
+        .given("no content exists")
         .upon_receiving("a request to create a draft content item")
         .with(
           method: :put,
@@ -75,7 +75,7 @@ describe GdsApi::PublishingApi do
       publish_intent = intent_for_publishing_api(base_path)
 
       publishing_api
-        .given("both content stores and the url-arbiter are empty")
+        .given("no content exists")
         .upon_receiving("a request to create a publish intent")
         .with(
           method: :put,
@@ -105,7 +105,7 @@ describe GdsApi::PublishingApi do
       publish_intent = intent_for_publishing_api(base_path)
 
       publishing_api
-        .given("a publish intent exists at /test-intent in the live content store")
+        .given("a publish intent exists at /test-intent")
         .upon_receiving("a request to delete a publish intent")
         .with(
           method: :delete,
@@ -129,7 +129,7 @@ describe GdsApi::PublishingApi do
       publish_intent = intent_for_publishing_api(base_path)
 
       publishing_api
-        .given("both content stores and the url-arbiter are empty")
+        .given("no content exists")
         .upon_receiving("a request to delete a publish intent")
         .with(
           method: :delete,
@@ -156,7 +156,7 @@ describe GdsApi::PublishingApi do
       }
 
       publishing_api
-        .given("both content stores and the url-arbiter are empty")
+        .given("no content exists")
         .upon_receiving("a request to put a path")
         .with(
           method: :put,
@@ -185,7 +185,7 @@ describe GdsApi::PublishingApi do
       }
 
       publishing_api
-        .given("/test-item has been reserved in url-arbiter by the Publisher application")
+        .given("/test-item has been reserved by the Publisher application")
         .upon_receiving("a request to change publishing app")
         .with(
           method: :put,

data/test/publishing_api_v2_test.rb

@@ -38,7 +38,7 @@ describe GdsApi::PublishingApiV2 do
         @content_item = content_item_for_content_id(@content_id)
 
         publishing_api
-          .given("both content stores and the url-arbiter are empty")
+          .given("no content exists")
           .upon_receiving("a request to create a content item without links")
           .with(
             method: :put,
@@ -64,7 +64,7 @@ describe GdsApi::PublishingApiV2 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")
+          .given("/test-item has been reserved by the Publisher application")
           .upon_receiving("a request from the Whitehall application to create a content item at /test-item")
           .with(
             method: :put,
@@ -104,7 +104,7 @@ describe GdsApi::PublishingApiV2 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")
+          .given("no content exists")
           .upon_receiving("a request to create an invalid content-item")
           .with(
             method: :put,
@@ -139,6 +139,75 @@ describe GdsApi::PublishingApiV2 do
         assert_equal "Unprocessable entity", error.error_details["error"]["message"]
       end
     end
+
+    describe "optimistic locking" do
+      describe "if the content item has not change since it was requested" do
+        before do
+          @content_item = content_item_for_content_id(@content_id, "previous_version" => 3)
+
+          publishing_api
+            .given("the content item #{@content_id} is at version 3")
+            .upon_receiving("a request to update the content item at version 3")
+            .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 content item has changed in the meantime" do
+        before do
+          @content_item = content_item_for_content_id(@content_id, "previous_version" => 2)
+
+          publishing_api
+            .given("the content item #{@content_id} is at version 3")
+            .upon_receiving("a request to update the content item at version 2")
+            .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" => {
+                    "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.put_content(@content_id, @content_item)
+          end
+          assert_equal 409, error.code
+          assert_equal "Conflict", error.error_details["error"]["message"]
+        end
+      end
+    end
   end
 
   describe "#get_content" do
@@ -218,7 +287,7 @@ describe GdsApi::PublishingApiV2 do
     describe "a non-existent item" do
       before do
         publishing_api
-          .given("both content stores and the url-arbiter are empty")
+          .given("no content exists")
           .upon_receiving("a request for a non-existent content item")
           .with(
             method: :get,
@@ -274,7 +343,7 @@ describe GdsApi::PublishingApiV2 do
     describe "if the content item does not exist" do
       before do
         publishing_api
-          .given("both content stores and the url-arbiter are empty")
+          .given("no content exists")
           .upon_receiving("a publish request")
           .with(
             method: :post,
@@ -438,6 +507,77 @@ describe GdsApi::PublishingApiV2 do
         assert_equal 200, response.code
       end
     end
+
+    describe "optimistic locking" do
+      describe "if the content item has not change since it was requested" do
+        before do
+          publishing_api
+            .given("the content item #{@content_id} is at version 3")
+            .upon_receiving("a publish request for version 3")
+            .with(
+              method: :post,
+              path: "/v2/content/#{@content_id}/publish",
+              body: {
+                update_type: "minor",
+                previous_version: 3,
+              },
+              headers: {
+                "Content-Type" => "application/json",
+              },
+            )
+            .will_respond_with(
+              status: 200,
+            )
+        end
+
+        it "responds with 200 OK" do
+          response = @api_client.publish(@content_id, "minor", 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 content item #{@content_id} is at version 3")
+            .upon_receiving("a publish request for version 2")
+            .with(
+              method: :post,
+              path: "/v2/content/#{@content_id}/publish",
+              body: {
+                update_type: "minor",
+                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.publish(@content_id, "minor", 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
@@ -664,5 +804,92 @@ describe GdsApi::PublishingApiV2 do
         ), response.links)
       end
     end
+
+    describe "optimistic locking" do
+      describe "if the linkset has not change since it was requested" do
+        before do
+          publishing_api
+            .given("the linkset for #{@content_id} is at version 3")
+            .upon_receiving("a request to update the linkset at version 3")
+            .with(
+              method: :put,
+              path: "/v2/links/#{@content_id}",
+              body: {
+                links: {
+                  organisations: ["591436ab-c2ae-416f-a3c5-1901d633fbfb"],
+                },
+                previous_version: 3,
+              },
+              headers: {
+                "Content-Type" => "application/json",
+              },
+            )
+            .will_respond_with(
+              status: 200,
+            )
+        end
+
+        it "responds with 200 OK" do
+          response = @api_client.put_links(@content_id,
+            links: {
+              organisations: ["591436ab-c2ae-416f-a3c5-1901d633fbfb"],
+            },
+            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 linkset for #{@content_id} is at version 3")
+            .upon_receiving("a request to update the linkset at version 2")
+            .with(
+              method: :put,
+              path: "/v2/links/#{@content_id}",
+              body: {
+                links: {
+                  organisations: ["591436ab-c2ae-416f-a3c5-1901d633fbfb"],
+                },
+                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.put_links(@content_id,
+              links: {
+                organisations: ["591436ab-c2ae-416f-a3c5-1901d633fbfb"],
+              },
+              previous_version: 2,
+            )
+          end
+
+          assert_equal 409, error.code
+          assert_equal "Conflict", error.error_details["error"]["message"]
+        end
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 25.0.0
+  version: 25.1.0
 platform: ruby
 authors:
 - James Stewart
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-02 00:00:00.000000000 Z
+date: 2015-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plek