feat: exported MediaTypeProblemJSON and MediaTypeProblemXML

otaxhu · Nov 16, 2024 · 7dfe224 · 7dfe224
1 parent 555f4a6
commit 7dfe224
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 21 deletions.
diff --git a/http.go b/http.go
@@ -35,9 +35,9 @@ func (p *problemHTTPWrapper) ServeHTTP(w http.ResponseWriter, r *http.Request) {
 	h := w.Header()
 
 	switch p.contentType {
-	case problemJsonContentType:
+	case MediaTypeProblemJSON:
 		_ = json.NewEncoder(buf).Encode(p.p)
-	case problemXmlContentType:
+	case MediaTypeProblemXML:
 		buf.WriteString(xml.Header)
 		_ = xml.NewEncoder(buf).Encode(p.p)
 	}
@@ -58,7 +58,7 @@ func (p *problemHTTPWrapper) ServeHTTP(w http.ResponseWriter, r *http.Request) {
 func ServeXML(p Problem) http.Handler {
 	return &problemHTTPWrapper{
 		p:           p,
-		contentType: problemXmlContentType,
+		contentType: MediaTypeProblemXML,
 	}
 }
 
@@ -69,6 +69,6 @@ func ServeXML(p Problem) http.Handler {
 func ServeJSON(p Problem) http.Handler {
 	return &problemHTTPWrapper{
 		p:           p,
-		contentType: problemJsonContentType,
+		contentType: MediaTypeProblemJSON,
 	}
 }
diff --git a/problem.go b/problem.go
@@ -72,10 +72,10 @@ func ParseResponse(res *http.Response) (Problem, error) {
 
 	var p Problem
 
-	if contentType == problemJsonContentType {
+	if contentType == MediaTypeProblemJSON {
 		// Use a MapProblem
 		p = &MapProblem{}
-	} else if contentType == problemXmlContentType {
+	} else if contentType == MediaTypeProblemXML {
 		// Use RegisteredProblem, gonna lost extension members but it's better than failing
 		p = &RegisteredProblem{}
 	} else {
@@ -103,20 +103,20 @@ func ParseResponse(res *http.Response) (Problem, error) {
 func ParseResponseCustom(res *http.Response, p Problem) error {
 	contentType := res.Header.Get("Content-Type")
 
-	if contentType != problemJsonContentType && contentType != problemXmlContentType {
+	if contentType != MediaTypeProblemJSON && contentType != MediaTypeProblemXML {
 		return fmt.Errorf("%w: got '%s'", ErrInvalidContentType, contentType)
 	}
 
 	defer res.Body.Close()
 
-	if contentType == problemJsonContentType {
+	if contentType == MediaTypeProblemJSON {
 
 		err := json.NewDecoder(res.Body).Decode(p)
 		if err != nil {
 			return err
 		}
 
-	} else if contentType == problemXmlContentType {
+	} else if contentType == MediaTypeProblemXML {
 
 		err := xml.NewDecoder(res.Body).Decode(p)
 		if err != nil {

diff --git a/problem_test.go b/problem_test.go
@@ -91,7 +91,7 @@ func TestParseResponse(t *testing.T) {
 		ExpectedError   bool
 	}{
 		"JSON: OK": {
-			InputBody: responseFactory(http.StatusInternalServerError, problemJsonContentType, `
+			InputBody: responseFactory(http.StatusInternalServerError, MediaTypeProblemJSON, `
 				{
 					"type": "about:blank",
 					"status": 500,
@@ -110,7 +110,7 @@ func TestParseResponse(t *testing.T) {
 			ExpectedError: false,
 		},
 		"XML: OK": {
-			InputBody: responseFactory(http.StatusInternalServerError, problemXmlContentType, xml.Header+`
+			InputBody: responseFactory(http.StatusInternalServerError, MediaTypeProblemXML, xml.Header+`
 				<problem xmlns="urn:ietf:rfc:7807">
 					<type>about:blank</type>
 					<status>500</status>
@@ -134,7 +134,7 @@ func TestParseResponse(t *testing.T) {
 			ExpectedError:   true,
 		},
 		"JSON: Bad Syntax": {
-			InputBody: responseFactory(http.StatusInternalServerError, problemJsonContentType, `
+			InputBody: responseFactory(http.StatusInternalServerError, MediaTypeProblemJSON, `
 				{
 					"status": 500 // Invalid JSON
 				}
@@ -143,7 +143,7 @@ func TestParseResponse(t *testing.T) {
 			ExpectedError:   true,
 		},
 		"XML: Bad Syntax": {
-			InputBody: responseFactory(http.StatusInternalServerError, problemXmlContentType, xml.Header+`
+			InputBody: responseFactory(http.StatusInternalServerError, MediaTypeProblemXML, xml.Header+`
 				<problem>
 					<status>500</status>
 					No Closing Tag
@@ -207,8 +207,8 @@ func TestServe(t *testing.T) {
 
 			contentType := recorder.Result().Header.Get("Content-Type")
 
-			if contentType != problemJsonContentType {
-				t.Errorf("expected %s, got %s", problemJsonContentType, contentType)
+			if contentType != MediaTypeProblemJSON {
+				t.Errorf("expected %s, got %s", MediaTypeProblemJSON, contentType)
 			}
 
 			// TODO: See above, find a way to compact a XML document.
@@ -243,7 +243,7 @@ func TestEmbeddedParseResponseCustom(t *testing.T) {
 		ExpectedError   bool
 	}{
 		"JSON: OK": {
-			InputBody: responseFactory(http.StatusInternalServerError, problemJsonContentType, `
+			InputBody: responseFactory(http.StatusInternalServerError, MediaTypeProblemJSON, `
 				{
 					"type": "about:blank",
 					"status": 500,
@@ -268,7 +268,7 @@ func TestEmbeddedParseResponseCustom(t *testing.T) {
 			ExpectedError: false,
 		},
 		"XML: OK": {
-			InputBody: responseFactory(http.StatusInternalServerError, problemXmlContentType, xml.Header+`
+			InputBody: responseFactory(http.StatusInternalServerError, MediaTypeProblemXML, xml.Header+`
 				<problem xmlns="urn:ietf:rfc:7807">
 					<type>about:blank</type>
 					<status>500</status>
@@ -298,7 +298,7 @@ func TestEmbeddedParseResponseCustom(t *testing.T) {
 			ExpectedError:   true,
 		},
 		"JSON: Bad Syntax": {
-			InputBody: responseFactory(http.StatusInternalServerError, problemJsonContentType, `
+			InputBody: responseFactory(http.StatusInternalServerError, MediaTypeProblemJSON, `
 				{
 					"status": 500 // Invalid JSON
 				}
@@ -307,7 +307,7 @@ func TestEmbeddedParseResponseCustom(t *testing.T) {
 			ExpectedError:   true,
 		},
 		"XML: Bad Syntax": {
-			InputBody: responseFactory(http.StatusInternalServerError, problemXmlContentType, xml.Header+`
+			InputBody: responseFactory(http.StatusInternalServerError, MediaTypeProblemXML, xml.Header+`
 				<problem>
 					<status>500</status>
 					No Closing Tag

diff --git a/registered.go b/registered.go
@@ -1,8 +1,14 @@
 package problem
 
-const problemJsonContentType = "application/problem+json"
+// Media type for JSON Problem Details
+//
+// https://datatracker.ietf.org/doc/html/rfc9457#name-iana-considerations
+const MediaTypeProblemJSON = "application/problem+json"
 
-const problemXmlContentType = "application/problem+xml"
+// Media type for XML Problem Details
+//
+// https://datatracker.ietf.org/doc/html/rfc9457#name-iana-considerations
+const MediaTypeProblemXML = "application/problem+xml"
 
 // Problem details registered members, as those specified in
 // https://datatracker.ietf.org/doc/html/rfc9457#name-members-of-a-problem-detail