Merge pull request #18 from Gruncan/1.0.0

Version 1.0.0 final update

Author: Gruncan

README.md

@@ -42,14 +42,13 @@ and executing it with your spotifyClient `executeRequest`
 Example:
 
 ```java
-public static void main(String[]args){
-        SpotifyClient spotifyClient=new SpotifyClientBuilder("CLIENT_ID","CLIENT_SECRET","REDIRECT_URL")
-        .getBuiltClient();
-        TrackGet trackGet=new TrackGet("Track_id");
-        SpotifyResponse response=spotifyClient.executeRequest(trackGet);
-        JSONObject jsonObject=response.getJsonObject();
-        System.out.println(jsonObject.toString());
-        }
+public static void main(String[] args){
+    SpotifyClient spotifyClient = new SpotifyClientBuilder("CLIENT_ID", "CLIENT_SECRET", "REDIRECT_URL").getBuiltClient();
+    TrackGet trackGet = new TrackGet("Track_id");
+    SpotifyResponse response = spotifyClient.executeRequest(trackGet);
+    JSONObject jsonObject = response.getJsonObject();
+    System.out.println(jsonObject.toString());
+}
 ```
 
 Returns a `SpotifyResponse` that encapsulates the json response from the spotify api
@@ -61,9 +60,9 @@ All Json classes were taken from https://github.com/tdunning/open-json with only
 <details open>
 <summary><strong><u>Album:</u></strong></summary>
 
