gds-api-adapters 96.0.0 → 96.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ab536f0fbe0e60f60edea9d2b153f7c7db489571459b2d87d355d4d31a4f21d
-  data.tar.gz: 0c14e46d9e034a2e18a8c2a8a89b77998cfe9da6d33b7475af87309ea4a9faa6
+  metadata.gz: dc4d5293f2005f19ecf4e118705f8dada987a1dcc7d6a100ee750402d5d3ca2f
+  data.tar.gz: 90b47aa245e497c7d652fc1b2885af98438b69b704b8f7cb229b9960492426e2
 SHA512:
-  metadata.gz: eed5df27e224986a79a0f64e93f130a88e1bac77917ad58b686173a1363ac688b3409831a12ca4f80adbc6183a885a38d1d84e3497e8e9823b52256e13f19c25
-  data.tar.gz: 663b024e797914e9b490b14f278aea5f9071c5fd9429e7e1ab764711f0dcb47a7d61ffcf0085eccfd0f9fac4909a17c0a3e2f006e6c0da8b7ca900a1b53cc75b
+  metadata.gz: f2bfe2f375887428b7f29dd888bce619900f0ff8f0c3d51d37fe7771a5282492ad54f584022ac28d4a2e7901c015cb9968c00b15d611b0915302027a27cc1e96
+  data.tar.gz: 3c5ef5415b155090e5c763d5c9087b8b1f2e7db181d558aba488bdcb35a548113d221a6330245999c3e6ea1d2665ef675e84d9efc9924158bd044ecaf1f659f6

data/lib/gds_api/publishing_api.rb

@@ -487,6 +487,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

@@ -802,6 +802,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.0".freeze
+  VERSION = "96.0.2".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 96.0.0
+  version: 96.0.2
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-09 00:00:00.000000000 Z
+date: 2024-06-25 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: 4.18.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.16.1
+        version: 4.18.0
 - !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.14
 signing_key: 
 specification_version: 4
 summary: Adapters to work with GDS APIs