gds-api-adapters 38.0.0 → 38.1.0

data/lib/gds_api/test_helpers/publishing_api_v2.rb

@@ -35,7 +35,7 @@ module GdsApi
         response = {
           status: 200,
           body: '{}',
-          headers: {"Content-Type" => "application/json; charset=utf-8"}
+          headers: { "Content-Type" => "application/json; charset=utf-8" }
         }.merge(response_hash)
         stub_request(:post, url).with(body: body).to_return(response)
       end
@@ -45,14 +45,14 @@ module GdsApi
         response = {
           status: 200,
           body: '{}',
-          headers: {"Content-Type" => "application/json; charset=utf-8"}
+          headers: { "Content-Type" => "application/json; charset=utf-8" }
         }.merge(response_hash)
         stub_request(:post, url).with(params).to_return(response)
       end
 
       def stub_publishing_api_discard_draft(content_id)
         url = PUBLISHING_API_V2_ENDPOINT + "/content/#{content_id}/discard-draft"
-        stub_request(:post, url).to_return(status: 200, headers: {"Content-Type" => "application/json; charset=utf-8"})
+        stub_request(:post, url).to_return(status: 200, headers: { "Content-Type" => "application/json; charset=utf-8" })
       end
 
       def stub_publishing_api_put_content_links_and_publish(body, content_id = nil, publish_body = nil)
