rfc-api-problem 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a19ce32dc8342d753c5102259e58df1195f1f233a6a3cae3c83399e8cfa192c0
+  data.tar.gz: 84a471cfc3b1c53ea7a58d49f4de6f67878da29f2977823cf597ec32e083d782
+SHA512:
+  metadata.gz: 58a62a1bf5bd36959f083f69c652f21a5428c1d99abba82298c2f6413f1bbbac32f8eb712bc5634181be15262f6481d7580f511ba07f69fc0dc0d5d9dc4361fc
+  data.tar.gz: 07442fe2e26b1b882b38c6305380f5f4f9544a6cbed601c915d1b1292ef99c632c5e77cfec65640a6e878472b08d23d69546f1641592b2c3c8ea78164d7b329f

data/LICENSE.adoc

@@ -0,0 +1,134 @@
+= Hippocratic License
+
+Version: 2.1.0.
+
+Purpose. The purpose of this License is for the Licensor named above to
+permit the Licensee (as defined below) broad permission, if consistent
+with Human Rights Laws and Human Rights Principles (as each is defined
+below), to use and work with the Software (as defined below) within the
+full scope of Licensor’s copyright and patent rights, if any, in the
+Software, while ensuring attribution and protecting the Licensor from
+liability.
+
+Permission and Conditions. The Licensor grants permission by this
+license ("License"), free of charge, to the extent of Licensor’s
+rights under applicable copyright and patent law, to any person or
+entity (the "Licensee") obtaining a copy of this software and
+associated documentation files (the "Software"), to do everything with
+the Software that would otherwise infringe (i) the Licensor’s copyright
+in the Software or (ii) any patent claims to the Software that the
+Licensor can license or becomes able to license, subject to all of the
+following terms and conditions:
+
+* Acceptance. This License is automatically offered to every person and
+entity subject to its terms and conditions. Licensee accepts this
+License and agrees to its terms and conditions by taking any action with
+the Software that, absent this License, would infringe any intellectual
+property right held by Licensor.
+* Notice. Licensee must ensure that everyone who gets a copy of any part
+of this Software from Licensee, with or without changes, also receives
+the License and the above copyright notice (and if included by the
+Licensor, patent, trademark and attribution notice). Licensee must cause
+any modified versions of the Software to carry prominent notices stating
+that Licensee changed the Software. For clarity, although Licensee is
+free to create modifications of the Software and distribute only the
+modified portion created by Licensee with additional or different terms,
+the portion of the Software not modified must be distributed pursuant to
+this License. If anyone notifies Licensee in writing that Licensee has
+not complied with this Notice section, Licensee can keep this License by
+taking all practical steps to comply within 30 days after the notice. If
+Licensee does not do so, Licensee’s License (and all rights licensed
+hereunder) shall end immediately.
+* Compliance with Human Rights Principles and Human Rights Laws.
+[arabic]
+. Human Rights Principles.
+[loweralpha]
+.. Licensee is advised to consult the articles of the United Nations
+Universal Declaration of Human Rights and the United Nations Global
+Compact that define recognized principles of international human rights
+(the "Human Rights Principles"). Licensee shall use the Software in a
+manner consistent with Human Rights Principles.
+.. Unless the Licensor and Licensee agree otherwise, any dispute,
+controversy, or claim arising out of or relating to (i) Section 1(a)
+regarding Human Rights Principles, including the breach of Section 1(a),
+termination of this License for breach of the Human Rights Principles,
+or invalidity of Section 1(a) or (ii) a determination of whether any Law
+is consistent or in conflict with Human Rights Principles pursuant to
+Section 2, below, shall be settled by arbitration in accordance with the
+Hague Rules on Business and Human Rights Arbitration (the "Rules");
+provided, however, that Licensee may elect not to participate in such
+arbitration, in which event this License (and all rights licensed
+hereunder) shall end immediately. The number of arbitrators shall be one
+unless the Rules require otherwise.
++
+Unless both the Licensor and Licensee agree to the contrary: (1) All
+documents and information concerning the arbitration shall be public and
+may be disclosed by any party; (2) The repository referred to under
+Article 43 of the Rules shall make available to the public in a timely
+manner all documents concerning the arbitration which are communicated
+to it, including all submissions of the parties, all evidence admitted
+into the record of the proceedings, all transcripts or other recordings
+of hearings and all orders, decisions and awards of the arbitral
+tribunal, subject only to the arbitral tribunal’s powers to take such
+measures as may be necessary to safeguard the integrity of the arbitral
+process pursuant to Articles 18, 33, 41 and 42 of the Rules; and (3)
+Article 26(6) of the Rules shall not apply.
+. Human Rights Laws. The Software shall not be used by any person or
+entity for any systems, activities, or other uses that violate any Human
+Rights Laws. "Human Rights Laws" means any applicable laws,
+regulations, or rules (collectively, "Laws") that protect human,
+civil, labor, privacy, political, environmental, security, economic, due
+process, or similar rights; provided, however, that such Laws are
+consistent and not in conflict with Human Rights Principles (a dispute
+over the consistency or a conflict between Laws and Human Rights
+Principles shall be determined by arbitration as stated above). Where
+the Human Rights Laws of more than one jurisdiction are applicable or in
+conflict with respect to the use of the Software, the Human Rights Laws
+that are most protective of the individuals or groups harmed shall
+apply.
+. Indemnity. Licensee shall hold harmless and indemnify Licensor (and
+any other contributor) against all losses, damages, liabilities,
+deficiencies, claims, actions, judgments, settlements, interest, awards,
+penalties, fines, costs, or expenses of whatever kind, including
+Licensor’s reasonable attorneys’ fees, arising out of or relating to
+Licensee’s use of the Software in violation of Human Rights Laws or
+Human Rights Principles.
+* Failure to Comply. Any failure of Licensee to act according to the
+terms and conditions of this License is both a breach of the License and
+an infringement of the intellectual property rights of the Licensor
+(subject to exceptions under Laws, e.g., fair use). In the event of a
+breach or infringement, the terms and conditions of this License may be
+enforced by Licensor under the Laws of any jurisdiction to which
+Licensee is subject. Licensee also agrees that the Licensor may enforce
+the terms and conditions of this License against Licensee through
+specific performance (or similar remedy under Laws) to the extent
+permitted by Laws. For clarity, except in the event of a breach of this
+License, infringement, or as otherwise stated in this License, Licensor
+may not terminate this License with Licensee.
+* Enforceability and Interpretation. If any term or provision of this
+License is determined to be invalid, illegal, or unenforceable by a
+court of competent jurisdiction, then such invalidity, illegality, or
+unenforceability shall not affect any other term or provision of this
+License or invalidate or render unenforceable such term or provision in
+any other jurisdiction; provided, however, subject to a court
+modification pursuant to the immediately following sentence, if any term
+or provision of this License pertaining to Human Rights Laws or Human
+Rights Principles is deemed invalid, illegal, or unenforceable against
+Licensee by a court of competent jurisdiction, all rights in the
+Software granted to Licensee shall be deemed null and void as between
+Licensor and Licensee. Upon a determination that any term or provision
+is invalid, illegal, or unenforceable, to the extent permitted by Laws,
+the court may modify this License to affect the original purpose that
+the Software be used in compliance with Human Rights Principles and
+Human Rights Laws as closely as possible. The language in this License
+shall be interpreted as to its fair meaning and not strictly for or
+against any party.
+* Disclaimer. TO THE FULL EXTENT ALLOWED BY LAW, THIS SOFTWARE COMES
+"AS IS," WITHOUT ANY WARRANTY, EXPRESS OR IMPLIED, AND LICENSOR AND
+ANY OTHER CONTRIBUTOR SHALL NOT BE LIABLE TO ANYONE FOR ANY DAMAGES OR
+OTHER LIABILITY ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE
+OR THIS LICENSE, UNDER ANY KIND OF LEGAL CLAIM.
+
+This Hippocratic License is an link:https://ethicalsource.dev[Ethical Source license] and is offered
+for use by licensors and licensees at their own risk, on an "AS IS" basis, and with no warranties
+express or implied, to the maximum extent permitted by Laws.