-- **AlbumGet** ([api.spotify.com/v1/albums/{id}](https://developer.spotify.com/documentation/web-api/reference/#/operations/get-an-album))
+- AlbumGet ([api.spotify.com/v1/albums/{id}](https://developer.spotify.com/documentation/web-api/reference/#/operations/get-an-album))
 - AlbumTracksGet ([api.spotify.com/v1/albums/{id}/tracks](https://developer.spoify.com/documentation/web-api/reference/#/operations/get-an-albums-tracks))
-- **SeveralAlbumsGet** ([api.spotify.com/v1/albums](https://developer.spotify.com/documentation/web-api/reference/#/operations/get-multiple-albums))
+- SeveralAlbumsGet ([api.spotify.com/v1/albums](https://developer.spotify.com/documentation/web-api/reference/#/operations/get-multiple-albums))
 
 </details>
 <br>
@@ -79,96 +78,94 @@ All Json classes were taken from https://github.com/tdunning/open-json with only
 </details>
 <br>
 <details open>
-<summary><strong><u>Audiobooks</u></strong></summary>
+<summary><strong><u>Audiobooks:</u></strong></summary>
 
-- AudiobookGet
-- SeveralAudioBooksGet
+- AudiobookGet ([api.spotify.com/v1/audiobooks/{id}](https://developer.spotify.com/documentation/web-api/reference/get-an-audiobook))
+- SeveralAudioBooksGet ([api.spotify.com/v1/audiobooks/](https://developer.spotify.com/documentation/web-api/reference/get-multiple-audiobooks))
+- AudiobookChaptersGet ([api.spotify.com/v1/audiobooks/{id}/chapters](https://developer.spotify.com/documentation/web-api/reference/get-audiobook-chapters))
 
 </details>
 <br>
 <details open>
-<summary><strong><u>Chapters</u></strong></summary>
+<summary><strong><u>Categories:</u></strong></summary>
 
-- ChapterGet
-- SeveralChaptersGet
+- CategoriesGet ([api.spotify.com/v1/browse/categories/{category_id}](https://developer.spotify.com/documentation/web-api/reference/get-a-category))
+- SeveralCategoriesGet ([api.spotify.com/v1/browse/categories](https://developer.spotify.com/documentation/web-api/reference/get-categories))
 
 </details>
 <br>
 <details open>
-<summary><strong><u>Categories</u></strong></summary>
+<summary><strong><u>Chapters:</u></strong></summary>
 
-- SeveralCategoriesGet
-- SingleCategoriesGet
+- ChapterGet ([api.spotify.com/v1/chapters/{id}](https://developer.spotify.com/documentation/web-api/reference/get-a-chapter))
+- SeveralChaptersGet ([api.spotify.com/v1/chapters](https://developer.spotify.com/documentation/web-api/reference/get-several-chapters))
 
 </details>
 <br>
 <details open>
-<summary><strong><u>Episodes</u></strong></summary>
+<summary><strong><u>Episodes:</u></strong></summary>
 
-- EpisodeGet
-- SeveralEpisodesGet
+- EpisodeGet ([api.spotify.com/v1/episodes/{id}](https://developer.spotify.com/documentation/web-api/reference/get-an-episode))
+- SeveralEpisodesGet ([api.spotify.com/v1/episodes](https://developer.spotify.com/documentation/web-api/reference/get-multiple-episodes))
 
 </details>
 <br>
 <details open>
-<summary><strong><u>Genres</u></strong></summary>
+<summary><strong><u>Genres:</u></strong></summary>
 
-- GenreAvailableGet
+- GenreAvailableGet ([api.spotify.com/v1/recommendations/available-genre-seeds](https://developer.spotify.com/documentation/web-api/reference/get-recommendation-genres))
 
 </details>
 <br>
 <details open>
-<summary><strong><u>Markets</u></strong></summary>
+<summary><strong><u>Markets:</u></strong></summary>
 
-- MarketsAvailableGet
+- MarketsAvailableGet ([api.spotify.com/v1/markets](https://developer.spotify.com/documentation/web-api/reference/get-available-markets))
 
 </details>
 <br>
 <details open>
-<summary><strong><u>Playlists</u></strong></summary>
+<summary><strong><u>Playlists:</u></strong></summary>
 
-- CategoriesPlaylistsGet
-- FeaturedPlaylistGet
-- PlaylistGet
-- PlaylistImageGet
-- PlaylistTracksGet
+- PlaylistGet ([api.spotify.com/v1/playlists/{playlist_id}](https://developer.spotify.com/documentation/web-api/reference/get-playlist))
+- CategoriesPlaylistsGet ([api.spotify.com/v1/browse/categories/{category_id}/playlists](https://developer.spotify.com/documentation/web-api/reference/get-a-categories-playlists))
+- FeaturedPlaylistGet ([api.spotify.com/v1/browse/featured-playlists](https://developer.spotify.com/documentation/web-api/reference/get-featured-playlists))
+- PlaylistImageGet ([api.spotify.com/v1/playlists/{playlist_id}/images](https://developer.spotify.com/documentation/web-api/reference/get-playlist-cover))
+- PlaylistTracksGet [api.spotify.com/v1/playlists/{playlist_id}/tracks](https://developer.spotify.com/documentation/web-api/reference/get-playlists-tracks))
 
 </details>
 <br>
 <details open>
-<summary><strong><u>Search</u></strong></summary>
+<summary><strong><u>Search:</u></strong></summary>
 
-- **SearchGet**
+- SearchGet ([api.spotify.com/v1/search](https://developer.spotify.com/documentation/web-api/reference/search))
 
 </details>
 <br>
 <details open>
-<summary><strong><u>Shows</u></strong></summary>
+<summary><strong><u>Shows:</u></strong></summary>
+
+- ShowGet ([api.spotify.com/v1/shows/{id}](https://developer.spotify.com/documentation/web-api/reference/get-a-show))
+- SeveralShowsGet ([api.spotify.com/v1/shows](https://developer.spotify.com/documentation/web-api/reference/get-multiple-shows))
+- ShowEpisodesGet ([api.spotify.com/v1/shows/{id}/episodes](https://developer.spotify.com/documentation/web-api/reference/get-a-shows-episodes))
 
-- SeveralShowsGet
-- ShowEpisodesGet
-- ShowGet
 
 </details>
 <br>
 <details open>
-<summary><strong><u>Tracks</u></strong></summary>
+<summary><strong><u>Tracks:</u></strong></summary>
 
-- **SeveralTrackAudioFeaturesGet** ([api.spotify.com/audio-features](https://developer.spotify.com/documentation/web-api/reference/#/operations/get-several-audio-features))
-- **SeveralTracksGet** ([api.spotify.com/tracks](https://developer.spotify.com/documentation/web-api/reference/#/operations/get-several-tracks))
-- **TrackAudioAnalysisGet** ([api.spotify.com/audio-analysis/{id}](https://developer.spotify.com/documentation/web-api/reference/#/operations/get-audio-analysis))
-- **TrackAudioFeaturesGet** ([api.spotify.com/audio-features/{id}](https://developer.spotify.com/documentation/web-api/reference/#/operations/get-audio-features))
-- **TrackGet** ([api.spotify.com/tracks/{id}](https://developer.spotify.com/documentation/web-api/reference/#/operations/get-track))
-- **TrackRecommendationGet** ([api.spotify.com/recommendations](https://developer.spotify.com/documentation/web-api/reference/#/operations/get-recommendations))
+- SeveralTrackAudioFeaturesGet ([api.spotify.com/audio-features](https://developer.spotify.com/documentation/web-api/reference/#/operations/get-several-audio-features))
+- SeveralTracksGet ([api.spotify.com/tracks](https://developer.spotify.com/documentation/web-api/reference/#/operations/get-several-tracks))
+- TrackAudioAnalysisGet ([api.spotify.com/audio-analysis/{id}](https://developer.spotify.com/documentation/web-api/reference/#/operations/get-audio-analysis))
+- TrackAudioFeaturesGet ([api.spotify.com/audio-features/{id}](https://developer.spotify.com/documentation/web-api/reference/#/operations/get-audio-features))
+- TrackGet ([api.spotify.com/tracks/{id}](https://developer.spotify.com/documentation/web-api/reference/#/operations/get-track))
+- TrackRecommendationGet ([api.spotify.com/recommendations](https://developer.spotify.com/documentation/web-api/reference/#/operations/get-recommendations))
 
 </details>
 
-(<b>bold</b> items are able to be serialized into the respective classes)
-
 ### <u>Future Plans</u>
 - Implement the remainder of api request
-- Completely finish writing the spotify objects
-- Rewrite how requests classes are written (annotations)
 - Bring back Spring support for handling user authentication
 - Add more branches of api requests not just web api
 - Optimise multiple call different threads

pom.xml

@@ -7,7 +7,7 @@
 
     <groupId>com.spotstat</groupId>
     <artifactId>S4J</artifactId>
-    <version>1.0.0-SNAPSHOT</version>
+    <version>1.0.0</version>
 
     <properties>
         <maven.compiler.source>17</maven.compiler.source>

src/main/java/com/spotify/objects/categories/Category.java

@@ -4,15 +4,15 @@
 import com.spotify.objects.SpotifyObject;
 import com.spotify.objects.search.AbstractSearchItems;
 import com.spotify.objects.wrappers.SpotifyImage;
-import com.spotify.requests.categories.SingleCategoriesGet;
+import com.spotify.requests.categories.CategoriesGet;
 import lombok.Getter;
 import lombok.Setter;
 
 /**
  * Represents spotify category<br>
  * Serialized from <a href="https://developer.spotify.com/documentation/web-api/reference/get-a-category">SingleCategoriesGet</a>
  *
- * @see SingleCategoriesGet
+ * @see CategoriesGet
  * @see AbstractSearchItems
  * @see SpotifyObject
  */

…ests/categories/SingleCategoriesGet.java …y/requests/categories/CategoriesGet.javasrc/main/java/com/spotify/requests/categories/SingleCategoriesGet.java renamed to src/main/java/com/spotify/requests/categories/CategoriesGet.java src/main/java/com/spotify/requests/categories/SingleCategoriesGet.java renamed to src/main/java/com/spotify/requests/categories/CategoriesGet.java

@@ -24,7 +24,7 @@
 @Setter
 @SpotifyRequest("browse/categories")
 @SpotifySerialize(Category.class)
-public class SingleCategoriesGet implements SpotifyRequestVariant {
+public class CategoriesGet implements SpotifyRequestVariant {
 
 
     /**
@@ -46,10 +46,10 @@ public class SingleCategoriesGet implements SpotifyRequestVariant {
     private String locale;
 
     /**
-     * Initializes the {@link SingleCategoriesGet} request
+     * Initializes the {@link CategoriesGet} request
      * @param id The Spotify category ID for the category.
      */
-    public SingleCategoriesGet(String id) {
+    public CategoriesGet(String id) {
         this.id = id;
     }
 

src/test/java/com/spotify/requests/connection/tests/CategoriesConnectionTests.java

@@ -3,7 +3,7 @@
 import com.spotify.SpotifyResponse;
 import com.spotify.requests.SpotifyRequestVariant;
 import com.spotify.requests.categories.SeveralCategoriesGet;
-import com.spotify.requests.categories.SingleCategoriesGet;
+import com.spotify.requests.categories.CategoriesGet;
 import com.spotify.requests.connection.AbstractConnectionTest;
 import org.junit.jupiter.api.Tag;
 import org.junit.jupiter.api.Test;
@@ -24,7 +24,7 @@ public void severalCategoriesGetTest() {
     @Test
     @Tag("NetworkTest")
     public void singleCategoriesGetTest() {
-        SpotifyRequestVariant request = new SingleCategoriesGet("dinner");
+        SpotifyRequestVariant request = new CategoriesGet("dinner");
         SpotifyResponse spotifyResponse = super.client.executeRequest(request);
         assertTrue(spotifyResponse.wasSuccess());
     }

src/test/java/com/spotify/requests/data/resources/SpotifyResponses-V1_0_0.json

@@ -59,7 +59,7 @@
   "com.spotify.requests.categories.SeveralCategoriesGet": {
     "url": "https://api.spotify.com/v1/browse/categories"
   },
-  "com.spotify.requests.categories.SingleCategoriesGet": {
+  "com.spotify.requests.categories.CategoriesGet": {
     "url": "https://api.spotify.com/v1/browse/categories/dinner",
     "id": "dinner"
   },

src/test/java/com/spotify/requests/data/resources/requestUrlClasses.json

@@ -2,7 +2,7 @@
 
 import com.spotify.requests.SpotifyRequestVariant;
 import com.spotify.requests.categories.SeveralCategoriesGet;
-import com.spotify.requests.categories.SingleCategoriesGet;
+import com.spotify.requests.categories.CategoriesGet;
 import com.spotify.requests.data.AbstractUrlTest;
 import org.junit.jupiter.api.Test;
 
@@ -20,7 +20,7 @@ public void severalCategoriesGetTestUrl() {
 
     @Test
     public void singleCategoriesGetTestUrl() {
-        SpotifyRequestVariant request = new SingleCategoriesGet("dinner");
+        SpotifyRequestVariant request = new CategoriesGet("dinner");
         String actualUrl = super.client.getBuiltURL(request);
         assertEquals(actualUrl, super.getCorrectURL(request.getClass()));
     }