gds-api-adapters 96.0.1 → 96.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97f27ebc485a71a0b76119ca9e0f8b4544b6da2e77f74730ac7a641c7056fa12
-  data.tar.gz: 716e69344154e3cc0bed94ac564f9e1aa598f5b51c86873dc60d61d2449f8b23
+  metadata.gz: 3182c86f70e20b3d92c0cf4f28f63a487e343dff7394d41de0f0953b51fde3fa
+  data.tar.gz: 2e31481af69353c207b13cc4e94c6e59a7f151c94c5eda22d5b2a0d0c4ef86ef
 SHA512:
-  metadata.gz: 3943261403391e42f4ff59e0eade97bcb45830e69bf8b267e7b9b9da73019c8344d59ddcbc3ea10e766ca299bbe0a900ba8528a60e021fa7b0cdd3c098c53e65
-  data.tar.gz: f518c237981c112048dfc205cfe8f3cdd57c4ae3398bbb0917e1b1b4e556e4da1e99099b9f2f31cb5783c564c01b62d7ee6f2254cf76ff75c84b9a1242687e23
+  metadata.gz: 3b4d1743e125d8d1d8928fc7d4bc705fee3dd0eae19342d75d5c07f28dcea2590f8986efc3fd4671885ad610c311cf88deb62bccecd580cef39c3231cbe93834
+  data.tar.gz: a3a01fd52aa66cf83a346c90a025fa7972aee550f19f81de5ff3d033d98415101cf900a2e3e455286e245675a6aaa85ed7a3c1c93a6ac974355cb59eadac4845

data/lib/gds_api/publishing_api.rb

@@ -337,6 +337,22 @@ class GdsApi::PublishingApi < GdsApi::Base
     get_json("#{endpoint}/v2/content#{query}")
   end
 
+  # Get content items which embed a reusable content_id
+  #
+  # No params are currently permitted.
+  #
+  # @example
+  #
+  #   publishing_api.get_content_by_embedded_document("4b148ebc-b2bb-40db-8e48-dd8cff363ff7")
+  #
+  # @return [GdsApi::Response] A response containing a summarised list of the content items which embed the target.
+  # The content items returned will be in either the draft of published state.
+  #
+  # @see https://github.com/alphagov/publishing-api/blob/main/docs/api.md#get-v2contentcontent_idembedded
+  def get_content_by_embedded_document(content_id)
+    get_json("#{endpoint}/v2/content/#{content_id}/embedded")
+  end
+
   # Returns an Enumerator of content items for the provided
   # query string parameters.
   #
@@ -487,6 +503,53 @@ class GdsApi::PublishingApi < GdsApi::Base
     e
   end
 
+  # Get all schemas
+  #
+  # @return [GdsApi::Response] A map of schema names with JSON schemas.
+  #
+  # @example
+  #
+  #   publishing_api.get_schemas()
+  #     # => {
+  #       "email_address" => {
+  #           "type": "email_address",
+  #           "required": ["email"],
+  #           "properties": {
+  #             "email": { "type" => "string" },
+  #           },
+  #         }
+  #     }
+  #
+  # @see https://github.com/alphagov/publishing-api/blob/main/docs/api.md#get-v2schemas
+  def get_schemas
+    get_json("#{endpoint}/v2/schemas").to_hash
+  end
+
+  # Get a content schema by name
+  #
+  # @param schema_name [String]
+  #
+  # @return [GdsApi::Response] A response mapping schema name with JSON schema.
+  #
+  # @example
+  #
+  #   publishing_api.get_schema("email_address")
+  #     # => {
+  #       "email_address" => {
+  #           "type": "email_address",
+  #           "required": ["email"],
+  #           "properties": {
+  #             "email": { "type" => "string" },
+  #           },
+  #         }
+  #     }
+  #
+  # @raise [HTTPNotFound] when the schema is not found
+  # @see https://github.com/alphagov/publishing-api/blob/main/docs/api.md#get-v2schemasschema_name
+  def get_schema(schema_name)
+    get_json("#{endpoint}/v2/schemas/#{schema_name}").to_hash
+  end
+
 private
 
   def content_url(content_id, params = {})

data/lib/gds_api/support_api.rb

@@ -22,6 +22,22 @@ class GdsApi::SupportApi < GdsApi::Base
     post_json("#{endpoint}/anonymous-feedback/global-export-requests", global_export_request: request_details)
   end
 
+  # Raise a support ticket
+  # Makes a +POST+ request to support-api to create a new support ticket.
+  #
+  # @params params [Hash] Any attributes that relate to creating a new support ticket.
+
+  # @example
+  # SupportApi.raise_support_ticket(
+  #   subject: "Feedback for app",
+  #   tags: ["app_name"]
+  #   user_agent: "Safari",
+  #   description: "Ticket details go here.",
+  # )
+  def raise_support_ticket(params)
+    post_json("#{endpoint}/support-tickets", params)
+  end
+
   # Create a Page Improvement
   #
   # Makes a +POST+ request to the support api to create a Page Improvement.

data/lib/gds_api/test_helpers/publishing_api.rb

@@ -340,6 +340,43 @@ module GdsApi
           .to_return(status: 200, body: body.to_json, headers: {})
       end
 
