gds-api-adapters 88.1.0 → 89.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79fe1575665027a5ad13f85d14e744690c101f68b96eb07bdcaddda05cb64e8a
-  data.tar.gz: 660f4807575e2cf6027eac405bcf0dbe5b07d176a8416be908d44c6a785f1af9
+  metadata.gz: d3eb40035b5fa647944d596304bd5ae025bafef25b92e642e6a5d8480f4f928c
+  data.tar.gz: 01d7a039b547736315c2d67974e3408b566a176a93bd4d912ae47fbedca97039
 SHA512:
-  metadata.gz: 6a50caa040385b76a6238df0f1f13ffce44a2b807434b6cc51f280109b3f15ae9d756cbf93c2ea3c7ae7b9790ae3a314aae1e28ed85bf6be24414edf7911d7af
-  data.tar.gz: 68e20ea7f52cb1451d1cdb847125c3278901381d6346941e74a13fdf21dafd58bd74a3363348c2f573b5f046eddc3e271de06a569374304eff3887c0fdd0e8d4
+  metadata.gz: 2759dda02d68912b14e7a918846b98dda7d439be7b352f1499dda2f9131eff75aa26e952931b836553be86c603e90ca7ae2ff5e3a1e3df7934596fc7adf2be0a
+  data.tar.gz: 5aae0a77fafc975e667966f859d4f9e96b50c669c8460f1e5debec6254258d0ef9cdcb0b9b8586ef289334f93a563d3e76cdb2a6f2de623fc234834552bc2b73

data/lib/gds_api/asset_manager.rb

@@ -128,7 +128,7 @@ class GdsApi::AssetManager < GdsApi::Base
     post_multipart("#{base_url}/whitehall_assets", asset: asset)
   end
 
-  # Fetches a Whitehall asset given the legacy URL path
+  # Fetches a Whitehall asset's metadata given the legacy URL path
   #
   # @param legacy_url_path [String] The Whitehall asset identifier.
   # @return [GdsApi::Response] A response object containing the parsed JSON
@@ -171,7 +171,7 @@ class GdsApi::AssetManager < GdsApi::Base
     put_multipart("#{base_url}/assets/#{id}", asset: asset)
   end
 
-  # Fetches an asset given the id
+  # Fetches an asset's metadata given the id
   #
   # @param id [String] The asset identifier (a UUID).
   # @return [GdsApi::Response, nil] A response object containing the parsed JSON response. If
@@ -228,6 +228,17 @@ class GdsApi::AssetManager < GdsApi::Base
     post_json("#{base_url}/assets/#{id}/restore")
   end
 
+  # Fetches a Whitehall asset given the legacy URL path
+  #
+  # @param legacy_url_path [String] The Whitehall asset identifier.
+  # @return [GdsApi::Response] A response object containing the raw asset.
+  #   If the asset cannot be found, +GdsApi::HTTPNotFound+ will be raised.
+  #
+  # @raise [HTTPErrorResponse] if the request returns an error
+  def whitehall_media(legacy_url_path)
+    get_raw("#{base_url}/#{uri_encode(legacy_url_path)}")
+  end
+
 private
 
   def base_url

data/lib/gds_api/json_client.rb

@@ -157,7 +157,7 @@ module GdsApi
     end
 
     def do_request(method, url, params = nil, additional_headers = {})
-      loggable = { request_uri: url, start_time: Time.now.to_f }
+      loggable = { request_uri: url, start_time: Time.now.to_f, govuk_request_id: GdsApi::GovukHeaders.headers[:govuk_request_id] }.compact
       start_logging = loggable.merge(action: "start")
       logger.debug start_logging.to_json
 

data/lib/gds_api/test_helpers/asset_manager.rb

@@ -33,6 +33,9 @@ module GdsApi
 
         stub_request(:get, "#{ASSET_MANAGER_ENDPOINT}/whitehall_assets/#{legacy_url_path}")
           .to_return(body: response.to_json, status: 200)
+
+        stub_request(:get, "#{ASSET_MANAGER_ENDPOINT}/#{legacy_url_path}")
+          .to_return(body: "Some file content", status: 200)
       end
 
       def stub_asset_manager_does_not_have_an_asset(id)

data/lib/gds_api/test_helpers/worldwide.rb

@@ -8,95 +8,48 @@ module GdsApi
 
       WORLDWIDE_API_ENDPOINT = Plek.new.website_root
 
-      # Sets up the index endpoints for the given country slugs
-      # The stubs are setup to paginate in chunks of 20
-      #
-      # This also sets up the individual endpoints for each slug
-      # by calling stub_worldwide_api_has_location below
       def stub_worldwide_api_has_locations(location_slugs)
-        location_slugs.each { |s| stub_worldwide_api_has_location(s) }
-        pages = []
-        location_slugs.each_slice(20) do |slugs|
-          pages << slugs.map { |s| world_location_details_for_slug(s) }
+        international_delegation_slugs = location_slugs.select do |slug|
+          slug =~ /(delegation|mission)/
         end
 
-        pages.each_with_index do |page, i|
-          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,
-          )
-
-          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.zero?
-          page_details["_response_info"]["links"] = []
-          link_headers = []
-          links.each do |rel, 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(", ") })
-
-          next unless i.zero?
+        international_delegations = international_delegation_slugs.map do |slug|
+          {
+            "active": true,
+            "analytics_identifier": "WL1",
+            "content_id": "content_id_for_#{slug}",
+            "iso2": slug[0..1].upcase,
+            "name": titleize_slug(slug, title_case: true),
+            "slug": slug,
+            "updated_at": "2013-03-25T13:06:42+00:00",
+          }
+        end
 
