gds-api-adapters 38.1.0 → 39.0.0

data/test/test_helper.rb

@@ -1,55 +0,0 @@
-# Ensure that in tests, we get a consistent domain back from Plek < 1.0.0
-# Without this, content API tests re chunking of requests with long URLs would
-# pass/fail in dev/CI.
-ENV['RACK_ENV'] = "test"
-
-require 'bundler'
-Bundler.setup :default, :development, :test
-
-require 'minitest/autorun'
-require 'rack/utils'
-require 'rack/test'
-require 'simplecov'
-require 'simplecov-rcov'
-require 'mocha/mini_test'
-require 'timecop'
-require 'gds-api-adapters'
-
-SimpleCov.start do
-  add_filter "/test/"
-  add_group "Test Helpers", "lib/gds_api/test_helpers"
-  formatter SimpleCov::Formatter::RcovFormatter
-end
-
-class Minitest::Test
-  def teardown
-    Timecop.return
-  end
-end
-
-require 'pact/consumer/minitest'
-module PactTest
-  include Pact::Consumer::Minitest
-
-  def before_suite
-    # Pact does its own stubbing of network connections, so we want to
-    # prevent WebMock interfering when pact is being used.
-    ::WebMock.allow_net_connect!
-    super
-  end
-
-  def after_suite
-    super
-    ::WebMock.disable_net_connect!
-  end
-end
-
-def load_fixture_file(filename)
-  File.open(File.join(File.dirname(__FILE__), "fixtures", filename), encoding: 'utf-8')
-end
-
-require 'webmock/minitest'
-WebMock.disable_net_connect!
-
-require 'gds_api/test_helpers/json_client_helper'
-require 'test_helpers/pact_helper'

data/test/test_helpers/email_alert_api_test.rb

@@ -1,24 +0,0 @@
-require 'test_helper'
-require 'gds_api/email_alert_api'
-require 'gds_api/test_helpers/email_alert_api'
-
-describe GdsApi::TestHelpers::EmailAlertApi do
-  include GdsApi::TestHelpers::EmailAlertApi
-
-  let(:base_api_url) { Plek.current.find("email-alert-api") }
-  let(:email_alert_api) { GdsApi::EmailAlertApi.new(base_api_url) }
-
-  describe "#assert_email_alert_sent" do
-    before { stub_any_email_alert_api_call }
-
-    it "matches a post request with any empty attributes by default" do
-      email_alert_api.send_alert("foo" => "bar")
-      assert_email_alert_sent
-    end
-
-    it "matches a post request subset of attributes" do
-      email_alert_api.send_alert("foo" => "bar", "baz" => "qux")
-      assert_email_alert_sent("foo" => "bar")
-    end
-  end
-end

data/test/test_helpers/pact_helper.rb

@@ -1,13 +0,0 @@
-PUBLISHING_API_PORT = 3001
-
-def publishing_api_host
-  "http://localhost:#{PUBLISHING_API_PORT}"
-end
-
-Pact.service_consumer "GDS API Adapters" do
-  has_pact_with "Publishing API" do
-    mock_service :publishing_api do
-      port PUBLISHING_API_PORT
-    end
-  end
-end

data/test/test_helpers/panopticon_test.rb

@@ -1,44 +0,0 @@
-require 'test_helper'
-require 'gds_api/panopticon'
-require 'gds_api/test_helpers/panopticon'
-
-describe GdsApi::TestHelpers::Panopticon do
-  include GdsApi::TestHelpers::Panopticon
-
-  def assert_stub_exists(*args)
-    expected_signature = WebMock::RequestSignature.new(*args)
-
-    assert(
-      WebMock::StubRegistry.instance.registered_request?(expected_signature),
-      "Stub is not registered:\n\t#{expected_signature}"
-    )
-  end
-
-  let(:base_api_endpoint) { GdsApi::TestHelpers::Panopticon::PANOPTICON_ENDPOINT }
-
-  it 'stubs the tag creation request' do
-    atts = { tag_id: 'foo' }
-    stub_panopticon_tag_creation(atts)
-
-    assert_stub_exists(:post, "#{base_api_endpoint}/tags.json", body: atts.to_json)
-  end
-
-  it 'stubs the tag update request' do
-    atts = { title: 'Foo' }
-    stub_panopticon_tag_update('section', 'foo/bar', atts)
-
-    assert_stub_exists(:put,
-      "#{base_api_endpoint}/tags/section/foo/bar.json",
-      body: atts.to_json
-    )
-  end
-
-  it 'stubs the tag publish request' do
-    stub_panopticon_tag_publish('section', 'foo/bar')
-
-    assert_stub_exists(:post,
-      "#{base_api_endpoint}/tags/section/foo/bar/publish.json",
-      body: {}.to_json
-    )
-  end
-end

