Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/UweTrottmann/trakt-java
An unofficial Java wrapper around the Trakt v2 API using retrofit 2.
https://github.com/UweTrottmann/trakt-java
Last synced: about 2 months ago
JSON representation
An unofficial Java wrapper around the Trakt v2 API using retrofit 2.
- Host: GitHub
- URL: https://github.com/UweTrottmann/trakt-java
- Owner: UweTrottmann
- License: apache-2.0
- Created: 2011-12-04T10:43:04.000Z (almost 13 years ago)
- Default Branch: main
- Last Pushed: 2024-07-12T14:20:34.000Z (2 months ago)
- Last Synced: 2024-07-13T15:28:24.297Z (2 months ago)
- Language: Java
- Homepage:
- Size: 1.55 MB
- Stars: 98
- Watchers: 16
- Forks: 43
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
trakt-java
==========
A Java wrapper around the [Trakt v2 API](https://trakt.docs.apiary.io/) using [retrofit 2](https://square.github.io/retrofit/).
[Pull requests](CONTRIBUTING.md) are welcome.
Trakt methods are grouped into service objects which can be centrally
managed by a `TraktV2` instance. It will act as a factory for
all of the services and will automatically initialize them with your
API key (OAuth client id) and optionally a given user access token.
## Usage
Add the following dependency to your Gradle project:
```groovy
implementation("com.uwetrottmann.trakt5:trakt-java:6.14.0")
```
Or for Maven:
```xml
com.uwetrottmann.trakt5
trakt-java
6.14.0
```
### Android
This library ships Java 8 bytecode. This requires Android Gradle Plugin 3.2.x or newer.
This library depends on [threetenbp](https://github.com/ThreeTen/threetenbp). To avoid
[issues on Android](https://github.com/JakeWharton/ThreeTenABP#why-not-use-threetenbp) you should exclude this
dependency and include [ThreeTenABP](https://github.com/JakeWharton/ThreeTenABP) instead:
```groovy
implementation ("com.uwetrottmann.trakt5:trakt-java:") {
exclude group: "org.threeten", module: "threetenbp"
}
implementation("com.jakewharton.threetenabp:threetenabp:")
```
### Example
Use like any other retrofit2 based service. You only need to supply your
[OAuth 2.0](https://www.digitalocean.com/community/tutorials/an-introduction-to-oauth-2) credentials and optional user
OAuth access token obtained from Trakt.
`TraktV2` provides some helper methods to handle the OAuth 2.0 flow.
```java
TraktV2 trakt = new TraktV2("api_key");
Shows traktShows = trakt.shows();
try {
// Get trending shows
Response> response = traktShows.trending(1, null, Extended.FULL).execute();
if (response.isSuccessful()) {
List shows = response.body();
for (TrendingShow trending : shows) {
System.out.println("Title: " + trending.show.title);
}
} else {
if (response.code() == 401) {
// authorization required, supply a valid OAuth access token
} else {
// the request failed for some other reason
}
}
} catch (Exception e) {
// see execute() javadoc
}
```
See test cases in `src/test/` for more examples and the [retrofit website](https://square.github.io/retrofit/) for configuration options.
## Proguard / R8
It is likely not every method in this library is used, so it is probably useful to strip unused ones with Proguard.
Apply the [Proguard rules for retrofit](https://square.github.io/retrofit/#download).
The specific rules for this library are [already bundled](src/main/resources/META-INF/proguard/trakt-java.pro) into the
release which can be interpreted by R8 automatically, ProGuard users must manually add the rules.
## License
This work by [Uwe Trottmann](https://uwetrottmann.com) is licensed under the [Apache License 2.0](LICENSE.txt).
[Contributors](https://github.com/UweTrottmann/trakt-java/graphs/contributors) and changes are tracked by Git.
Do not just copy, make it better.