0.2.0: Add DwollaException (#17)

* Add DwollaException

* Bump version to 0.2.0

* Refactor

* ktlint -F

* Rethrow DwollaExceptions without rewrapping them

* Formatting changes

Author: sausman

.travis.yml

@@ -1,35 +1,42 @@
 language: java
+
 install: true
+
 jdk:
-#- openjdk13 # see jobs.include
-- openjdk12
-- openjdk11
-- openjdk10
-- openjdk9
-#- openjdk8 # see jobs.include
-- oraclejdk13
-- oraclejdk12
-- oraclejdk11
-- oraclejdk9
+  #- openjdk13 # see jobs.include
+  - openjdk12
+  - openjdk11
+  - openjdk10
+  - openjdk9
+  #- openjdk8 # see jobs.include
+  - oraclejdk13
+  - oraclejdk12
+  - oraclejdk11
+  - oraclejdk9
+
 jobs:
   include:
     - jdk: openjdk13
       script:
-      - "./gradlew ktlintCheck"
-      - "./gradlew test --stacktrace"
+        - "./gradlew ktlintCheck"
+        - "./gradlew test --stacktrace"
     - jdk: openjdk8
       script:
-      - "./gradlew ktlintCheck"
-      - "./gradlew test --stacktrace"
+        - "./gradlew ktlintCheck"
+        - "./gradlew test --stacktrace"
+
 script:
-- "./gradlew ktlintCheck"
-- "./gradlew test -PjUnitExcludeTags=api --stacktrace"
+  - "./gradlew ktlintCheck"
+  - "./gradlew test -PjUnitExcludeTags=api --stacktrace"
+
 before_cache:
-- rm -f  $HOME/.gradle/caches/modules-2/modules-2.lock
-- rm -fr $HOME/.gradle/caches/*/plugin-resolution/
+  - rm -f  $HOME/.gradle/caches/modules-2/modules-2.lock
+  - rm -fr $HOME/.gradle/caches/*/plugin-resolution/
+
 cache:
   directories:
-  - "$HOME/.gradle/caches/"
-  - "$HOME/.gradle/wrapper/"
+    - "$HOME/.gradle/caches/"
+    - "$HOME/.gradle/wrapper/"
+
 env:
   secure: btlewfZncfLs+aYQ8Ccdp2QDAqspV9fS7qqW7ZfRtrLq4ZhgxxaK5SNXXGYFHmovdvVWwKjTAGskV8DbJKuSO6II9HeZDLRkN/J1Qco6hUTl44YhDaodxF9gzC/6tJE24Kd6+mn4dT8Ca+LCpNZnlYbMWqzRibjBPBCWwDcqB6o07GhlQHHsTaGs4d0FvNEvw6tbq51cNKHJfc+s+WPZs3sX1efHa+k5uqJCkVQakhZOX9jMBrzuRcnyY62Fhrr5Vj+xQgHOCY8P/Na+hHNQdFyuiBMFlK7z4Jjs4Xd7iLzpxgGD6WNjjba2XEZrC9dTzn+gCctfoX4Fz8VvPs+ToZHDmZLnJTgp7oKKFJqAIbIjxHG5pi8OOCLJM8hPT5a08HN1M0DSvg6FhiCOX4ya3FdGeB+El4UPFahh3zcblhoAsk8qVUK9y+Jh1bNViviGUxk7tZ9J+y6XmMemnA1OJBeufBiJrFTrkv8dfQJAtIr7n/JKXnM4v6LTcknIQNeqSVfvPCdajjrcDqechsDTb4MGKoWHLumxQxqwp+knBhL6Dy0uR0nsQVJCv6W0pAtEr18DqR+yJlJ1WpUHUneh9XnzrfmAh5F9rcGfyw1qvUh3yn6EK8uLGuk3I7fstgMghLu5lQd513GjLgV75SwzL1WXPRgt1iioM9ayuzRusBU=

README.md

@@ -22,7 +22,7 @@ Add this to your project's POM:
 <dependency>
     <groupId>com.github.Dwolla</groupId>
     <artifactId>dwolla-v2-kotlin</artifactId>
-    <version>0.1.2</version>
+    <version>0.2.0</version>
 </dependency>
 ```
 
@@ -41,7 +41,7 @@ repositories {
 
 ```groovy
 dependencies {
-    implementation("com.github.Dwolla:dwolla-v2-kotlin:0.1.2")
+    implementation("com.github.Dwolla:dwolla-v2-kotlin:0.2.0")
 }
 ```
 
@@ -128,13 +128,19 @@ As of now, a subset of the Dwolla API has high-level methods available:
 
 ## Handling errors
 
-Requests made with Dwolla V2 Kotlin throw two types of exceptions:
+Dwolla V2 Kotlin has 3 types of exceptions:
 
-- `DwollaApiException`: Thrown when an API request is unsuccessful. This could occur for a variety of reasons such as
-  invalid request parameters. Details can be found in the exception's `error (DwollaApiError)` object.
+```
+DwollaException
+├── DwollaApiException
+└── DwollaAuthException
+```
+
+- `DwollaApiException`: Thrown when the Dwolla API returns an error response. This could occur
+  for a variety of reasons such as invalid request parameters.
 - `DwollaAuthException`: Thrown when an error occurs obtaining authenticating with the API. You should not encounter
-  this exception unless your `Dwolla` key and/or secret is incorrect. Details can be found in the exception's
-  `error (DwollaAuthError)` object.
+  this exception unless your `Dwolla` key/secret are incorrect.
+- `DwollaException`: The base class other exceptions inherit from.
 
 #### Kotlin
 
@@ -146,11 +152,14 @@ try {
     e.statusCode // Int
     e.headers // Headers
     e.error // DwollaError
-} catch (e: DwollaApiException) {
+} catch (e: DwollaAuthException) {
     e.message // String
     e.statusCode // Int
     e.headers // Headers
     e.error // OAuthError
+} catch (e: DwollaException) {
+    e.message // String
+    e.cause // Throwable?
 }
 ```
 
@@ -169,6 +178,9 @@ try {
     Integer statusCode = e.statusCode;
     Headers headers = e.headers;
     OAuthError error = e.error;
+} catch (DwollaAuthException e) {
+    String message = e.message;
+    Throwable cause = e.cause;
 }
 ```
 
@@ -179,6 +191,9 @@ If you have any feedback please [reach out](https://discuss.dwolla.com/) to us o
 
 ## Changelog
 
+- **0.2.0**
+  - Add `DwollaException` base exception class
+  - Swallow and rethrow exceptions using `DwollaException`
 - **0.1.2**
   - Add `delete` methods to `DwollaClient`
 - **0.1.1**

build.gradle.kts

@@ -1,5 +1,5 @@
 group = "com.dwolla"
-version = "0.1.2"
+version = "0.2.0"
 
 plugins {
     // Apply the Kotlin JVM plugin to add support for Kotlin on the JVM.

src/main/kotlin/com/dwolla/Dwolla.kt

@@ -2,6 +2,7 @@ package com.dwolla
 
 import com.dwolla.api.* // ktlint-disable no-wildcard-imports
 import com.dwolla.exception.DwollaAuthException
+import com.dwolla.exception.DwollaException
 import com.dwolla.http.Headers
 import com.dwolla.resource.DwollaAuthError
 import com.dwolla.util.Deserializer
@@ -64,27 +65,33 @@ class Dwolla(
     }
 
     internal fun fetchToken(vararg params: Pair<String, String?>): TokenResponse {
-        val result = fuelManager
-            .post(environment.tokenUrl, params.filterNot { (_, v) -> v.isNullOrBlank() }.toList())
-            .header(USER_AGENT_HEADER)
-            .authentication()
-            .basic(key, secret)
-            .responseObject(Deserializer(gson, TokenResponse::class.java))
-        val responseHeaders = Headers(*result.second.headers.map { h -> h.key to h.value.first() }.toTypedArray())
-        return result.third.fold(
-            success = { res -> res },
-            failure = {
-                val rawBody = result.second.data.toString(Charsets.UTF_8)
-                if (rawBody.isBlank() && result.second.statusCode == 401) {
-                    // for some reason we can't read the response body when a 401 is returned
-                    val error = DwollaAuthError("", null, null)
-                    throw DwollaAuthException("401 Unauthorized", result.second.statusCode, responseHeaders, error)
-                } else {
-                    val error = Deserializer(gson, DwollaAuthError::class.java).deserialize(rawBody)
-                    throw DwollaAuthException(rawBody, result.second.statusCode, responseHeaders, error)
+        try {
+            val result = fuelManager
+                .post(environment.tokenUrl, params.filterNot { (_, v) -> v.isNullOrBlank() }.toList())
+                .header(USER_AGENT_HEADER)
+                .authentication()
+                .basic(key, secret)
+                .responseObject(Deserializer(gson, TokenResponse::class.java))
+            val responseHeaders = Headers(*result.second.headers.map { h -> h.key to h.value.first() }.toTypedArray())
+            return result.third.fold(
+                success = { res -> res },
+                failure = {
+                    val rawBody = result.second.data.toString(Charsets.UTF_8)
+                    if (rawBody.isBlank() && result.second.statusCode == 401) {
+                        // for some reason we can't read the response body when a 401 is returned
+                        val error = DwollaAuthError("", null, null)
+                        throw DwollaAuthException("401 Unauthorized", result.second.statusCode, responseHeaders, error)
+                    } else {
+                        val error = Deserializer(gson, DwollaAuthError::class.java).deserialize(rawBody)
+                        throw DwollaAuthException(rawBody, result.second.statusCode, responseHeaders, error)
+                    }
                 }
-            }
-        )
+            )
+        } catch (e: DwollaException) {
+            throw e
+        } catch (e: Exception) {
+            throw DwollaException("See stack trace for more details...", e)
+        }
     }
 
     // for testing purposes

src/main/kotlin/com/dwolla/DwollaClient.kt

@@ -2,6 +2,7 @@ package com.dwolla
 
 import com.dwolla.exception.DwollaApiException
 import com.dwolla.exception.DwollaAuthException
+import com.dwolla.exception.DwollaException
 import com.dwolla.http.* // ktlint-disable no-wildcard-imports
 import com.dwolla.resource.DwollaApiError
 import com.dwolla.util.Deserializer
@@ -28,7 +29,7 @@ abstract class DwollaClient(@JvmField val environment: DwollaEnvironment) {
 
     companion object {
         val ACCEPT_HEADER = mapOf("accept" to "application/vnd.dwolla.v1.hal+json")
-        val USER_AGENT_HEADER = mapOf("user-agent" to "dwolla-v2-kotlin/0.1.2")
+        val USER_AGENT_HEADER = mapOf("user-agent" to "dwolla-v2-kotlin/0.2.0")
     }
 
     @Throws(DwollaApiException::class, DwollaAuthException::class)
@@ -254,15 +255,27 @@ abstract class DwollaClient(@JvmField val environment: DwollaEnvironment) {
     }
 
     private fun makeRequest(request: Request): Response<String> {
-        val preparedRequest = prepareRequest(request)
-        val result = preparedRequest.responseString()
-        return handleResponse(result)
+        try {
+            val preparedRequest = prepareRequest(request)
+            val result = preparedRequest.responseString()
+            return handleResponse(result)
+        } catch (e: DwollaException) {
+            throw e
+        } catch (e: Exception) {
+            throw DwollaException("See stack trace for more details...", e)
+        }
     }
 
     private fun <T : Any> makeRequest(deserializeAs: Class<T>, request: Request): Response<T> {
-        val preparedRequest = prepareRequest(request)
-        val result = preparedRequest.responseObject(Deserializer(gson, deserializeAs))
-        return handleResponse(result)
+        try {
+            val preparedRequest = prepareRequest(request)
+            val result = preparedRequest.responseObject(Deserializer(gson, deserializeAs))
+            return handleResponse(result)
+        } catch (e: DwollaException) {
+            throw e
+        } catch (e: Exception) {
+            throw DwollaException("See stack trace for more details...", e)
+        }
     }
 
     private fun prepareRequest(request: Request): Request {

src/main/kotlin/com/dwolla/exception/DwollaApiException.kt

@@ -8,4 +8,4 @@ open class DwollaApiException(
     @JvmField val statusCode: Int,
     @JvmField val headers: Headers,
     @JvmField val error: DwollaApiError
-) : Exception(message)
+) : DwollaException(message)

src/main/kotlin/com/dwolla/exception/DwollaAuthException.kt

@@ -8,4 +8,4 @@ open class DwollaAuthException(
     @JvmField val statusCode: Int,
     @JvmField val headers: Headers,
     @JvmField val error: DwollaAuthError
-) : Exception(message)
+) : DwollaException(message)

src/main/kotlin/com/dwolla/exception/DwollaException.kt

@@ -0,0 +1,6 @@
+package com.dwolla.exception
+
+open class DwollaException(
+    message: String,
+    cause: Throwable? = null
+) : Exception(message, cause)