Spotify Web API reference update (#112)

sonallux · web-flow · commit 17d7b984b3ad · 2021-10-17T21:46:03.000+02:00
* Automated update from Spotify Web API reference

* Fix scopes
diff --git a/pom.xml b/pom.xml
@@ -6,7 +6,7 @@
 
     <groupId>de.sonallux.spotify</groupId>
     <artifactId>spotify-web-api-parent</artifactId>
-    <version>2021.8.28</version>
+    <version>2021.10.17</version>
     <packaging>pom</packaging>
 
     <name>spotify-web-api-parent</name>
diff --git a/spotify-web-api-core/pom.xml b/spotify-web-api-core/pom.xml
@@ -7,12 +7,12 @@
     <parent>
         <groupId>de.sonallux.spotify</groupId>
         <artifactId>spotify-web-api-parent</artifactId>
-        <version>2021.8.28</version>
+        <version>2021.10.17</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 
     <artifactId>spotify-web-api-core</artifactId>
-    <version>2021.8.28</version>
+    <version>2021.10.17</version>
     <packaging>jar</packaging>
 
     <name>spotify-web-api-core</name>
diff --git a/spotify-web-api-core/src/main/java/de/sonallux/spotify/core/model/SpotifyWebApiEndpoint.java b/spotify-web-api-core/src/main/java/de/sonallux/spotify/core/model/SpotifyWebApiEndpoint.java
@@ -38,6 +38,11 @@ public SpotifyWebApiEndpoint(@NonNull String id, String name, String link, Strin
         this(id, name, link, description, httpMethod, path, parameters, requestBody, responseDescription, scopes, notes, new ArrayList<>());
     }
 
+    public SpotifyWebApiEndpoint addScope(String scope) {
+        this.scopes.add(scope);
+        return this;
+    }
+
     @Getter
     @Setter
     @NoArgsConstructor
diff --git a/spotify-web-api-core/src/main/resources/spotify-web-api.yml b/spotify-web-api-core/src/main/resources/spotify-web-api.yml
diff --git a/spotify-web-api-generator-open-api/pom.xml b/spotify-web-api-generator-open-api/pom.xml
@@ -7,12 +7,12 @@
     <parent>
         <groupId>de.sonallux.spotify</groupId>
         <artifactId>spotify-web-api-parent</artifactId>
-        <version>2021.8.28</version>
+        <version>2021.10.17</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 
     <artifactId>spotify-web-api-generator-open-api</artifactId>
-    <version>2021.8.28</version>
+    <version>2021.10.17</version>
     <packaging>jar</packaging>
 
     <name>spotify-web-api-generator-open-api</name>
@@ -31,7 +31,7 @@
         <dependency>
             <groupId>de.sonallux.spotify</groupId>
             <artifactId>spotify-web-api-core</artifactId>
-            <version>2021.8.28</version>
+            <version>2021.10.17</version>
         </dependency>
         <dependency>
             <groupId>com.fasterxml.jackson.core</groupId>
diff --git a/spotify-web-api-generator-open-api/spotify-web-api-openapi.yml b/spotify-web-api-generator-open-api/spotify-web-api-openapi.yml
diff --git a/spotify-web-api-parser/pom.xml b/spotify-web-api-parser/pom.xml
@@ -7,12 +7,12 @@
     <parent>
         <groupId>de.sonallux.spotify</groupId>
         <artifactId>spotify-web-api-parent</artifactId>
-        <version>2021.8.28</version>
+        <version>2021.10.17</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 
     <artifactId>spotify-web-api-parser</artifactId>
-    <version>2021.8.28</version>
+    <version>2021.10.17</version>
     <packaging>jar</packaging>
 
     <name>spotify-web-api-parser</name>
@@ -30,7 +30,7 @@
         <dependency>
             <groupId>de.sonallux.spotify</groupId>
             <artifactId>spotify-web-api-core</artifactId>
-            <version>2021.8.28</version>
+            <version>2021.10.17</version>
         </dependency>
         <dependency>
             <groupId>org.jsoup</groupId>
diff --git a/spotify-web-api-parser/src/main/java/de/sonallux/spotify/parser/ApiEndpointParser.java b/spotify-web-api-parser/src/main/java/de/sonallux/spotify/parser/ApiEndpointParser.java
@@ -153,7 +153,7 @@ private SpotifyWebApiEndpoint parseSpotifyApiEndpoint(Elements elements) throws
 
         var requestBody = extractRequestBody(parameters);
 
-        var scopes = extractScopes(id, parameters);
+        var scopes = new ArrayList<String>();
 
         return new SpotifyWebApiEndpoint(id, name, link, description, httpMethod, path, parameters, requestBody, responseDescription, scopes, notes);
     }
