gds-api-adapters 38.1.0 → 39.0.0

data/test/rummager_helpers_test.rb

@@ -1,20 +0,0 @@
-require 'test_helper'
-require 'gds_api/rummager'
-require 'gds_api/test_helpers/rummager'
-
-class RummagerHelpersTest < Minitest::Test
-  include GdsApi::TestHelpers::Rummager
-
-  def test_services_and_info_data_returns_an_adequate_response_object
-    response = rummager_has_services_and_info_data_for_organisation
-
-    assert_instance_of GdsApi::Response, response
-  end
-
-  def test_no_services_and_info_data_found_for_organisation
-    response = rummager_has_no_services_and_info_data_for_organisation
-
-    assert_instance_of GdsApi::Response, response
-    assert_equal 0, response['facets']['specialist_sectors']['total_options']
-  end
-end

data/test/rummager_test.rb

@@ -1,150 +0,0 @@
-require "test_helper"
-require "gds_api/rummager"
-
-describe GdsApi::Rummager do
-  before(:each) do
-    stub_request(:get, /example.com\/advanced_search/).to_return(body: "[]")
-    stub_request(:get, /example.com\/search/).to_return(body: "[]")
-  end
-
-  # tests for #advanced_search
-
-  it "#advanced_search should raise an exception if the service at the search URI returns a 500" do
-    stub_request(:get, /example.com\/advanced_search/).to_return(status: [500, "Internal Server Error"])
-    assert_raises(GdsApi::HTTPServerError) do
-      GdsApi::Rummager.new("http://example.com").advanced_search(keywords: "query")
-    end
-  end
-
-  it "#advanced_search should raise an exception if the service at the search URI returns a 404" do
-    stub_request(:get, /example.com\/advanced_search/).to_return(status: [404, "Not Found"])
-    assert_raises(GdsApi::HTTPNotFound) do
-      GdsApi::Rummager.new("http://example.com").advanced_search(keywords: "query")
-    end
-  end
-
-  it "#advanced_search should raise an exception if the service at the search URI times out" do
-    stub_request(:get, /example.com\/advanced_search/).to_timeout
-    assert_raises(GdsApi::TimedOutException) do
-      GdsApi::Rummager.new("http://example.com").advanced_search(keywords: "query")
-    end
-  end
-
-  it "#advanced_search should return the search deserialized from json" do
-    search_results = [{ "title" => "document-title" }]
-    stub_request(:get, /example.com\/advanced_search/).to_return(body: search_results.to_json)
-    results = GdsApi::Rummager.new("http://example.com").advanced_search(keywords: "query")
-
-    assert_equal search_results, results.to_hash
-  end
-
-  it "#advanced_search should return an empty set of results without making request if arguments are empty" do
-    assert_raises(ArgumentError) do
-      GdsApi::Rummager.new("http://example.com").advanced_search({})
-    end
-  end
-
-  it "#advanced_search should return an empty set of results without making request if arguments is nil" do
-    assert_raises(ArgumentError) do
-      GdsApi::Rummager.new("http://example.com").advanced_search(nil)
-    end
-  end
-
-  it "#advanced_search should request the search results in JSON format" do
-    GdsApi::Rummager.new("http://example.com").advanced_search(keywords: "query")
-
-    assert_requested :get, /.*/, headers: { "Accept" => "application/json" }
-  end
-
-  it "#advanced_search should issue a request for all the params supplied" do
-    GdsApi::Rummager.new("http://example.com").advanced_search(keywords: "query & stuff", topics: %w(1 2), order: { public_timestamp: "desc" })
-
-    assert_requested :get, /keywords=query%20%26%20stuff/
-    assert_requested :get, /topics\[\]=1&topics\[\]=2/
-    assert_requested :get, /order\[public_timestamp\]=desc/
-  end
-
-  # tests for search
-
-  it "#search should raise an exception if the service at the search URI returns a 500" do
-    stub_request(:get, /example.com\/search.json/).to_return(status: [500, "Internal Server Error"])
-    assert_raises(GdsApi::HTTPServerError) do
-      GdsApi::Rummager.new("http://example.com").search(q: "query")
-    end
-  end
-
-  it "#search should raise an exception if the service at the search URI returns a 404" do
-    stub_request(:get, /example.com\/search/).to_return(status: [404, "Not Found"])
-    assert_raises(GdsApi::HTTPNotFound) do
-      GdsApi::Rummager.new("http://example.com").search(q: "query")
-    end
-  end
-
-  it "#search should raise an exception if the service at the search URI returns a 400" do
-    stub_request(:get, /example.com\/search/).to_return(
-      status: [400, "Bad Request"],
-      body: '"error":"Filtering by \"coffee\" is not allowed"',
-    )
-    assert_raises(GdsApi::HTTPClientError) do
-      GdsApi::Rummager.new("http://example.com").search(q: "query", filter_coffee: "tea")
-    end
-  end
-
-  it "#search should raise an exception if the service at the search URI returns a 422" do
-    stub_request(:get, /example.com\/search/).to_return(
-      status: [422, "Bad Request"],
-      body: '"error":"Filtering by \"coffee\" is not allowed"',
-    )
-    assert_raises(GdsApi::HTTPClientError) do
-      GdsApi::Rummager.new("http://example.com").search(q: "query", filter_coffee: "tea")
-    end
-  end
-
-  it "#search should raise an exception if the service at the search URI times out" do
-    stub_request(:get, /example.com\/search/).to_timeout
-    assert_raises(GdsApi::TimedOutException) do
-      GdsApi::Rummager.new("http://example.com").search(q: "query")
-    end
-  end
-
-  it "#search should return the search deserialized from json" do
-    search_results = [{ "title" => "document-title" }]
-    stub_request(:get, /example.com\/search/).to_return(body: search_results.to_json)
-    results = GdsApi::Rummager.new("http://example.com").search(q: "query")
-    assert_equal search_results, results.to_hash
-  end
-
-  it "#search should request the search results in JSON format" do
-    GdsApi::Rummager.new("http://example.com").search(q: "query")
-
-    assert_requested :get, /.*/, headers: { "Accept" => "application/json" }
-  end
-
-  it "#search should issue a request for all the params supplied" do
-    GdsApi::Rummager.new("http://example.com").search(
-      q: "query & stuff",
-      filter_topics: %w(1 2),
-      order: "-public_timestamp",
-    )
-
-    assert_requested :get, /q=query%20%26%20stuff/
-    assert_requested :get, /filter_topics\[\]=1&filter_topics\[\]=2/
-    assert_requested :get, /order=-public_timestamp/
-  end
-
-  it "#delete_content removes a document" do
-    request = stub_request(:delete, "http://example.com/content?link=/foo/bar")
-
-    GdsApi::Rummager.new("http://example.com").delete_content("/foo/bar")
-
-    assert_requested(request)
-  end
-
-  it "#get_content Retrieves a document" do
-    request = stub_request(:get, "http://example.com/content?link=/foo/bar")
-
-    GdsApi::Rummager.new("http://example.com").get_content("/foo/bar")
-
-    assert_requested(request)
-  end
-end

