Bump version to 1.3.0 and update JNA dependencies; introduce secret provider interface

Author: LabyStudio

README.md

@@ -47,61 +47,76 @@ if (api.hasPosition()) {
 
 Register a listener to get notified when the song changes:
 ```java
-SpotifyAPI api = SpotifyAPIFactory.create();
-api.registerListener(new SpotifyListener() {
+SpotifyAPI localApi = SpotifyAPIFactory.create();
+localApi.registerListener(new SpotifyListener() {
     @Override
     public void onConnect() {
         System.out.println("Connected to Spotify!");
     }
-    
+
     @Override
     public void onTrackChanged(Track track) {
         System.out.printf("Track changed: %s (%s)\n", track, formatDuration(track.getLength()));
+
+        // You could use the OpenSpotifyAPI to request the track cover image
+        // try {
+        //     BufferedImage imageTrackCover = openApi.requestImage(track);
+        //     System.out.println("Loaded track cover: " + imageTrackCover.getWidth() + "x" + imageTrackCover.getHeight());
+        // } catch (Exception e) {
+        //     System.out.println("Could not load track cover: " + e.getMessage());
+        // }
     }
-    
+
     @Override
     public void onPositionChanged(int position) {
-        if (!api.hasTrack()) {
+        if (!localApi.hasTrack()) {
             return;
         }
-        
-        int length = api.getTrack().getLength();
+
+        int length = localApi.getTrack().getLength();
         float percentage = 100.0F / length * position;
-        
+
         System.out.printf(
-            "Position changed: %s of %s (%d%%)\n",
-            formatDuration(position),
-            formatDuration(length),
-            (int) percentage
+                "Position changed: %s of %s (%d%%)\n",
+                formatDuration(position),
+                formatDuration(length),
+                (int) percentage
         );
     }
-    
+
     @Override
     public void onPlayBackChanged(boolean isPlaying) {
         System.out.println(isPlaying ? "Song started playing" : "Song stopped playing");
     }
-    
+
     @Override
     public void onSync() {
-        
+        // System.out.println(formatDuration(api.getPosition()));
     }
-    
+
     @Override
     public void onDisconnect(Exception exception) {
         System.out.println("Disconnected: " + exception.getMessage());
-        
+
         // api.stop();
     }
 });
 
 // Initialize the API
-api.initialize();
+localApi.initialize();
 ```
 
 Fetch an image of the current playing track:
 ```java
-// Create an instance of the Open Spotify API (Or use SpotifyAPI#getOpenAPI)
-OpenSpotifyAPI openSpotifyAPI = new OpenSpotifyAPI();
+// Create a secret provider
+SecretProvider secretProvider = new DefaultSecretProvider(
+        // Note: You have to update the secret with the latest TOTP secret from open.spotify.com
+        // or find a way to retrieve it automatically from their website
+        Secret.fromString("meZcB\\tlUFV1D6W2Hy4@9+$QaH5)N8", 9)
+);
+
+// Create an instance of the Open Spotify API
+OpenSpotifyAPI openSpotifyAPI = new OpenSpotifyAPI(secretProvider);
 
 // Download the cover art of the current song
 BufferedImage imageTrackCover = openSpotifyAPI.requestImage(track);

build.gradle

@@ -4,7 +4,7 @@ plugins {
 }
 
 group 'de.labystudio'
-version '1.2.4'
+version '1.3.0'
 
 compileJava {
     sourceCompatibility = '1.8'
@@ -21,8 +21,8 @@ repositories {
 }
 
 dependencies {
-    implementation group: 'net.java.dev.jna', name: 'jna', version: '4.5.0'
-    implementation group: 'net.java.dev.jna', name: 'jna-platform', version: '4.5.0'
+    implementation group: 'net.java.dev.jna', name: 'jna', version: '5.14.0'
+    implementation group: 'net.java.dev.jna', name: 'jna-platform', version: '5.14.0'
     implementation group: 'com.google.code.gson', name: 'gson', version: '2.8.9'
 }
 

src/main/java/de/labystudio/spotifyapi/SpotifyAPI.java

@@ -3,7 +3,6 @@
 import de.labystudio.spotifyapi.config.SpotifyConfiguration;
 import de.labystudio.spotifyapi.model.MediaKey;
 import de.labystudio.spotifyapi.model.Track;
-import de.labystudio.spotifyapi.open.OpenSpotifyAPI;
 
 import java.util.concurrent.CompletableFuture;
 
@@ -145,8 +144,6 @@ default boolean hasTrack() {
      */
     SpotifyConfiguration getConfiguration();
 
-    OpenSpotifyAPI getOpenAPI();
-
     /**
      * Disconnect from the Spotify application and stop all background tasks.
      */

src/main/java/de/labystudio/spotifyapi/open/OpenSpotifyAPI.java

@@ -1,14 +1,16 @@
 package de.labystudio.spotifyapi.open;
 
 import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
 import com.google.gson.JsonObject;
 import com.google.gson.stream.JsonReader;
 import de.labystudio.spotifyapi.model.Track;
 import de.labystudio.spotifyapi.open.model.AccessTokenResponse;
 import de.labystudio.spotifyapi.open.model.track.OpenTrack;
-import de.labystudio.spotifyapi.open.totp.Secret;
-import de.labystudio.spotifyapi.open.totp.SecretFetcher;
 import de.labystudio.spotifyapi.open.totp.TOTP;
+import de.labystudio.spotifyapi.open.totp.gson.SecretDeserializer;
+import de.labystudio.spotifyapi.open.totp.model.Secret;
+import de.labystudio.spotifyapi.open.totp.provider.SecretProvider;
 
 import javax.imageio.ImageIO;
 import javax.net.ssl.HttpsURLConnection;
@@ -32,7 +34,9 @@
  */
 public class OpenSpotifyAPI {
 
-    public static final Gson GSON = new Gson();
+    public static final Gson GSON = new GsonBuilder()
+            .registerTypeAdapter(Secret.class, new SecretDeserializer())
+            .create();
 
     public static final String USER_AGENT = "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/138.0.0.0 Safari/537." + (int) (Math.random() * 90);
     public static final String URL_API_GEN_ACCESS_TOKEN = "https://open.spotify.com/api/token?reason=%s&productType=web-player&totp=%s&totpServer=%s&totpVer=%s";
@@ -45,8 +49,14 @@ public class OpenSpotifyAPI {
     private final Cache<BufferedImage> imageCache = new Cache<>(10);
     private final Cache<OpenTrack> openTrackCache = new Cache<>(100);
 
+    private final SecretProvider secretProvider;
+
     private AccessTokenResponse accessTokenResponse;
 
+    public OpenSpotifyAPI(SecretProvider secretProvider) {
+        this.secretProvider = secretProvider;
+    }
+
     /**
      * Generate an access token asynchronously for the open spotify api
      */
@@ -87,8 +97,8 @@ public long requestServerTime() throws IOException {
      * Generate an access token for the open spotify api
      */
     private AccessTokenResponse generateAccessToken() throws IOException {
-        SecretFetcher secretFetcher = new SecretFetcher();
-        Secret secret = secretFetcher.fetchLatest();
+        Secret secret = this.secretProvider.getSecret();
+
         long serverTime = this.requestServerTime();
         String totp = TOTP.generateOtp(secret.toBytes(), serverTime, 30, 6);
 

src/main/java/de/labystudio/spotifyapi/open/totp/SecretFetcher.java

@@ -7,6 +7,12 @@
 import java.security.InvalidKeyException;
 import java.security.NoSuchAlgorithmException;
 
+/**
+ * This class is used to generate a TOTP (Time-based One-Time Password) using the given secret, time, period, and number of digits.
+ * It uses the HMAC-SHA1 algorithm to compute the TOTP based on the provided parameters.
+ *
+ * @author LabyStudio
+ */
 public class TOTP {
 
     private static final String DEFAULT_ALGORITHM = "HmacSHA1";
@@ -23,7 +29,6 @@ public class TOTP {
     public static String generateOtp(byte[] secret, long time, int period, int digits) {
         long counter = time / period;
 
-
         // Convert counter to byte array (Big Endian)
         ByteBuffer buffer = ByteBuffer.allocate(8).order(ByteOrder.BIG_ENDIAN);
         buffer.putLong(counter);
@@ -52,6 +57,4 @@ public static String generateOtp(byte[] secret, long time, int period, int digit
             throw new IllegalStateException("Failed to generate TOTP", e);
         }
     }
-
-
 }