-          # 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(", ") })
+        world_locations = (location_slugs - international_delegation_slugs).map do |slug|
+          {
+            "active": true,
+            "analytics_identifier": "WL1",
+            "content_id": "content_id_for_#{slug}",
+            "iso2": slug[0..1].upcase,
+            "name": titleize_slug(slug, title_case: true),
+            "slug": slug,
+            "updated_at": "2013-03-25T13:06:42+00:00",
+          }
         end
-      end
 
-      def stub_worldwide_api_has_selection_of_locations
-        stub_worldwide_api_has_locations %w[
-          afghanistan
-          angola
-          australia
-          bahamas
-          belarus
-          brazil
-          brunei
-          cambodia
-          chad
-          croatia
-          denmark
-          eritrea
-          france
-          ghana
-          iceland
-          japan
-          laos
-          luxembourg
-          malta
-          micronesia
-          mozambique
-          nicaragua
-          panama
-          portugal
-          sao-tome-and-principe
-          singapore
-          south-korea
-          sri-lanka
-          uk-delegation-to-council-of-europe
-          uk-delegation-to-organization-for-security-and-co-operation-in-europe
-          united-kingdom
-          venezuela
-          vietnam
-        ]
-      end
+        content_item = {
+          "details": {
+            "international_delegation": international_delegations,
+            "world_locations": world_locations,
+          },
+        }
 
-      def stub_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)
+        stub_request(:get, "#{WORLDWIDE_API_ENDPOINT}/api/content/world")
+            .to_return(status: 200, body: content_item.to_json)
       end
 
-      def stub_worldwide_api_does_not_have_location(location_slug)
-        stub_request(:get, "#{WORLDWIDE_API_ENDPOINT}/api/world-locations/#{location_slug}").to_return(status: 404)
+      def stub_worldwide_api_has_location(location_slug)
+        stub_worldwide_api_has_locations([location_slug])
       end
 
       def stub_worldwide_api_has_organisations_for_location(location_slug, json_or_hash)
@@ -112,33 +65,6 @@ module GdsApi
         stub_request(:get, url)
           .to_return(status: 200, body: details.to_json, headers: { "Link" => "<#{url}; rel\"self\"" })
       end
-
-      def world_location_for_slug(slug)
-        singular_response_base.merge(world_location_details_for_slug(slug))
-      end
-
-      # Constructs a sample world_location
-      #
-      # if the slug contains 'delegation' or 'mission' the format will be set to 'International delegation'
-      # othersiwe it will be set to 'World location'
-      def world_location_details_for_slug(slug)
-        {
-          "id" => "https://www.gov.uk/api/world-locations/#{slug}",
-          "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}",
-          "details" => {
-            "slug" => slug,
-            "iso2" => slug[0..1].upcase,
-          },
-          "organisations" => {
-            "id" => "https://www.gov.uk/api/world-locations/#{slug}/organisations",
-            "web_url" => "https://www.gov.uk/government/world/#{slug}#organisations",
-          },
-          "content_id" => "content_id_for_#{slug}",
-        }
-      end
     end
   end
 end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = "88.1.0".freeze
+  VERSION = "89.0.0".freeze
 end

data/lib/gds_api/worldwide.rb

@@ -2,11 +2,17 @@ require_relative "base"
 
 class GdsApi::Worldwide < GdsApi::Base
   def world_locations
-    get_list("#{base_url}/world-locations")
+    all_world_locations
   end
 
   def world_location(location_slug)
-    get_json("#{base_url}/world-locations/#{location_slug}")
+    world_location = all_world_locations.find do |location|
+      location.dig("details", "slug") == location_slug
+    end
+
+    raise GdsApi::HTTPNotFound, 404 unless world_location
+
+    world_location
   end
 
   def organisations_for_world_location(location_slug)
@@ -18,4 +24,35 @@ private
   def base_url
     "#{endpoint}/api"
   end
+
+  def all_world_locations
+    content_item = JSON.parse(get_raw("#{base_url}/content/world"))
+
+    world_locations = format_locations(content_item.dig("details", "world_locations"), "World location")
+    international_delegations = format_locations(content_item.dig("details", "international_delegations"), "International delegation")
+
+    Array(world_locations) + Array(international_delegations)
+  end
+
+  def format_locations(locations, type)
+    locations&.map do |location|
+      {
+        "id" => "#{Plek.new.website_root}/world/#{location['slug']}",
+        "title" => location["name"],
+        "format" => type,
+        "updated_at" => location["updated_at"],
+        "web_url" => "#{Plek.new.website_root}/world/#{location['slug']}",
+        "analytics_identifier" => location["analytics_identifier"],
+        "details" => {
+          "slug" => location["slug"],
+          "iso2" => location["iso2"],
+        },
+        "organisations" => {
+          "id" => "#{Plek.new.website_root}/world/#{location['slug']}#organisations",
+          "web_url" => "#{Plek.new.website_root}/world/#{location['slug']}#organisations",
+        },
+        "content_id" => location["content_id"],
+      }
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 88.1.0
+  version: 89.0.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-30 00:00:00.000000000 Z
+date: 2023-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -268,14 +268,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.10.0
+        version: 4.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.10.0
+        version: 4.11.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -417,7 +417,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.13
+rubygems_version: 3.4.17
 signing_key: 
 specification_version: 4
 summary: Adapters to work with GDS APIs