gds-api-adapters 97.6.0 → 98.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 546bac9e86b385628f50ab89c8bc1f619fe7517f4cecea5d1ca373c1df2fe7c3
-  data.tar.gz: 1f51515b81f17c573cf1c69b1c15cc5dbc3e59d6af20ce48d00b3819ae7e5857
+  metadata.gz: b2b9f52394507921888ca9abe107c764de4af4da163dc2609f9909559f31e288
+  data.tar.gz: 94ff2e4bfb6f7a6b015e0049f82bc609cdbe416ee6355fdcc757b3d8d3177668
 SHA512:
-  metadata.gz: e0ffc11729c1b4a907eaa57d777c862b481bcbd64570aa0d4b2135d0d0bf012761df48afcc96527631d7bd4a4980d0c5b24a516e16d56d744ac5e8d360b927f0
-  data.tar.gz: 6c63c18fe23adced762bdf531ffd304d61cb3631617229bed9171052306676a1b5779453608b682e847183558db38e2a0235298b0694143825cc477cc4213a65
+  metadata.gz: b1cdf84bd90af029ea2c0ca24cc091cdc3b69b9c261ee6ec2632b4587e4c7db454fb56de499d0e499b110ac39567c013313f6ee6440368fe46dbf67f0ed07e74
+  data.tar.gz: 53ad365fffa3ac456e7e77412c986af8e6403dabb63c571a3327db5ac16fbcf573605d901c8ca29bf6cea9f1e9573320299c8e40050a0d7d9e4ea17ec2ca73b3

data/lib/gds_api/json_client.rb

@@ -52,8 +52,8 @@ module GdsApi
       do_json_request(:get, url, nil, additional_headers, &create_response)
     end
 
-    def post_json(url, params = {}, additional_headers = {})
-      do_json_request(:post, url, params, additional_headers)
+    def post_json(url, params = {}, additional_headers = {}, &create_response)
+      do_json_request(:post, url, params, additional_headers, &create_response)
     end
 
     def put_json(url, params, additional_headers = {})

data/lib/gds_api/publishing_api.rb

@@ -378,6 +378,24 @@ class GdsApi::PublishingApi < GdsApi::Base
     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.
   #
@@ -584,6 +602,25 @@ class GdsApi::PublishingApi < GdsApi::Base
     post_json("#{endpoint}/graphql", query:)
   end
 
+  # Make a GraphQL query and return the response in the same format as a Content Store content item
+  #
+  # @param query [String]
+  #
+  # @return [GdsApi::Response] A response with the result of the GraphQL query formatted like a Content Store content item.
+  def graphql_content_item(query)
+    create_response = proc do |r|
+      updated_body = JSON.parse(r.body).dig("data", "edition")
+      updated_response = RestClient::Response.create(
+        updated_body.to_json,
+        r.net_http_res,
+        r.request,
+      )
+      GdsApi::Response.new(updated_response)
+    end
+
+    post_json("#{endpoint}/graphql", query:, &create_response)
+  end
+
 private
 
   def content_url(content_id, params = {})

data/lib/gds_api/test_helpers/publishing_api.rb

@@ -201,6 +201,19 @@ module GdsApi
         stub_request(:post, url).with(body: { query: }).to_return(response)
       end
 
+      # Stub a POST /graphql content item request
+      #
+      # @param query [String]
+      def stub_publishing_api_graphql_content_item(query, response_hash = {})
+        url = "#{PUBLISHING_API_ENDPOINT}/graphql"
+        response = {
+          status: 200,
+          body: response_hash.to_json,
+          headers: { "Content-Type" => "application/json; charset=utf-8" },
+        }
+        stub_request(:post, url).with(body: { query: }).to_return(response)
+      end
+
       # Assert that a draft was saved and published, and links were updated.
       # - PUT /v2/content/:content_id
       # - POST /v2/content/:content_id/publish

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = "97.6.0".freeze
+  VERSION = "98.1.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.6.0
+  version: 98.1.0
 platform: ruby
 authors:
 - GOV.UK Dev
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-12-09 00:00:00.000000000 Z
+date: 2024-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -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.1
 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