data/test/support_api_test.rb

@@ -1,189 +0,0 @@
-require 'test_helper'
-require 'gds_api/support_api'
-require 'gds_api/test_helpers/support_api'
-
-describe GdsApi::SupportApi do
-  include GdsApi::TestHelpers::SupportApi
-
-  before do
-    @base_api_url = Plek.current.find("support-api")
-    @api = GdsApi::SupportApi.new(@base_api_url)
-  end
-
-  it "can report a problem" do
-    request_details = { certain: "details" }
-
-    stub_post = stub_request(:post, "#{@base_api_url}/anonymous-feedback/problem-reports").
-      with(body: { "problem_report" => request_details }.to_json).
-      to_return(status: 201)
-
-    @api.create_problem_report(request_details)
-
-    assert_requested(stub_post)
-  end
-
-  it "can pass service feedback" do
-    request_details = { "transaction-completed-values" => "1", "details" => "abc" }
-
-    stub_post = stub_request(:post, "#{@base_api_url}/anonymous-feedback/service-feedback").
-      with(body: { "service_feedback" => request_details }.to_json).
-      to_return(status: 201)
-
-    @api.create_service_feedback(request_details)
-
-    assert_requested(stub_post)
-  end
-
-  it "can submit long-form anonymous feedback" do
-    request_details = { certain: "details" }
-
-    stub_post = stub_request(:post, "#{@base_api_url}/anonymous-feedback/long-form-contacts").
-      with(body: { "long_form_contact" => request_details }.to_json).
-      to_return(status: 201)
-
-    @api.create_anonymous_long_form_contact(request_details)
-
-    assert_requested(stub_post)
-  end
-
-  it "fetches problem report daily totals" do
-    response_body = { "data" => ["results"] }
-
-    stub_get = stub_request(:get, "#{@base_api_url}/anonymous-feedback/problem-reports/2014-07-12/totals").
-      to_return(status: 200, body: response_body.to_json)
-
-    result = @api.problem_report_daily_totals_for(Date.new(2014, 7, 12))
-
-    assert_requested(stub_get)
-    assert_equal response_body, result.to_hash
-  end
-
-  it "throws an exception when the support app isn't available" do
-    support_api_isnt_available
-
-    assert_raises(GdsApi::HTTPServerError) { @api.create_service_feedback({}) }
-  end
-
-  describe "GET /anonymous-feedback" do
-    it "fetches anonymous feedback" do
-      stub_get = stub_anonymous_feedback(
-        path_prefix: "/vat-rates",
-        page: 55,
-      )
-
-      @api.anonymous_feedback(
-        path_prefix: "/vat-rates",
-        page: 55,
-      )
-
-      assert_requested(stub_get)
-    end
-  end
-
-  describe "GET /anonymous-feedback/organisations/:organisation_slug" do
-    it "fetches organisation summary" do
-      slug = "hm-revenue-customs"
-
-      stub_get = stub_anonymous_feedback_organisation_summary(slug)
-
-      @api.organisation_summary(slug)
-
-      assert_requested(stub_get)
-    end
-
-    it "accepts an ordering parameter" do
-      slug = "hm-revenue-customs"
-      ordering = "last_30_days"
-
-      stub_get = stub_anonymous_feedback_organisation_summary(slug, ordering)
-
-      @api.organisation_summary(slug, ordering: ordering)
-
-      assert_requested(stub_get)
-    end
-  end
-
-  describe "POST /anonymous-feedback/export-requests" do
-    it "makes a POST request to the support api" do
-      stub_post = stub_support_feedback_export_request_creation(notification_email: "foo@example.com")
-
-      @api.create_feedback_export_request(notification_email: "foo@example.com")
-
-      assert_requested(stub_post)
-    end
-  end
-
-  describe "POST /anonymous-feedback/global-export-requests" do
-    it "makes a POST request to the support API" do
-      params = { from_date: "1 June 2016", to_date: "8 June 2016", notification_email: "foo@example.com" }
-      stub_post = stub_support_global_export_request_creation(params)
-
-      @api.create_global_export_request(params)
-      assert_requested(stub_post)
-    end
-  end
-
-  describe "POST /page-improvements" do
-    it "makes a POST request to the support API" do
-      params = { description: "The title could be better." }
-      stub_post = stub_create_page_improvement(params)
-
-      @api.create_page_improvement(params)
-
-      assert_requested(stub_post)
-    end
-  end
-
-  describe "GET /anonymous-feedback/export-requests/:id" do
-    it "fetches the export request details from the API" do
-      stub_get = stub_support_feedback_export_request(123)
-
-      @api.feedback_export_request(123)
-
-      assert_requested(stub_get)
-    end
-  end
-
-  describe "GET /organisations" do
-    it "fetches a list of organisations" do
-      stub_get = stub_organisations_list
-
-      @api.organisations_list
-
-      assert_requested(stub_get)
-    end
-  end
-
-  describe "GET /organisations/:slug" do
-    it "fetches a list of organisations" do
-      stub_get = stub_organisation("foo")
-
-      @api.organisation("foo")
-
-      assert_requested(stub_get)
-    end
-  end
-
-  describe "GET /anonymous-feedback/problem-reports" do
-    it "fetches a list of problem reports" do
-      params = { from_date: '2016-12-12', to_date: '2016-12-13', page: 1, exclude_reviewed: true }
-      stub_get = stub_support_problem_reports(params)
-
-      @api.problem_reports(params)
-
-      assert_requested(stub_get)
-    end
-  end
-
-  describe "POST /anonymous-feedback/problem-reports/mark-reviewed-for-spam" do
-    it "makes a PUT request to the support API" do
-      params = { "1" => true, "2" => true }
-
-      stub_post = stub_support_mark_reviewed_for_spam(params)
-
-      @api.mark_reviewed_for_spam(params)
-
-      assert_requested(stub_post)
-    end
-  end
-end