data/test/test_helpers/publishing_api_test.rb

@@ -1,129 +0,0 @@
-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 '#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

data/test/test_helpers/publishing_api_v2_test.rb

@@ -1,170 +0,0 @@
-require 'test_helper'
-require 'gds_api/publishing_api_v2'
-require 'gds_api/test_helpers/publishing_api_v2'
-
-describe GdsApi::TestHelpers::PublishingApiV2 do
-  include GdsApi::TestHelpers::PublishingApiV2
-  let(:publishing_api) { GdsApi::PublishingApiV2.new(Plek.current.find("publishing-api")) }
-
-  describe '#publishing_api_has_linked_items' do
-    it "stubs the get linked items api call" do
-      links = [
-        { 'content_id' => 'id-1', 'title' => 'title 1', 'link_type' => 'taxons' },
-        { 'content_id' => 'id-2', 'title' => 'title 2', 'link_type' => 'taxons' },
-      ]
-      publishing_api_has_linked_items(
-        links,
-        content_id: 'content-id',
-        link_type: 'taxons',
-        fields: [:title]
-      )
-
-      api_response = publishing_api.get_linked_items(
-        'content-id',
-        link_type: 'taxons',
-        fields: [:title]
-      )
-
-      assert_equal(
-        api_response.to_hash,
-        links
-      )
-    end
-  end
-
-  describe "#publishing_api_has_lookups" do
-    it "stubs the lookup for content items" do
-      lookup_hash = { "/foo" => "2878337b-bed9-4e7f-85b6-10ed2cbcd504" }
-
-      publishing_api_has_lookups(lookup_hash)
-
-      assert_equal publishing_api.lookup_content_ids(base_paths: ["/foo"]), lookup_hash
-      assert_equal publishing_api.lookup_content_id(base_path: "/foo"), "2878337b-bed9-4e7f-85b6-10ed2cbcd504"
-    end
-  end
-
-  describe "#publishing_api_has_content" do
-    it "stubs the call to get content items" do
-      publishing_api_has_content([{ "content_id" => "2878337b-bed9-4e7f-85b6-10ed2cbcd504" }])
-
-      response = publishing_api.get_content_items({})['results']
-
-      assert_equal([{ "content_id" => "2878337b-bed9-4e7f-85b6-10ed2cbcd504" }], response)
-    end
-
-    it 'allows params' do
-      publishing_api_has_content(
-        [{
-          "content_id" => "2878337b-bed9-4e7f-85b6-10ed2cbcd504"
-        }],
-        document_type: 'document_collection',
-        query: 'query',
-      )
-
-      response = publishing_api.get_content_items(
-        document_type: 'document_collection',
-        query: 'query'
-      )['results']
-
-      assert_equal(
-        [{ "content_id" => "2878337b-bed9-4e7f-85b6-10ed2cbcd504" }],
-        response
-      )
-    end
-
-    it 'returns paginated results' do
-      content_id_1 = "2878337b-bed9-4e7f-85b6-10ed2cbcd504"
-      content_id_2 = "2878337b-bed9-4e7f-85b6-10ed2cbcd505"
-      content_id_3 = "2878337b-bed9-4e7f-85b6-10ed2cbcd506"
-
-      publishing_api_has_content(
-        [
-          { "content_id" => content_id_1 },
-          { "content_id" => content_id_2 },
-          { "content_id" => content_id_3 },
-        ],
-                  page: 1,
-          per_page: 2
-      )
-
-      response = publishing_api.get_content_items(page: 1, per_page: 2)
-      records = response['results']
-
-      assert_equal(response['total'], 3)
-      assert_equal(response['pages'], 2)
-      assert_equal(response['current_page'], 1)
-
-      assert_equal(records.length, 2)
-      assert_equal(records.first['content_id'], content_id_1)
-      assert_equal(records.last['content_id'], content_id_2)
-    end
-
-    it 'returns an empty list of results for out-of-bound queries' do
-      content_id_1 = "2878337b-bed9-4e7f-85b6-10ed2cbcd504"
-      content_id_2 = "2878337b-bed9-4e7f-85b6-10ed2cbcd505"
-
-      publishing_api_has_content(
-        [
-          { "content_id" => content_id_1 },
-          { "content_id" => content_id_2 },
-        ],
-                  page: 10,
-          per_page: 2
-      )
-
-      response = publishing_api.get_content_items(page: 10, per_page: 2)
-      records = response['results']
-
-      assert_equal(records, [])
-    end
-  end
-
-  describe "#publishing_api_has_expanded_links" do
-    it "stubs the call to get expanded links" do
-      payload = {
-        content_id: "2e20294a-d694-4083-985e-d8bedefc2354",
-        organisations: [
-          {
-            content_id: ["a8a09822-1729-48a7-8a68-d08300de9d1e"]
-          }
-        ]
-      }
-
-      publishing_api_has_expanded_links(payload)
-      response = publishing_api.get_expanded_links("2e20294a-d694-4083-985e-d8bedefc2354")
-
-      assert_equal({
-        "content_id" => "2e20294a-d694-4083-985e-d8bedefc2354",
-        "organisations" => [
-          {
-            "content_id" => ["a8a09822-1729-48a7-8a68-d08300de9d1e"]
-          }
-        ]
-      }, response.to_h)
-    end
-  end
-
-  describe "stub_any_publishing_api_publish" do
-    it "stubs any publish request to the publishing api" do
-      stub_any_publishing_api_publish
-      publishing_api.publish("some-content-id", "major")
-      assert_publishing_api_publish("some-content-id")
-    end
-  end
-
-  describe "stub_any_publishing_api_unpublish" do
-    it "stubs any unpublish request to the publishing api" do
-      stub_any_publishing_api_unpublish
-      publishing_api.unpublish("some-content-id", type: :gone)
-      assert_publishing_api_unpublish("some-content-id")
-    end
-  end
-
-  describe "stub_any_publishing_api_discard_draft" do
-    it "stubs any discard draft request to the publishing api" do
-      stub_any_publishing_api_discard_draft
-      publishing_api.discard_draft("some-content-id")
-      assert_publishing_api_discard_draft("some-content-id")
-    end
-  end
-end

