gds-api-adapters 24.6.0 → 24.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 212e116b422961283b637ba076848769be4c2eaa
-  data.tar.gz: c79059c7b2f7040590283f54ff51950db3b401cb
+  metadata.gz: 4ef68ae8d9f4be614277bc8a7acb8027f1c07545
+  data.tar.gz: 932afdaf75d50446a826c4f3792457977eebe3c8
 SHA512:
-  metadata.gz: 982d5e547eec900056a748469da51fe2be0f62c831eb90074f56dfb748d8aa8a624e7af3b30b0c7996c61d52cfbb1c9db68ce9e350c8e3bbc1f8696f988c3897
-  data.tar.gz: 88442f8971daf8150de2328246199d0f1ee89e020a97f4443cb180a0da95d2f94af65783468420f7f005c5921d10faaaa51a2945780fc254d4adaa9cbefd5fd9
+  metadata.gz: c09577ea35742649e8614f0c0a274e5604fd416c031f47b1d22853a21724cc8d2826aeafd571f125f690be6b7ba794e9eb8451228c9ec3356f8160b1efe71e31
+  data.tar.gz: 06d0fa4e1ec14347dbb178d57aa011a5b75c188255f2e1cee60ec718aaa614820011c0a2da8a2c1836f1c91e62fb11792c98646e37c9b2dfa7a8fe60cdd17c04

data/Rakefile

@@ -1,6 +1,5 @@
 # -*- encoding: utf-8 -*-
 
-require "bundler/gem_tasks"
 require "rdoc/task"
 require 'rake/testtask'
 
@@ -15,11 +14,35 @@ Rake::TestTask.new("test") do |t|
   t.test_files = FileList["test/**/*_test.rb"]
   t.verbose = true
 end
+task :default => :test
+
+require 'pact_broker/client/tasks'
+
+def configure_pact_broker_location(task)
+  task.pact_broker_base_url = ENV.fetch("PACT_BROKER_BASE_URL")
+  if ENV['PACT_BROKER_USERNAME']
+    task.pact_broker_basic_auth =  { username: ENV['PACT_BROKER_USERNAME'], password: ENV['PACT_BROKER_PASSWORD']}
+  end
+end
+
+PactBroker::Client::PublicationTask.new("branch") do | task |
+  task.consumer_version = ENV.fetch("PACT_TARGET_BRANCH")
+  configure_pact_broker_location(task)
+end
+
+PactBroker::Client::PublicationTask.new("released_version") do | task |
+  require 'gds_api/version'
+  task.consumer_version = GdsApi::VERSION
+  configure_pact_broker_location(task)
+end
 
 require "gem_publisher"
+desc "Publish gem to rubygems.org if necessary"
 task :publish_gem do |t|
   gem = GemPublisher.publish_if_updated("gds-api-adapters.gemspec", :rubygems)
-  puts "Published #{gem}" if gem
-end
+  if gem
+    puts "Published #{gem}"
 
-task :default => :test
+    Rake::Task["pact:publish:released_version"].invoke
+  end
+end

data/lib/gds_api/publishing_api.rb

@@ -21,6 +21,10 @@ class GdsApi::PublishingApi < GdsApi::Base
     e
   end
 
+  def put_path(base_path, payload)
+    put_json!(paths_url(base_path), payload)
+  end
+
 
   private
 
@@ -35,4 +39,8 @@ class GdsApi::PublishingApi < GdsApi::Base
   def intent_url(base_path)
     "#{endpoint}/publish-intent#{base_path}"
   end
+
+  def paths_url(base_path)
+    "#{endpoint}/paths#{base_path}"
+  end
 end

data/lib/gds_api/publishing_api_v2.rb

@@ -6,14 +6,18 @@ class GdsApi::PublishingApiV2 < GdsApi::Base
     put_json!(content_url(content_id), payload)
   end
 
-  def get_content(content_id)
-    get_json(content_url(content_id))
+  def get_content(content_id, options = {})
+    params = {}
+    params = params.merge(locale: options[:locale]) if options[:locale]
+
+    get_json(content_url(content_id, params))
   end
 
-  def publish(content_id, update_type)
-    post_json!(content_url(content_id) + "/publish", {
-      update_type: update_type,
-    })
+  def publish(content_id, update_type, options = {})
+    params = { update_type: update_type }
+    params = params.merge(locale: options[:locale]) if options[:locale]
+
+    post_json!(publish_url(content_id), params)
   end
 
   def get_links(content_id)
@@ -27,11 +31,16 @@ class GdsApi::PublishingApiV2 < GdsApi::Base
 
 private
 
