about summary refs log tree commit diff stats
path: root/org.fox.ttrss
diff options
context:
space:
mode:
authorAndrew Dolgov <fox@fakecake.org>2026-06-06 13:03:58 +0300
committerAndrew Dolgov <fox@fakecake.org>2026-06-06 13:03:58 +0300
commita85ec311eb456e0dabdea32facef5929f45547db (patch)
treeb1828f6760bb6c4b1b7863730cd5b4dcd6fe7095 /org.fox.ttrss
parent09d69aa3654e20303bff5152bd2ae7a56e3e46b0 (diff)
downloadtt-rss-android-a85ec311eb456e0dabdea32facef5929f45547db.tar.gz
tt-rss-android-a85ec311eb456e0dabdea32facef5929f45547db.tar.xz
split testable stuff from ApiRequest into a separate class and add tests
Diffstat (limited to 'org.fox.ttrss')
-rw-r--r--org.fox.ttrss/src/main/java/org/fox/ttrss/ApiResponseParser.java130
-rw-r--r--org.fox.ttrss/src/main/java/org/fox/ttrss/ApiV2Client.java100
-rw-r--r--org.fox.ttrss/src/test/java/org/fox/ttrss/ApiResponseParserTest.java239
3 files changed, 376 insertions, 93 deletions
diff --git a/org.fox.ttrss/src/main/java/org/fox/ttrss/ApiResponseParser.java b/org.fox.ttrss/src/main/java/org/fox/ttrss/ApiResponseParser.java
new file mode 100644
index 00000000..18b2e4a7
--- /dev/null
+++ b/org.fox.ttrss/src/main/java/org/fox/ttrss/ApiResponseParser.java
@@ -0,0 +1,130 @@
+package org.fox.ttrss;
+
+import com.google.gson.JsonElement;
+import com.google.gson.JsonObject;
+import com.google.gson.JsonParser;
+
+import org.fox.ttrss.ApiCommon.ApiError;
+
+import java.util.Objects;
+
+/**
+ * Parses TT-RSS API v2 responses and maps error codes to ApiError enum.
+ *
+ * This is a pure-logic class with no Android dependencies, making it
+ * easy to unit test. ApiV2Client delegates to it after receiving HTTP responses.
+ */
+public final class ApiResponseParser {
+
+    /**
+     * Result of parsing a v2 API response.
+     */
+    public static final class ParsedResponse {
+        public final boolean success;
+        public final JsonElement data;
+        public final ApiError error;
+        public final String errorMessage;
+
+        public ParsedResponse(boolean success, JsonElement data, ApiError error, String errorMessage) {
+            this.success = success;
+            this.data = data;
+            this.error = error;
+            this.errorMessage = errorMessage;
+        }
+    }
+
+    private ApiResponseParser() {
+        // no instances
+    }
+
+    /**
+     * Parse a v2 API response payload.
+     *
+     * Response format: {"success": true/false, "data": ..., "error": {"code": "..."}}
+     *
+     * @param payload raw JSON string from the HTTP response body
+     * @return parsed response with success flag, data, and error info
+     */
+    public static ParsedResponse parse(String payload) {
+        try {
+            JsonElement result = JsonParser.parseString(payload);
+            JsonObject resultObj = result.getAsJsonObject();
+            boolean success = resultObj.get("success").getAsBoolean();
+
+            if (success) {
+                JsonElement data = resultObj.get("data");
+                return new ParsedResponse(
+                        true,
+                        data != null ? data : JsonParser.parseString("null"),
+                        ApiError.SUCCESS,
+                        null
+                );
+            } else {
+                JsonObject errorObj = resultObj.getAsJsonObject("error");
+                String errorCode = errorObj != null && errorObj.has("code")
+                        ? errorObj.get("code").getAsString()
+                        : "UNKNOWN";
+
+                return new ParsedResponse(
+                        false,
+                        null,
+                        mapApiError(errorCode),
+                        errorCode
+                );
+            }
+        } catch (Exception e) {
+            return new ParsedResponse(
+                    false,
+                    null,
+                    ApiError.PARSE_ERROR,
+                    "Failed to parse v2 response: " + e.getMessage()
+            );
+        }
+    }
+
+    /**
+     * Map v2 API error codes to the common ApiError enum.
+     *
+     * @param errorCode error code from the v2 API response
+     * @return corresponding ApiError
+     */
+    public static ApiError mapApiError(String errorCode) {
+        switch (Objects.requireNonNull(errorCode)) {
+            case "LOGIN_ERROR":
+            case "NOT_LOGGED_IN":
+                return ApiError.LOGIN_FAILED;
+            case "API_DISABLED":
+                return ApiError.API_DISABLED;
+            case "INCORRECT_USAGE":
+                return ApiError.API_INCORRECT_USAGE;
+            default:
+                return ApiError.API_UNKNOWN;
+        }
+    }
+
+    /**
+     * Map HTTP status codes to the common ApiError enum.
+     *
+     * @param httpCode raw HTTP response status code
+     * @return corresponding ApiError
+     */
+    public static ApiError mapHttpStatusError(int httpCode) {
+        switch (httpCode) {
+            case 400:
+                return ApiError.HTTP_BAD_REQUEST;
+            case 401:
+                return ApiError.HTTP_UNAUTHORIZED;
+            case 403:
+                return ApiError.HTTP_FORBIDDEN;
+            case 404:
+                return ApiError.HTTP_NOT_FOUND;
+            case 405:
+                return ApiError.API_UNKNOWN_METHOD;
+            case 500:
+            case 501:
+                return ApiError.HTTP_SERVER_ERROR;
+            default:
+                return ApiError.HTTP_OTHER_ERROR;
+        }
+    }
+}
diff --git a/org.fox.ttrss/src/main/java/org/fox/ttrss/ApiV2Client.java b/org.fox.ttrss/src/main/java/org/fox/ttrss/ApiV2Client.java
index 12163413..be4e643a 100644
--- a/org.fox.ttrss/src/main/java/org/fox/ttrss/ApiV2Client.java
+++ b/org.fox.ttrss/src/main/java/org/fox/ttrss/ApiV2Client.java
@@ -10,8 +10,6 @@ import androidx.preference.PreferenceManager;
 
 import com.google.gson.Gson;
 import com.google.gson.JsonElement;
