gds-api-adapters 23.0.0 → 23.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ea6ab5e0f8cd1e6568d3588d21b9918c7818a65
-  data.tar.gz: 57953905ccbcd5453f4acc5548248a02b57e1fa2
+  metadata.gz: bd7b1a091da260080fb3bed10086d31c84e1708d
+  data.tar.gz: 1d82d8b9d6d16adae35fe3aa6dd602330a237f5c
 SHA512:
-  metadata.gz: fed21cbb734110e486fe6e390a4e8960b4f018d886643a76cd1d75c91ca076a87fd052103c5c982afc287b869c83336d60da7e6a60bcd66ca7f43f3ba6c6db32
-  data.tar.gz: e2f4fdf14f51fe5ece8d45ffd822b4c4f1fcbc393a3d601bf224a89a6c94bacea7ccf941f20b0e9b0ed8db0ddc045e255da3a0930e3740233c0f3e4947fca885
+  metadata.gz: 72c4bab7cb84d20997f1c1739c55939f113590a7d357721127d68df77fcc99568a37068edbebf4c56f381fd2e2018d4e2d1276b5a530fb30713ca923e27184af
+  data.tar.gz: 05b9bc994f6f69880135f722e67930673a2ad47735cff4d4aa1d1409f0732d94bc84acb089ced7049eadb78bd130dcb500dfd3d13126e5bf0e0f73a0caceb18c

data/lib/gds_api/test_helpers/publishing_api.rb

