gds-api-adapters 38.0.0 → 38.1.0

data/lib/gds_api/test_helpers/intent_helpers.rb

@@ -1,7 +1,6 @@
 module GdsApi
   module TestHelpers
     module IntentHelpers
-
       def intent_for_base_path(base_path)
         {
           "base_path" => base_path,
@@ -11,4 +10,3 @@ module GdsApi
     end
   end
 end
-

data/lib/gds_api/test_helpers/local_links_manager.rb

@@ -3,7 +3,6 @@ require 'gds_api/test_helpers/json_client_helper'
 module GdsApi
   module TestHelpers
     module LocalLinksManager
-
       LOCAL_LINKS_MANAGER_ENDPOINT = Plek.current.find('local-links-manager')
 
       def local_links_manager_has_a_link(authority_slug:, lgsl:, lgil:, url:)
@@ -22,7 +21,7 @@ module GdsApi
         }
 
         stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/link")
-          .with(query: {authority_slug: authority_slug, lgsl: lgsl, lgil: lgil})
+          .with(query: { authority_slug: authority_slug, lgsl: lgsl, lgil: lgil })
           .to_return(body: response.to_json, status: 200)
       end
 
@@ -37,7 +36,7 @@ module GdsApi
         }
 
         stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/link")
-          .with(query: {authority_slug: authority_slug, lgsl: lgsl, lgil: lgil})
+          .with(query: { authority_slug: authority_slug, lgsl: lgsl, lgil: lgil })
           .to_return(body: response.to_json, status: 200)
       end
 
@@ -52,7 +51,7 @@ module GdsApi
         }
 
         stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/link")
-          .with(query: {authority_slug: authority_slug, lgsl: lgsl, lgil: lgil})
+          .with(query: { authority_slug: authority_slug, lgsl: lgsl, lgil: lgil })
           .to_return(body: response.to_json, status: 200)
       end
 
@@ -72,7 +71,7 @@ module GdsApi
         }
 
         stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/link")
-          .with(query: {authority_slug: authority_slug, lgsl: lgsl})
+          .with(query: { authority_slug: authority_slug, lgsl: lgsl })
           .to_return(body: response.to_json, status: 200)
       end
 
@@ -87,7 +86,7 @@ module GdsApi
         }
 
         stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/link")
-          .with(query: {authority_slug: authority_slug, lgsl: lgsl})
+          .with(query: { authority_slug: authority_slug, lgsl: lgsl })
           .to_return(body: response.to_json, status: 200)
       end
 
@@ -100,9 +99,9 @@ module GdsApi
           .to_return(body: {}.to_json, status: 400)
       end
 
-      def local_links_manager_does_not_have_required_objects(authority_slug, lgsl, lgil=nil)
+      def local_links_manager_does_not_have_required_objects(authority_slug, lgsl, lgil = nil)
         params = { authority_slug: authority_slug, lgsl: lgsl }
-        params.merge!(lgil: lgil) if lgil
+        params[:lgil] = lgil if lgil
 
         stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/link")
           .with(query: params)
@@ -121,7 +120,7 @@ module GdsApi
         }
 
         stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/local-authority")
-          .with(query: {authority_slug: authority_slug})
+          .with(query: { authority_slug: authority_slug })
           .to_return(body: response.to_json, status: 200)
       end
 
@@ -142,19 +141,19 @@ module GdsApi
         }
 
         stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/local-authority")
-          .with(query: {authority_slug: district_slug})
+          .with(query: { authority_slug: district_slug })
           .to_return(body: response.to_json, status: 200)
       end
 
       def local_links_manager_request_without_local_authority_slug
         stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/local-authority")
-        .with(query: {authority_slug: ''})
+        .with(query: { authority_slug: '' })
         .to_return(body: {}.to_json, status: 400)
       end
 
       def local_links_manager_does_not_have_an_authority(authority_slug)
         stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/local-authority")
-        .with(query: {authority_slug: authority_slug})
+        .with(query: { authority_slug: authority_slug })
         .to_return(body: {}.to_json, status: 404)
       end
 
@@ -170,7 +169,7 @@ module GdsApi
         }
 
         stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/local-authority")
-          .with(query: {authority_slug: authority_slug})
+          .with(query: { authority_slug: authority_slug })
           .to_return(body: response.to_json, status: 200)
       end
     end

data/lib/gds_api/test_helpers/mapit.rb

@@ -1,7 +1,6 @@
 module GdsApi
   module TestHelpers
     module Mapit