-import com.google.gson.JsonObject;
-import com.google.gson.JsonParser;
 
 import org.fox.ttrss.ApiCommon.ApiError;
 import org.fox.ttrss.util.KeyChainKeyManager;
@@ -247,11 +245,16 @@ public class ApiV2Client {
                     Log.d(TAG, "<<< " + payload);
                 }
 
-                return parseV2Response(payload, caller);
+                ApiResponseParser.ParsedResponse parsed = ApiResponseParser.parse(payload);
+                caller.setLastError(parsed.error);
+                caller.setLastErrorMessage(parsed.errorMessage);
+                return parsed.data;
             } else {
                 // Handle HTTP error codes
                 response.body().close();
-                mapHttpStatusError(response.code(), caller);
+                ApiError error = ApiResponseParser.mapHttpStatusError(response.code());
+                caller.setLastError(error);
+                caller.setLastErrorMessage("HTTP " + response.code());
                 return null;
             }
 
@@ -278,95 +281,6 @@ public class ApiV2Client {
         }
     }
 
-    /**
-     * Parse the v2 response wrapper: {"success": true/false, "data": ..., "error": {...}}
-     */
-    private static JsonElement parseV2Response(String payload, ApiCommon.ApiCaller caller) {
-        JsonParser parser = new JsonParser();
-        JsonElement result = parser.parse(payload);
-
-        try {
-            JsonObject resultObj = result.getAsJsonObject();
-            boolean success = resultObj.get("success").getAsBoolean();
-
-            if (success) {
-                caller.setLastError(ApiError.SUCCESS);
-                JsonElement data = resultObj.get("data");
-                return data != null ? data : JsonParser.parseString("null");
-            } else {
-                // Error response
-                JsonObject errorObj = resultObj.getAsJsonObject("error");
-                String errorCode = errorObj != null && errorObj.has("code")
-                        ? errorObj.get("code").getAsString()
-                        : "UNKNOWN";
-
-                mapApiError(errorCode, caller);
-                return null;
-            }
-        } catch (Exception e) {
-            caller.setLastError(ApiError.PARSE_ERROR);
-            caller.setLastErrorMessage("Failed to parse v2 response: " + e.getMessage());
-            e.printStackTrace();
-            return null;
-        }
-    }
-
-    /**
-     * Map v2 error codes to the common ApiError enum.
-     */
-    private static void mapApiError(String errorCode, ApiCommon.ApiCaller caller) {
-        switch (errorCode) {
-            case "LOGIN_ERROR":
-            case "NOT_LOGGED_IN":
-                caller.setLastError(ApiError.LOGIN_FAILED);
-                break;
-            case "API_DISABLED":
-                caller.setLastError(ApiError.API_DISABLED);
-                break;
-            case "INCORRECT_USAGE":
-                caller.setLastError(ApiError.API_INCORRECT_USAGE);
-                break;
-            default:
-                Log.d(TAG, "Unknown APIv2 error: " + errorCode);
-                caller.setLastErrorMessage(errorCode);
-                caller.setLastError(ApiError.API_UNKNOWN);
-                break;
-        }
-    }
-
-    /**
-     * Map HTTP status codes to the common ApiError enum.
-     */
-    private static void mapHttpStatusError(int httpCode, ApiCommon.ApiCaller caller) {
-        switch (httpCode) {
-            case 400:
-                caller.setLastError(ApiError.HTTP_BAD_REQUEST);
-                break;
-            case 401:
-                caller.setLastError(ApiError.HTTP_UNAUTHORIZED);
-                break;
-            case 403:
-                caller.setLastError(ApiError.HTTP_FORBIDDEN);
-                break;
-            case 404:
-                caller.setLastError(ApiError.HTTP_NOT_FOUND);
-                break;
-            case 405:
-                // @todo what about METHOD_NOT_ALLOWED? do these two share status code?
-                caller.setLastError(ApiError.API_UNKNOWN_METHOD);
-                break;
-            case 500:
-            case 501:
-                caller.setLastError(ApiError.HTTP_SERVER_ERROR);
-                break;
-            default:
-                Log.d(TAG, "HTTP error code: " + httpCode);
-                caller.setLastErrorMessage("HTTP " + httpCode);
-                caller.setLastError(ApiError.HTTP_OTHER_ERROR);
-                break;
-        }
-    }
-
     // ─── Progress support ─────────────────────────────────────────────────────
 
     /**
diff --git a/org.fox.ttrss/src/test/java/org/fox/ttrss/ApiResponseParserTest.java b/org.fox.ttrss/src/test/java/org/fox/ttrss/ApiResponseParserTest.java
new file mode 100644
index 00000000..d75c41b7
--- /dev/null
+++ b/org.fox.ttrss/src/test/java/org/fox/ttrss/ApiResponseParserTest.java
@@ -0,0 +1,239 @@
+package org.fox.ttrss;
+
+import com.google.gson.JsonElement;
+import com.google.gson.JsonParser;
+
+import org.junit.Test;
+
+import org.fox.ttrss.ApiCommon.ApiError;
+import org.fox.ttrss.ApiResponseParser.ParsedResponse;
+
+import static org.junit.Assert.*;
+
+/**
+ * Tests for ApiResponseParser — pure logic, no Android dependencies.
+ */
+public class ApiResponseParserTest {
+
+    // ── parse() — success responses ────────────────────────────────────────
+
+    @Test
+    public void parse_successResponse_returnsSuccessTrue() {
+        String json = "{\"success\":true,\"data\":{\"hello\":\"world\"},\"error\":null}";
+        ParsedResponse result = ApiResponseParser.parse(json);
+
+        assertTrue("Should be successful", result.success);
+        assertEquals("Error should be SUCCESS", ApiError.SUCCESS, result.error);
+    }
+
+    @Test
+    public void parse_successResponse_returnsData() {
+        String json = "{\"success\":true,\"data\":{\"count\":42},\"error\":null}";
+        ParsedResponse result = ApiResponseParser.parse(json);
+
+        assertNotNull("Data should not be null", result.data);
+        assertEquals("Data should be correct", JsonParser.parseString("{\"count\":42}"), result.data);
+    }
+
+    @Test
+    public void parse_successResponse_withNullData_returnsNullElement() {
+        String json = "{\"success\":true,\"data\":null,\"error\":null}";
+        ParsedResponse result = ApiResponseParser.parse(json);
+
+        assertTrue("Should be successful", result.success);
+        assertNotNull("Data element should exist (null JsonElement)", result.data);
+        assertTrue("Data should be null JSON", result.data.isJsonNull());
+    }
+
+    @Test
+    public void parse_successResponse_withEmptyDataObject() {
+        String json = "{\"success\":true,\"data\":{},\"error\":null}";
+        ParsedResponse result = ApiResponseParser.parse(json);
+
+        assertTrue("Should be successful", result.success);
+        assertNotNull("Data should not be null", result.data);
+        assertTrue("Data should be an empty object", result.data.isJsonObject());
+    }
+
+    // ── parse() — error responses ──────────────────────────────────────────
+
+    @Test
+    public void parse_errorResponse_returnsSuccessFalse() {
+        String json = "{\"success\":false,\"data\":null,\"error\":{\"code\":\"LOGIN_ERROR\"}}";
+        ParsedResponse result = ApiResponseParser.parse(json);
+
+        assertFalse("Should not be successful", result.success);
+        assertNotNull("Error should be set", result.error);
+    }
+
+    @Test
+    public void parse_errorResponse_loginError_mapsToLOGIN_FAILED() {
+        String json = "{\"success\":false,\"data\":null,\"error\":{\"code\":\"LOGIN_ERROR\"}}";
+        ParsedResponse result = ApiResponseParser.parse(json);
+
+        assertEquals("LOGIN_ERROR should map to LOGIN_FAILED", ApiError.LOGIN_FAILED, result.error);
+    }
+
+    @Test
+    public void parse_errorResponse_notLoggedIn_mapsToLOGIN_FAILED() {
+        String json = "{\"success\":false,\"data\":null,\"error\":{\"code\":\"NOT_LOGGED_IN\"}}";
+        ParsedResponse result = ApiResponseParser.parse(json);
+
+        assertEquals("NOT_LOGGED_IN should map to LOGIN_FAILED", ApiError.LOGIN_FAILED, result.error);
+    }
+
+    @Test
+    public void parse_errorResponse_apiDisabled_mapsToAPI_DISABLED() {
+        String json = "{\"success\":false,\"data\":null,\"error\":{\"code\":\"API_DISABLED\"}}";
+        ParsedResponse result = ApiResponseParser.parse(json);
+
+        assertEquals("API_DISABLED should map to API_DISABLED", ApiError.API_DISABLED, result.error);
+    }
+
+    @Test
+    public void parse_errorResponse_incorrectUsage_mapsToAPI_INCORRECT_USAGE() {
+        String json = "{\"success\":false,\"data\":null,\"error\":{\"code\":\"INCORRECT_USAGE\"}}";
+        ParsedResponse result = ApiResponseParser.parse(json);
+
+        assertEquals("INCORRECT_USAGE should map to API_INCORRECT_USAGE", ApiError.API_INCORRECT_USAGE, result.error);
+    }
+
+    @Test
+    public void parse_errorResponse_unknownCode_mapsToAPI_UNKNOWN() {
+        String json = "{\"success\":false,\"data\":null,\"error\":{\"code\":\"SOME_UNKNOWN_CODE\"}}";
+        ParsedResponse result = ApiResponseParser.parse(json);
+
+        assertEquals("Unknown error should map to API_UNKNOWN", ApiError.API_UNKNOWN, result.error);
+    }
+
+    @Test
+    public void parse_errorResponse_missingCode_mapsToAPI_UNKNOWN() {
+        String json = "{\"success\":false,\"data\":null,\"error\":{}}";
+        ParsedResponse result = ApiResponseParser.parse(json);
+
+        assertEquals("Missing error code should map to API_UNKNOWN", ApiError.API_UNKNOWN, result.error);
+    }
+
+    @Test
+    public void parse_errorResponse_missingErrorField_mapsToAPI_UNKNOWN() {
+        String json = "{\"success\":false,\"data\":null}";
+        ParsedResponse result = ApiResponseParser.parse(json);
+
+        assertEquals("Missing error object should map to API_UNKNOWN", ApiError.API_UNKNOWN, result.error);
+    }
+
+    // ── parse() — malformed responses ──────────────────────────────────────
+
+    @Test
+    public void parse_malformedJson_returnsParseError() {
+        String json = "not valid json at all";
+        ParsedResponse result = ApiResponseParser.parse(json);
+
+        assertFalse("Should not be successful", result.success);
+        assertEquals("Should be PARSE_ERROR", ApiError.PARSE_ERROR, result.error);
+        assertNotNull("Error message should be set", result.errorMessage);
+        assertTrue("Error message should mention parse", result.errorMessage.contains("parse"));
+    }
+
+    @Test
+    public void parse_missingSuccessField_returnsParseError() {
+        String json = "{\"data\":{\"hello\":\"world\"}}";
+        ParsedResponse result = ApiResponseParser.parse(json);
+
+        assertFalse("Should not be successful", result.success);
+        assertEquals("Missing success field should be PARSE_ERROR", ApiError.PARSE_ERROR, result.error);
+    }
+
+    @Test
+    public void parse_emptyString_returnsParseError() {
+        ParsedResponse result = ApiResponseParser.parse("");
+
+        assertFalse("Should not be successful", result.success);
+        assertEquals("Empty string should be PARSE_ERROR", ApiError.PARSE_ERROR, result.error);
+    }
+
+    // ── mapApiError() — direct tests ───────────────────────────────────────
+
+    @Test
+    public void mapApiError_loginError_returnsLOGIN_FAILED() {
+        assertEquals(ApiError.LOGIN_FAILED, ApiResponseParser.mapApiError("LOGIN_ERROR"));
+    }
+
+    @Test
+    public void mapApiError_notLoggedIn_returnsLOGIN_FAILED() {
+        assertEquals(ApiError.LOGIN_FAILED, ApiResponseParser.mapApiError("NOT_LOGGED_IN"));
+    }
+
+    @Test
+    public void mapApiError_apiDisabled_returnsAPI_DISABLED() {
+        assertEquals(ApiError.API_DISABLED, ApiResponseParser.mapApiError("API_DISABLED"));
+    }
+
+    @Test
+    public void mapApiError_incorrectUsage_returnsAPI_INCORRECT_USAGE() {
+        assertEquals(ApiError.API_INCORRECT_USAGE, ApiResponseParser.mapApiError("INCORRECT_USAGE"));
+    }
+
+    @Test
+    public void mapApiError_unknown_returnsAPI_UNKNOWN() {
+        assertEquals(ApiError.API_UNKNOWN, ApiResponseParser.mapApiError("SOME_RANDOM_ERROR"));
+    }
+
+    // ── mapHttpStatusError() — direct tests ────────────────────────────────
+
+    @Test
+    public void mapHttpStatusError_400_returnsHTTP_BAD_REQUEST() {
+        assertEquals(ApiError.HTTP_BAD_REQUEST, ApiResponseParser.mapHttpStatusError(400));
+    }
+
+    @Test
+    public void mapHttpStatusError_401_returnsHTTP_UNAUTHORIZED() {
+        assertEquals(ApiError.HTTP_UNAUTHORIZED, ApiResponseParser.mapHttpStatusError(401));
+    }
+
+    @Test
+    public void mapHttpStatusError_403_returnsHTTP_FORBIDDEN() {
+        assertEquals(ApiError.HTTP_FORBIDDEN, ApiResponseParser.mapHttpStatusError(403));
+    }
+
+    @Test
+    public void mapHttpStatusError_404_returnsHTTP_NOT_FOUND() {
+        assertEquals(ApiError.HTTP_NOT_FOUND, ApiResponseParser.mapHttpStatusError(404));
+    }
+
+    @Test
+    public void mapHttpStatusError_405_returnsAPI_UNKNOWN_METHOD() {
+        assertEquals(ApiError.API_UNKNOWN_METHOD, ApiResponseParser.mapHttpStatusError(405));
+    }
+
+    @Test
+    public void mapHttpStatusError_500_returnsHTTP_SERVER_ERROR() {
+        assertEquals(ApiError.HTTP_SERVER_ERROR, ApiResponseParser.mapHttpStatusError(500));
+    }
+
+    @Test
+    public void mapHttpStatusError_501_returnsHTTP_SERVER_ERROR() {
+        assertEquals(ApiError.HTTP_SERVER_ERROR, ApiResponseParser.mapHttpStatusError(501));
+    }
+
+    @Test
+    public void mapHttpStatusError_502_returnsHTTP_OTHER_ERROR() {
+        assertEquals(ApiError.HTTP_OTHER_ERROR, ApiResponseParser.mapHttpStatusError(502));
+    }
+
+    @Test
+    public void mapHttpStatusError_503_returnsHTTP_OTHER_ERROR() {
+        assertEquals(ApiError.HTTP_OTHER_ERROR, ApiResponseParser.mapHttpStatusError(503));
+    }
+
+    @Test
+    public void mapHttpStatusError_200_returnsHTTP_OTHER_ERROR() {
+        // 200 is a success code, but this method is only called for error responses
+        assertEquals(ApiError.HTTP_OTHER_ERROR, ApiResponseParser.mapHttpStatusError(200));
+    }
+
+    @Test
+    public void mapHttpStatusError_999_returnsHTTP_OTHER_ERROR() {
+        assertEquals(ApiError.HTTP_OTHER_ERROR, ApiResponseParser.mapHttpStatusError(999));
+    }
+}