Support 3xx http responses statuses in generated client code (#254)

Co-authored-by: Jens Zettelmeyer <[email protected]>
cjbooms · Nov 29, 2023 · eba93e1 · eba93e1
1 parent 46b2985
commit eba93e1
Show file tree

Hide file tree

Showing 12 changed files with 55 additions and 0 deletions.
diff --git a/src/main/resources/templates/client-code/api-models.kt.hbs b/src/main/resources/templates/client-code/api-models.kt.hbs
@@ -14,6 +14,11 @@ data class ApiResponse<T>(val statusCode: Int, val headers: Headers, val data: T
  */
 open class ApiException(override val message: String) : RuntimeException(message)
 
+/**
+ * API 3xx redirect response returned by API call.
+ */
+open class ApiRedirectException(val statusCode: Int, val headers: Headers, override val message: String) : ApiException(message)
+
 /**
  * API 4xx failure responses returned by API call.
  */
@@ -23,3 +28,4 @@ data class ApiClientException(val statusCode: Int, val headers: Headers, overrid
  * API 5xx failure responses returned by API call.
  */
 data class ApiServerException(val statusCode: Int, val headers: Headers, override val message: String) : ApiException(message)
+
diff --git a/src/main/resources/templates/client-code/http-util.kt.hbs b/src/main/resources/templates/client-code/http-util.kt.hbs
@@ -39,6 +39,8 @@ fun <T> Request.execute(client: OkHttpClient, objectMapper: ObjectMapper, typeRe
         when {
             response.isSuccessful ->
                 ApiResponse(response.code, response.headers, response.body?.deserialize(objectMapper, typeRef))
+            response.isRedirection() ->
+                throw ApiRedirectException(response.code, response.headers, response.errorMessage())
             response.isBadRequest() ->
                 throw ApiClientException(response.code, response.headers, response.errorMessage())
             response.isServerError() ->
@@ -63,3 +65,5 @@ private fun Response.errorMessage(): String = this.body?.string() ?: this.messag
 private fun Response.isBadRequest(): Boolean = this.code in 400..499
 
 private fun Response.isServerError(): Boolean = this.code in 500..599
+
+private fun Response.isRedirection(): Boolean = this.code in 300..399
diff --git a/src/test/resources/examples/multiMediaType/client/ApiModels.kt b/src/test/resources/examples/multiMediaType/client/ApiModels.kt
@@ -14,6 +14,11 @@ data class ApiResponse<T>(val statusCode: Int, val headers: Headers, val data: T
  */
 open class ApiException(override val message: String) : RuntimeException(message)
 
+/**
+ * API 3xx redirect response returned by API call.
+ */
+open class ApiRedirectException(val statusCode: Int, val headers: Headers, override val message: String) : ApiException(message)
+
 /**
  * API 4xx failure responses returned by API call.
  */

diff --git a/src/test/resources/examples/multiMediaType/client/HttpUtil.kt b/src/test/resources/examples/multiMediaType/client/HttpUtil.kt
@@ -39,6 +39,8 @@ fun <T> Request.execute(client: OkHttpClient, objectMapper: ObjectMapper, typeRe
         when {
             response.isSuccessful ->
                 ApiResponse(response.code, response.headers, response.body?.deserialize(objectMapper, typeRef))
+            response.isRedirection() ->
+                throw ApiRedirectException(response.code, response.headers, response.errorMessage())
             response.isBadRequest() ->
                 throw ApiClientException(response.code, response.headers, response.errorMessage())
             response.isServerError() ->
@@ -63,3 +65,5 @@ private fun Response.errorMessage(): String = this.body?.string() ?: this.messag
 private fun Response.isBadRequest(): Boolean = this.code in 400..499
 
 private fun Response.isServerError(): Boolean = this.code in 500..599
+
+private fun Response.isRedirection(): Boolean = this.code in 300..399
diff --git a/src/test/resources/examples/okHttpClient/client/ApiModels.kt b/src/test/resources/examples/okHttpClient/client/ApiModels.kt
@@ -14,6 +14,11 @@ data class ApiResponse<T>(val statusCode: Int, val headers: Headers, val data: T
  */
 open class ApiException(override val message: String) : RuntimeException(message)
 
+/**
+ * API 3xx redirect response returned by API call.
+ */
+open class ApiRedirectException(val statusCode: Int, val headers: Headers, override val message: String) : ApiException(message)
+
 /**
  * API 4xx failure responses returned by API call.
  */

diff --git a/src/test/resources/examples/okHttpClient/client/HttpUtil.kt b/src/test/resources/examples/okHttpClient/client/HttpUtil.kt
@@ -39,6 +39,8 @@ fun <T> Request.execute(client: OkHttpClient, objectMapper: ObjectMapper, typeRe
         when {
             response.isSuccessful ->
                 ApiResponse(response.code, response.headers, response.body?.deserialize(objectMapper, typeRef))
+            response.isRedirection() ->
+                throw ApiRedirectException(response.code, response.headers, response.errorMessage())
             response.isBadRequest() ->
                 throw ApiClientException(response.code, response.headers, response.errorMessage())
             response.isServerError() ->
@@ -63,3 +65,5 @@ private fun Response.errorMessage(): String = this.body?.string() ?: this.messag
 private fun Response.isBadRequest(): Boolean = this.code in 400..499
 
 private fun Response.isServerError(): Boolean = this.code in 500..599
+
+private fun Response.isRedirection(): Boolean = this.code in 300..399
diff --git a/src/test/resources/examples/okHttpClientPostWithoutRequestBody/client/ApiModels.kt b/src/test/resources/examples/okHttpClientPostWithoutRequestBody/client/ApiModels.kt
@@ -14,6 +14,11 @@ data class ApiResponse<T>(val statusCode: Int, val headers: Headers, val data: T
  */
 open class ApiException(override val message: String) : RuntimeException(message)
 
+/**
+ * API 3xx redirect response returned by API call.
+ */
+open class ApiRedirectException(val statusCode: Int, val headers: Headers, override val message: String) : examples.multiMediaType.client.ApiException(message)
+
 /**
  * API 4xx failure responses returned by API call.
  */

diff --git a/src/test/resources/examples/okHttpClientPostWithoutRequestBody/client/HttpUtil.kt b/src/test/resources/examples/okHttpClientPostWithoutRequestBody/client/HttpUtil.kt
@@ -39,6 +39,8 @@ fun <T> Request.execute(client: OkHttpClient, objectMapper: ObjectMapper, typeRe
         when {
             response.isSuccessful ->
                 ApiResponse(response.code, response.headers, response.body?.deserialize(objectMapper, typeRef))
+            response.isRedirection() ->
+                throw ApiRedirectException(response.code, response.headers, response.errorMessage())
             response.isBadRequest() ->
                 throw ApiClientException(response.code, response.headers, response.errorMessage())
             response.isServerError() ->
@@ -63,3 +65,5 @@ private fun Response.errorMessage(): String = this.body?.string() ?: this.messag
 private fun Response.isBadRequest(): Boolean = this.code in 400..499
 
 private fun Response.isServerError(): Boolean = this.code in 500..599
+
+private fun Response.isRedirection(): Boolean = this.code in 300..399
diff --git a/src/test/resources/examples/parameterNameClash/client/ApiModels.kt b/src/test/resources/examples/parameterNameClash/client/ApiModels.kt
@@ -14,6 +14,11 @@ data class ApiResponse<T>(val statusCode: Int, val headers: Headers, val data: T
  */
 open class ApiException(override val message: String) : RuntimeException(message)
 
+/**
+ * API 3xx redirect response returned by API call.
+ */
+open class ApiRedirectException(val statusCode: Int, val headers: Headers, override val message: String) : examples.multiMediaType.client.ApiException(message)
+
 /**
  * API 4xx failure responses returned by API call.
  */

diff --git a/src/test/resources/examples/parameterNameClash/client/HttpUtil.kt b/src/test/resources/examples/parameterNameClash/client/HttpUtil.kt
@@ -39,6 +39,8 @@ fun <T> Request.execute(client: OkHttpClient, objectMapper: ObjectMapper, typeRe
         when {
             response.isSuccessful ->
                 ApiResponse(response.code, response.headers, response.body?.deserialize(objectMapper, typeRef))
+            response.isRedirection() ->
+                throw ApiRedirectException(response.code, response.headers, response.errorMessage())
             response.isBadRequest() ->
                 throw ApiClientException(response.code, response.headers, response.errorMessage())
             response.isServerError() ->
@@ -63,3 +65,5 @@ private fun Response.errorMessage(): String = this.body?.string() ?: this.messag
 private fun Response.isBadRequest(): Boolean = this.code in 400..499
 
 private fun Response.isServerError(): Boolean = this.code in 500..599
+
+private fun Response.isRedirection(): Boolean = this.code in 300..399
diff --git a/src/test/resources/examples/pathLevelParameters/client/ApiModels.kt b/src/test/resources/examples/pathLevelParameters/client/ApiModels.kt
@@ -14,6 +14,11 @@ data class ApiResponse<T>(val statusCode: Int, val headers: Headers, val data: T
  */
 open class ApiException(override val message: String) : RuntimeException(message)
 
+/**
+ * API 3xx redirect response returned by API call.
+ */
+open class ApiRedirectException(val statusCode: Int, val headers: Headers, override val message: String) : examples.multiMediaType.client.ApiException(message)
+
 /**
  * API 4xx failure responses returned by API call.
  */

diff --git a/src/test/resources/examples/pathLevelParameters/client/HttpUtil.kt b/src/test/resources/examples/pathLevelParameters/client/HttpUtil.kt
@@ -39,6 +39,8 @@ fun <T> Request.execute(client: OkHttpClient, objectMapper: ObjectMapper, typeRe
         when {
             response.isSuccessful ->
                 ApiResponse(response.code, response.headers, response.body?.deserialize(objectMapper, typeRef))
+            response.isRedirection() ->
+                throw ApiRedirectException(response.code, response.headers, response.errorMessage())
             response.isBadRequest() ->
                 throw ApiClientException(response.code, response.headers, response.errorMessage())
             response.isServerError() ->
@@ -63,3 +65,5 @@ private fun Response.errorMessage(): String = this.body?.string() ?: this.messag
 private fun Response.isBadRequest(): Boolean = this.code in 400..499
 
 private fun Response.isServerError(): Boolean = this.code in 500..599
+
+private fun Response.isRedirection(): Boolean = this.code in 300..399