+      # Stub GET /v2/content/:content_id/embedded to return a list of content items that embed the target content_id
+      #
+      # @example
+      #
+      #   stub_publishing_api_has_content_(
+      #     content_id: "9faacf5c-f4e6-4bf9-ba90-413e997c1f22" # this is the content_id for a reusable edition
+      #     total: 1 # the number of results returned
+      #     results: [{
+      #       "title" => "foo",
+      #       "document_type" => "document",
+      #       "base_path" => "/foo",
+      #       "content_id" => "e60fae2a-5490-4e2f-9e80-2093c47608d4",
+      #       "primary_publishing_organisation" => {
+      #         "content_id" => "7662e1e7-79f9-4d0a-b754-6232186851f6",
+      #         "title" => "bar",
+      #         "base_path" => "/organisation/bar",
+      #       },
+      #     }] # an array of content items that embed the target content_id
+      #   )
+      # @param content_id [UUID, Mocha::ParameterMatchers::Anything]
+      # @param total Integer
+      # @param params [Hash]
+      def stub_publishing_api_has_embedded_content(content_id:, total: 0, results: [])
+        url = if content_id.is_a?(Mocha::ParameterMatchers::Anything)
+                %r{\A#{PUBLISHING_API_V2_ENDPOINT}/content/[0-9a-fA-F-]{36}/embedded}
+              else
+                "#{PUBLISHING_API_V2_ENDPOINT}/content/#{content_id}/embedded"
+              end
+
+        stub_request(:get, url)
+          .to_return(body: {
+            "content_id" => content_id,
+            "total" => total,
+            "results" => results,
+          }.to_json)
+      end
+
       # 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 stub_publishing_api_has_fields_for_document(document_type, items, fields)
@@ -802,6 +839,59 @@ module GdsApi
                      body: { error: }.to_json)
       end
 
+      # Stub a request to get a schema by schema name
+      #
+      # @param [String] schema name
+      #
+      # @example
+      #   stub_publishing_api_has_schemas_for_schema_name(
+      #     "email_address",
+      #     { "email_address" =>  {
+      #         "type": "email_address",
+      #         "required": ["email"],
+      #         "properties": {
+      #           "email": { "type" => "string" },
+      #         },
+      #       },
+      #     }
+      #   )
+      def stub_publishing_api_has_schemas_for_schema_name(schema_name, schema)
+        url = "#{PUBLISHING_API_V2_ENDPOINT}/schemas/#{schema_name}"
+        stub_request(:get, url).to_return(status: 200, body: schema.to_json, headers: {})
+      end
+
+      def stub_publishing_api_schema_name_path_to_return_not_found(schema_name)
+        url = "#{PUBLISHING_API_V2_ENDPOINT}/schemas/#{schema_name}"
+        stub_request(:get, url).to_return(status: 404, headers: { "Content-Type" => "application/json; charset=utf-8" })
+      end
+
+      # Stub a request to get all schemas
+      #
+      #
+      # @example
+      #   stub_publishing_api_has_schemas(
+      #     {
+      #         "email_address" =>  {
+      #           "type": "email_address",
+      #           "required": ["email"],
+      #           "properties": {
+      #             "email": { "type" => "string" },
+      #           },
+      #         },
+      #         "tax_bracket" => {
+      #           "type": "tax_bracket",
+      #           "required": ["code"],
+      #           "properties": {
+      #             "code": { "type" => "string" },
+      #           },
+      #         }
+      #     }
+      #   )
+      def stub_publishing_api_has_schemas(schemas)
+        url = "#{PUBLISHING_API_V2_ENDPOINT}/schemas"
+        stub_request(:get, url).to_return(status: 200, body: schemas.to_json, headers: {})
+      end
+
     private
 
       def stub_publishing_api_put(*args)

data/lib/gds_api/test_helpers/support_api.rb

@@ -150,6 +150,18 @@ module GdsApi
           .to_return(status: 200, body: response_body.to_json)
       end
 
+      def stub_support_api_valid_raise_support_ticket(params)
+        post_stub = stub_http_request(:post, "#{SUPPORT_API_ENDPOINT}/support-tickets")
+        post_stub.with(body: params)
+        post_stub.to_return(status: 201, body: { status: "success" }.to_json)
+      end
+
+      def stub_support_api_invalid_raise_support_ticket(params)
+        post_stub = stub_http_request(:post, "#{SUPPORT_API_ENDPOINT}/support-tickets")
+        post_stub.with(body: params)
+        post_stub.to_return(status: 422, body: { status: "error" }.to_json)
+      end
+
       def stub_any_support_api_call
         stub_request(:any, %r{\A#{SUPPORT_API_ENDPOINT}})
       end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = "96.0.1".freeze
+  VERSION = "96.0.3".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 96.0.1
+  version: 96.0.3
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-21 00:00:00.000000000 Z
+date: 2024-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -268,14 +268,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.16.1
+        version: 5.0.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.16.1
+        version: 5.0.2
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -402,7 +402,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.10
+rubygems_version: 3.5.18
 signing_key: 
 specification_version: 4
 summary: Adapters to work with GDS APIs