@@ -43,37 +43,72 @@ module GdsApi
         stub_request(:put, %r{\A#{PUBLISHING_API_ENDPOINT}/publish-intent})
       end
 
-      def assert_publishing_api_put_item(base_path, attributes = {}, times = 1)
+      def assert_publishing_api_put_item(base_path, attributes_or_matcher = {}, times = 1)
         url = PUBLISHING_API_ENDPOINT + "/content" + base_path
-        assert_publishing_api_put(url, attributes, times)
+        assert_publishing_api_put(url, attributes_or_matcher, times)
       end
 
-      def assert_publishing_api_put_draft_item(base_path, attributes = {}, times = 1)
+      def assert_publishing_api_put_draft_item(base_path, attributes_or_matcher = {}, times = 1)
         url = PUBLISHING_API_ENDPOINT + "/draft-content" + base_path
-        assert_publishing_api_put(url, attributes, times)
+        assert_publishing_api_put(url, attributes_or_matcher, times)
       end
 
-      def assert_publishing_api_put_intent(base_path, attributes = {}, times = 1)
+      def assert_publishing_api_put_intent(base_path, attributes_or_matcher = {}, times = 1)
         url = PUBLISHING_API_ENDPOINT + "/publish-intent" + base_path
-        assert_publishing_api_put(url, attributes, times)
+        assert_publishing_api_put(url, attributes_or_matcher, times)
       end
 
-      def assert_publishing_api_put(url, attributes = {}, times = 1)
-        if attributes.empty?
-          assert_requested(:put, url, times: times)
+      def assert_publishing_api_put(url, attributes_or_matcher = {}, times = 1)
+        if attributes_or_matcher.is_a?(Hash)
+          matcher = attributes_or_matcher.empty? ? nil : request_json_matching(attributes_or_matcher)
         else
-          assert_requested(:put, url, times: times) do |req|
-            data = JSON.parse(req.body)
-            attributes.to_a.all? do |key, value|
-              data[key.to_s] == value
-            end
-          end
+          matcher = attributes_or_matcher
+        end
+
+        if matcher
+          assert_requested(:put, url, times: times, &matcher)
+        else
+          assert_requested(:put, url, times: times)
+        end
+      end
+
+      def request_json_matching(required_attributes)
+        ->(request) do
+          data = JSON.parse(request.body)
+          required_attributes.to_a.all? { |key, value| data[key.to_s] == value }
+        end
+      end
+
+      def request_json_including(required_attributes)
+        ->(request) do
+          data = JSON.parse(request.body)
+          values_match_recursively(required_attributes, data)
         end
       end
 
       def publishing_api_isnt_available
         stub_request(:any, /#{PUBLISHING_API_ENDPOINT}\/.*/).to_return(:status => 503)
       end
+
+    private
+      def values_match_recursively(expected_value, actual_value)
+        case expected_value
+        when Hash
+          return false unless actual_value.is_a?(Hash)
+          expected_value.all? do |expected_sub_key, expected_sub_value|
+            actual_value.has_key?(expected_sub_key.to_s) &&
+              values_match_recursively(expected_sub_value, actual_value[expected_sub_key.to_s])
+          end
+        when Array
+          return false unless actual_value.is_a?(Array)
+          return false unless actual_value.size == expected_value.size
+          expected_value.each.with_index.all? do |expected_sub_value, i|
+            values_match_recursively(expected_sub_value, actual_value[i])
+          end
+        else
+          expected_value == actual_value
+        end
+      end
     end
   end
 end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '23.0.0'
+  VERSION = '23.1.0'
 end

data/test/test_helpers/publishing_api_test.rb

@@ -0,0 +1,158 @@
+require 'test_helper'
+require 'gds_api/publishing_api'
+require 'gds_api/test_helpers/publishing_api'
+
+describe GdsApi::TestHelpers::PublishingApi do
+  include GdsApi::TestHelpers::PublishingApi
+  let(:base_api_url) { Plek.current.find("publishing-api") }
+  let(:publishing_api) { GdsApi::PublishingApi.new(base_api_url) }
+
+  describe "#assert_publishing_api_put_item" do
+    before { stub_default_publishing_api_put }
+    let(:base_path) { "/example" }
+
+    it "matches a put request with any empty attributes by default" do
+      publishing_api.put_content_item(base_path, {})
+      assert_publishing_api_put_item(base_path)
+    end
+
+    it "matches a put request with any arbitrary attributes by default" do
+      random_attributes = Hash[10.times.map {|n| [Random.rand * 1_000_000_000_000, Random.rand * 1_000_000_000_000]}]
+      publishing_api.put_content_item(base_path, random_attributes)
+      assert_publishing_api_put_item(base_path)
+    end
+
+    it "if attributes are specified, matches a request with at least those attributes" do
+      publishing_api.put_content_item(base_path, {"required_attribute" => 1, "extra_attrbibute" => 1})
+      assert_publishing_api_put_item(base_path, {"required_attribute" => 1})
+    end
+
+    it "matches using a custom request matcher" do
+      publishing_api.put_content_item(base_path, {})
+      matcher_was_called = false
+      matcher = ->(request) { matcher_was_called = true; true }
+      assert_publishing_api_put_item(base_path, matcher)
+      assert matcher_was_called, "matcher should have been called"
+    end
+  end
+
+  describe '#request_json_matching predicate' do
+    describe "nested required attribute" do
+      let(:matcher) { request_json_matching({"a" => {"b" => 1}}) }
+
+      it "matches a body with exact same nested hash strucure" do
+        assert matcher.call(stub("request", body: '{"a": {"b": 1}}'))
+      end
+
+      it "matches a body with exact same nested hash strucure and an extra attribute at the top level" do
+        assert matcher.call(stub("request", body: '{"a": {"b": 1}, "c": 3}'))
+      end
+
+      it "does not match a body where the inner hash has the required attribute and an extra one" do
+        refute matcher.call(stub("request", body: '{"a": {"b": 1, "c": 2}}'))
+      end
+
+      it "does not match a body where the inner hash has the required attribute with the wrong value" do
+        refute matcher.call(stub("request", body: '{"a": {"b": 0}}'))
+      end
+
+      it "does not match a body where the inner hash lacks the required attribute" do
+        refute matcher.call(stub("request", body: '{"a": {"c": 1}}'))
+      end
+    end
+
+    describe "hash to match uses symbol keys" do
+      let(:matcher) { request_json_matching({a: 1}) }
+
+      it "matches a json body" do
+        assert matcher.call(stub("request", body: '{"a": 1}'))
+      end
+    end
+  end
+
+  describe '#request_json_including predicate' do
+    describe "no required attributes" do
+      let(:matcher) { request_json_including({}) }
+
+      it "matches an empty body" do
+        assert matcher.call(stub("request", body: "{}"))
+      end
+
+      it "matches a body with some attributes" do
+        assert matcher.call(stub("request", body: '{"a": 1}'))
+      end
+    end
+
+    describe "one required attribute" do
+      let(:matcher) { request_json_including({"a" => 1}) }
+
+      it "does not match an empty body" do
+        refute matcher.call(stub("request", body: "{}"))
+      end
+
+      it "does not match a body with the required attribute if the value is different" do
+        refute matcher.call(stub("request", body: '{"a": 2}'))
+      end
+
+      it "matches a body with the required attribute and value" do
+        assert matcher.call(stub("request", body: '{"a": 1}'))
+      end
+
+      it "matches a body with the required attribute and value and extra attributes" do
+        assert matcher.call(stub("request", body: '{"a": 1, "b": 2}'))
+      end
+    end
+
+    describe "nested required attribute" do
+      let(:matcher) { request_json_including({"a" => {"b" => 1}}) }
+
+      it "matches a body with exact same nested hash strucure" do
+        assert matcher.call(stub("request", body: '{"a": {"b": 1}}'))
+      end
+
+      it "matches a body where the inner hash has the required attribute and an extra one" do
+        assert matcher.call(stub("request", body: '{"a": {"b": 1, "c": 2}}'))
+      end
+
+      it "does not match a body where the inner hash has the required attribute with the wrong value" do
+        refute matcher.call(stub("request", body: '{"a": {"b": 0}}'))
+      end
+
+      it "does not match a body where the inner hash lacks the required attribute" do
+        refute matcher.call(stub("request", body: '{"a": {"c": 1}}'))
+      end
+    end
+
+    describe "hash to match uses symbol keys" do
+      let(:matcher) { request_json_including({a: {b: 1}}) }
+
+      it "matches a json body" do
+        assert matcher.call(stub("request", body: '{"a": {"b": 1}}'))
+      end
+    end
+
+    describe "nested arrays" do
+      let(:matcher) { request_json_including({"a" => [1]}) }
+
+      it "matches a body with exact same inner array" do
+        assert matcher.call(stub("request", body: '{"a": [1]}'))
+      end
+
+      it "does not match a body with an array with extra elements" do
+        refute matcher.call(stub("request", body: '{"a": [1, 2]}'))
+      end
+    end
+
+    describe "hashes in nested arrays" do
+      let(:matcher) { request_json_including({"a" => [{"b" => 1}, 2]}) }
+
+      it "matches a body with exact same inner array" do
+        assert matcher.call(stub("request", body: '{"a": [{"b": 1}, 2]}'))
+      end
+
+      it "matches a body with an inner hash with extra elements" do
+        assert matcher.call(stub("request", body: '{"a": [{"b": 1, "c": 3}, 2]}'))
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 23.0.0
+  version: 23.1.0
 platform: ruby
 authors:
 - James Stewart
@@ -381,6 +381,7 @@ files:
 - test/support_test.rb
 - test/test_helper.rb
 - test/test_helpers/panopticon_test.rb
+- test/test_helpers/publishing_api_test.rb
 - test/whitehall_admin_api_test.rb
 - test/worldwide_api_test.rb
 homepage: http://github.com/alphagov/gds-api-adapters
@@ -418,6 +419,7 @@ test_files:
 - test/support_test.rb
 - test/content_register_test.rb
 - test/fact_cave_test.rb
+- test/test_helpers/publishing_api_test.rb
 - test/test_helpers/panopticon_test.rb
 - test/licence_application_api_test.rb
 - test/gov_uk_delivery_test.rb