-
       MAPIT_ENDPOINT = Plek.current.find('mapit')
 
       def mapit_has_a_postcode(postcode, coords)
@@ -11,10 +10,10 @@ module GdsApi
           "postcode"  => postcode
         }
 
-        stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/" + postcode.gsub(' ','+') + ".json")
-          .to_return(:body => response.to_json, :status => 200)
+        stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/" + postcode.tr(' ', '+') + ".json")
+          .to_return(body: response.to_json, status: 200)
         stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/partial/" + postcode.split(' ').first + ".json")
-          .to_return(:body => response.to_json, :status => 200)
+          .to_return(body: response.to_json, status: 200)
       end
 
       def mapit_has_a_postcode_and_areas(postcode, coords, areas)
@@ -36,40 +35,40 @@ module GdsApi
           }]
         }]
 
-        stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/" + postcode.gsub(' ','+') + ".json")
-          .to_return(:body => response.merge({'areas' => area_response}).to_json, :status => 200)
+        stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/" + postcode.tr(' ', '+') + ".json")
+          .to_return(body: response.merge('areas' => area_response).to_json, status: 200)
         stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/partial/" + postcode.split(' ').first + ".json")
-          .to_return(:body => response.to_json, :status => 200)
+          .to_return(body: response.to_json, status: 200)
       end
 
       def mapit_does_not_have_a_postcode(postcode)
-        stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/" + postcode.gsub(' ','+') + ".json")
-          .to_return(:body => { "code" => 404, "error" => "No Postcode matches the given query." }.to_json, :status => 404)
+        stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/" + postcode.tr(' ', '+') + ".json")
+          .to_return(body: { "code" => 404, "error" => "No Postcode matches the given query." }.to_json, status: 404)
       end
 
       def mapit_does_not_have_a_bad_postcode(postcode)
-        stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/" + postcode.gsub(' ','+') + ".json")
-          .to_return(:body => { "code" => 400, "error" => "Postcode '#{postcode}' is not valid." }.to_json, :status => 400)
+        stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/" + postcode.tr(' ', '+') + ".json")
+          .to_return(body: { "code" => 400, "error" => "Postcode '#{postcode}' is not valid." }.to_json, status: 400)
       end
 
       def mapit_has_areas(area_type, areas)
         stub_request(:get, "#{MAPIT_ENDPOINT}/areas/" + area_type + ".json")
-          .to_return(:body => areas.to_json, :status => 200)
+          .to_return(body: areas.to_json, status: 200)
       end
 
       def mapit_does_not_have_areas(area_type)
         stub_request(:get, "#{MAPIT_ENDPOINT}/areas/" + area_type + ".json")
-          .to_return(:body => [].to_json, :status => 200)
+          .to_return(body: [].to_json, status: 200)
       end
 
       def mapit_has_area_for_code(code_type, code, area)
         stub_request(:get, "#{MAPIT_ENDPOINT}/code/#{code_type}/#{code}.json")
-          .to_return(:body => area.to_json, :status => 200)
+          .to_return(body: area.to_json, status: 200)
       end
 
       def mapit_does_not_have_area_for_code(code_type, code)
         stub_request(:get, "#{MAPIT_ENDPOINT}/code/#{code_type}/#{code}.json")
-        .to_return(:body => { "code" => 404, "error" => "No areas were found that matched code #{code_type} = #{code}." }.to_json, :status => 404)
+        .to_return(body: { "code" => 404, "error" => "No areas were found that matched code #{code_type} = #{code}." }.to_json, status: 404)
       end
     end
   end

data/lib/gds_api/test_helpers/need_api.rb

@@ -51,7 +51,7 @@ module GdsApi
       end
 
       def need_api_has_need_ids(needs)