@@ -225,20 +225,4 @@ private String parseNotes(List<Element> elements) {
         elements.removeIf(e -> "Try in our Web Console".equalsIgnoreCase(e.text()));
         return Html2Markdown.convert(elements);
     }
-
-    private List<String> extractScopes(String id, List<SpotifyWebApiEndpoint.Parameter> parameters) {
-        var authHeader = parameters.stream().filter(p -> "Authorization".equals(p.getName())).findFirst();
-        if (authHeader.isEmpty()) {
-            log.warn("Endpoint {} has no Authorization header", id);
-            return new ArrayList<>();
-        }
-
-        var codePattern = Pattern.compile("`([a-z-]+)`");
-        var matcher = codePattern.matcher(authHeader.get().getDescription());
-        var scopes = new ArrayList<String>();
-        while (matcher.find()) {
-            scopes.add(matcher.group(1));
-        }
-        return scopes;
-    }
 }
diff --git a/spotify-web-api-parser/src/main/java/de/sonallux/spotify/parser/ScopeInjector.java b/spotify-web-api-parser/src/main/java/de/sonallux/spotify/parser/ScopeInjector.java
@@ -0,0 +1,43 @@
+package de.sonallux.spotify.parser;
+
+import de.sonallux.spotify.core.model.*;
+import lombok.AccessLevel;
+import lombok.RequiredArgsConstructor;
+
+import java.util.Comparator;
+import java.util.Map;
+import java.util.stream.Collectors;
+
+/**
+ * Injects the scopes from the {@link de.sonallux.spotify.core.model.SpotifyAuthorizationScopes} into the scopes field of
+ * {@link de.sonallux.spotify.core.model.SpotifyWebApiEndpoint}
+ */
+@RequiredArgsConstructor(access = AccessLevel.PACKAGE)
+class ScopeInjector {
+    private static final String API_NAME = "web-api";
+
+    private final Map<String, SpotifyWebApiEndpoint> endpointMap;
+
+    static void run(SpotifyWebApi spotifyWebApi) {
+        var endpointMap = spotifyWebApi.getCategoryList().stream()
+            .flatMap(category -> category.getEndpointList().stream())
+            .collect(Collectors.toMap(SpotifyWebApiEndpoint::getId, e -> e));
+
+        var scopeInjector = new ScopeInjector(endpointMap);
+        scopeInjector.injectScopes(spotifyWebApi.getScopes());
+    }
+
+    void injectScopes(SpotifyAuthorizationScopes scopes) {
+        scopes.getScopeList().stream()
+            .sorted(Comparator.comparing(SpotifyScope::getId))
+            .forEach(this::injectScope);
+    }
+
+    private void injectScope(SpotifyScope scope) {
+        scope.getEndpoints().stream()
+            .filter(endpointLink -> API_NAME.equals(endpointLink.getApi()))
+            .map(SpotifyScope.EndpointLink::getEndpoint)
+            .map(endpointMap::get)
+            .forEach(endpoint -> endpoint.addScope(scope.getId()));
+    }
+}
diff --git a/spotify-web-api-parser/src/main/java/de/sonallux/spotify/parser/ScopeValidator.java b/spotify-web-api-parser/src/main/java/de/sonallux/spotify/parser/ScopeValidator.java
diff --git a/spotify-web-api-parser/src/main/java/de/sonallux/spotify/parser/WebApiParser.java b/spotify-web-api-parser/src/main/java/de/sonallux/spotify/parser/WebApiParser.java
@@ -48,12 +48,13 @@ public SpotifyWebApi parse(String documentationUrl, String endpointUrl, Document
         var apiPatches = new ApiPatches();
         spotifyWebApi = apiPatches.applyPatches(spotifyWebApi);
 
+        ScopeInjector.run(spotifyWebApi);
+
         // Sort object properties by name
         for (var object : spotifyWebApi.getObjectList()) {
             object.getProperties().sort(Comparator.comparing(SpotifyWebApiObject.Property::getName));
         }
 
-        ScopeValidator.validateScopes(spotifyWebApi);
         return spotifyWebApi;
     }
 }
