gds-api-adapters 26.4.0 → 26.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0855c236df08760a5bb3c690fe3edea108d3448
-  data.tar.gz: c5c1ef0acb097c7a29899a8051ba2f7c5f3fab30
+  metadata.gz: 6e6086fcd077f82492196d0fba5f3c57ec3c739a
+  data.tar.gz: 9f4140565169ee3dbf5ff33a638bbb483c1124d3
 SHA512:
-  metadata.gz: da29b92b57fb706bfc91914383e6720d6d72002a7eea5bb1b10bbbbfe845a26e91cef7a03aabce3b26b6912e5f816cb98c6435297d24575de3d734b3d47370e8
-  data.tar.gz: 6aa6907363f65a729e003747033ced7faf5a8c294b1abd9832b273d8f44b8c9852aed0d19d3366bd0fd61da17aab4faeaf4b0e048d8f391e83f53a16f84e6e70
+  metadata.gz: f4ae8d18936478c15316167e6c815eb34ed715b7e99d9a19aea47779ab6b1e23f872e92a8ff2de15171399901f3c9854c156e339ad3bf212b7491af13ae2494f
+  data.tar.gz: 32850c738b23681f5b2610351ea018a48f1aa41a4ad59462a25f788afdec48e2c360e7aa9e0f6cce7066d5af1b024cd6880354928a044cdf04e1b02244797c80

data/lib/gds_api/publishing_api/special_route_publisher.rb

@@ -1,4 +1,4 @@
-require "gds_api/publishing_api"
+require "gds_api/publishing_api_v2"
 require "time"
 
 module GdsApi
@@ -6,14 +6,14 @@ module GdsApi
     class SpecialRoutePublisher
       def initialize(options = {})
         @logger = options[:logger] || GdsApi::Base.logger
-        @publishing_api = options[:publishing_api] || GdsApi::PublishingApi.new(Plek.find("publishing-api"))
+        @publishing_api = options[:publishing_api] || GdsApi::PublishingApiV2.new(Plek.find("publishing-api"))
       end
 
       def publish(options)
         logger.info("Publishing #{options.fetch(:type)} route #{options.fetch(:base_path)}, routing to #{options.fetch(:rendering_app)}")
 