data/test/support_test.rb

@@ -1,95 +0,0 @@
-require 'test_helper'
-require 'gds_api/support'
-require 'gds_api/test_helpers/support'
-
-describe GdsApi::Support do
-  include GdsApi::TestHelpers::Support
-
-  before do
-    @base_api_url = Plek.current.find("support")
-    @api = GdsApi::Support.new(@base_api_url)
-  end
-
-  it "can create an FOI request" do
-    request_details = { "foi_request" => { "requester" => { "name" => "A", "email" => "a@b.com" }, "details" => "abc" } }
-
-    stub_post = stub_request(:post, "#{@base_api_url}/foi_requests").
-      with(body: { "foi_request" => request_details }.to_json).
-      to_return(status: 201)
-
-    @api.create_foi_request(request_details)
-
-    assert_requested(stub_post)
-  end
-
-  it "throws an exception when the support app isn't available" do
-    support_isnt_available
-
-    assert_raises(GdsApi::HTTPServerError) { @api.create_foi_request({}) }
-  end
-
-  it "can report a problem" do
-    request_details = { certain: "details" }
-
-    stub_post = stub_request(:post, "#{@base_api_url}/anonymous_feedback/problem_reports").
-      with(body: { "problem_report" => request_details }.to_json).
-      to_return(status: 201)
-
-    @api.create_problem_report(request_details)
-
-    assert_requested(stub_post)
-  end
-
-  it "can submit long-form anonymous feedback" do
-    request_details = { certain: "details" }
-
-    stub_post = stub_request(:post, "#{@base_api_url}/anonymous_feedback/long_form_contacts").
-      with(body: { "long_form_contact" => request_details }.to_json).
-      to_return(status: 201)
-
-    @api.create_anonymous_long_form_contact(request_details)
-
-    assert_requested(stub_post)
-  end
-
-  it "can create a named contact" do
-    request_details = { certain: "details" }
-
-    stub_post = stub_request(:post, "#{@base_api_url}/named_contacts").
-      with(body: { "named_contact" => request_details }.to_json).
-      to_return(status: 201)
-
-    @api.create_named_contact(request_details)
-
-    assert_requested(stub_post)
-  end
-
-  it "throws an exception when the support app isn't available" do
-    support_isnt_available
-
-    assert_raises(GdsApi::HTTPServerError) { @api.create_problem_report({}) }
-  end
-
-  it "can pass service feedback" do
-    request_details = { "transaction-completed-values" => "1", "details" => "abc" }
-
-    stub_post = stub_request(:post, "#{@base_api_url}/anonymous_feedback/service_feedback").
-      with(body: { "service_feedback" => request_details }.to_json).
-      to_return(status: 201)
-
-    @api.create_service_feedback(request_details)
-
-    assert_requested(stub_post)
-  end
-
-  it "throws an exception when the support app isn't available" do
-    support_isnt_available
-
-    assert_raises(GdsApi::HTTPServerError) { @api.create_service_feedback({}) }
-  end
-
-  it "gets the correct feedback URL" do
-    assert_equal("#{@base_api_url}/anonymous_feedback?path=foo",
-                 @api.feedback_url('foo'))
-  end
-end