@@ -94,7 +94,7 @@ module GdsApi
 
       def stub_any_publishing_api_call_to_return_not_found
         stub_request(:any, %r{\A#{PUBLISHING_API_V2_ENDPOINT}})
-          .to_return(status: 404, headers: {"Content-Type" => "application/json; charset=utf-8"})
+          .to_return(status: 404, headers: { "Content-Type" => "application/json; charset=utf-8" })
       end
 
       def publishing_api_isnt_available
@@ -186,7 +186,7 @@ module GdsApi
           page = 1
         end
 
-        start_position = (page-1) * per_page
+        start_position = (page - 1) * per_page
         page_items = items.slice(start_position, per_page) || []
 
         number_of_pages =
@@ -210,7 +210,7 @@ module GdsApi
 
       # This method has been refactored into publishing_api_has_content (above)
       # publishing_api_has_content allows for flexible passing in of arguments, please use instead
-      def publishing_api_has_fields_for_document(format, items, fields)
+      def publishing_api_has_fields_for_document(document_type, items, fields)
         body = Array(items).map { |item|
           item.with_indifferent_access.slice(*fields)
         }
@@ -219,14 +219,14 @@ module GdsApi
           "&fields%5B%5D=#{f}"
         }
 
-        url = PUBLISHING_API_V2_ENDPOINT + "/content?document_type=#{format}#{query_params.join('')}"
+        url = PUBLISHING_API_V2_ENDPOINT + "/content?document_type=#{document_type}#{query_params.join('')}"
 
-        stub_request(:get, url).to_return(:status => 200, :body => { results: body }.to_json, :headers => {})
+        stub_request(:get, url).to_return(status: 200, body: { results: body }.to_json, headers: {})
       end
 
       def publishing_api_has_linkables(linkables, document_type:)
         url = PUBLISHING_API_V2_ENDPOINT + "/linkables?document_type=#{document_type}"
-        stub_request(:get, url).to_return(:status => 200, :body => linkables.to_json, :headers => {})
+        stub_request(:get, url).to_return(status: 200, body: linkables.to_json, headers: {})
       end
 
       def publishing_api_has_item(item)
@@ -240,7 +240,7 @@ module GdsApi
         url = PUBLISHING_API_V2_ENDPOINT + "/content/" + content_id
         calls = -1
 
-        stub_request(:get, url).to_return do |request|
+        stub_request(:get, url).to_return do |_request|
           calls += 1
           item = items[calls] || items.last
 
@@ -414,7 +414,7 @@ module GdsApi
       end
 
       def stub_publishing_api_postlike_call(method, content_id, body, resource_path, override_response_hash = {})
-        response_hash = {status: 200, body: '{}', headers: {"Content-Type" => "application/json; charset=utf-8"}}
+        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
@@ -422,7 +422,7 @@ module GdsApi
       end
 
       def deep_stringify_keys(hash)
-        deep_transform_keys(hash) { |key| key.to_s }
+        deep_transform_keys(hash, &:to_s)
       end
 
       def deep_transform_keys(object, &block)
@@ -432,7 +432,7 @@ module GdsApi
             result[yield(key)] = deep_transform_keys(value, &block)
           end
         when Array
-          object.map{ |item| deep_transform_keys(item, &block) }
+          object.map { |item| deep_transform_keys(item, &block) }
         else
           object
         end

data/lib/gds_api/test_helpers/router.rb

@@ -12,10 +12,10 @@ module GdsApi
       end
 
       def stub_router_backend_registration(backend_id, backend_url)
-        backend = { "backend" => { "backend_url" => backend_url }}
+        backend = { "backend" => { "backend_url" => backend_url } }
         stub_http_request(:put, "#{ROUTER_API_ENDPOINT}/backends/#{backend_id}")
-            .with(:body => backend.to_json)
-            .to_return(:status => 201)
+            .with(body: backend.to_json)
+            .to_return(status: 201)
       end
 
       def stub_route_registration(path, type, backend_id)
@@ -66,8 +66,8 @@ module GdsApi
 
       def stub_route_put(route)
         stub_http_request(:put, "#{ROUTER_API_ENDPOINT}/routes")
-            .with(:body => route.to_json)
-            .to_return(:status => 201)
+            .with(body: route.to_json)
+            .to_return(status: 201)
       end
     end
   end

data/lib/gds_api/test_helpers/rummager.rb

@@ -100,7 +100,7 @@ module GdsApi
         run_example_query
       end
 
-      def rummager_has_specialist_sector_organisations(sub_sector)
+      def rummager_has_specialist_sector_organisations(_sub_sector)
         stub_request_for(sub_sector_organisations_results)
         run_example_query
       end
@@ -111,9 +111,9 @@ module GdsApi
       end
 
       def rummager_has_policies_for_every_type(options = {})
-        if count = options[:count]
-          stub_request(:get, %r{/search.json.*count=#{count}.*})
-            .to_return(body: first_n_results(new_policies_results, n: count))
+        if options[:count]
+          stub_request(:get, %r{/search.json.*count=#{options[:count]}.*})
+            .to_return(body: first_n_results(new_policies_results, n: options[:count]))
         else
           stub_request(:get, %r{/search.json})
             .to_return(body: new_policies_results)
@@ -121,6 +121,7 @@ module GdsApi
       end
 
     private
+
       def stub_request_for(result_set)
         stub_request(:get, /example.com\/search/).to_return(body: result_set)
       end

data/lib/gds_api/test_helpers/support.rb

@@ -5,36 +5,36 @@ module GdsApi
 
       def stub_support_foi_request_creation(request_details = nil)
         post_stub = stub_http_request(:post, "#{SUPPORT_ENDPOINT}/foi_requests")
-        post_stub.with(:body => {"foi_request" => request_details}) unless request_details.nil?
-        post_stub.to_return(:status => 201)
+        post_stub.with(body: { "foi_request" => request_details }) unless request_details.nil?
+        post_stub.to_return(status: 201)
       end
 
       def stub_support_problem_report_creation(request_details = nil)
         post_stub = stub_http_request(:post, "#{SUPPORT_ENDPOINT}/anonymous_feedback/problem_reports")
-        post_stub.with(:body => { problem_report: request_details }) unless request_details.nil?
-        post_stub.to_return(:status => 201)
+        post_stub.with(body: { problem_report: request_details }) unless request_details.nil?
+        post_stub.to_return(status: 201)
       end
 
       def stub_support_named_contact_creation(request_details = nil)
         post_stub = stub_http_request(:post, "#{SUPPORT_ENDPOINT}/named_contacts")
-        post_stub.with(:body => { named_contact: request_details }) unless request_details.nil?
-        post_stub.to_return(:status => 201)
+        post_stub.with(body: { named_contact: request_details }) unless request_details.nil?
+        post_stub.to_return(status: 201)
       end
 
       def stub_support_long_form_anonymous_contact_creation(request_details = nil)
         post_stub = stub_http_request(:post, "#{SUPPORT_ENDPOINT}/anonymous_feedback/long_form_contacts")
-        post_stub.with(:body => { long_form_contact: request_details }) unless request_details.nil?
-        post_stub.to_return(:status => 201)
+        post_stub.with(body: { long_form_contact: request_details }) unless request_details.nil?
+        post_stub.to_return(status: 201)
       end
 
       def stub_support_service_feedback_creation(feedback_details = nil)
         post_stub = stub_http_request(:post, "#{SUPPORT_ENDPOINT}/anonymous_feedback/service_feedback")
-        post_stub.with(:body => { service_feedback: feedback_details }) unless feedback_details.nil?
-        post_stub.to_return(:status => 201)
+        post_stub.with(body: { service_feedback: feedback_details }) unless feedback_details.nil?
+        post_stub.to_return(status: 201)
       end
 
       def support_isnt_available
-        stub_request(:post, /#{SUPPORT_ENDPOINT}\/.*/).to_return(:status => 503)
+        stub_request(:post, /#{SUPPORT_ENDPOINT}\/.*/).to_return(status: 503)
       end
     end
   end

data/lib/gds_api/test_helpers/support_api.rb

@@ -8,38 +8,38 @@ module GdsApi
 
       def stub_support_api_problem_report_creation(request_details = nil)
         post_stub = stub_http_request(:post, "#{SUPPORT_API_ENDPOINT}/anonymous-feedback/problem-reports")
-        post_stub.with(:body => { problem_report: request_details }) unless request_details.nil?
-        post_stub.to_return(:status => 202)
+        post_stub.with(body: { problem_report: request_details }) unless request_details.nil?
+        post_stub.to_return(status: 202)
       end
 
       def stub_support_api_service_feedback_creation(feedback_details = nil)
         post_stub = stub_http_request(:post, "#{SUPPORT_API_ENDPOINT}/anonymous-feedback/service-feedback")
-        post_stub.with(:body => { service_feedback: feedback_details }) unless feedback_details.nil?
-        post_stub.to_return(:status => 201)
+        post_stub.with(body: { service_feedback: feedback_details }) unless feedback_details.nil?
+        post_stub.to_return(status: 201)
       end
 
       def stub_support_long_form_anonymous_contact_creation(request_details = nil)
         post_stub = stub_http_request(:post, "#{SUPPORT_API_ENDPOINT}/anonymous-feedback/long-form-contacts")
-        post_stub.with(:body => { long_form_contact: request_details }) unless request_details.nil?
-        post_stub.to_return(:status => 202)
+        post_stub.with(body: { long_form_contact: request_details }) unless request_details.nil?
+        post_stub.to_return(status: 202)
       end
 
       def stub_support_feedback_export_request_creation(request_details = nil)
         post_stub = stub_http_request(:post, "#{SUPPORT_API_ENDPOINT}/anonymous-feedback/export-requests")
-        post_stub.with(:body => { export_request: request_details }) unless request_details.nil?
-        post_stub.to_return(:status => 202)
+        post_stub.with(body: { export_request: request_details }) unless request_details.nil?
+        post_stub.to_return(status: 202)
       end
 
       def stub_support_global_export_request_creation(request_details = nil)
         post_stub = stub_http_request(:post, "#{SUPPORT_API_ENDPOINT}/anonymous-feedback/global-export-requests")
-        post_stub.with(:body => { global_export_request: request_details }) unless request_details.nil?
-        post_stub.to_return(:status => 202)
+        post_stub.with(body: { global_export_request: request_details }) unless request_details.nil?
+        post_stub.to_return(status: 202)
       end
 
       def stub_create_page_improvement(params)
         post_stub = stub_http_request(:post, "#{SUPPORT_API_ENDPOINT}/page-improvements")
-        post_stub.with(:body => params)
-        post_stub.to_return(:status => 201)
+        post_stub.with(body: params)
+        post_stub.to_return(status: 201)
       end
 
       def stub_problem_report_daily_totals_for(date, expected_results = nil)
@@ -58,12 +58,12 @@ module GdsApi
 
       def stub_support_mark_reviewed_for_spam(request_details = nil, response_body = {})
         post_stub = stub_http_request(:put, "#{SUPPORT_API_ENDPOINT}/anonymous-feedback/problem-reports/mark-reviewed-for-spam")
-        post_stub.with(:body => { reviewed_problem_report_ids: request_details}) unless request_details.nil?
+        post_stub.with(body: { reviewed_problem_report_ids: request_details }) unless request_details.nil?
         post_stub.to_return(status: 200, body: response_body.to_json)
       end
 
       def support_api_isnt_available
-        stub_request(:post, /#{SUPPORT_API_ENDPOINT}\/.*/).to_return(:status => 503)
+        stub_request(:post, /#{SUPPORT_API_ENDPOINT}\/.*/).to_return(status: 503)
       end
 
       def stub_anonymous_feedback(params, response_body = {})

data/lib/gds_api/test_helpers/whitehall_admin_api.rb

@@ -1,7 +1,7 @@
 module GdsApi
   module TestHelpers
     module WhitehallAdminApi
-      WHITEHALL_ADMIN_API_ENDPOINT = "#{Plek.current.find("whitehall-admin")}/government/admin/api"
+      WHITEHALL_ADMIN_API_ENDPOINT = "#{Plek.current.find('whitehall-admin')}/government/admin/api".freeze
 
       def stub_all_whitehall_admin_api_requests
         stub_request(:any, %r|^#{WHITEHALL_ADMIN_API_ENDPOINT}|)

data/lib/gds_api/test_helpers/worldwide.rb

@@ -14,38 +14,36 @@ module GdsApi
       # This also sets up the individual endpoints for each slug
       # by calling worldwide_api_has_location below
       def worldwide_api_has_locations(location_slugs)
-        location_slugs.each {|s| worldwide_api_has_location(s) }
+        location_slugs.each { |s| worldwide_api_has_location(s) }
         pages = []
         location_slugs.each_slice(20) do |slugs|
-          pages << slugs.map {|s| world_location_details_for_slug(s) }
+          pages << slugs.map { |s| world_location_details_for_slug(s) }
         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" => location_slugs.size,
             "pages" => pages.size,
             "current_page" => i + 1,
             "page_size" => 20,
-            "start_index" => i * 20 + 1,
-          })
+            "start_index" => i * 20 + 1)
 
-          links = {:self => "#{WORLDWIDE_API_ENDPOINT}/api/world-locations?page=#{i + 1}" }
-          links[:next] = "#{WORLDWIDE_API_ENDPOINT}/api/world-locations?page=#{i + 2}" if pages[i+1]
+          links = { self: "#{WORLDWIDE_API_ENDPOINT}/api/world-locations?page=#{i + 1}" }
+          links[:next] = "#{WORLDWIDE_API_ENDPOINT}/api/world-locations?page=#{i + 2}" if pages[i + 1]
           links[:previous] = "#{WORLDWIDE_API_ENDPOINT}/api/world-locations?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
@@ -61,28 +59,28 @@ module GdsApi
         )
       end
 
-      def worldwide_api_has_location(location_slug, details=nil)
+      def worldwide_api_has_location(location_slug, details = nil)
         details ||= world_location_for_slug(location_slug)
         stub_request(:get, "#{WORLDWIDE_API_ENDPOINT}/api/world-locations/#{location_slug}").
-          to_return(:status => 200, :body => details.to_json)
+          to_return(status: 200, body: details.to_json)
       end
 
       def worldwide_api_does_not_have_location(location_slug)
-        stub_request(:get, "#{WORLDWIDE_API_ENDPOINT}/api/world-locations/#{location_slug}").to_return(:status => 404)
+        stub_request(:get, "#{WORLDWIDE_API_ENDPOINT}/api/world-locations/#{location_slug}").to_return(status: 404)
       end
 
       def worldwide_api_has_organisations_for_location(location_slug, json_or_hash)
         json = json_or_hash.is_a?(Hash) ? json_or_hash.to_json : json_or_hash
         url = "#{WORLDWIDE_API_ENDPOINT}/api/world-locations/#{location_slug}/organisations"
         stub_request(:get, url).
-          to_return(:status => 200, :body => json, :headers => {"Link" => "<#{url}; rel\"self\""})
+          to_return(status: 200, body: json, headers: { "Link" => "<#{url}; rel\"self\"" })
       end
 
       def worldwide_api_has_no_organisations_for_location(location_slug)
-        details = {"results" => [], "total" => 0, "_response_info" => { "status" => "ok" } }
+        details = { "results" => [], "total" => 0, "_response_info" => { "status" => "ok" } }
         url = "#{WORLDWIDE_API_ENDPOINT}/api/world-locations/#{location_slug}/organisations"
         stub_request(:get, url).
-          to_return(:status => 200, :body => details.to_json, :headers => {"Link" => "<#{url}; rel\"self\""})
+          to_return(status: 200, body: details.to_json, headers: { "Link" => "<#{url}; rel\"self\"" })
       end
 
       def world_location_for_slug(slug)
@@ -96,7 +94,7 @@ module GdsApi
       def world_location_details_for_slug(slug)
         {
           "id" => "https://www.gov.uk/api/world-locations/#{slug}",
-          "title" => titleize_slug(slug, :title_case => true),
+          "title" => titleize_slug(slug, title_case: true),
           "format" => (slug =~ /(delegation|mission)/ ? "International delegation" : "World location"),
           "updated_at" => "2013-03-25T13:06:42+00:00",
           "web_url" => "https://www.gov.uk/government/world/#{slug}",
@@ -110,7 +108,6 @@ module GdsApi
           },
         }
       end
-
     end
   end
 end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '38.0.0'.freeze
+  VERSION = '38.1.0'.freeze
 end

data/lib/gds_api/worldwide.rb

@@ -1,20 +1,20 @@
 require_relative 'base'
 
 class GdsApi::Worldwide < GdsApi::Base
-
   def world_locations
-    get_list! "#{base_url}/world-locations"
+    get_list("#{base_url}/world-locations")
   end
 
   def world_location(location_slug)
-    get_json "#{base_url}/world-locations/#{location_slug}"
+    get_json("#{base_url}/world-locations/#{location_slug}")
   end
 
   def organisations_for_world_location(location_slug)
-    get_list! "#{base_url}/world-locations/#{location_slug}/organisations"
+    get_list("#{base_url}/world-locations/#{location_slug}/organisations")
   end
 
 private
+
   def base_url
     "#{endpoint}/api"
   end

data/test/asset_manager_test.rb

@@ -24,10 +24,10 @@ describe GdsApi::AssetManager do
 
   it "creates an asset with a file" do
     req = stub_request(:post, "#{base_api_url}/assets").
-      with(:body => %r{Content\-Disposition: form\-data; name="asset\[file\]"; filename="hello\.txt"\r\nContent\-Type: text/plain}).
-      to_return(:body => JSON.dump(asset_manager_response), :status => 201)
+      with(body: %r{Content\-Disposition: form\-data; name="asset\[file\]"; filename="hello\.txt"\r\nContent\-Type: text/plain}).
+      to_return(body: JSON.dump(asset_manager_response), status: 201)
 
-    response = api.create_asset(:file => file_fixture)
+    response = api.create_asset(file: file_fixture)
 
     assert_equal asset_url, response['asset']['id']
     assert_requested(req)
@@ -55,9 +55,9 @@ describe GdsApi::AssetManager do
 
     it "updates an asset with a file" do
       req = stub_request(:put, "#{base_api_url}/assets/test-id").
-        to_return(:body => JSON.dump(asset_manager_response), :status => 200)
+        to_return(body: JSON.dump(asset_manager_response), status: 200)
 
-      response = api.update_asset(asset_id, :file => file_fixture)
+      response = api.update_asset(asset_id, file: file_fixture)
 
       assert_equal "#{base_api_url}/assets/#{asset_id}", response['asset']['id']
       assert_requested(req)
@@ -74,7 +74,7 @@ describe GdsApi::AssetManager do
 
   it "deletes an asset for the given id" do
     req = stub_request(:delete, "#{base_api_url}/assets/#{asset_id}").
-      to_return(:body => JSON.dump(asset_manager_response), :status => 200)
+      to_return(body: JSON.dump(asset_manager_response), status: 200)
 
     response = api.delete_asset(asset_id)