Merge pull request #58 from wjakethompson/the-life-of-a-showgirl

The Life of a Showgirl

Author: wjakethompson

.Rbuildignore

@@ -12,5 +12,6 @@
 ^\.github$
 ^\.lintr$
 ^CRAN-SUBMISSION$
+^\.httr-oauth$
 ^[.]?air[.]toml$
 ^\.vscode$

.github/workflows/R-CMD-check.yaml

@@ -24,7 +24,7 @@ jobs:
           - {os: windows-latest, r: 'release'}
           - {os: ubuntu-latest,   r: 'devel', http-user-agent: 'release'}
           - {os: ubuntu-latest,   r: 'release'}
-          - {os: ubuntu-latest,   r: 'oldrel-1'}
+          # - {os: ubuntu-latest,   r: 'oldrel-1'}
 
     env:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -4,5 +4,6 @@
 .Ruserdata
 docs
 inst/doc
+.httr-oauth
 data-raw/*.rds
 data-raw/soundstat/*.rds

DESCRIPTION

@@ -7,7 +7,7 @@ Authors@R:
 Description: A comprehensive resource for data on Taylor Swift songs. Data
     is included for all officially released studio albums, extended plays
     (EPs), and individual singles are included. Data comes from 'Genius'
-    (lyrics) and 'Spotify' (song characteristics). Additional functions
+    (lyrics) and 'SoundStat' (song characteristics). Additional functions
     are included for easily creating data visualizations with color
     palettes inspired by Taylor Swift's album covers.
 License: MIT + file LICENSE

NAMESPACE

@@ -33,7 +33,9 @@ export(scale_fill_taylor_b)
 export(scale_fill_taylor_c)
 export(scale_fill_taylor_d)
 export(set_soundstat_api_key)
+export(set_spotify_api_key)
 export(taylor_examples)
+export(taylor_sitrep)
 export(title_case)
 export(translate_bracelet)
 import(vctrs)

NEWS.md

@@ -1,5 +1,23 @@
 # taylor (development version)
 
+* New data and visualization tools have been added for
+  *The Life of a Showgirl*.
+  * Added lyrics and SoundState audio features to `taylor_all_songs` and
+    `taylor_album_songs`.
+  * Added composite critic score from Metacritic to `taylor_albums`.
+  * Added a new themed color palette to `album_palettes`.
+  * Added a new single color to `album_compare`.
+
+* New functions for accessing APIs for track information
+  (`get_spotify_track_info()`) and audio features
+  (`get_soundstat_audio_features()` and `get_reccobeats_audio_features()`).
+
+* New helper functions for setting up API configuration.
+  * `set_spotify_api_key()` / `get_spotify_api_key()`
+  * `set_soundstat_api_key()` / `get_soundstat_api_key()`
+
+* `taylor_sitrep()` can be used to quickly check the configuration of API keys.
+
 * Updated data API due to Spotify changes. Implications for data:
   * Lost columns: `liveness`, `speechiness`, `time_signature`
   * Data may be slightly different due to differences between the Spotify and
@@ -50,9 +68,8 @@
 * New data and visualization tools have been added for
   *THE TORTURED POETS DEPARTMENT*.
   * Added lyrics and Spotify audio features to `taylor_all_songs` and
-  `taylor_album_songs`.
-  * Added composite critic score from Metacritic to
-  `taylor_albums`.
+    `taylor_album_songs`.
+  * Added composite critic score from Metacritic to `taylor_albums`.
   * Added a new themed color palette to `album_palettes`.
   * Added a new single color to `album_compare`.
 

R/api-access.R

@@ -32,7 +32,12 @@ get_spotify_track_info <- function(
   api_key = get_spotify_access_token()
 ) {
   check_character(track_id, allow_na = TRUE)
-  check_character(api_key)
+  check_character(api_key$client_id)
+  check_character(api_key$client_secret)
+  api_key <- spotifyr::get_spotify_access_token(
+    client_id = api_key$client_id,
+    client_secret = api_key$client_secret
+  )
 
   if (is.na(track_id) || track_id == "") {
     return(NULL)
@@ -60,19 +65,24 @@ get_spotify_track_info <- function(
 
 #' Spotify API helpers
 #'
-#' This is a wrapper around [spotifyr::get_spotify_access_token()] to create a
-#' Spotify access token from stored environment variables.
+#' Set and retrieve Spotify client information.
+#'
+#' @param id A Spotify Client ID.
+#' @param secret A Spotify Client Secret.
 #'
-#' @returns The Spotify access token.
+#' @returns
+#'   * `get_spotify_api_key()` returns a previously stored Client ID and Secret.
+#'   * `set_spotify_api_key()` is called for side effects only.
+#' @name spotify-api
 #' @export
 #'
 #' @examplesIf taylor_examples()
 #' \donttest{get_spotify_access_token()}
 get_spotify_access_token <- function() {
   client_id <- Sys.getenv("SPOTIFY_CLIENT_ID")
   client_secret <- Sys.getenv("SPOTIFY_CLIENT_SECRET")
-  if (!any(identical(client_id, ""), identical(client_secret, ""))) {
-    token <- spotifyr::get_spotify_access_token(
+  if (all(nzchar(client_id), nzchar(client_secret))) {
+    token <- list(
       client_id = client_id,
       client_secret = client_secret
     )
@@ -85,16 +95,39 @@ get_spotify_access_token <- function() {
     cli::cli_abort(
       cli::format_message(
         c(
-          "No access token found, please see",
+          "Client ID or Secret not found, please see",
           "{.fun spotifyr::get_spotify_access_token}"
         )
       )
     )
   }
 }
 
+#' @export
+#' @rdname spotify-api
+set_spotify_api_key <- function(id = NULL, secret = NULL) {
+  check_character(id, allow_null = TRUE)
+  check_character(secret, allow_null = TRUE)
+
+  if (is.null(id)) {
+    id <- askpass::askpass("Please enter your Client ID")
+    if (is.null(id)) {
+      cli::cli_abort("Client ID not provided")
+    }
+  }
+  Sys.setenv("SPOTIFY_CLIENT_ID" = id)
+
+  if (is.null(secret)) {
+    secret <- askpass::askpass("Please enter your Client Secret")
+    if (is.null(secret)) {
+      cli::cli_abort("Client Secret not provided")
+    }
+  }
+  Sys.setenv("SPOTIFY_CLIENT_SECRET" = secret)
+}
+
 spotify_testing_key <- function() {
-  spotifyr::get_spotify_access_token(
+  list(
     client_id = httr2::secret_decrypt(
       "UOF5NVolAFuZUfPsrqB6zRGiuT2U6kZTly16hmop_vkzywAmTyHJaDuWl13gymsI",
       "TAYLOR_KEY"
@@ -120,10 +153,11 @@ spotify_testing_key <- function() {
 #'
 #' @details
 #' Due to differences in algorithms and methodologies, the SoundStat audio
-#' features are on a slightly different scale than the Spotify audio features
-#' that were originally included in [taylor] prior the [changes to the Spotify
-#' API](). We can convert the SoundStat values to the Spotify scale using the
-#' formulas in the [SoundStat
+#' features are on a slightly different scale than the audio features that were
+#' originally included in [taylor] prior to the [changes to the Spotify
+#' API](https://developer.spotify.com/blog/2024-11-27-changes-to-the-web-api).
+#' We can convert the SoundStat values to the Spotify scale using the formulas
+#' in the [SoundStat
 #' docs](https://soundstat.info/article/Understanding-Audio-Analysis.html):
 #'
 #' ```

R/data.R

@@ -6,18 +6,20 @@
 #'
 #' @details
 #' `taylor_all_songs` contains all songs in Taylor's discography.
-#' Lyrics come from Genius, and songs characteristics come from the Spotify API.
+#' Lyrics come from Genius, and songs characteristics come from the SoundStat
+#' API.
 #' Some data is known to be missing. The Beautiful Eyes EP is not available on
-#' any streaming service, and therefore has no data from the Spotify API.
+#' any streaming service, and therefore has no data from the SoundStat API.
 #' Similarly, the song *American Girl*, a cover of the Tom Petty original, was
 #' released exclusively on Rhapsody (now Napster), and therefore also does not
-#' have data from the Spotify API.
+#' have data from the SoundStat API.
 #'
-#' For songs released separately from Taylor's official albums or EPs, album
-#' information is not included. For example, *I Don't Wanna Live Forever* was
-#' released as part of the *Fifty Shades Darker* movie soundtrack. However, the
-#' `album_name` column for this song is `NA`, indicating that it does not appear
-#' on one of Taylor's albums.
+#' For songs released separately from Taylor's official albums or EPs, full
+#' album information is not included.
+#' For example, *I Don't Wanna Live Forever* was released as part of the
+#' *Fifty Shades Darker (Original Motion Picture Soundtrack)*.
+#' However, the `album_release` and `track_number` columns for this song are
+#' `NA`.
 #'
 #' Songs are only included one time. For example, if a song appears on both the
 #' standard and deluxe version of an album, there is only one record of the
@@ -36,14 +38,6 @@
 #' `taylor_album_songs` contains the same information as `taylor_all_songs`, but
 #' only for Taylor's official studio albums. Thus, `taylor_album_songs` is a
 #' subset of [`taylor_all_songs`], with EPs and individual singles excluded.
-#' Critically, this subset also only includes versions owned by Taylor when
-#' possible, because we stan artists owning their own work. This means that
-#' although both *Fearless* and *Fearless (Taylor's Version)* appear in the full
-#' [`taylor_all_songs`] data, only *Fearless (Taylor's Version)* appears in this
-#' subset. This also means that this data set will change as additional
-#' re-releases are made available (i.e., *Red* was replaced with
-#' *Red (Taylor's Version)* in [version
-#' 1.0.0](https://wjakethompson.com/blog/taylor/2021-12-17-taylor-1.0.0/)).
 #'
 #' @format `taylor_all_songs` is a [tibble][tibble::tibble-package] with
 #' `r nrow(taylor_all_songs)` rows and `r ncol(taylor_all_songs)` variables.
@@ -94,7 +88,7 @@
 #' * `mode`: Modality of a track (major/minor). `0` = minor, `1` = major.
 #'
 #' Finally, the last set of variables includes those calculated from the
-#' Soundstat API data, and a list-column containing song lyrics.
+#' SoundStat API data, and a list-column containing song lyrics.
 #' * `key_name`: Corresponds directly to the `key`, but the integer is converted
 #'   to the key name using Pitch Class notation (e.g., `0` becomes `C`).
 #' * `mode_name`: Corresponds directly to the `mode`, but the integer is

R/ggplot2-color-scales.R

@@ -238,8 +238,17 @@ scale_fill_albums <- function(
   limits = force,
   na.value = NA
 ) {
-  album_pal <- vec_data(taylor::album_compare)
-  names(album_pal) <- taylor::album_levels
+  album_pal <- album_labels() |>
+    dplyr::select("name", "value") |>
+    tibble::deframe()
+
+  album_pal <- rep(album_pal, 4) |>
+    rlang::set_names(c(
+      names(album_pal),
+      tolower(names(album_pal)),
+      toupper(names(album_pal)),
+      title_case(names(album_pal))
+    ))
 
   ggplot2::scale_fill_manual(
     values = album_pal,
@@ -260,8 +269,17 @@ scale_colour_albums <- function(
   limits = force,
   na.value = NA
 ) {
-  album_pal <- vec_data(taylor::album_compare)
-  names(album_pal) <- taylor::album_levels
+  album_pal <- album_labels() |>
+    dplyr::select("name", "value") |>
+    tibble::deframe()
+
+  album_pal <- rep(album_pal, 4) |>
+    rlang::set_names(c(
+      names(album_pal),
+      tolower(names(album_pal)),
+      toupper(names(album_pal)),
+      title_case(names(album_pal))
+    ))
 
   ggplot2::scale_colour_manual(
     values = album_pal,

R/sitrep.R

@@ -0,0 +1,44 @@
+#' Situation report for APIs
+#'
+#' Check configuration status for Spotify and SoundStat APIs.
+#'
+#' @return Called for side effects.
+#' @export
+#'
+#' @examplesIf taylor_examples()
+#' taylor_sitrep()
+taylor_sitrep <- function() {
+  cli::cli_h1("taylor Situation Report")
+
+  display_heading("Spotify Configuration")
+  display_status("SPOTIFY_CLIENT_ID", name = "Client ID")
+  display_status("SPOTIFY_CLIENT_SECRET", name = "Client Secret", n = NULL)
+
+  display_heading("SoundStat Configuration")
+  display_status("SOUNDSTAT_KEY", name = "API Key")
+}
+
+
+has_key <- function(key) {
+  nzchar(Sys.getenv(key))
+}
+
+display_key <- function(key, n = 6) {
+  cli::format_message("{.strong {substr(Sys.getenv(key), 1, n)}}...")
+}
+
+display_status <- function(key, name, n = 6) {
+  if (has_key(key) && !is.null(n)) {
+    cli::cli_alert_success("{name}: {display_key(key, n = n)}")
+  } else if (has_key(key) && is.null(n)) {
+    cli::cli_alert_success("{name}: {.strong Found}")
+  } else {
+    cli::cli_alert_danger("{name}: {.strong Not found}")
+  }
+}
+
+display_heading <- function(text) {
+  cli::cli_div(theme = list(h2 = list(`margin-bottom` = 0)))
+  cli::cli_h2(text)
+  cli::cli_end()
+}