diff --git a/spotify-web-api-parser/src/main/resources/patches/endpoint-get-available-markets.yml b/spotify-web-api-parser/src/main/resources/patches/endpoint-get-available-markets.yml
diff --git a/spotify-web-api-parser/src/main/resources/patches/endpoint-get-information-about-the-users-current-playback.yml b/spotify-web-api-parser/src/main/resources/patches/endpoint-get-information-about-the-users-current-playback.yml
diff --git a/spotify-web-api-parser/src/main/resources/patches/scope-playlist-modify-private.yml b/spotify-web-api-parser/src/main/resources/patches/scope-playlist-modify-private.yml
@@ -0,0 +1,10 @@
+description: Delete duplicate endpoint links from scope playlist-modify-private
+operations:
+  - op: test
+    path: "$.scopes.scopes.playlist-modify-private.endpoints.[6].endpoint"
+    value: "endpoint-reorder-or-replace-playlists-tracks"
+  - op: test
+    path: "$.scopes.scopes.playlist-modify-private.endpoints.[7].endpoint"
+    value: "endpoint-reorder-or-replace-playlists-tracks"
+  - op: delete
+    path: "$.scopes.scopes.playlist-modify-private.endpoints.[7]"
diff --git a/spotify-web-api-parser/src/main/resources/patches/scope-playlist-modify-public.yml b/spotify-web-api-parser/src/main/resources/patches/scope-playlist-modify-public.yml
@@ -0,0 +1,10 @@
+description: Delete duplicate endpoint links from scope playlist-modify-public
+operations:
+  - op: test
+    path: "$.scopes.scopes.playlist-modify-public.endpoints.[6].endpoint"
+    value: "endpoint-reorder-or-replace-playlists-tracks"
+  - op: test
+    path: "$.scopes.scopes.playlist-modify-public.endpoints.[7].endpoint"
+    value: "endpoint-reorder-or-replace-playlists-tracks"
+  - op: delete
+    path: "$.scopes.scopes.playlist-modify-public.endpoints.[7]"
diff --git a/spotify-web-api-parser/src/main/resources/patches/scope-user-library-modify.yml b/spotify-web-api-parser/src/main/resources/patches/scope-user-library-modify.yml
@@ -0,0 +1,23 @@
+description: Add missing endpoint links to scope user-library-modify
+operations:
+  - op: test
+    path: "$.scopes.scopes.user-library-modify.endpoints.[*].endpoint"
+    value:
+      - "endpoint-remove-albums-user"
+      - "endpoint-remove-tracks-user"
+      - "endpoint-remove-episodes-user"
+      - "endpoint-save-albums-user"
+      - "endpoint-save-tracks-user"
+      - "endpoint-save-episodes-user"
+  - op: add
+    path: "$.scopes.scopes.user-library-modify.endpoints"
+    value:
+      url: https://developer.spotify.com/documentation/web-api/reference/#endpoint-remove-shows-user
+      api: web-api
+      endpoint: endpoint-remove-shows-user
+  - op: add
+    path: "$.scopes.scopes.user-library-modify.endpoints"
+    value:
+      url: https://developer.spotify.com/documentation/web-api/reference/#endpoint-save-shows-user
+      api: web-api
+      endpoint: endpoint-save-shows-user
diff --git a/spotify-web-api-parser/src/main/resources/patches/scope-user-library-read.yml b/spotify-web-api-parser/src/main/resources/patches/scope-user-library-read.yml
@@ -0,0 +1,23 @@
+description: Add missing endpoint links to scope user-library-read
+operations:
+  - op: test
+    path: "$.scopes.scopes.user-library-read.endpoints.[*].endpoint"
+    value:
+      - "endpoint-check-users-saved-albums"
+      - "endpoint-check-users-saved-tracks"
+      - "endpoint-get-users-saved-albums"
+      - "endpoint-get-users-saved-tracks"
+      - "endpoint-check-users-saved-episodes"
+      - "endpoint-get-users-saved-episodes"
+  - op: add
+    path: "$.scopes.scopes.user-library-read.endpoints"
+    value:
+      url: https://developer.spotify.com/documentation/web-api/reference/#endpoint-check-users-saved-shows
+      api: web-api
+      endpoint: endpoint-check-users-saved-shows
+  - op: add
+    path: "$.scopes.scopes.user-library-read.endpoints"
+    value:
+      url: https://developer.spotify.com/documentation/web-api/reference/#endpoint-get-users-saved-shows
+      api: web-api
+      endpoint: endpoint-get-users-saved-shows
diff --git a/spotify-web-api-parser/src/main/resources/patches/scope-user-modify-playback-state.yml b/spotify-web-api-parser/src/main/resources/patches/scope-user-modify-playback-state.yml
@@ -0,0 +1,19 @@
+description: Delete and add endpoint links to scope user-modify-playback-state
+operations:
+  - op: test
+    path: "$.scopes.scopes.user-modify-playback-state.endpoints.[?(@.endpoint=='endpoint-add-to-queue')]"
+    value: []
+  - op: test
+    path: "$.scopes.scopes.user-modify-playback-state.endpoints.[9].endpoint"
+    value: "endpoint-seek-to-position-in-currently-playing-track"
+  - op: test
+    path: "$.scopes.scopes.user-modify-playback-state.endpoints.[1].endpoint"
+    value: "endpoint-seek-to-position-in-currently-playing-track"
+  - op: delete
+    path: "$.scopes.scopes.user-modify-playback-state.endpoints.[9]"
+  - op: add
+    path: "$.scopes.scopes.user-modify-playback-state.endpoints"
+    value:
+      url: https://developer.spotify.com/documentation/web-api/reference/#endpoint-add-to-queue
+      api: web-api
+      endpoint: endpoint-add-to-queue
diff --git a/spotify-web-api-parser/src/main/resources/patches/scope-user-read-currently-playing.yml b/spotify-web-api-parser/src/main/resources/patches/scope-user-read-currently-playing.yml
@@ -0,0 +1,11 @@
+description: Fix endpoint link in user-read-currently-playing
+operations:
+  - op: test
+    path: "$.scopes.scopes.user-read-currently-playing.endpoints.[?(@.endpoint=='endpoint-get-recently-played')].url"
+    value: ["https://developer.spotify.com/documentation/web-api/reference/#endpoint-get-recently-played"]
+  - op: set
+    path: "$.scopes.scopes.user-read-currently-playing.endpoints.[?(@.endpoint=='endpoint-get-recently-played')]"
+    value:
+      url: https://developer.spotify.com/documentation/web-api/reference/#endpoint-get-the-users-currently-playing-track
+      api: web-api
+      endpoint: endpoint-get-the-users-currently-playing-track
diff --git a/spotify-web-api-parser/src/main/resources/patches/scope-user-read-playback-state.yml b/spotify-web-api-parser/src/main/resources/patches/scope-user-read-playback-state.yml
@@ -0,0 +1,7 @@
+description: Remove endpoint-get-recently-played link from user-read-playback-state
+operations:
+  - op: test
+    path: "$.scopes.scopes.user-read-playback-state.endpoints.[?(@.endpoint=='endpoint-get-recently-played')].url"
+    value: ["https://developer.spotify.com/documentation/web-api/reference/#endpoint-get-recently-played"]
+  - op: delete
+    path: "$.scopes.scopes.user-read-playback-state.endpoints.[?(@.endpoint=='endpoint-get-recently-played')]"
diff --git a/spotify-web-api-parser/src/main/resources/patches/scope-user-read-recently-played.yml b/spotify-web-api-parser/src/main/resources/patches/scope-user-read-recently-played.yml
@@ -0,0 +1,11 @@
+description: Fix endpoint link in user-read-recently-played
+operations:
+  - op: test
+    path: "$.scopes.scopes.user-read-recently-played.endpoints.[?(@.endpoint=='endpoint-get-the-users-currently-playing-track')].url"
+    value: ["https://developer.spotify.com/documentation/web-api/reference/#endpoint-get-the-users-currently-playing-track"]
+  - op: set
+    path: "$.scopes.scopes.user-read-recently-played.endpoints.[?(@.endpoint=='endpoint-get-the-users-currently-playing-track')]"
+    value:
+      url: https://developer.spotify.com/documentation/web-api/reference/#endpoint-get-recently-played
+      api: web-api
+      endpoint: endpoint-get-recently-played
