Combine error callbacks

api/src/main/java/com/vimeo/networking2/VimeoCallback.kt

@@ -10,29 +10,14 @@ interface VimeoCallback<ResponseType_T> {
      *
      * @param response  Data returned by the API.
      */
-    fun onSuccess(response: ApiResponse.Success<ResponseType_T>)
+    fun onSuccess(response: VimeoResponse.Success<ResponseType_T>)
 
     /**
-     * An error occurred on the API. [apiError] contains information about the error that occurred.
+     * An error occurred when making the request.
      *
-     * @param apiError Information on the error returned by API.
+     * @param error Information on the error. This error could be due to an exception thrown or
+     *              parsing response error.
      */
-    fun onApiError(apiError: ApiResponse.Failure.ApiFailure)
-
-    /**
-     * Generic error occurred. This occurred was not caused by the API rather it was due to
-     * parsing the data or the response body was null.
-     *
-     * @param genericFailure  The response code of the API request.
-     */
-    fun onGenericError(genericFailure: ApiResponse.Failure.GenericFailure)
-
-    /**
-     * An exception occurred by Retrofit in the API request.
-     *
-     * @param exceptionFailure  The exception thrown by Retrofit for the request.
-     */
-    fun onExceptionError(exceptionFailure: ApiResponse.Failure.ExceptionFailure)
+    fun onError(error: VimeoResponse.Error)
 
 }
-

api/src/main/java/com/vimeo/networking2/VimeoResponse.kt

@@ -0,0 +1,52 @@
+package com.vimeo.networking2
+
+import com.vimeo.networking2.VimeoResponse.Error
+import com.vimeo.networking2.VimeoResponse.Success
+
+/**
+ * Result of the API response. [Success] contains the data while the [Error] class will
+ * inform you of an api error.
+ */
+sealed class VimeoResponse<out T> {
+
+    /**
+     * A successful response.
+     *
+     * @param data The parsed data for the request.
+     */
+    data class Success<out T>(val data: T) : VimeoResponse<T>()
+
+    /**
+     * An error occurred when making the request. This error may be due to invalid parameters,
+     * exception thrown when making the request or there was an error parsing the response.
+     *
+     * @param message The error message.
+     */
+    sealed class Error(val message: String): VimeoResponse<Nothing>() {
+
+        /**
+         * Vimeo API returned an error response for the request you made.
+         *
+         * @param reason Info on the error.
+         */
+        data class Api(val reason: ApiError): Error("API error: ${reason.errorCode ?: "unknown"}")
+
+        /**
+         * Exception was thrown when making the request. This maybe due to no internet.
+         *
+         * @param throwable Info on the exception that was thrown.
+         */
+        data class Exception(val throwable: Throwable): Error("Exception thrown")
+
+        /**
+         * Generic error occurred. The request was successful, but the response could not be
+         * parsed by the SDK. This maybe because it is not formatted correctly. The raw response
+         * will allows you to see the info about the request.
+         *
+         * @param rawResponse Raw response from the API.
+         */
+        data class Generic(val rawResponse: String): Error("Generic error")
+
+    }
+
+}

api/src/main/java/com/vimeo/networking2/internal/VimeoCallAdapter.kt

