gds-api-adapters 97.5.0 → 98.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1eb266c1aeb0bea17c497f8fc50f2c63acde3d912ac9912fee8ab5f75e98fde
-  data.tar.gz: d77d9241107d1c03ce40eed9c590819419475f8ba0e3b1a0b544ecc29c4a755e
+  metadata.gz: 4713a40baf4587862f28d5ab412bff34567eb2be929f81bf9f9946d119a978a3
+  data.tar.gz: 6c924fb31cdcc61d690f948b372d6c29b25cccd622431803b784755b5d89a138
 SHA512:
-  metadata.gz: 94266ef292952415ab4115c3725f11aacd433e26ee1c13ca21990be51c5b858d2bfa3a3857d26a311fcb60d429c7676f75331139870156348b7a6824185fe95e
-  data.tar.gz: d4227f9e0aaa8a3ac834bf2df109b560ba00bceb9186a2221421494f0bab4f611d75bc701982d1213a47dfbde809ad47c499381b2bf204b9f162dc0164a152c4
+  metadata.gz: 5c40c6142acf029075d1e2fb0438a53d62bde1a6ea7f3d4ab48c1e3381b444b2448cd3929f41e090bc96b9ffae7043e65f8cdb843b232a893191076177ad084a
+  data.tar.gz: b15571c36e56b8722eae8deb09562184b88e1b9dc626108517929d982cb91c3aaef8d75dd9a5237cddcfd8c8184994c6ef88b23c5eecbb852f0b8c5db6e833dd

data/lib/gds_api/publishing_api.rb

@@ -356,11 +356,46 @@ class GdsApi::PublishingApi < GdsApi::Base
     get_json("#{endpoint}/v2/content/#{content_id}/host-content#{query}")
   end
 
+  # Get a specific content item which embeds a reusable content_id
+  #
+  # @param content_id [UUID]
+  # @param host_content_id [UUID]
+  #
+  #   publishing_api.get_host_content_item_for_content_id(
+  #     "4b148ebc-b2bb-40db-8e48-dd8cff363ff7",
+  #     "10d91dd1-cc9d-4c4c-9540-219ebb8d4501",
+  #   )
+  #
+  # @return [GdsApi::Response] A response containing the content item which embeds the target.
+  #
+  # @see https://github.com/alphagov/publishing-api/blob/main/docs/api.md#get-v2contentcontent_idhost-contenthost_content_id
+  def get_host_content_item_for_content_id(content_id, host_content_id)
+    get_json("#{endpoint}/v2/content/#{content_id}/host-content/#{host_content_id}")
+  end
+
   def get_content_by_embedded_document(content_id, params = {})
     warn "GdsAPI::PublishingApi: #get_content_by_embedded_document deprecated (please use #get_host_content_for_content_id)"
     get_host_content_for_content_id(content_id, params)
   end
 
+  # Get events for a specific content_id
+  #
+  # @param content_id [UUID]
+  # @param params [Hash]
+  #
+  #  publishing_api.get_events_for_content_id(
+  #     "7ac47b33-c09c-4c1d-a9a7-0cfef99081ac",
+  #     { action: "PutContent", from: "2023-01-01T00:00:00Z", to: "2023-01-05T10:00:00Z" }
+  #  )
+  #
+  # @return [GdsApi::Response] A response containing a list of events for that content ID
+  #
+  # @see https://github.com/alphagov/publishing-api/blob/main/docs/api.md#get-v2contentcontent_idevents
+  def get_events_for_content_id(content_id, params = {})
+    query = query_string(params)
+    get_json("#{endpoint}/v2/content/#{content_id}/events#{query}")
+  end
+
   # Returns an Enumerator of content items for the provided
   # query string parameters.
   #

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = "97.5.0".freeze
+  VERSION = "98.0.0".freeze
 end

data/lib/gds_api.rb

@@ -14,7 +14,6 @@ require "gds_api/locations_api"
 require "gds_api/maslow"
 require "gds_api/organisations"
 require "gds_api/publishing_api"
-require "gds_api/router"
 require "gds_api/search"
 require "gds_api/search_api_v2"
 require "gds_api/support"
@@ -155,19 +154,6 @@ module GdsApi
     )
   end
 
-  # Creates a GdsApi::Router adapter for communicating with Router API
-  #
-  # This will set a bearer token if a ROUTER_API_BEARER_TOKEN environment
-  # variable is set
-  #
-  # @return [GdsApi::Router]
-  def self.router(options = {})
-    GdsApi::Router.new(
-      Plek.find("router-api"),
-      { bearer_token: ENV["ROUTER_API_BEARER_TOKEN"] }.merge(options),
-    )
-  end
-
   # Creates a GdsApi::Search adapter to access via a search.* hostname
   #
   # @return [GdsApi::Search]

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 97.5.0
+  version: 98.0.0
 platform: ruby
 authors:
 - GOV.UK Dev
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-12-03 00:00:00.000000000 Z
+date: 2024-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -268,14 +267,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.0.4
+        version: 5.0.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.0.4
+        version: 5.0.5
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -351,7 +350,6 @@ files:
 - lib/gds_api/publishing_api/special_route_publisher.rb
 - lib/gds_api/railtie.rb
 - lib/gds_api/response.rb
-- lib/gds_api/router.rb
 - lib/gds_api/search.rb
 - lib/gds_api/search_api_v2.rb
 - lib/gds_api/support.rb