-  def content_url(content_id)
-    "#{endpoint}/v2/content/#{content_id}"
+  def content_url(content_id, params = {})
+    query = query_string(params)
+    "#{endpoint}/v2/content/#{content_id}#{query}"
   end
 
   def links_url(content_id)
     "#{endpoint}/v2/links/#{content_id}"
   end
+
+  def publish_url(content_id)
+    "#{endpoint}/v2/content/#{content_id}/publish"
+  end
 end

data/lib/gds_api/test_helpers/publishing_api.rb

@@ -11,16 +11,16 @@ module GdsApi
 
       PUBLISHING_API_ENDPOINT = Plek.current.find('publishing-api')
 
-      def stub_publishing_api_put_draft_item(base_path, body = content_item_for_base_path(base_path))
+      def stub_publishing_api_put_draft_item(base_path, body = content_item_for_publishing_api(base_path))
         stub_publishing_api_put_item(base_path, body, '/draft-content')
       end
 
-      def stub_publishing_api_put_item(base_path, body = content_item_for_base_path(base_path), resource_path = '/content')
+      def stub_publishing_api_put_item(base_path, body = content_item_for_publishing_api(base_path), resource_path = '/content')
         url = PUBLISHING_API_ENDPOINT + resource_path + base_path
         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))
+      def stub_publishing_api_put_intent(base_path, body = intent_for_publishing_api(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: 200, body: '{}', headers: {"Content-Type" => "application/json; charset=utf-8"})
@@ -109,6 +109,14 @@ module GdsApi
           expected_value == actual_value
         end
       end
+
+      def content_item_for_publishing_api(base_path, publishing_app="publisher")
+        content_item_for_base_path(base_path).merge("publishing_app" => publishing_app)
+      end
+
+      def intent_for_publishing_api(base_path, publishing_app="publisher")
+        intent_for_base_path(base_path).merge("publishing_app" => publishing_app)
+      end
     end
   end
 end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '24.6.0'
+  VERSION = '24.7.0'
 end

data/test/asset_manager_test.rb

@@ -52,7 +52,7 @@ describe GdsApi::AssetManager do
     let(:asset_id) { "test-id" }
 
     it "updates an asset with a file" do
-      req = stub_request(:put, "http://asset-manager.dev.gov.uk/assets/test-id").
+      req = stub_request(:put, "#{base_api_url}/assets/test-id").
         to_return(:body => JSON.dump(asset_manager_response), :status => 200)
 
       response = api.update_asset(asset_id, :file => file_fixture)

data/test/publishing_api_test.rb

@@ -14,7 +14,7 @@ describe GdsApi::PublishingApi do
   describe "#put_content_item" do
     it "responds with 200 OK if the entry is valid" do
       base_path = "/test-content-item"
-      content_item = content_item_for_base_path(base_path).merge("update_type" => "major")
+      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")
@@ -43,7 +43,7 @@ describe GdsApi::PublishingApi do
   describe "#put_draft_content_item" do
     it "responds with 200 OK if the entry is valid" do
       base_path = "/test-draft-content-item"
-      content_item = content_item_for_base_path(base_path).merge("update_type" => "major")
+      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")
@@ -72,7 +72,7 @@ describe GdsApi::PublishingApi do
   describe "#put_intent" do
     it "responds with 200 OK if publish intent is valid" do
       base_path = "/test-intent"
-      publish_intent = intent_for_base_path(base_path)
+      publish_intent = intent_for_publishing_api(base_path)
 
       publishing_api
         .given("both content stores and the url-arbiter are empty")
@@ -102,7 +102,7 @@ describe GdsApi::PublishingApi do
     it "returns 200 OK if intent existed and was deleted" do
       base_path = "/test-intent"
 
-      publish_intent = intent_for_base_path(base_path)
+      publish_intent = intent_for_publishing_api(base_path)
 
       publishing_api
         .given("a publish intent exists at /test-intent in the live content store")
@@ -126,7 +126,7 @@ describe GdsApi::PublishingApi do
     it "returns 404 Not found if the intent does not exist" do
       base_path = "/test-intent"
 
-      publish_intent = intent_for_base_path(base_path)
+      publish_intent = intent_for_publishing_api(base_path)
 
       publishing_api
         .given("both content stores and the url-arbiter are empty")
@@ -147,4 +147,72 @@ describe GdsApi::PublishingApi do
       assert_equal 404, response.code
     end
   end
+
+  describe "#put_path" do
+    it "returns 200 if the path was successfully reserved" do
+      base_path = "/test-intent"
+      payload = {
+        publishing_app: "publisher"
+      }
+
+      publishing_api
+        .given("both content stores and the url-arbiter are empty")
+        .upon_receiving("a request to put a path")
+        .with(
+          method: :put,
+          path: "/paths#{base_path}",
+          body: payload,
+          headers: {
+            "Content-Type" => "application/json"
+          },
+        )
+        .will_respond_with(
+          status: 200,
+          body: {},
+          headers: {
+            "Content-Type" => "application/json; charset=utf-8"
+          }
+        )
+
+      response = @api_client.put_path(base_path, payload)
+      assert_equal 200, response.code
+    end
+
+    it "returns 422 if the request is invalid" do
+      base_path = "/test-item"
+      payload = {
+        publishing_app: "whitehall"
+      }
+
+      publishing_api
+        .given("/test-item has been reserved in url-arbiter by the Publisher application")
+        .upon_receiving("a request to change publishing app")
+        .with(
+          method: :put,
+          path: "/paths#{base_path}",
+          body: payload,
+          headers: {
+            "Content-Type" => "application/json"
+          },
+
+        )
+        .will_respond_with(
+          status: 422,
+          body: {
+            "error" => {
+              "code" => 422,
+              "message" => Pact.term(generate: "Unprocessable", matcher:/\S+/),
+              "fields" => {
+                "base_path" => Pact.each_like("has been reserved", :min => 1),
+              },
+            },
+          },
+        )
+
+      error = assert_raises GdsApi::HTTPClientError do
+        @api_client.put_path(base_path, payload)
+      end
+      assert_equal "Unprocessable", error.error_details["error"]["message"]
+    end
+  end
 end

data/test/publishing_api_v2_test.rb

@@ -75,10 +75,10 @@ describe GdsApi::PublishingApiV2 do
             }
           )
           .will_respond_with(
-            status: 409,
+            status: 422,
             body: {
               "error" => {
-                "code" => 409,
+                "code" => 422,
                 "message" => Pact.term(generate: "Conflict", matcher:/\S+/),
                 "fields" => {
                   "base_path" => Pact.each_like("is already in use by the 'publisher' app", :min => 1),
@@ -91,8 +91,8 @@ describe GdsApi::PublishingApiV2 do
           )
       end
 
-      it "responds with 409 Conflict" do
-        error = assert_raises GdsApi::HTTPConflict do
+      it "responds with 422 Unprocessable Entity" do
+        error = assert_raises GdsApi::HTTPClientError do
           @api_client.put_content(@content_id, @content_item)
         end
         assert_equal "Conflict", error.error_details["error"]["message"]
@@ -178,6 +178,43 @@ describe GdsApi::PublishingApiV2 do
       end
     end
 
+    describe "when a content item exists in multiple locales" do
+      before do
+        @content_item = content_item_for_content_id(@content_id)
+
+        publishing_api
+          .given("a content item exists in multiple locales with content_id: #{@content_id}")
+          .upon_receiving("a request to return the content item")
+          .with(
+            method: :get,
+            path: "/v2/content/#{@content_id}",
+            query: "locale=fr",
+          )
+          .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" => "fr",
+              "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, locale: "fr")
+        assert_equal 200, response.code
+        assert_equal response["locale"], "fr"
+      end
+    end
+
     describe "a non-existent item" do
       before do
         publishing_api
@@ -237,7 +274,7 @@ describe GdsApi::PublishingApiV2 do
     describe "if the content item does not exist" do
       before do
         publishing_api
-          .given("both content stores and url-arbiter empty")
+          .given("both content stores and the url-arbiter are empty")
           .upon_receiving("a publish request")
           .with(
             method: :post,
@@ -374,6 +411,33 @@ describe GdsApi::PublishingApiV2 do
         assert_equal "Cannot publish an already published content item", error.error_details["error"]["message"]
       end
     end
+
+    describe "if the update information contains a locale" do
+      before do
+        publishing_api
+          .given("a draft content item exists with content_id: #{@content_id} and locale: fr")
+          .upon_receiving("a publish request")
+          .with(
+            method: :post,
+            path: "/v2/content/#{@content_id}/publish",
+            body: {
+              update_type: "major",
+              locale: "fr",
+            },
+            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", locale: "fr")
+        assert_equal 200, response.code
+      end
+    end
   end
 
   describe "#get_links" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 24.6.0
+  version: 24.7.0
 platform: ruby
 authors:
 - James Stewart
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-21 00:00:00.000000000 Z
+date: 2015-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plek
@@ -290,6 +290,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.19'
+- !ruby/object:Gem::Dependency
+  name: pact_broker-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 description: A set of adapters providing easy access to the GDS GOV.UK APIs
 email:
 - jystewart@gmail.com