-        ids = needs.map {|need| (need["id"] || need[:id]).to_i }.sort.join(',')
+        ids = needs.map { |need| (need["id"] || need[:id]).to_i }.sort.join(',')
         url = NEED_API_ENDPOINT + "/needs?ids=#{ids}"
 
         body = response_base.merge(
@@ -85,7 +85,7 @@ module GdsApi
       def need_api_has_no_need(need_id)
         url = NEED_API_ENDPOINT + "/needs/#{need_id}"
         not_found_body = {
-          "_response_info" => {"status" => "not_found"},
+          "_response_info" => { "status" => "not_found" },
           "error" => "No need exists with this ID"
         }
         stub_request(:get, url).to_return(
@@ -97,8 +97,8 @@ module GdsApi
 
       def stub_create_note(note_details = nil)
         post_stub = stub_request(:post, NEED_API_ENDPOINT + "/notes")
-        post_stub.with(:body => note_details.to_json) unless note_details.nil?
-        post_stub.to_return(:status => 201)
+        post_stub.with(body: note_details.to_json) unless note_details.nil?
+        post_stub.to_return(status: 201)
       end
     end
   end

data/lib/gds_api/test_helpers/organisations.rb

@@ -34,43 +34,41 @@ module GdsApi
         end
 
         pages.each_with_index do |page, i|
-          page_details = plural_response_base.merge({
-            "results" => page,
+          page_details = plural_response_base.merge("results" => page,
             "total" => organisation_bodies.size,
             "pages" => pages.size,
             "current_page" => i + 1,
             "page_size" => 20,
-            "start_index" => i * 20 + 1,
-          })
+            "start_index" => i * 20 + 1)
 
-          links = {:self => "#{ORGANISATIONS_API_ENDPOINT}/api/organisations?page=#{i + 1}" }
-          links[:next] = "#{ORGANISATIONS_API_ENDPOINT}/api/organisations?page=#{i + 2}" if pages[i+1]
+          links = { self: "#{ORGANISATIONS_API_ENDPOINT}/api/organisations?page=#{i + 1}" }
+          links[:next] = "#{ORGANISATIONS_API_ENDPOINT}/api/organisations?page=#{i + 2}" if pages[i + 1]
           links[:previous] = "#{ORGANISATIONS_API_ENDPOINT}/api/organisations?page=#{i}" unless i == 0
           page_details["_response_info"]["links"] = []
           link_headers = []
           links.each do |rel, href|
-            page_details["_response_info"]["links"] << {"rel" => rel, "href" => href}
+            page_details["_response_info"]["links"] << { "rel" => rel, "href" => href }
             link_headers << "<#{href}>; rel=\"#{rel}\""
           end
 
           stub_request(:get, links[:self]).
-            to_return(:status => 200, :body => page_details.to_json, :headers => {"Link" => link_headers.join(", ")})
+            to_return(status: 200, body: page_details.to_json, headers: { "Link" => link_headers.join(", ") })
           if i == 0
             # First page exists at URL with and without page param
             stub_request(:get, links[:self].sub(/\?page=1/, '')).
-              to_return(:status => 200, :body => page_details.to_json, :headers => {"Link" => link_headers.join(", ")})
+              to_return(status: 200, body: page_details.to_json, headers: { "Link" => link_headers.join(", ") })
           end
         end
       end
 
-      def organisations_api_has_organisation(organisation_slug, details=nil)
+      def organisations_api_has_organisation(organisation_slug, details = nil)
         details ||= organisation_for_slug(organisation_slug)
         stub_request(:get, "#{ORGANISATIONS_API_ENDPOINT}/api/organisations/#{organisation_slug}").
-          to_return(:status => 200, :body => details.to_json)
+          to_return(status: 200, body: details.to_json)
       end
 
       def organisations_api_does_not_have_organisation(organisation_slug)
-        stub_request(:get, "#{ORGANISATIONS_API_ENDPOINT}/api/organisations/#{organisation_slug}").to_return(:status => 404)
+        stub_request(:get, "#{ORGANISATIONS_API_ENDPOINT}/api/organisations/#{organisation_slug}").to_return(status: 404)
       end
 
       def organisation_for_slug(slug)
@@ -81,17 +79,17 @@ module GdsApi
       #
       # if the slug contains 'ministry' the format will be set to 'Ministerial department'
       # otherwise it will be set to 'Executive agency'
-      def organisation_details_for_slug(slug, content_id=SecureRandom.uuid)
+      def organisation_details_for_slug(slug, content_id = SecureRandom.uuid)
         {
           "id" => "#{ORGANISATIONS_API_ENDPOINT}/api/organisations/#{slug}",
-          "title" => titleize_slug(slug, :title_case => true),
+          "title" => titleize_slug(slug, title_case: true),
           "format" => (slug =~ /ministry/ ? "Ministerial department" : "Executive agency"),
           "updated_at" => "2013-03-25T13:06:42+00:00",
           "web_url" => "#{PUBLIC_HOST}/government/organisations/#{slug}",
           "details" => {
             "slug" => slug,
             "abbreviation" => acronymize_slug(slug),
-            "logo_formatted_name" => titleize_slug(slug, :title_case => true),
+            "logo_formatted_name" => titleize_slug(slug, title_case: true),
             "organisation_brand_colour_class_name" => slug,
             "organisation_logo_type_class_name" => (slug =~ /ministry/ ? "single-identity" : "eo"),
             "closed_at" => nil,

data/lib/gds_api/test_helpers/panopticon.rb

@@ -23,20 +23,20 @@ module GdsApi
         urls << "#{PANOPTICON_ENDPOINT}/artefacts/#{metadata['id']}.json" if metadata['id']
         urls << "#{PANOPTICON_ENDPOINT}/artefacts/#{metadata['slug']}.json" if metadata['slug']
 
-        urls.each { |url| stub_request(:get, url).to_return(:status => 200, :body => json, :headers => {}) }
+        urls.each { |url| stub_request(:get, url).to_return(status: 200, body: json, headers: {}) }
 
-        return urls.first
+        urls.first
       end
 
       def panopticon_has_no_metadata_for(slug)
         url = "#{PANOPTICON_ENDPOINT}/artefacts/#{slug}.json"
-        stub_request(:get, url).to_return(:status => 404, :body => "", :headers => {})
+        stub_request(:get, url).to_return(status: 404, body: "", headers: {})
       end
 
       def stub_panopticon_default_artefact
         stub_request(:get, %r{\A#{PANOPTICON_ENDPOINT}/artefacts}).to_return { |request|
           # return a response with only a slug, and set that slug to match the requested artefact slug
-          {:body => JSON.dump("slug" => request.uri.path.split('/').last.chomp('.json'))}
+          { body: JSON.dump("slug" => request.uri.path.split('/').last.chomp('.json')) }
         }
       end
 
@@ -45,10 +45,10 @@ module GdsApi
 
         if request_details
           request_details = request_details.to_json unless custom_matcher
-          stub.with(:body => request_details) 
+          stub.with(body: request_details)
         end
 
-        stub.to_return(:status => 201)
+        stub.to_return(status: 201)
       end
 
       def stub_panopticon_tag_creation(attributes)

data/lib/gds_api/test_helpers/performance_platform/data_in.rb

@@ -2,42 +2,42 @@ module GdsApi
   module TestHelpers
     module PerformancePlatform
       module DataIn
-        PP_DATA_IN_ENDPOINT = "http://www.performance.dev.gov.uk"
+        PP_DATA_IN_ENDPOINT = "http://www.performance.dev.gov.uk".freeze
 
         def stub_service_feedback_day_aggregate_submission(slug, request_body = nil)
           post_stub = stub_http_request(:post, "#{PP_DATA_IN_ENDPOINT}/data/#{slug}/customer-satisfaction")
           post_stub.with(body: request_body) unless request_body.nil?
-          post_stub.to_return(:status => 200)
+          post_stub.to_return(status: 200)
         end
 
         def stub_corporate_content_problem_report_count_submission(submissions = nil)
           post_stub = stub_http_request(:post, "#{PP_DATA_IN_ENDPOINT}/data/gov-uk-content/feedback-count")
           post_stub.with(body: submissions.to_json) unless submissions.nil?
-          post_stub.to_return(:status => 200)
+          post_stub.to_return(status: 200)
         end
 
         def stub_corporate_content_urls_with_the_most_problem_reports_submission(submissions = nil)
           post_stub = stub_http_request(:post, "#{PP_DATA_IN_ENDPOINT}/data/gov-uk-content/top-urls")
           post_stub.with(body: submissions.to_json) unless submissions.nil?
-          post_stub.to_return(:status => 200)
+          post_stub.to_return(status: 200)
         end
 
         def stub_problem_report_daily_totals_submission(submissions = nil)
           post_stub = stub_http_request(:post, "#{PP_DATA_IN_ENDPOINT}/data/govuk-info/page-contacts")
           post_stub.with(body: submissions.to_json) unless submissions.nil?
-          post_stub.to_return(:status => 200)
+          post_stub.to_return(status: 200)
         end
 
         def stub_service_feedback_bucket_unavailable_for(slug)
-          stub_request(:post, "#{PP_DATA_IN_ENDPOINT}/data/#{slug}/customer-satisfaction").to_return(:status => 404)
+          stub_request(:post, "#{PP_DATA_IN_ENDPOINT}/data/#{slug}/customer-satisfaction").to_return(status: 404)
         end
 
         def stub_pp_isnt_available
-          stub_request(:post, /#{PP_DATA_IN_ENDPOINT}\/.*/).to_return(:status => 503)
+          stub_request(:post, /#{PP_DATA_IN_ENDPOINT}\/.*/).to_return(status: 503)
         end
 
         def stub_pp_dataset_unavailable
-          stub_request(:any, /#{PP_DATA_IN_ENDPOINT}/).to_return(:status => 404)
+          stub_request(:any, /#{PP_DATA_IN_ENDPOINT}/).to_return(status: 404)
         end
       end
     end

data/lib/gds_api/test_helpers/publishing_api.rb

@@ -14,15 +14,15 @@ module GdsApi
       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"})
+        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_destroy_intent(base_path)
         url = PUBLISHING_API_ENDPOINT + "/publish-intent" + base_path
-        stub_request(:delete, url).to_return(status: 200, body: '{}', headers: {"Content-Type" => "application/json; charset=utf-8"})
+        stub_request(:delete, url).to_return(status: 200, body: '{}', headers: { "Content-Type" => "application/json; charset=utf-8" })
       end
 
-      def stub_default_publishing_api_put_intent()
+      def stub_default_publishing_api_put_intent
         stub_request(:put, %r{\A#{PUBLISHING_API_ENDPOINT}/publish-intent})
       end
 
@@ -60,43 +60,42 @@ module GdsApi
       end
 
       def publishing_api_isnt_available
-        stub_request(:any, /#{PUBLISHING_API_ENDPOINT}\/.*/).to_return(:status => 503)
+        stub_request(:any, /#{PUBLISHING_API_ENDPOINT}\/.*/).to_return(status: 503)
       end
 
       def stub_default_publishing_api_path_reservation
         stub_request(:put, %r[\A#{PUBLISHING_API_ENDPOINT}/paths/]).to_return { |request|
-           base_path = request.uri.path.sub(%r{\A/paths/}, "")
-           { :status => 200,  :headers => {:content_type => "application/json"},
-             :body => publishing_api_path_data_for(base_path).to_json }
+          base_path = request.uri.path.sub(%r{\A/paths/}, "")
+          { status: 200, headers: { content_type: "application/json" },
+            body: publishing_api_path_data_for(base_path).to_json }
         }
       end
 
       def publishing_api_has_path_reservation_for(path, publishing_app)
         data = publishing_api_path_data_for(path, "publishing_app" => publishing_app)
-        error_data = data.merge({
-          "errors" => {"path" => ["is already reserved by the #{publishing_app} application"]},
-        })
+        error_data = data.merge("errors" => { "path" => ["is already reserved by the #{publishing_app} application"] })
 
         stub_request(:put, "#{PUBLISHING_API_ENDPOINT}/paths#{path}").
-                  to_return(:status => 422, :body => error_data.to_json,
-                            :headers => {:content_type => "application/json"})
+                  to_return(status: 422, body: error_data.to_json,
+                            headers: { content_type: "application/json" })
 
         stub_request(:put, "#{PUBLISHING_API_ENDPOINT}/paths#{path}").
-          with(:body => {"publishing_app" => publishing_app}).
-          to_return(:status => 200,
-                    :headers => {:content_type => "application/json"},
-                    :body => data.to_json)
+          with(body: { "publishing_app" => publishing_app }).
+          to_return(status: 200,
+                    headers: { content_type: "application/json" },
+                    body: data.to_json)
       end
 
       def publishing_api_returns_path_reservation_validation_error_for(path, error_details = nil)
-        error_details ||= {"base" => ["computer says no"]}
+        error_details ||= { "base" => ["computer says no"] }
         error_data = publishing_api_path_data_for(path).merge("errors" => error_details)
 
         stub_request(:put, "#{PUBLISHING_API_ENDPOINT}/paths#{path}").
-          to_return(:status => 422, :body => error_data.to_json, :headers => {:content_type => "application/json"})
+          to_return(status: 422, body: error_data.to_json, headers: { content_type: "application/json" })
       end
 
     private
+
       def values_match_recursively(expected_value, actual_value)
         case expected_value
         when Hash
@@ -116,11 +115,11 @@ module GdsApi
         end
       end
 
-      def content_item_for_publishing_api(base_path, publishing_app="publisher")
+      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")
+      def intent_for_publishing_api(base_path, publishing_app = "publisher")
         intent_for_base_path(base_path).merge("publishing_app" => publishing_app)
       end