Refactor request logic (#332)

* refactor request logic

* move the retry logic to the http client

* small cleanup + tests

* remove invalid comment

* add integration test support + IT for TmdbHttpClient

* update comment

Author: c-eg

README.md

@@ -9,30 +9,7 @@ The wrapper implements most, if not all, of the JSON API. However, because the A
 not be implemented, or current functionality may break. Please point this out by submitting an issue, or even better, just send us a pull 
 request!
 
-It's available via [Maven Central](https://central.sonatype.com/artifact/uk.co.conoregan/themoviedbapi). Just add it as dependency to your 
-project.
-
-<details open>
-<summary>Maven</summary>
-
-```xml
-<dependency>
-    <groupId>uk.co.conoregan</groupId>
-    <artifactId>themoviedbapi</artifactId>
-    <version>{version}</version>
-</dependency>
-```
-</details>
-
-<details>
-<summary>Gradle (Kotlin)</summary>
-
-```kotlin
-dependencies {
-    implementation("uk.co.conoregan:themoviedbapi:{version}")
-}
-```
-</details>
+It's available via [Maven Central](https://central.sonatype.com/artifact/uk.co.conoregan/themoviedbapi). Just add it as dependency to your project.
 
 ## Usage
 To register for a TMdB API key, click the [API link](https://www.themoviedb.org/settings/api) from within your account settings page. There are two types of API keys currently provided by TMdB, please ensure you are using the `API Read Access Token` key.
@@ -42,6 +19,9 @@ With this you can instantiate `info.movito.themoviedbapi.TmdbApi`, which has get
 TmdbApi tmdbApi = new TmdbApi("<apikey>");
 ```
 
+By default this uses the library's built-in HTTP client. If you would rather plug in your own, see
+[Using your own HTTP client](#using-your-own-http-client).
+
 ### Examples
 #### Get movie details
 ```java
@@ -78,7 +58,7 @@ MovieDb movie = tmdbMovies.getDetails(5353, "en-US", MovieAppendToResponse.value
 To find all methods that use append to response, see the `info.movito.themoviedbapi.tools.appendtoresponse.AppendToResponse` interface 
 implementations.
 
-### Exception Handling
+### Exception handling
 Every API method can throw a `info.movito.themoviedbapi.tools.TmdbException` if the request fails for any reason. You should catch this 
 exception and handle it appropriately.
 
@@ -106,6 +86,20 @@ catch (TmdbException exception) {
 We chose to throw exceptions rather than returning `null`, so you have more control over what you do with each failure case. E.g. with the
 example above, you may want to display an error message to the user about failing authentication.
 
+### Using your own HTTP client
+By default, `TmdbApi` uses the built-in `info.movito.themoviedbapi.tools.TmdbHttpClient`, which is backed by the JDK's
+`java.net.http.HttpClient`. If you would rather use a different HTTP client, you can provide your own
+implementation of the `info.movito.themoviedbapi.tools.TmdbRequestExecutor` interface.
+
+Your implementation only has to make the call and hand back the raw response. If the request fails (e.g. an `IOException`), wrap it in a 
+`info.movito.themoviedbapi.tools.TmdbException`. Interpreting TMdB status codes (e.g. mapping unsuccessful responses to exceptions) is handled by the library on top of your executor, so 
+you do not need to deal with that (see `info.movito.themoviedbapi.tools.TmdbApiClient` for more information).
+
+Then, simply pass your implementation to `TmdbApi` instead of the API key:
+```java
+TmdbApi tmdbApi = new TmdbApi(new CustomHttpClient());
+```
+
 ## Project Logging
 
 This project uses [SLF4J](http://www.slf4j.org) to abstract the logging in the project. To use the logging in your own

build.gradle.kts

@@ -28,6 +28,8 @@ dependencies {
     testImplementation("org.mockito:mockito-core")
     testImplementation("org.mockito:mockito-junit-jupiter")
 
+    testImplementation("org.wiremock:wiremock:3.13.2")
+
     // util
     compileOnly("org.projectlombok:lombok:1.18.46")
     annotationProcessor("org.projectlombok:lombok:1.18.46")
@@ -49,7 +51,24 @@ java {
 }
 
 tasks.test {
-    useJUnitPlatform()
+    useJUnitPlatform {
+        excludeTags("integration")
+    }
+}
+
+tasks.register<Test>("integrationTest") {
+    description = "Runs integration tests (tagged with \"integration\")."
+    group = "verification"
+    useJUnitPlatform {
+        includeTags("integration")
+    }
+    testClassesDirs = sourceSets["test"].output.classesDirs
+    classpath = sourceSets["test"].runtimeClasspath
+    shouldRunAfter(tasks.test)
+}
+
+tasks.check {
+    dependsOn("integrationTest")
 }
 
 checkstyle {

src/main/java/info/movito/themoviedbapi/AbstractTmdbApi.java

@@ -12,6 +12,7 @@
 import info.movito.themoviedbapi.model.rated.RatedTvSeriesResultsPage;
 import info.movito.themoviedbapi.tools.ApiUrl;
 import info.movito.themoviedbapi.tools.RequestType;
+import info.movito.themoviedbapi.tools.TmdbApiClient;
 import info.movito.themoviedbapi.tools.TmdbException;
 import info.movito.themoviedbapi.tools.sortby.AccountSortBy;
 import info.movito.themoviedbapi.util.JsonUtil;
@@ -20,15 +21,17 @@
  * The movie database api for accounts. See the
  * <a href="https://developer.themoviedb.org/reference/account-details">documentation</a> for more info.
  */
-public class TmdbAccount extends AbstractTmdbApi {
+public class TmdbAccount {
     public static final String PARAM_SESSION = "session_id";
     protected static final String TMDB_METHOD_ACCOUNT = "account";
 
+    private final TmdbApiClient tmdbApiClient;
+
     /**
      * Create a new TmdbAccount instance to call the account related TMDb API methods.
      */
-    TmdbAccount(TmdbApi tmdbApi) {
-        super(tmdbApi);
+    TmdbAccount(TmdbApiClient tmdbApiClient) {
+        this.tmdbApiClient = tmdbApiClient;
     }
 
     /**
@@ -44,7 +47,7 @@ public Account getDetails(Integer accountId, String sessionId) throws TmdbExcept
         ApiUrl apiUrl = new ApiUrl(TMDB_METHOD_ACCOUNT, accountId)
             .addQueryParam(PARAM_SESSION, sessionId);
 
-        return mapJsonResult(apiUrl, Account.class);
+        return tmdbApiClient.get(apiUrl, Account.class);
     }
 
     /**
@@ -90,7 +93,7 @@ private ResponseStatus changeFavoriteStatus(Integer accountId, String sessionId,
         body.put("favorite", isFavorite);
 
         String jsonBody = JsonUtil.toJson(body);
-        return mapJsonResult(apiUrl, jsonBody, RequestType.POST, ResponseStatus.class);
+        return tmdbApiClient.request(apiUrl, jsonBody, RequestType.POST, ResponseStatus.class);
     }
 
     /**
@@ -136,7 +139,7 @@ private ResponseStatus changeWatchListStatus(Integer accountId, String sessionId
         body.put("watchlist", isWatchList);
 
         String jsonBody = JsonUtil.toJson(body);
-        return mapJsonResult(apiUrl, jsonBody, RequestType.POST, ResponseStatus.class);
+        return tmdbApiClient.request(apiUrl, jsonBody, RequestType.POST, ResponseStatus.class);
     }
 
     /**
@@ -159,7 +162,7 @@ public MovieResultsPage getFavoriteMovies(Integer accountId, String sessionId, S
             .addPage(page)
             .addSortBy(sortBy);
 
-        return mapJsonResult(apiUrl, MovieResultsPage.class);
+        return tmdbApiClient.get(apiUrl, MovieResultsPage.class);
     }
 
     /**
@@ -182,7 +185,7 @@ public TvSeriesResultsPage getFavoriteTv(Integer accountId, String sessionId, St
             .addPage(page)
             .addSortBy(sortBy);
 
-        return mapJsonResult(apiUrl, TvSeriesResultsPage.class);
+        return tmdbApiClient.get(apiUrl, TvSeriesResultsPage.class);
     }
 
     /**
@@ -200,7 +203,7 @@ public MovieListResultsPage getLists(Integer accountId, String sessionId, Intege
             .addQueryParam(PARAM_SESSION, sessionId)
             .addPage(page);
 
-        return mapJsonResult(apiUrl, MovieListResultsPage.class);
+        return tmdbApiClient.get(apiUrl, MovieListResultsPage.class);
     }
 
     /**
@@ -223,7 +226,7 @@ public RatedMovieResultsPage getRatedMovies(int accountId, String sessionId, Str
             .addPage(page)
             .addSortBy(sortBy);
 
-        return mapJsonResult(apiUrl, RatedMovieResultsPage.class);
+        return tmdbApiClient.get(apiUrl, RatedMovieResultsPage.class);
     }
 
     /**
@@ -246,7 +249,7 @@ public RatedTvSeriesResultsPage getRatedTvSeries(int accountId, String sessionId
             .addPage(page)
             .addSortBy(sortBy);
 
-        return mapJsonResult(apiUrl, RatedTvSeriesResultsPage.class);
+        return tmdbApiClient.get(apiUrl, RatedTvSeriesResultsPage.class);
     }
 
     /**
@@ -269,7 +272,7 @@ public RatedTvEpisodeResultsPage getRatedTvEpisodes(int accountId, String sessio
             .addPage(page)
             .addSortBy(sortBy);
 
-        return mapJsonResult(apiUrl, RatedTvEpisodeResultsPage.class);
+        return tmdbApiClient.get(apiUrl, RatedTvEpisodeResultsPage.class);
     }
 
     /**
@@ -292,7 +295,7 @@ public MovieResultsPage getWatchListMovies(Integer accountId, String sessionId,
             .addPage(page)
             .addSortBy(sortBy);
 
-        return mapJsonResult(apiUrl, MovieResultsPage.class);
+        return tmdbApiClient.get(apiUrl, MovieResultsPage.class);
     }
 
     /**
@@ -315,7 +318,7 @@ public TvSeriesResultsPage getWatchListTvSeries(Integer accountId, String sessio
             .addPage(page)
             .addSortBy(sortBy);
 
-        return mapJsonResult(apiUrl, TvSeriesResultsPage.class);
+        return tmdbApiClient.get(apiUrl, TvSeriesResultsPage.class);
     }
 
     /**