@@ -371,7 +369,6 @@ files:
 - lib/gds_api/test_helpers/organisations.rb
 - lib/gds_api/test_helpers/places_manager.rb
 - lib/gds_api/test_helpers/publishing_api.rb
-- lib/gds_api/test_helpers/router.rb
 - lib/gds_api/test_helpers/search.rb
 - lib/gds_api/test_helpers/support_api.rb
 - lib/gds_api/test_helpers/worldwide.rb
@@ -387,7 +384,6 @@ files:
 homepage: http://github.com/alphagov/gds-api-adapters
 licenses: []
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -402,8 +398,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
-signing_key: 
+rubygems_version: 3.6.0
 specification_version: 4
 summary: Adapters to work with GDS APIs
 test_files: []

data/lib/gds_api/router.rb

@@ -1,62 +0,0 @@
-require_relative "base"
-
-class GdsApi::Router < GdsApi::Base
-  ### Backends
-
-  def get_backend(id)
-    get_json("#{endpoint}/backends/#{CGI.escape(id)}")
-  end
-
-  def add_backend(id, url)
-    put_json("#{endpoint}/backends/#{CGI.escape(id)}", backend: { backend_url: url })
-  end
-
-  def delete_backend(id)
-    delete_json("#{endpoint}/backends/#{CGI.escape(id)}")
-  end
-
-  ### Routes
-
-  def get_route(path)
-    get_json("#{endpoint}/routes?incoming_path=#{CGI.escape(path)}")
-  end
-
-  def add_route(path, type, backend_id)
-    put_json(
-      "#{endpoint}/routes",
-      route: {
-        incoming_path: path,
-        route_type: type,
-        handler: "backend",
-        backend_id:,
-      },
-    )
-  end
-
-  def add_redirect_route(path, type, destination, options = {})
-    put_json(
-      "#{endpoint}/routes",
-      route: {
-        incoming_path: path,
-        route_type: type,
-        handler: "redirect",
-        redirect_to: destination,
-        segments_mode: options[:segments_mode],
-      },
-    )
-  end
-
-  def add_gone_route(path, type)
-    put_json(
-      "#{endpoint}/routes",
-      route: { incoming_path: path, route_type: type, handler: "gone" },
-    )
-  end
-
-  def delete_route(path, hard_delete: false)
-    url = "#{endpoint}/routes?incoming_path=#{CGI.escape(path)}"
-    url += "&hard_delete=true" if hard_delete
-
-    delete_json(url)
-  end
-end

data/lib/gds_api/test_helpers/router.rb

@@ -1,94 +0,0 @@
-require "gds_api/test_helpers/json_client_helper"
-
-module GdsApi
-  module TestHelpers
-    module Router
-      ROUTER_API_ENDPOINT = Plek.find("router-api")
-
-      def stub_router_has_route(path, route, bearer_token = ENV["ROUTER_API_BEARER_TOKEN"])
-        stub_get_route(path, bearer_token).to_return(
-          status: 200,
-          body: route.to_json,
-          headers: { "Content-Type" => "application/json" },
-        )
-      end
-
-      def stub_router_doesnt_have_route(path, bearer_token = ENV["ROUTER_API_BEARER_TOKEN"])
-        stub_get_route(path, bearer_token).to_return(status: 404)
-      end
-
-      def stub_router_has_backend_route(path, backend_id:, route_type: "exact", disabled: false)
-        stub_router_has_route(path, handler: "backend", backend_id:, disabled:, route_type:)
-      end
-
-      def stub_router_has_redirect_route(path, redirect_to:, route_type: "exact", disabled: false)
-        stub_router_has_route(path, handler: "redirect", redirect_to:, disabled:, route_type:)
-      end
-
-      def stub_router_has_gone_route(path, route_type: "exact", disabled: false)
-        stub_router_has_route(path, handler: "gone", route_type:, disabled:)
-      end
-
-      def stub_all_router_registration
-        stub_request(:put, %r{\A#{ROUTER_API_ENDPOINT}/backends/[a-z0-9-]+\z})
-        stub_request(:put, "#{ROUTER_API_ENDPOINT}/routes")
-      end
-
-      def stub_router_backend_registration(backend_id, 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)
-      end
-
-      def stub_route_registration(path, type, backend_id)
-        stub_route_put({
-          route: {
-            incoming_path: path,
-            route_type: type,
-            handler: "backend",
-            backend_id:,
-          },
-        })
-      end
-
-      def stub_redirect_registration(path, type, destination, segments_mode = nil)
-        stub_route_put({
-          route: {
-            incoming_path: path,
-            route_type: type,
-            handler: "redirect",
-            redirect_to: destination,
-            segments_mode:,
-          },
-        })
-      end
-
-      def stub_gone_route_registration(path, type)
-        stub_route_put({
-          route: {
-            incoming_path: path,
-            route_type: type,
-            handler: "gone",
-          },
-        })
-      end
-
-    private
-
-      def stub_get_route(path, bearer_token)
-        stub_http_request(:get, "#{ROUTER_API_ENDPOINT}/routes")
-          .with(
-            query: { "incoming_path" => path },
-            headers: { "Authorization" => "Bearer #{bearer_token}" },
-          )
-      end
-
-      def stub_route_put(route)
-        stub_http_request(:put, "#{ROUTER_API_ENDPOINT}/routes")
-            .with(body: route.to_json)
-            .to_return(status: 201)
-      end
-    end
-  end
-end