data/test/worldwide_api_test.rb

@@ -1,82 +0,0 @@
-require_relative 'test_helper'
-require 'gds_api/worldwide'
-require 'gds_api/test_helpers/worldwide'
-
-describe GdsApi::Worldwide do
-  include GdsApi::TestHelpers::Worldwide
-
-  before do
-    @base_api_url = GdsApi::TestHelpers::Worldwide::WORLDWIDE_API_ENDPOINT
-    @api = GdsApi::Worldwide.new(@base_api_url)
-  end
-
-  describe "fetching list of world locations" do
-    it "should get the world locations" do
-      country_slugs = %w(the-shire rivendel rohan lorien gondor arnor mordor)
-      worldwide_api_has_locations(country_slugs)
-
-      response = @api.world_locations
-      assert_equal country_slugs, response.map { |r| r['details']['slug'] }
-      assert_equal "Rohan", response['results'][2]['title']
-    end
-
-    it "should handle the pagination" do
-      country_slugs = (1..50).map { |n| "country-#{n}" }
-      worldwide_api_has_locations(country_slugs)
-
-      response = @api.world_locations
-      assert_equal(
-        country_slugs,
-        response.with_subsequent_pages.map { |r| r['details']['slug'] }
-      )
-    end
-
-    it "should raise error if endpoint 404s" do
-      stub_request(:get, "#{@base_api_url}/api/world-locations").to_return(status: 404)
-      assert_raises GdsApi::HTTPNotFound do
-        @api.world_locations
-      end
-    end
-  end
-
-  describe "fetching a world location" do
-    it "should return the details" do
-      worldwide_api_has_location('rohan')
-
-      response = @api.world_location('rohan')
-      assert_equal 'Rohan', response['title']
-    end
-
-    it "raises for a non-existent location" do
-      worldwide_api_does_not_have_location('non-existent')
-
-      assert_raises(GdsApi::HTTPNotFound) do
-        @api.world_location('non-existent')
-      end
-    end
-  end
-
-  describe "fetching organisations for a location" do
-    it "should return the organisation details" do
-      details = JSON.parse(load_fixture_file("world_organisations_australia.json").read)
-      worldwide_api_has_organisations_for_location('australia', details)
-
-      response = @api.organisations_for_world_location('australia')
-      assert response.is_a?(GdsApi::ListResponse)
-      assert_equal(
-        [
-          "UK Trade & Investment Australia",
-          "British High Commission Canberra"
-        ],
-        response.map { |item| item['title'] }
-      )
-    end
-
-    it "should raise error on 404" do
-      stub_request(:get, "#{@base_api_url}/api/world-locations/non-existent/organisations").to_return(status: 404)
-      assert_raises GdsApi::HTTPNotFound do
-        @api.organisations_for_world_location('non-existent')
-      end
-    end
-  end
-end