-        publishing_api.put_content_item(options.fetch(:base_path), {
-          content_id: options.fetch(:content_id),
+        put_content_response = publishing_api.put_content(options.fetch(:content_id), {
+          base_path: options.fetch(:base_path),
           format: "special_route",
           title: options.fetch(:title),
           description: options[:description] || "",
@@ -25,9 +25,10 @@ module GdsApi
           ],
           publishing_app: options.fetch(:publishing_app),
           rendering_app: options.fetch(:rendering_app),
-          update_type: "major",
           public_updated_at: time.now.iso8601,
         })
+        publishing_api.publish(options.fetch(:content_id), 'major')
+        put_content_response
       end
 
     private

data/lib/gds_api/test_helpers/publishing_api_v2.rb

@@ -10,8 +10,20 @@ module GdsApi
 
       PUBLISHING_API_V2_ENDPOINT = Plek.current.find('publishing-api') + '/v2'
 
-      def stub_publishing_api_put_content(content_id, body)
-        stub_publishing_api_put(content_id, body, '/content')
+      # stubs a PUT /v2/content/:content_id request with the given content id and request body.
+      # if no response_hash is given, a default response as follows is created:
+      # {status: 200, body: '{}', headers: {"Content-Type" => "application/json; charset=utf-8"}}
+      #
+      # if a response is given, then it will be merged with the default response.
+      # if the given parameter for the response body is a Hash, it will be converted to JSON.
+      #
+      # e.g. The following two examples are equivalent: 
+      #
+      # * stub_publishing_api_put_content(my_content_id, my_request_body, { status: 201, body: {version: 33}.to_json })
+      # * stub_publishing_api_put_content(my_content_id, my_request_body, { status: 201, body: {version: 33} })
+      #
+      def stub_publishing_api_put_content(content_id, body, response_hash = {})
+        stub_publishing_api_put(content_id, body, '/content', response_hash)
       end
 
       def stub_publishing_api_put_links(content_id, body)
@@ -58,6 +70,10 @@ module GdsApi
           .to_return(status: 404, headers: {"Content-Type" => "application/json; charset=utf-8"})
       end
 
+      def publishing_api_isnt_available
+        stub_request(:any, /#{PUBLISHING_API_V2_ENDPOINT}\/.*/).to_return(status: 503)
+      end
+
       def assert_publishing_api_put_content(content_id, attributes_or_matcher = {}, times = 1)
         url = PUBLISHING_API_V2_ENDPOINT + "/content/" + content_id
         assert_publishing_api(:put, url, attributes_or_matcher, times)
@@ -68,6 +84,11 @@ module GdsApi
         assert_publishing_api(:post, url, attributes_or_matcher, times)
       end
 
+      def assert_publishing_api_put_links(content_id, attributes_or_matcher = {}, times = 1)
+        url = PUBLISHING_API_V2_ENDPOINT + "/links/" + content_id
+        assert_publishing_api(:put, url, attributes_or_matcher, times)
+      end
+
       def assert_publishing_api_discard_draft(content_id, attributes_or_matcher = {}, times = 1)
         url = PUBLISHING_API_V2_ENDPOINT + "/content/#{content_id}/discard-draft"
         assert_publishing_api(:post, url, attributes_or_matcher, times)
@@ -122,9 +143,12 @@ module GdsApi
       end
 
     private
-      def stub_publishing_api_put(content_id, body, resource_path)
+      def stub_publishing_api_put(content_id, body, resource_path, override_response_hash = {})
+        response_hash = {status: 200, body: '{}', headers: {"Content-Type" => "application/json; charset=utf-8"}}
+        response_hash.merge!(override_response_hash)
+        response_hash[:body] = response_hash[:body].to_json if response_hash[:body].is_a?(Hash)
         url = PUBLISHING_API_V2_ENDPOINT + resource_path + "/" + content_id
-        stub_request(:put, url).with(body: body).to_return(status: 200, body: '{}', headers: {"Content-Type" => "application/json; charset=utf-8"})
+        stub_request(:put, url).with(body: body).to_return(response_hash)
       end
     end
   end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '26.4.0'
+  VERSION = '26.5.0'
 end

data/test/publishing_api/special_route_publisher_test.rb

@@ -1,18 +1,14 @@
 require 'test_helper'
 require "gds_api/publishing_api/special_route_publisher"
+require File.dirname(__FILE__) + '/../../lib/gds_api/test_helpers/publishing_api_v2'
 
 describe GdsApi::PublishingApi::SpecialRoutePublisher do
-  let(:publishing_api) {
-    stub(:publishing_api, put_content_item: nil)
-  }
-
-  let(:publisher) {
-    GdsApi::PublishingApi::SpecialRoutePublisher.new(publishing_api: publishing_api)
-  }
+  include ::GdsApi::TestHelpers::PublishingApiV2
 
+  let(:content_id) { 'a-content-id-of-sorts' }  
   let(:special_route) {
     {
-      content_id: "a-content-id-of-sorts",
+      content_id: content_id,
       title: "A title",
       description: "A description",
       base_path: "/favicon.ico",
@@ -24,55 +20,71 @@ describe GdsApi::PublishingApi::SpecialRoutePublisher do
 
   describe ".publish" do
     it "publishes the special routes" do
+      
       Timecop.freeze(Time.now) do
-        publishing_api.expects(:put_content_item).with(
-          special_route[:base_path],
-          {
-            content_id: special_route[:content_id],
-            format: "special_route",
-            title: special_route[:title],
-            description: special_route[:description],
-            routes: [
-              {
-                path: special_route[:base_path],
-                type: special_route[:type],
-              }
-            ],
-            publishing_app: special_route[:publishing_app],
-            rendering_app: special_route[:rendering_app],
-            update_type: "major",
-            public_updated_at: Time.now.iso8601,
-          }
-        )
+        publisher = GdsApi::PublishingApi::SpecialRoutePublisher.new
+        endpoint = Plek.current.find('publishing-api')
+        payload = {
+          base_path: special_route[:base_path],
+          format: "special_route",
+          title: special_route[:title],
+          description: special_route[:description],
+          routes: [
+            {
+              path: special_route[:base_path],
+              type: special_route[:type],
+            }
+          ],
+          publishing_app: special_route[:publishing_app],
+          rendering_app: special_route[:rendering_app],
+          public_updated_at: Time.now.iso8601,
+        }
 
+        stub_any_publishing_api_call
+        
         publisher.publish(special_route)
+
+        base_path = "#{endpoint}/v2/content/#{content_id}"
+        assert_requested(:put, base_path, body: payload)
+        assert_requested(:post, "#{base_path}/publish", body: { update_type: 'major' })
+
       end
     end
 
-    it "is robust to Time.zone returning nil" do
-      Timecop.freeze(Time.now) do
-        Time.stubs(:zone).returns(nil)
+    describe 'Timezone handling' do
+      let(:publishing_api) {
+        stub(:publishing_api, put_content_item: nil)
+      }
+      let(:publisher) {
+        GdsApi::PublishingApi::SpecialRoutePublisher.new(publishing_api: publishing_api)
+      }
 
-        publishing_api.expects(:put_content_item).with(
-          anything,
-          has_entries(public_updated_at: Time.now.iso8601)
-        )
+      it "is robust to Time.zone returning nil" do
+        Timecop.freeze(Time.now) do
+          Time.stubs(:zone).returns(nil)
+          publishing_api.expects(:put_content).with(
+            anything,
+            has_entries(public_updated_at: Time.now.iso8601)
+          )
+          publishing_api.expects(:publish)
 
-        publisher.publish(special_route)
+          publisher.publish(special_route)
+        end
       end
-    end
 
-    it "uses Time.zone if available" do
-      Timecop.freeze(Time.now) do
-        time_in_zone = stub("Time in zone", now: Time.parse("2010-01-01 10:10:10 +04:00"))
-        Time.stubs(:zone).returns(time_in_zone)
+      it "uses Time.zone if available" do
+        Timecop.freeze(Time.now) do
+          time_in_zone = stub("Time in zone", now: Time.parse("2010-01-01 10:10:10 +04:00"))
+          Time.stubs(:zone).returns(time_in_zone)
 
-        publishing_api.expects(:put_content_item).with(
-          anything,
-          has_entries(public_updated_at: time_in_zone.now.iso8601)
-        )
+          publishing_api.expects(:put_content).with(
+            anything,
+            has_entries(public_updated_at: time_in_zone.now.iso8601)
+          )
+          publishing_api.expects(:publish)
 
-        publisher.publish(special_route)
+          publisher.publish(special_route)
+        end
       end
     end
   end

metadata

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