@@ -26,30 +26,37 @@ internal class VimeoCallAdapter<T>(
 ) : VimeoCall<T> {
 
     override fun enqueue(callback: VimeoCallback<T>): VimeoRequest {
+
         call.enqueue(object : Callback<T> {
             override fun onResponse(call: Call<T>, response: Response<T>) {
 
                 if (response.hasBody()) {
-                    callbackExecutor.sendResponse { callback.onSuccess(ApiResponse.Success(response.body()!!)) }
+                    callbackExecutor.sendResponse {
+                        callback.onSuccess(VimeoResponse.Success(response.body()!!))
+                    }
                 } else {
                     val apiError = response.parseApiError()
                     if (apiError != null) {
-                        callbackExecutor.sendResponse { callback.onApiError(ApiResponse.Failure.ApiFailure(apiError)) }
+                        callbackExecutor.sendResponse {
+                            callback.onError(VimeoResponse.Error.Api(apiError))
+                        }
                     } else {
-                        callbackExecutor.sendResponse { callback.onGenericError(ApiResponse.Failure.GenericFailure(response.code())) }
+                        callbackExecutor.sendResponse {
+                            callback.onError(VimeoResponse.Error.Generic(response.raw().toString()))
+                        }
                     }
                 }
             }
 
             override fun onFailure(call: Call<T>, t: Throwable) {
-                callbackExecutor.sendResponse { callback.onExceptionError(ApiResponse.Failure.ExceptionFailure(t)) }
+                callbackExecutor.sendResponse { callback.onError(VimeoResponse.Error.Exception(t)) }
             }
         })
         return CancellableVimeoRequest(call)
     }
 
     override fun enqueueError(apiError: ApiError, callback: VimeoCallback<T>): VimeoRequest {
-        callbackExecutor.sendResponse { callback.onApiError(ApiResponse.Failure.ApiFailure(apiError)) }
+        callbackExecutor.sendResponse { callback.onError(VimeoResponse.Error.Api(apiError)) }
         return NoOpVimeoRequest
     }
 

auth/src/main/java/com/vimeo/networking2/Authenticator.kt

@@ -24,19 +24,11 @@ import okhttp3.Credentials
  * val authenticator = Authenticator.create(serverConfig)
  * authenticator.clientCredentials(object: VimeoCallback<BasicAuthToken>() {
  *
- *      override fun onSuccess(authResponse: ApiResponse.Success<BasicAuthToken>) {
+ *       override fun onSuccess(authResponse: VimeoResponse.Success<BasicAuthToken>) {
  *
  *       }
  *
- *       override fun onGenericError(genericFailure: ApiResponse.Failure.GenericFailure) {
- *
- *       }
- *
- *       override fun onApiError(apiFailure: ApiResponse.Failure.ApiFailure) {
- *
- *       }
- *
- *       override fun onExceptionError(exceptionFailure: ApiResponse.Failure.ExceptionFailure) {
+ *       override fun onError(error: VimeoResponse.Error) {
  *
  *       }
  * })

example-vimeo-networking2-android/src/main/java/com/vimeo/vimeonetworking2/playground/MainActivity.kt

@@ -3,10 +3,10 @@ package com.vimeo.vimeonetworking2.playground
 import android.os.Bundle
 import android.support.v7.app.AppCompatActivity
 import com.vimeo.moshiexampleandroid.R
-import com.vimeo.networking2.ApiResponse
 import com.vimeo.networking2.Authenticator
 import com.vimeo.networking2.BasicAccessToken
 import com.vimeo.networking2.VimeoCallback
+import com.vimeo.networking2.VimeoResponse
 import com.vimeo.networking2.config.ServerConfig
 import kotlinx.android.synthetic.main.activity_main.*
 
@@ -21,26 +21,16 @@ class MainActivity : AppCompatActivity() {
             val serverConfig = ServerConfig(CLIENT_ID, CLIENT_SECRET)
             val authenticator = Authenticator.create(serverConfig)
 
-            authenticator.clientCredentials(object: VimeoCallback<BasicAccessToken> {
-                override fun onSuccess(response: ApiResponse.Success<BasicAccessToken>) {
+            authenticator.clientCredentials(object : VimeoCallback<BasicAccessToken> {
+                override fun onSuccess(response: VimeoResponse.Success<BasicAccessToken>) {
 
                 }
 
-                override fun onApiError(apiError: ApiResponse.Failure.ApiFailure) {
-
-                }
-
-                override fun onGenericError(genericFailure: ApiResponse.Failure.GenericFailure) {
-
-                }
-
-                override fun onExceptionError(exceptionFailure: ApiResponse.Failure.ExceptionFailure) {
+                override fun onError(error: VimeoResponse.Error) {
 
                 }
             })
-
         }
-
     }
 
     companion object {