updated vignette and readme

JBGruber · Oct 8, 2024 · c2a8843 · c2a8843
1 parent 47d8477
commit c2a8843
Show file tree

Hide file tree

Showing 8 changed files with 315 additions and 122 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -21,6 +21,7 @@ export(tt_get_liked)
 export(tt_get_pinned)
 export(tt_get_reposted)
 export(tt_json)
+export(tt_playlist)
 export(tt_playlist_api)
 export(tt_query_videos)
 export(tt_request_hidden)

diff --git a/R/api_research.r b/R/api_research.r
@@ -901,6 +901,12 @@ api_error_handler <- function(resp) {
 api_user_error_checker <- function(resp) {
   if (httr2::resp_status(resp) < 400L) return(FALSE)
   if (httr2::resp_status(resp) == 404L) return(TRUE)
+  # it looks like the API sometimes returns 500 falsely, but in these cases, no
+  # error message is present
+  if (httr2::resp_status(resp) == 500L &&
+      !purrr::pluck_exists(httr2::resp_body_json(resp), "error", "message")) {
+    return(FALSE)
+  }
   # if likes can't be accessed, which is true for many users, this should
   # not throw an error
   if (grepl("information.cannot.be.returned",

diff --git a/R/shorthands.r b/R/shorthands.r
@@ -61,6 +61,11 @@ tt_videos <- function(...) {
 tt_user_info <- tt_user_info_api
 
 
+#' @rdname tt_playlist_api
+#' @export
+tt_playlist <- tt_playlist_api
+
+
 #' @rdname tt_user_liked_videos_api
 #' @export
 tt_get_liked <- tt_user_liked_videos_api

diff --git a/README.Rmd b/README.Rmd
@@ -33,9 +33,9 @@ knitr::opts_chunk$set(
 | get comments under a video  | tt_comments      | tt_comments_api           | \-                      |
 | get who follows a user      | tt_get_follower  | tt_user_follower_api      | tt_get_follower_hidden  |
 | get who a user is following | tt_get_following | tt_user_following_api     | tt_get_following_hidden |
-| get videos a user liked     | tt_get_liked     | tt_user_liked_videos_api  | \-
-| ???                         |                  | tt_user_pinned_videos_api | \-
-| ???                         |                  | tt_playlist_info_api      | \-
+| get videos a user liked     | tt_get_liked     | tt_user_liked_videos_api  | \-                      |
+| get pinned videos of users  | tt_get_pinned    | tt_user_pinned_videos_api | \-                      |
+| get videos in a playlist    | tt_playlist      | tt_playlist_api           | \-                      |
 | get raw video data          | \-               | \-                        | tt_request_hidden       |
 | authenticate a session      | \-               | auth_research             | auth_hidden             |
 

diff --git a/README.md b/README.md
@@ -15,16 +15,20 @@ coverage](https://codecov.io/gh/JBGruber/traktok/branch/main/graph/badge.svg)](h
 
 ## Feature overview
 
-| Description                 | Shorthand        | Research API     | Hidden API              |
-|:----------------------------|:-----------------|:-----------------|:------------------------|
-| search videos               | tt_search        | tt_search_api    | tt_search_hidden        |
-| get video detail (+file)    | tt_videos        | \-               | tt_videos_hidden        |
-| get user videos             | tt_user_info     | tt_user_info_api | \-                      |
-| get comments under a video  | tt_comments      | tt_comments_api  | \-                      |
-| get who follows a user      | tt_get_follower  | \-               | tt_get_follower_hidden  |
-| get who a user is following | tt_get_following | \-               | tt_get_following_hidden |
-| get raw video data          | \-               | \-               | tt_request_hidden       |
-| authenticate a session      | \-               | auth_research    | auth_hidden             |
+| Description                 | Shorthand        | Research API              | Hidden API              |
+|:----------------------------|:-----------------|:--------------------------|:------------------------|
+| search videos               | tt_search        | tt_search_api             | tt_search_hidden        |
+| get video detail (+file)    | tt_videos        | \-                        | tt_videos_hidden        |
+| get user videos             | tt_user_info     | tt_user_info_api          | tt_user_videos_hidden   |
+| get user info               | tt_user_info     | tt_user_info_api          | tt_user_videos_hidden   |
+| get comments under a video  | tt_comments      | tt_comments_api           | \-                      |
+| get who follows a user      | tt_get_follower  | tt_user_follower_api      | tt_get_follower_hidden  |
+| get who a user is following | tt_get_following | tt_user_following_api     | tt_get_following_hidden |
+| get videos a user liked     | tt_get_liked     | tt_user_liked_videos_api  | \-                      |
+| get pinned videos of users  | tt_get_pinned    | tt_user_pinned_videos_api | \-                      |
+| get videos in a playlist    | tt_playlist      | tt_playlist_api           | \-                      |
+| get raw video data          | \-               | \-                        | tt_request_hidden       |
+| authenticate a session      | \-               | auth_research             | auth_hidden             |
 
 The goal of traktok is to provide easy access to TikTok data. This
 package one started as an R port of Deen Freelon’s

diff --git a/man/tt_playlist_api.Rd b/man/tt_playlist_api.Rd