Skip to contents

Changelog

Source: NEWS.md

tRakt 0.19.0.9000 (development version)

  • Refreshed the bundled reference datasets (trakt_networks, trakt_genres, trakt_languages, trakt_countries, trakt_certifications) from the API. trakt_networks no longer contains blank or duplicate network names, so looking up networks and filtering by networks is more reliable.

  • New movies_updates() and shows_updates() return media recently updated on trakt.tv since a start_date (default yesterday). The trakt.tv API only serves updates from the last 30 days; older start_dates warn. These endpoints do not support filters.

  • New filter builders filters_movies(), filters_shows(), and filters_episodes() assemble a validated trakt_filters object to pass to the filters argument of the dynamic-list functions (movies_popular(), shows_trending(), …) and search_query(). This centralizes and documents filtering, adds the filters the trakt.tv API gained over time — subgenres, studio_ids, votes, tmdb_ratings/tmdb_votes, imdb_ratings/imdb_votes, rt_meters, rt_user_meters, metascores, network_ids, episode_types — and expands the status vocabulary to all eight API values. Values are validated up front (unknown vocabulary warns and is dropped; out-of-range numbers warn and are ignored). (#36)

  • Passing filters as individual arguments to the dynamic-list functions and search_query() (genres, years, networks, …) is soft-deprecated in favour of the filters argument. The individual arguments keep working for now; if both a filters object and individual arguments are supplied, filters wins and a warning is emitted.

tRakt 0.19.0

  • lists_popular() / lists_trending() gain a type argument ("personal" or "official", default "personal") and now send it as a required path segment. The trakt.tv API changed: the bare lists/popular / lists/trending endpoints now return an empty HTTP 204 response, and the list type must be specified explicitly (lists/popular/:type). Previously these functions silently returned an empty tibble.
  • Fix an error in the networks (and other fixed-vocabulary) filter validation used by the dynamic-list functions (shows_anticipated(), movies_popular(), etc.): a filter value that matched several entries differing only in case or duplicated in the API’s lookup data (e.g. "Netflix" / "NETFLIX") aborted with “Result must be length 1, not 2”. Such values now resolve to a single canonical spelling.
  • trakt_get() now retries transient server errors (HTTP 500, 502, 503, 504) and connection failures, not just the httr2 defaults (429, 503). The trakt.tv API intermittently returns gateway errors (502/504) that succeed on a retry; previously these surfaced as hard failures.
  • New trakt_api_available(): a lightweight, non-erroring check of whether the API is reachable (returns TRUE/FALSE). It is used to guard runnable documentation examples so they execute when the API is up but are skipped (rather than failing) during outages or when offline.
  • Documentation examples for public (non-authenticated) endpoints now run conditionally via @examplesIf trakt_api_available() instead of being hidden in \dontrun{}. They are exercised by R CMD check and example() when the API is reachable, and skipped otherwise, so upstream flakiness no longer produces spurious example failures. Examples that genuinely require authentication remain in \dontrun{}.
  • Tests: vcr cassettes are now replay-only. The previous re_record_interval of 30 days caused CI to make live API calls (and fail on any upstream hiccup or drift) once cassettes aged past the interval. Re-record cassettes deliberately and locally instead.
  • Vignettes (Getting Started, Show Analysis: 24) are now pre-computed: they are authored in vignettes/*.Rmd.orig (with live API code) and knitted into static vignettes/*.Rmd via vignettes/precompile.R. The shipped vignettes contain baked-in output and make no API calls at check/build time, so an upstream outage no longer breaks R CMD check or the pkgdown site. Regenerate them deliberately with make vignettes (or Rscript vignettes/precompile.R).

tRakt 0.18.0

  • The guest_stars argument of shows_people() / seasons_people() / episodes_people() is now deprecated (via lifecycle::deprecate_warn()). The trakt.tv API stopped returning a separate guest_stars array — guest cast is now included in cast. The argument is a no-op pending removal in a future release.
  • Fix vectorisation bug in movies_related() / shows_related(): when called with multiple IDs, the internal recursion forwarded the extended argument positionally as limit, producing malformed ?limit=min URLs and empty responses for non-first IDs (subsequently erroring in column-flattening).
  • seasons_ratings() adapts to the new multi-source rating response shape. The API now returns separate sub-objects per source (trakt, tmdb, imdb, metascore, rotten_tomatoes). The trakt source is promoted to the top level (preserving the existing rating / votes / distribution columns), and external scores are surfaced as <source>_<field> columns (tmdb_rating, imdb_link, metascore_rating, rotten_tomatoes_state, etc.). Missing values are returned as NA.
  • unpack_user() now renames the user’s own trakt id to user_trakt to avoid colliding with the media or list trakt id when an unpacked user is bind_cols()’d alongside other identifiers. Previously this produced auto-repaired column names such as trakt...17. Affects all functions that embed user data: *_lists(), user_lists(), user_list(), user_comments(), user_summary(), comments, media_watching(), and list-popular endpoints.
  • user_list() no longer errors on single-list responses where the embedded user profile contains NULL fields (e.g. age, vip_cover_image); these are now coerced to NA before tibble conversion.
  • shows_people() / seasons_people() / episodes_people() no longer return a separate guest_stars table when called with guest_stars = TRUE, because the trakt API stopped returning that array. Guest cast is now mixed into cast. The guest_stars argument is currently a no-op pending a deprecation decision.
  • Adapt to trakt.tv API response changes:
    • Show results now include plex_guid and plex_slug ID columns, subgenres as a list column, and new fields tagline and original_title.
    • Nested images and colors objects are dropped from show data as they don’t fit tabular output.
    • search_query() and search_id() now return properly structured show data for both extended = "min" and extended = "full".
  • Token refresh failures (e.g. expired or revoked refresh tokens) now fall back to device authentication instead of erroring.
  • Catch up with inconsistent API endpoints:
  • Start using {vcr} for recording API responses.
  • Bump testthat dependency to >=3.0.0, which had been necessary since adopting 3e.
  • Modernize interal purrr usage
    • Swap purrr-style anonymous functions ~ .x with base-R \(x) x-style ones
    • Substitute map_df() with map() + list_rbind()
  • Overhaul the extended parameter across all API functions:
    • "min" no longer sends ?extended=min to the API (which was never a valid API value). Instead, the query parameter is omitted entirely, matching the API’s documented behavior.
    • New values "images", "metadata", and combinations like c("full", "images") or "full,images" are now supported.
    • When extended includes "images", image data is preserved as a list-column instead of being dropped.
    • All functions now use validate_extended() internally instead of match.arg(), providing clearer error messages for invalid values.

tRakt 0.17.0

Switch from {httr} to {httr2}

This should have been a small under the hood change, but it also enabled major changes in the way I’m handling API secrets, allowing me to include my encrypted client secret with the package directly. This should make it more convenient for users to make authenticated requests without having to register their own app on trakt.tv.

The main user-facing highlight however should probably be more stable API interactions including

  • Automatic retries in case of errors (up to 3, currently not cofnigurable)
  • Caching of API results to getOption("tRakt_cache_dir"), which is pruned
    • after 1 week by default (option tRakt_cache_max_age)
    • after exceeding a total of 100MB (option tRakt_cache_max_size)

Minor changes

  • Remove magrittr import and use |> internally, hence bumping the R dependency to >= 4.1.
  • Clean up unused package imports.
  • tRakt_sitrep() is now available to check general settings and API credentials.
  • Switch to testthat 3e.

tRakt 0.16.0

  • Add GitHub actions via usethis::use_github_actions()
  • Use the tidy CI setup via usethis::use_tidy_ci(), this bumps the R dependency to >= 3.2.

Authenticated requests

By default, all requests to the API are now made using authentication if a trakt_client_secret is set. See ?trakt_credentials() for details on how to set your credentials.
If no secret is available, unauthenticated requests are made as in previous versions. In this case, you still need either the built-in or your own trakt_client_id.

OAuth2 support comes with the need to handle secrets, i.e. .httr-oauth files. This can be a pain with headless/automated setups, which is why I am trying to keep “no auth needed” as the default, as most (implemented) endpoints don’t strictly require authentication.

See vignette("Implemented-API-methods", package = "tRakt") for an overview of implemented methods with an indicator on whether authentication is required (it usually isn’t).

New functions

The Renamingering

Rename all the things to snake_case and drop the trakt. prefix.
This results in (most) functions mapping directly to API endpoints in the form section_method, e.g. the API endpoint movies/collected is handled by function movies_collected().

Search

Dynamic Lists

Movies

Shows

Seasons

Ratings

Stats

People

User functions

tRakt 0.15.0

This is a big one, but not 1.0.0 big one I guess.
This is a consolidation release with lots of internal improvements, but for the 1.0.0 I decided to overhaul the structure of the package again, so before I completely break any kind of backwards compatiblity, I thought I’d get this one out.

Consolidation for the people

  • Major refactor of the docs. Sadly, the user will only notice a little more consistency.

  • Consolidate related functions into the same Rd page

  • Centrally document common parameters and reuse them where needed

  • Also consolidate many similar functions by factoring out the relevant bits into more flexible helper functions. In some cases those are exported as well.

  • In the process, some functions where partially renamed (.show. -> .shows., .movie. -> .movies.) for consistency.

  • Rename get_trakt_credentials -> trakt_credentials

  • Many functions now return much flatter output, notably *people* functions. They return a list with cast and crew objects, which in turn are both flat tibbles.

Features

  • Improved search function (trakt.search).
    • If the result has a year that is NA but a search score == 1000, that’s probably bad and dropped.
  • Added more of the automated list methods, like most anticipated, most played and most watched items.
  • Added trakt.user.history for user/:id/history methods

tRakt 0.14.0

Many functions were refactored, which in some cases changes the output.
Not only do most functions return a tibble now, but some additionally computed variables have been removed as well.

Starting to clean things up with some major housekeeping

  • usethis::use_* all the things, basically.
  • Add a pkgdown site and a README.Rmd
  • Use codecov
  • Apply styler::style_pkg()
  • Update documentation to use markdown
  • Redo vignette
  • Tests. So many tests.

Less plyr, more purrr

  • Completely removed plyr dependency in favor of purrr

tRakt 0.13.0

  • Rename trakt.getEpisodeData -> trakt.get_all_episodes
    • Expand handling of season_nums argument to make it easier to get all episodes of a show.
    • Vectorize to enable multiple target input
  • Rename trakt.getFullShowData -> trakt.get_full_showdata

tRakt 0.12.1

  • Vectorize trakt.seasons.summary
  • Fix some bugs
  • Improve tests

tRakt 0.12.0

API changes, functional fixes

  • Add dropunaired param to trakt.seasons.summary (defaults to TRUE).
    • Requires extended to be more than min since the required aired_episodes field is only present with higher levels of detail.
  • Add extended param to trakt.user.f*
  • Fix trakt.user.f* now return NULL when the user is private instead of failing.

Internal changes

  • User internal, generalized functions to reduce duplicate code for the following:
    • trakt.*.popular
    • trakt.*.related
    • trakt.*.trending
    • trakt.*.summary
    • trakt.*.ratings

Vectorization improvements

  • Add multiple target input support (vectorization) for:
    • trakt.user.f* functions: Results will be rbinded together and a source_user column is appended.
    • trakt.seasons.season: Soon to make trakt.getEpisodeData obsolete.
    • trakt.*.summary: Forces force_data_frame to TRUE to enable rbinding.
    • trakt.*.related: Appends source column containing respective input id.
    • trakt.*.ratings: Returns result as a list with each entry containing data for each show or movie to accommodate the distribution variable (data.frame)
    • trakt.people.summary: Appends person column with target id.
    • trakt.*.watching: Returns data.frame with source column containing each target.

tRakt 0.11.3

API changes, functional fixes

  • Add build_trakt_url to ease trakt API URL assembly and reduce duplicate code.
  • Add force_data_frame option to trakt.*.summary: Forces unnesting.
  • Rename trakt.show.stats to trakt.stats, will work with both movies and shows as soon as the API endpoint actually works.

Minor changes

  • Expand @family tags in docs a little

tRakt 0.11.2

API changes, functional fixes

  • Add trakt.movie.watching and trakt.show.watching: Get trakt.tv users watching.
  • Add trakt.movie.releases: Gets release dates & certifications per movie.
  • Fix trakt.search.byid: Used to only work on shows, now actually works on movies.
  • Fix fix_datetime (internal): improve reliability.

Minor changes

  • Fix documentation error in *.movie.* functions.
  • Added tests for new functions

tRakt 0.11.1

  • Internal restructuring (moving functionally similar functions together)
    • TODO: Create generic functions for both movie and show functions to reduce duplicate code
  • Add extended param to trakt.user.watchlist
  • Improve consistency between trakt.user.watched and trakt.user.collection
    • Rename slug to id.slug
    • Ensure proper datetime conversion
  • Fix error in trakt.user.watchlist when type = shows was ignored by accident

tRakt 0.11.0

  • Rename trakt.getSeasons -> trakt.seasons.summary for consistency with the trakt API.
  • Rename trakt.show.season -> trakt.seasons.season for consistency with the trakt API.
  • Rename getNameFromUrl -> parse_trakt_url to be more descriptive. Also, de-camelCasezation.
  • Update vignette to reflect the above changes
  • Add some people functions:
    • trakt.people.summary
    • trakt.people.movies
    • trakt.people.shows
  • Unify output of trakt.show.people and trakt.movie.people
  • Add extended argument to trakt.movies.related and trakt.shows.related (defaults to min)
  • Add page param to paginated functions:
    • trakt.shows.popular
    • trakt.shows.trending
    • trakt.movies.popular
    • trakt.movies.trending
  • The usual bug fixes

tRakt 0.10.3

  • trakt.user.stats:
    • Tidy up rating distribution
    • Remove to.data.frame option because the output is too messy
  • Add another @family tag to docs for aggregation functions (.popular, .trending, .related)
  • Individual functions don’t have to warn about missing headers, that’s trakt.api.call’s job.
  • trakt.getEpisodeData:
    • Explicitly drop episodes with NA firstaired fields
    • The episode_abs field is usually NA, so let’s dump epnum on it
  • Use extended = "min" as default across functions for consistency with the trakt API

tRakt 0.10.2

  • Add year parameter to trakt.search
  • If query in trakt.search ends with a 4 digit number, this will be used as year parameter and stripped from the original query
  • Minor internal fixes

tRakt 0.10.1

  • Add testthat tests
  • Internal changes to how/where datetime variables are converted (user doesn’t see any of that)
  • Various bug fixes

tRakt 0.10.0

  • Add movie functions:
    • trakt.movies.popular: Analogous to trakt.shows.popular
    • trakt.movies.trending: Analogous to trakt.shows.trending
    • trakt.movie.summary: Get a single movie’s details, analogous to trakt.show.summary
    • trakt.movies.related: Get related movies
    • trakt.movie.people: Analogous to trakt.show.people
  • Add both trakt.show.ratings and trakt.movie.ratings to receive just the ratings and distribution for a single show or movie
  • Rename trakt.show.related -> trakt.shows.related for consistency with .trending and .popular
  • Expand allowed target params in accordance with changed trakt API docs

tRakt 0.9.0

  • Specified more exclusive package version requirements to avoid unforseen errors
  • Add trakt.user.ratings: Currently supported types: shows, movies, episodes
  • Add extended option to trakt.shows.popular and .trending
  • Make code in vignette a little more robust

tRakt 0.8.1

  • Fix a whole bunch of typos I only found after the CRAN release, naturally
  • Improve consistency across functions
    • The date fields ending in .posix have been removed and the existing date fiels are now converted to POSIXct to remove cluttering
    • firstaired.posix -> first_aired etc
  • Update vignette for the above change

tRakt 0.8.0

  • Added more user-facing functions (trakt.user.following / .followers / .friends) because maybe I want to throw networkD3 at my people
  • Improve consistency with date variables: The .posix variables should be removed and the existing date variables should just be properly converted to POSIXct
  • Improve documentation: Added @family tags to all functions to group them together
  • Add a package vignette
  • Minor fixes and non-breaking additions
  • Trying to keep things organized and all I got was this inconsistently header’d NEWS.md

tRakt 0.0.1

2015-02-16

I’ve been working on some user-specific methods, so you can now use the trakt.user.* family of functions to get a user’s…

  • Collection: trakt.user.collection()
  • Watched items: trakt.user.watched()
  • Stats: trakt.user.stats()

All of them default to the username set in getOption("trakt.username"), but any publicly viewable user should work. Note that OAuth2 is not implemented, so private users can’t be accessed.

2015-02-11

As of today, all the functions are updated to use the new APIv2, except for trakt.show.stats, which is currently not yet implemented at trakt.tv, see their docs

Now the package is usable again, and I can continue to work on bug fixes and enhancements. Yay.

2015-02-10

I am now trying to migrate everything to the new trakt.tv APIv2. Since I mostly don’t know what I’m doing, I have to make this up as I go along, but oh well. Now the search function trakt.search should be working fine, as it is the only function that is tested/built with the new API in mind. Others to come.