data/README.adoc

@@ -0,0 +1,461 @@
+:toc: macro
+:toclevels: 5
+:figure-caption!:
+
+:data_link: link:https://alchemists.io/articles/ruby_data[Data]
+:rfc_9457_link: link:https://www.rfc-editor.org/rfc/rfc9457[RFC 9457]
+
+= RFC API Problem
+
+RFC API Problem implements {rfc_9457_link}: Problem Details for HTTP APIs. This allows you to produce HTTP error responses that are structured, machine readable, and consistent.
+
+toc::[]
+
+== Features
+
+* Provides JSON and XML serialization and deserialization.
+* Provides HTTP header and media type support.
+
+== Requirements
+
+. link:https://www.ruby-lang.org[Ruby].
+
+== Setup
+
+To install _with_ security, run:
+
+[source,bash]
+----
+# 💡 Skip this line if you already have the public certificate installed.
+gem cert --add <(curl --compressed --location https://alchemists.io/gems.pem)
+gem install rfc-api-problem --trust-policy HighSecurity
+----
+
+To install _without_ security, run:
+
+[source,bash]
+----
+gem install rfc-api-problem
+----
+
+You can also add the gem directly to your project:
+
+[source,bash]
+----
+bundle add rfc-api-problem
+----
+
+Once the gem is installed, you only need to require it:
+
+[source,ruby]
+----
+require "rfc/api/problem"
+----
+
+== Usage
+
+The quickest way to get started is to create a new instance and then cast as JSON or XML:
+
+[source,ruby]
+----
+payload = RFC::API::Problem[
+  type: "https://demo.io/problem_details/timeout",
+  status: 413,
+  detail: "You've exceeded the 5MB upload limit.",
+  instance: "/profile/3a1bfd54-ae6c-4a61-8d0d-90c132428dc3"
+]
+
+payload.to_json
+
+# {
+#   "type" => "https://demo.io/problem_details/timeout",
+#   "title" => "Content Too Large",
+#   "status" => 413,
+#   "detail" => "You've exceeded the 5MB upload limit.",
+#   "instance" => "/profile/3a1bfd54-ae6c-4a61-8d0d-90c132428dc3"
+# }
+
+payload.to_xml
+
+# <?xml version='1.0' encoding='UTF-8'?>
+# <problem xmlns='urn:ietf:rfc:7807'>
+#   <type>https://demo.io/problem_details/timeout</type>
+#   <title>Content Too Large</title>
+#   <status>413</status>
+#   <detail>You&apos;ve exceeded the 5MB upload limit.</detail>
+#   <instance>/profile/3a1bfd54-ae6c-4a61-8d0d-90c132428dc3</instance>
+# </problem>
+----
+
+💡 You can also use `RFC::API::Problem.new` to create instances if you don't like `RFC::API::Problem.[]`, as shown above, but `.[]` is preferred.
+
+=== Members
+
+As briefly shown above, the minimum members (attributes) that make up problem details are:
+
+* `type` (optional): The full (or relative) URI that links to additional documentation. Default: `"about:blank"`.
+* `status` (optional): The link:https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status[HTTP status code] (or symbol) that must match your HTTP status code. Default: `nil`.
+* `title` (optional): The HTTP status label that must match your HTTP status code label. Default: HTTP status label (dynamically computed based on code unless overwritten).
+* `detail` (optional): The human readable reason for the error (should not include debugging information). Default: `nil`.
+* `instance` (optional): The full (or relative) URI that represents the cause of the error. Default: `nil`.
+* `extensions` (optional): A free form hash of additional details. Default: `{}`.
+
+=== Media Types
+
+For convenience, you can obtain the necessary media types for your HTTP headers as follows:
+
+[source,ruby]
+----
+RFC::API::Problem::MEDIA_TYPE_JSON  # "application/problem+json"
+RFC::API::Problem::MEDIA_TYPE_XML   # "application/problem+xml"
+
+RFC::API::Problem.media_type_for :json  # "application/problem+json"
+RFC::API::Problem.media_type_for :xml   # "application/problem+xml"
+----
+
+=== Payload
+
+You'll always get a `RFC::API::Problem::Payload` object answered back when using `RFC::API::Problem.[]` or `RFC::API::Problem.new` for which you can cast to JSON, XML, and other types. There are few conveniences provided for you when constructing a new payload. For instance, you can also use status to set default title:
+
+[source,ruby]
+----
+RFC::API::Problem[status: 413]
+
+# #<data RFC::API::Problem::Payload:0x00002950
+#   detail = nil,
+#   extensions = {},
+#   instance = nil,
+#   status = 413,
+#   title = "Content Too Large",
+#   type = "about:blank"
+# >
+----
+
+Notice that standard HTTP 413 title of "Content Too Large" is provided for you but only if you don't supply a title. This works for symbols too. Example:
+
+[source,ruby]
+----
+RFC::API::Problem[status: :bad_request]
+
+# #<data RFC::API::Problem::Payload:0x00002970
+#   detail = nil,
+#   extensions = {},
+#   instance = nil,
+#   status = 400,
+#   title = "Bad Request",
+#   type = "about:blank"
+# >
+----
+
+This is similar to the above, but notice the status is cast to an integer while the title is also populated for you. Using either an integer or symbol for the HTTP status is handy for situations where you don't need a custom title and prefer the default HTTP title.
+
+Due to the payload being a {data_link} object, you have all of the standard methods available to you which are frozen by default. That said, you can still add or check for extensions after the fact. Example:
+
+[source,]
+----
+payload = RFC::API::Problem[status: :forbidden]
+
+payload.add_extension(:account, "/accounts/1")
+       .add_extension(:balance, 50)
+
+# #<data RFC::API::Problem::Payload:0x000029a0
+#   detail = nil,
+#   extensions = {
+#     account: "/accounts/1",
+#     balance: 50
+#   },
+#   instance = nil,
+#   status = 403,
+#   title = "Forbidden",
+#   type = "about:blank"
+# >
+----
+
+Given the above, you can also check if an extension exists:
+
+[source,ruby]
+----
+payload.extension? :account  # true
+payload.extension? :bogus    # false
+----
+
+=== JSON
+
+Both serialization and deserialization of JSON is supported. For example, given the following payload:
+
+[source,ruby]
+----
+payload = RFC::API::Problem[
+  type: "https://demo.io/problem_details/out_of_credit",
+  title: "You do not have enough credit.",
+  status: 403,
+  detail: "Your current balance is 30, but that costs 50.",
+  instance: "/accounts/1",
+  extensions: {
+    balance: 30,
+    accounts: %w[/accounts/1 /accounts/10]
+  }
+]
+----
+
+This means you can serialize as follows:
+
+[source,ruby]
+----
+payload.to_json
+
+# "{\"type\":\"https://demo.io/problem_details/out_of_credit\",\"title\":\"You do not have enough credit.\",\"status\":403,\"detail\":\"Your current balance is 30, but that costs 50.\",\"instance\":\"/accounts/1\",\"balance\":30,\"accounts\":[\"/accounts/1\",\"/accounts/10\"]}"
+
+payload.to_json indent: "  ", space: " ", object_nl: "\n", array_nl: "\n"
+
+# {
+#   "type": "https://demo.io/problem_details/out_of_credit",
+#   "title": "You do not have enough credit.",
+#   "status": 403,
+#   "detail": "Your current balance is 30, but that costs 50.",
+#   "instance": "/accounts/1",
+#   "balance": 30,
+#   "accounts": [
+#     "/accounts/1",
+#     "/accounts/10"
+#   ]
+# }
+----
+
+💡 All of the link:https://docs.ruby-lang.org/en/master/JSON.html#module-JSON-label-Output+Options[JSON] output options are available to you when casting to JSON.
+
+You can also deserialize by taking the result of the above and turning the raw JSON back into a `RFC::API::Problem::Payload`:
+
+[source,ruby]
+----
+RFC::API::Problem.from_json "{\"type\":\"https://demo.io/problem_details/out_of_credit\",\"title\":\"You do not have enough credit.\",\"status\":403,\"detail\":\"Your current balance is 30, but that costs 50.\",\"instance\":\"/accounts/1\",\"balance\":30,\"accounts\":[\"/accounts/1\",\"/accounts/10\"]}"
+
+# #<data RFC::API::Problem::Payload:0x00002d10
+#   detail = "Your current balance is 30, but that costs 50.",
+#   extensions = {
+#      balance: 30,
+#     accounts: [
+#       "/accounts/1",
+#       "/accounts/10"
+#     ]
+#   },
+#   instance = "/accounts/1",
+#   status = 403,
+#   title = "You do not have enough credit.",
+#   type = "https://demo.io/problem_details/out_of_credit"
+# >
+----
+
+=== XML
+
+XML is supported too but isn't as robust as JSON support, at the moment. This is mostly due to the fact that extensions can be deeply nested so your mileage may vary. For example, given the following payload:
+
+[source,ruby]
+----
+payload = RFC::API::Problem[
+  type: "https://demo.io/problem_details/out_of_credit",
+  title: "You do not have enough credit.",
+  status: 403,
+  detail: "Your current balance is 30, but that costs 50.",
+  instance: "/accounts/1",
+  extensions: {
+    balance: 30,
+    accounts: %w[/accounts/1 /accounts/10]
+  }
+]
+----
+
+This means you can serialize as follows:
+
+[source,ruby]
+----
+payload.to_xml
+# "<?xml version='1.0' encoding='UTF-8'?><problem xmlns='urn:ietf:rfc:7807'><type>https://demo.io/problem_details/out_of_credit</type><title>You do not have enough credit.</title><status>403</status><detail>Your current balance is 30, but that costs 50.</detail><instance>/accounts/1</instance><balance>30</balance><accounts><i>/accounts/1</i><i>/accounts/10</i></accounts></problem>"
+
+payload.to_xml indent: 2
+# <?xml version='1.0' encoding='UTF-8'?>
+# <problem xmlns='urn:ietf:rfc:7807'>
+#   <type>
+#     https://demo.io/problem_details/out_of_credit
+#   </type>
+#   <title>
+#     You do not have enough credit.
+#   </title>
+#   <status>
+#     403
+#   </status>
+#   <detail>
+#     Your current balance is 30, but that costs 50.
+#   </detail>
+#   <instance>
+#     /accounts/1
+#   </instance>
+#   <balance>
+#     30
+#   </balance>
+#   <accounts>
+#     <i>
+#       /accounts/1
+#     </i>
+#     <i>
+#       /accounts/10
+#     </i>
+#   </accounts>
+# </problem>
+----
+
+💡 All of the link:https://ruby.github.io/rexml/REXML/Document.html#method-i-write[REXML::Document.write] output options are available to you when casting to XML.
+
+You can also deserialize by taking the result of the above and turning the raw JSON back into a `RFC::API::Problem::Payload`:
+
+[source,ruby]
+----
+payload = RFC::API::Problem.from_xml <<~XML
+  <?xml version='1.0' encoding='UTF-8'?>
+  <problem xmlns='urn:ietf:rfc:7807'>
+    <type>https://demo.io/problem_details/out_of_credit</type>
+    <title>You do not have enough credit.</title>
+    <status>403</status>
+    <detail>Your current balance is 30, but that costs 50.</detail>
+    <instance>/accounts/1</instance>
+    <balance>30</balance>
+    <accounts>
+      <i>/accounts/1</i>
+      <i>/accounts/10</i>
+    </accounts>
+  </problem>
+XML
+
+# #<data RFC::API::Problem::Payload:0x00000940
+#   detail = "Your current balance is 30, but that costs 50.",
+#   extensions = {
+#      balance: "30",
+#     accounts: [
+#       "/accounts/1",
+#       "/accounts/10"
+#     ]
+#   },
+#   instance = "/accounts/1",
+#   status = 403,
+#   title = "You do not have enough credit.",
+#   type = "https://demo.io/problem_details/out_of_credit"
+# >
+----
+
+=== Examples
+
+There is a lot of useful information you can provide in your problem details depending on the context you are working in. Some have been shown above but here's a few more that might be of interest.
+
+==== HATEOAS
+
+With link:https://nordicapis.com/tools-to-make-hateoas-compliance-easier[HATEOAS], you can provide additional information and links for which the client can understand what next actions are available. The below example shows how you can provide additional resources for clients to adjust accordingly:
+
+[source,ruby]
+----
+RFC::API::Problem[
+  type: "https://demo.io/problem_details/rate_limit",
+  title: "Rate limit exceeded",
+  status: 429,
+  detail: "You have exceeded your rate limit of 150 requests per minute",
+  instance: "/articles",
+  extensions: {
+    retry_after: 5,
+    links: [
+      {
+        ref: "self",
+        href: "/articles"
+      },
+      {
+        rel: "retry",
+        href: "/articles",
+        title: "Retry after five minutes"
+      },
+      {
+        rel: "status",
+        href: "/statuses/rate_limit",
+        title: "Check current rate limit usage"
+      }
+    ]
+  }
+]
+----
+
+==== Semantic Structure
+
+In other situations, you might need a different structure in order to aid clients that might be AI driven which needs a semantically structured response in order to course correct. Example:
+
+[source,ruby]
+----
+RFC::API::Problem[
+  type: "https://demo.io/problem_details/invalid_field",
+  title: "Invalid field value",
+  status: 400,
+  detail: "The category requested doesn't exist",
+  instance: "/categories",
+  extensions: {
+    parameters: {
+      category_id: 123
+    },
+    suggestions: [
+      "ruby",
+      "git",
+      "htmx"
+    ]
+  }
+]
+----
+
+With the above, the client now knows what parameters where invalid along with relevant suggestions for proceeding. Even better, the suggestions implicitly show the types of IDs that are required.
+
+== Development
+
+To contribute, run:
+
+[source,bash]
+----
+git clone https://github.com/bkuhlmann/rfc-api-problem
+cd rfc-api-problem
+bin/setup
+----
+
+You can also use the IRB console for direct access to all objects:
+
+[source,bash]
+----
+bin/console
+----
+
+== Tests
+
+To test, run:
+
+[source,bash]
+----
+bin/rake
+----
+
+== Resources
+
+You can find additional resources here:
+
+* link:https://www.iana.org/assignments/http-problem-types/http-problem-types.xhtml[IANA Hypertext Transfer Protocol (HTTP) Problem Types]: A registered list of problem types you can use.
+* link:https://github.com/protocol-registries/http-problem-types[HTTP Problem Type Registration Requests]: Where you can register new problem types.
+
+== link:https://alchemists.io/policies/license[License]
+
+== link:https://alchemists.io/policies/security[Security]
+
+== link:https://alchemists.io/policies/code_of_conduct[Code of Conduct]
+
+== link:https://alchemists.io/policies/contributions[Contributions]
+
+== link:https://alchemists.io/policies/developer_certificate_of_origin[Developer Certificate of Origin]
+
+== link:https://alchemists.io/projects/rfc-api-problem/versions[Versions]
+
+== link:https://alchemists.io/community[Community]
+
+== Credits
+
+* Built with link:https://alchemists.io/projects/gemsmith[Gemsmith].
+* Engineered by link:https://alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].

data/lib/rfc/api/problem/payload.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require "json"
+require "rack/utils"
+require "rexml"
+
+module RFC
+  module API
+    module Problem
+      PRIMARY_KEYS = %i[title type status detail instance].freeze
+
+      # Models the problem details response payload.
+      Payload = Data.define(*PRIMARY_KEYS, :extensions) do
+        def self.for **attributes
+          status = attributes.delete(:status).then { Rack::Utils.status_code it if it }
+          title = attributes.delete(:title).then { it || Rack::Utils::HTTP_STATUS_CODES[status] }
+
+          new title:, status:, **attributes
+        end
+
+        def self.from_json body
+          attributes = JSON body, symbolize_names: true
+          extensions = attributes.reject { |key| PRIMARY_KEYS.include? key }
+
+          self.for(**attributes.slice(*PRIMARY_KEYS), extensions:)
+        end
+
+        # :reek:TooManyStatements
+        def self.from_xml body, deserializer: XML::Deserializer
+          elements = REXML::Document.new(body).root.elements
+
+          attributes = elements.each_with_object({extensions: {}}) do |element, collection|
+            name = element.name.to_sym
+            text = element.text
+
+            case name
+              when *PRIMARY_KEYS then collection[name] = text
+              else collection[:extensions].merge! deserializer.call(element)
+            end
+          end
+
+          self.for(**attributes)
+        end
+
+        def initialize title: nil,
+                       type: nil,
+                       status: nil,
+                       detail: nil,
+                       instance: nil,
+                       extensions: nil
+          super title: title || Rack::Utils::HTTP_STATUS_CODES[status],
+                type: type || "about:blank",
+                status:,
+                detail:,
+                instance:,
+                extensions: extensions || {}
+        end
+
+        def add_extension name, value
+          extensions[name] = value
+          self
+        end
+
+        def extension?(name) = extensions.key? name
+
+        def to_h = {type:, title:, status:, detail:, instance:, **extensions}.compact
+
+        def to_json(*) = to_h.to_json(*)
+
+        # :reek:TooManyStatements
+        # :reek:FeatureEnvy
+        def to_xml serializer: XML::Serializer, **options
+          document = REXML::Document.new
+          document.add REXML::XMLDecl.new("1.0", "UTF-8")
+
+          problem = REXML::Element.new("problem").add_namespace("urn:ietf:rfc:7807")
+          document.add problem
+
+          to_h.each { |name, value| serializer.call name, value, problem }
+
+          "".dup.tap { document.write(**options, output: it) }
+        end
+      end
+    end
+  end
+end

data/lib/rfc/api/problem/xml/deserializer.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module RFC
+  module API
+    module Problem
+      module XML
+        # Converts an XML element into a Hash.
+        Deserializer = lambda do |node, attributes = {}|
+          if node.has_elements?
+            node.each_element do |element|
+              if element.name == "i"
+                attributes[node.name.to_sym] ||= []
+                attributes[node.name.to_sym].push element.text
+              elsif element.elements.empty?
+                attributes[element.name.to_sym] = element.text
+              else
+                attributes = {element.name.to_sym => Deserializer.call(element, attributes)}
+              end
+            end
+          else
+            attributes[node.name.to_sym] = node.text
+          end
+
+          attributes
+        end
+      end
+    end
+  end
+end

data/lib/rfc/api/problem/xml/serializer.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module RFC
+  module API
+    module Problem
+      module XML
+        # Converts name and value into an XML element.
+        Serializer = lambda do |name, value, node|
+          if value.is_a? Array
+            element = node.add_element name.to_s
+            value.map { |item| element.add_element("i").add_text item.to_s }
+          else
+            node.add_element(name.to_s).add_text value.to_s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rfc/api/problem.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "rfc/api/problem/payload"
+require "rfc/api/problem/xml/deserializer"
+require "rfc/api/problem/xml/serializer"
+
+module RFC
+  module API
+    # Main namespace.
+    module Problem
+      MEDIA_TYPE_JSON = "application/problem+json"
+      MEDIA_TYPE_XML = "application/problem+xml"
+      TYPES = %i[json xml].freeze
+
+      def self.[](**) = Payload.for(**)
+
+      def self.new(**) = Payload.for(**)
+
+      def self.from_json(...) = Payload.from_json(...)
+
+      def self.from_xml(...) = Payload.from_xml(...)
+
+      def self.media_type_for key, types: TYPES
+        types.include?(key) ? const_get("MEDIA_TYPE_#{key.upcase}") : ""
+      end
+    end
+  end
+end

data/rfc-api-problem.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name = "rfc-api-problem"
+  spec.version = "0.0.0"
+  spec.authors = ["Brooke Kuhlmann"]
+  spec.email = ["brooke@alchemists.io"]
+  spec.homepage = "https://alchemists.io/projects/rfc-api-problem"
+  spec.summary = "A RFC 9457 Problem Details for HTTP APIs implementation."
+  spec.license = "Hippocratic-2.1"
+
+  spec.metadata = {
+    "bug_tracker_uri" => "https://github.com/bkuhlmann/rfc-api-problem/issues",
+    "changelog_uri" => "https://alchemists.io/projects/rfc-api-problem/versions",
+    "homepage_uri" => "https://alchemists.io/projects/rfc-api-problem",
+    "funding_uri" => "https://github.com/sponsors/bkuhlmann",
+    "label" => "RFC API Problem",
+    "rubygems_mfa_required" => "true",
+    "source_code_uri" => "https://github.com/bkuhlmann/rfc-api-problem"
+  }
+
+  spec.signing_key = Gem.default_key_path
+  spec.cert_chain = [Gem.default_cert_path]
+
+  spec.required_ruby_version = ">= 4.0"
+
+  spec.add_dependency "rack", "~> 3.0"
+  spec.add_dependency "rexml", "~> 3.4"
+
+  spec.extra_rdoc_files = Dir["README*", "LICENSE*"]
+  spec.files = Dir["*.gemspec", "lib/**/*"]
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: rfc-api-problem
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Brooke Kuhlmann
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIENjCCAp6gAwIBAgIBAzANBgkqhkiG9w0BAQsFADBBMQ8wDQYDVQQDDAZicm9v
+  a2UxGjAYBgoJkiaJk/IsZAEZFgphbGNoZW1pc3RzMRIwEAYKCZImiZPyLGQBGRYC
+  aW8wHhcNMjYwMzI1MTI0OTEyWhcNMjcwMzI1MTI0OTEyWjBBMQ8wDQYDVQQDDAZi
+  cm9va2UxGjAYBgoJkiaJk/IsZAEZFgphbGNoZW1pc3RzMRIwEAYKCZImiZPyLGQB
+  GRYCaW8wggGiMA0GCSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQCro8tj5/E1Hg88
+  f4qfiwPVd2zJQHvdYt4GHVvuHRRgx4HGhJuNp+4BId08RBn7V6V1MW6MY3kezRBs
+  M+7QOQ4b1xNLTvY7FYQB1wGK5a4x7TTokDrPYQxDB2jmsdDYCzVbIMrAvUfcecRi
+  khyGZCdByiiCl4fKv77P12tTT+NfsvXkLt/AYCGwjOUyGKTQ01Z6eC09T27GayPH
+  QQvIkakyFgcJtzSyGzs8bzK5q9u7wQ12MNTjJoXzW69lqp0oNvDylu81EiSUb5S6
+  QzzPxZBiRB1sgtbt1gUbVI262ZDq1gR+HxPFmp+Cgt7ZLIJZAtesQvtcMzseXpfn
+  hpmm0Sw22KGhRAy/mqHBRhDl5HqS1SJp2Ko3lcnpXeFResp0HNlt8NSu13vhC08j
+  GUHU9MyIXbFOsnp3K3ADrAVjPWop8EZkmUR3MV/CUm00w2cZHCSGiXl1KMpiVKvk
+  Ywr1gd2ZME4QLSo+EXUtLxDUa/W3xnBS8dBOuMMz02FPWYr3PN8CAwEAAaM5MDcw
+  CQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFAFgmv0tYMZnItuPycSM
+  F5wykJEVMA0GCSqGSIb3DQEBCwUAA4IBgQAG+ykjp+DIXSybGEtX+/ve974mYfN6
+  8U7qcVfRM+qDSOZ+97iu30qUTbVAKIHlHCDKRn3SgOffDUB5VU2MsJBh/3TPKWBZ
+  anB/uzMcwOfru+qyA3b7ZFqZzRLWmR5FtPObFxc0gYMT3YvLNHk2Nb9Vjq/PoiGG
+  e75PXweDOokwDA5m1gMOz1rdp/dlGMXkSFQg94PPVyUKXgO4VzWTgePSDxOIL+v6
+  +OWV6AaEH9BaqxnmdA5ubi0L7bhl0gbN92FxpNO3kpTjww8kme856a+wCK3qyM5w
+  7ZLbUexynDN0Au8eSpT2Bf6ztGmB1S9ffzDJsGX1/lkpMIB51e48Xe2+gzzOgemk
+  CdZaGupj6WkarnT8kh/cPtyA5ax4rGX6GOS8meGxzkv8Uy0JSEOYAp6wLfIisYZp
+  IJBIXIOkwKKJ0eB5YHrUSJxzpP4LlcIg/eTftaXmJdYjy+2VRrCZYDjfguyLmMjR
+  KR9w4/Fjvqy87kCHmxMWa6IL2Vzt1Clm2cA=
+  -----END CERTIFICATE-----
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+email:
+- brooke@alchemists.io
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.adoc
+- README.adoc
+files:
+- LICENSE.adoc
+- README.adoc
+- lib/rfc/api/problem.rb
+- lib/rfc/api/problem/payload.rb
+- lib/rfc/api/problem/xml/deserializer.rb
+- lib/rfc/api/problem/xml/serializer.rb
+- rfc-api-problem.gemspec
+homepage: https://alchemists.io/projects/rfc-api-problem
+licenses:
+- Hippocratic-2.1
+metadata:
+  bug_tracker_uri: https://github.com/bkuhlmann/rfc-api-problem/issues
+  changelog_uri: https://alchemists.io/projects/rfc-api-problem/versions
+  homepage_uri: https://alchemists.io/projects/rfc-api-problem
+  funding_uri: https://github.com/sponsors/bkuhlmann
+  label: RFC API Problem
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/bkuhlmann/rfc-api-problem
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '4.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.19
+specification_version: 4
+summary: A RFC 9457 Problem Details for HTTP APIs implementation.
+test_files: []