spotted 0.1.0

data/lib/spotted/resources/users/playlists.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Resources
+    class Users
+      class Playlists
+        # Some parameter documentations has been truncated, see
+        # {Spotted::Models::Users::PlaylistCreateParams} for more details.
+        #
+        # Create a playlist for a Spotify user. (The playlist will be empty until you
+        # [add tracks](/documentation/web-api/reference/add-tracks-to-playlist).) Each
+        # user is generally limited to a maximum of 11000 playlists.
+        #
+        # @overload create(user_id, name:, collaborative: nil, description: nil, public: nil, request_options: {})
+        #
+        # @param user_id [String] The user's [Spotify user ID](/documentation/web-api/concepts/spotify-uris-ids).
+        #
+        # @param name [String] The name for the new playlist, for example `"Your Coolest Playlist"`. This name
+        #
+        # @param collaborative [Boolean] Defaults to `false`. If `true` the playlist will be collaborative. \_**Note**:
+        # to
+        #
+        # @param description [String] value for playlist description as displayed in Spotify Clients and in the Web AP
+        #
+        # @param public [Boolean] Defaults to `true`. The playlist's public/private status (if it should be added
+        #
+        # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Spotted::Models::Users::PlaylistCreateResponse]
+        #
+        # @see Spotted::Models::Users::PlaylistCreateParams
+        def create(user_id, params)
+          parsed, options = Spotted::Users::PlaylistCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["users/%1$s/playlists", user_id],
+            body: parsed,
+            model: Spotted::Models::Users::PlaylistCreateResponse,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Spotted::Models::Users::PlaylistListParams} for more details.
+        #
+        # Get a list of the playlists owned or followed by a Spotify user.
+        #
+        # @overload list(user_id, limit: nil, offset: nil, request_options: {})
+        #
+        # @param user_id [String] The user's [Spotify user ID](/documentation/web-api/concepts/spotify-uris-ids).
+        #
+        # @param limit [Integer] The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.
+        #
+        # @param offset [Integer] The index of the first playlist to return. Default:
+        #
+        # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Spotted::Internal::CursorURLPage<Spotted::Models::SimplifiedPlaylistObject>]
+        #
+        # @see Spotted::Models::Users::PlaylistListParams
+        def list(user_id, params = {})
+          parsed, options = Spotted::Users::PlaylistListParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: ["users/%1$s/playlists", user_id],
+            query: parsed,
+            page: Spotted::Internal::CursorURLPage,
+            model: Spotted::SimplifiedPlaylistObject,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Spotted::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/spotted/resources/users.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Spotted
+  module Resources
+    class Users
+      # @return [Spotted::Resources::Users::Playlists]
+      attr_reader :playlists
+
+      # Some parameter documentations has been truncated, see
+      # {Spotted::Models::UserRetrieveProfileParams} for more details.
+      #
+      # Get public profile information about a Spotify user.
+      #
+      # @overload retrieve_profile(user_id, request_options: {})
+      #
+      # @param user_id [String] The user's [Spotify user ID](/documentation/web-api/concepts/spotify-uris-ids).
+      #
+      # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Spotted::Models::UserRetrieveProfileResponse]
+      #
+      # @see Spotted::Models::UserRetrieveProfileParams
+      def retrieve_profile(user_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["users/%1$s", user_id],
+          model: Spotted::Models::UserRetrieveProfileResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Spotted::Client]
+      def initialize(client:)
+        @client = client
+        @playlists = Spotted::Resources::Users::Playlists.new(client: client)
+      end
+    end
+  end
+end

data/lib/spotted/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Spotted
+  VERSION = "0.1.0"
+end

data/lib/spotted.rb

@@ -0,0 +1,257 @@
+# frozen_string_literal: true
+
+# Standard libraries.
+# rubocop:disable Lint/RedundantRequireStatement
+require "English"
+require "base64"
+require "cgi"
+require "date"
+require "erb"
+require "etc"
+require "json"
+require "net/http"
+require "pathname"
+require "rbconfig"
+require "securerandom"
+require "set"
+require "stringio"
+require "thread"
+require "time"
+require "uri"
+# rubocop:enable Lint/RedundantRequireStatement
+
+# We already ship the preferred sorbet manifests in the package itself.
+# `tapioca` currently does not offer us a way to opt out of unnecessary compilation.
+if Object.const_defined?(:Tapioca) &&
+   caller.chain([$PROGRAM_NAME]).chain(ARGV).any?(/tapioca/) &&
+   ARGV.none?(/dsl/)
+  return
+end
+
+# Gems.
+require "connection_pool"
+
+# Package files.
+require_relative "spotted/version"
+require_relative "spotted/internal/util"
+require_relative "spotted/internal/type/converter"
+require_relative "spotted/internal/type/unknown"
+require_relative "spotted/internal/type/boolean"
+require_relative "spotted/internal/type/file_input"
+require_relative "spotted/internal/type/enum"
+require_relative "spotted/internal/type/union"
+require_relative "spotted/internal/type/array_of"
+require_relative "spotted/internal/type/hash_of"
+require_relative "spotted/internal/type/base_model"
+require_relative "spotted/internal/type/base_page"
+require_relative "spotted/internal/type/request_parameters"
+require_relative "spotted/internal"
+require_relative "spotted/request_options"
+require_relative "spotted/file_part"
+require_relative "spotted/errors"
+require_relative "spotted/internal/transport/base_client"
+require_relative "spotted/internal/transport/pooled_net_requester"
+require_relative "spotted/client"
+require_relative "spotted/internal/oauth2"
+require_relative "spotted/internal/cursor_url_page"
+require_relative "spotted/models/playlist_user_object"
+require_relative "spotted/models/album_list_params"
+require_relative "spotted/models/album_list_response"
+require_relative "spotted/models/album_list_tracks_params"
+require_relative "spotted/models/album_restriction_object"
+require_relative "spotted/models/album_retrieve_params"
+require_relative "spotted/models/album_retrieve_response"
+require_relative "spotted/models/artist_list_albums_params"
+require_relative "spotted/models/artist_list_albums_response"
+require_relative "spotted/models/artist_list_params"
+require_relative "spotted/models/artist_list_related_artists_params"
+require_relative "spotted/models/artist_list_related_artists_response"
+require_relative "spotted/models/artist_list_response"
+require_relative "spotted/models/artist_list_top_tracks_params"
+require_relative "spotted/models/artist_list_top_tracks_response"
+require_relative "spotted/models/artist_object"
+require_relative "spotted/models/artist_retrieve_params"
+require_relative "spotted/models/audio_analysis_retrieve_params"
+require_relative "spotted/models/audio_analysis_retrieve_response"
+require_relative "spotted/models/audiobook_list_chapters_params"
+require_relative "spotted/models/audiobook_list_params"
+require_relative "spotted/models/audiobook_list_response"
+require_relative "spotted/models/audiobook_retrieve_params"
+require_relative "spotted/models/audiobook_retrieve_response"
+require_relative "spotted/models/audio_feature_list_params"
+require_relative "spotted/models/audio_feature_list_response"
+require_relative "spotted/models/audio_feature_retrieve_params"
+require_relative "spotted/models/audio_feature_retrieve_response"
+require_relative "spotted/models/author_object"
+require_relative "spotted/models/browse/category_get_playlists_params"
+require_relative "spotted/models/browse/category_get_playlists_response"
+require_relative "spotted/models/browse/category_list_params"
+require_relative "spotted/models/browse/category_list_response"
+require_relative "spotted/models/browse/category_retrieve_params"
+require_relative "spotted/models/browse/category_retrieve_response"
+require_relative "spotted/models/browse_get_featured_playlists_params"
+require_relative "spotted/models/browse_get_featured_playlists_response"
+require_relative "spotted/models/browse_get_new_releases_params"
+require_relative "spotted/models/browse_get_new_releases_response"
+require_relative "spotted/models/chapter_list_params"
+require_relative "spotted/models/chapter_list_response"
+require_relative "spotted/models/chapter_restriction_object"
+require_relative "spotted/models/chapter_retrieve_params"
+require_relative "spotted/models/chapter_retrieve_response"
+require_relative "spotted/models/copyright_object"
+require_relative "spotted/models/episode_list_params"
+require_relative "spotted/models/episode_list_response"
+require_relative "spotted/models/episode_object"
+require_relative "spotted/models/episode_restriction_object"
+require_relative "spotted/models/episode_retrieve_params"
+require_relative "spotted/models/external_id_object"
+require_relative "spotted/models/external_url_object"
+require_relative "spotted/models/followers_object"
+require_relative "spotted/models/image_object"
+require_relative "spotted/models/linked_track_object"
+require_relative "spotted/models/market_list_params"
+require_relative "spotted/models/market_list_response"
+require_relative "spotted/models/me/album_check_params"
+require_relative "spotted/models/me/album_check_response"
+require_relative "spotted/models/me/album_list_params"
+require_relative "spotted/models/me/album_list_response"
+require_relative "spotted/models/me/album_remove_params"
+require_relative "spotted/models/me/album_save_params"
+require_relative "spotted/models/me/audiobook_check_params"
+require_relative "spotted/models/me/audiobook_check_response"
+require_relative "spotted/models/me/audiobook_list_params"
+require_relative "spotted/models/me/audiobook_list_response"
+require_relative "spotted/models/me/audiobook_remove_params"
+require_relative "spotted/models/me/audiobook_save_params"
+require_relative "spotted/models/me/context_object"
+require_relative "spotted/models/me/device_object"
+require_relative "spotted/models/me/episode_check_params"
+require_relative "spotted/models/me/episode_check_response"
+require_relative "spotted/models/me/episode_list_params"
+require_relative "spotted/models/me/episode_list_response"
+require_relative "spotted/models/me/episode_remove_params"
+require_relative "spotted/models/me/episode_save_params"
+require_relative "spotted/models/me/following_check_params"
+require_relative "spotted/models/me/following_check_response"
+require_relative "spotted/models/me/following_follow_params"
+require_relative "spotted/models/me/following_list_params"
+require_relative "spotted/models/me/following_list_response"
+require_relative "spotted/models/me/following_unfollow_params"
+require_relative "spotted/models/me/player/queue_add_params"
+require_relative "spotted/models/me/player/queue_get_params"
+require_relative "spotted/models/me/player/queue_get_response"
+require_relative "spotted/models/me/player_get_currently_playing_params"
+require_relative "spotted/models/me/player_get_currently_playing_response"
+require_relative "spotted/models/me/player_get_devices_params"
+require_relative "spotted/models/me/player_get_devices_response"
+require_relative "spotted/models/me/player_get_state_params"
+require_relative "spotted/models/me/player_get_state_response"
+require_relative "spotted/models/me/player_list_recently_played_params"
+require_relative "spotted/models/me/player_list_recently_played_response"
+require_relative "spotted/models/me/player_pause_playback_params"
+require_relative "spotted/models/me/player_seek_to_position_params"
+require_relative "spotted/models/me/player_set_repeat_mode_params"
+require_relative "spotted/models/me/player_set_volume_params"
+require_relative "spotted/models/me/player_skip_next_params"
+require_relative "spotted/models/me/player_skip_previous_params"
+require_relative "spotted/models/me/player_start_playback_params"
+require_relative "spotted/models/me/player_toggle_shuffle_params"
+require_relative "spotted/models/me/player_transfer_params"
+require_relative "spotted/models/me/playlist_list_params"
+require_relative "spotted/models/me/show_check_params"
+require_relative "spotted/models/me/show_check_response"
+require_relative "spotted/models/me/show_list_params"
+require_relative "spotted/models/me/show_list_response"
+require_relative "spotted/models/me/show_remove_params"
+require_relative "spotted/models/me/show_save_params"
+require_relative "spotted/models/me/top_list_top_artists_params"
+require_relative "spotted/models/me/top_list_top_tracks_params"
+require_relative "spotted/models/me/track_check_params"
+require_relative "spotted/models/me/track_check_response"
+require_relative "spotted/models/me/track_list_params"
+require_relative "spotted/models/me/track_list_response"
+require_relative "spotted/models/me/track_remove_params"
+require_relative "spotted/models/me/track_save_params"
+require_relative "spotted/models/me_retrieve_params"
+require_relative "spotted/models/me_retrieve_response"
+require_relative "spotted/models/narrator_object"
+require_relative "spotted/models/paging_playlist_object"
+require_relative "spotted/models/playlist_retrieve_params"
+require_relative "spotted/models/playlist_retrieve_response"
+require_relative "spotted/models/playlists/follower_check_params"
+require_relative "spotted/models/playlists/follower_check_response"
+require_relative "spotted/models/playlists/follower_follow_params"
+require_relative "spotted/models/playlists/follower_unfollow_params"
+require_relative "spotted/models/playlists/image_list_params"
+require_relative "spotted/models/playlists/image_list_response"
+require_relative "spotted/models/playlists/image_update_params"
+require_relative "spotted/models/playlists/track_add_params"
+require_relative "spotted/models/playlists/track_add_response"
+require_relative "spotted/models/playlists/track_list_params"
+require_relative "spotted/models/playlists/track_remove_params"
+require_relative "spotted/models/playlists/track_remove_response"
+require_relative "spotted/models/playlists/track_update_params"
+require_relative "spotted/models/playlists/track_update_response"
+require_relative "spotted/models/playlist_track_object"
+require_relative "spotted/models/playlist_tracks_ref_object"
+require_relative "spotted/models/playlist_update_params"
+require_relative "spotted/models/recommendation_get_params"
+require_relative "spotted/models/recommendation_get_response"
+require_relative "spotted/models/recommendation_list_available_genre_seeds_params"
+require_relative "spotted/models/recommendation_list_available_genre_seeds_response"
+require_relative "spotted/models/resume_point_object"
+require_relative "spotted/models/search_retrieve_params"
+require_relative "spotted/models/search_retrieve_response"
+require_relative "spotted/models/show_list_episodes_params"
+require_relative "spotted/models/show_list_params"
+require_relative "spotted/models/show_list_response"
+require_relative "spotted/models/show_retrieve_params"
+require_relative "spotted/models/show_retrieve_response"
+require_relative "spotted/models/simplified_artist_object"
+require_relative "spotted/models/simplified_chapter_object"
+require_relative "spotted/models/simplified_episode_object"
+require_relative "spotted/models/simplified_playlist_object"
+require_relative "spotted/models/simplified_track_object"
+require_relative "spotted/models/time_interval_object"
+require_relative "spotted/models/track_list_params"
+require_relative "spotted/models/track_list_response"
+require_relative "spotted/models/track_object"
+require_relative "spotted/models/track_restriction_object"
+require_relative "spotted/models/track_retrieve_params"
+require_relative "spotted/models/user_retrieve_profile_params"
+require_relative "spotted/models/user_retrieve_profile_response"
+require_relative "spotted/models/users/playlist_create_params"
+require_relative "spotted/models/users/playlist_create_response"
+require_relative "spotted/models/users/playlist_list_params"
+require_relative "spotted/models"
+require_relative "spotted/resources/albums"
+require_relative "spotted/resources/artists"
+require_relative "spotted/resources/audio_analysis"
+require_relative "spotted/resources/audiobooks"
+require_relative "spotted/resources/audio_features"
+require_relative "spotted/resources/browse"
+require_relative "spotted/resources/browse/categories"
+require_relative "spotted/resources/chapters"
+require_relative "spotted/resources/episodes"
+require_relative "spotted/resources/markets"
+require_relative "spotted/resources/me"
+require_relative "spotted/resources/me/albums"
+require_relative "spotted/resources/me/audiobooks"
+require_relative "spotted/resources/me/episodes"
+require_relative "spotted/resources/me/following"
+require_relative "spotted/resources/me/player"
+require_relative "spotted/resources/me/player/queue"
+require_relative "spotted/resources/me/playlists"
+require_relative "spotted/resources/me/shows"
+require_relative "spotted/resources/me/top"
+require_relative "spotted/resources/me/tracks"
+require_relative "spotted/resources/playlists"
+require_relative "spotted/resources/playlists/followers"
+require_relative "spotted/resources/playlists/images"
+require_relative "spotted/resources/playlists/tracks"
+require_relative "spotted/resources/recommendations"
+require_relative "spotted/resources/search"
+require_relative "spotted/resources/shows"
+require_relative "spotted/resources/tracks"
+require_relative "spotted/resources/users"
+require_relative "spotted/resources/users/playlists"

data/manifest.yaml

@@ -0,0 +1,15 @@
+dependencies:
+  - English
+  - cgi
+  - date
+  - erb
+  - etc
+  - json
+  - net/http
+  - pathname
+  - rbconfig
+  - securerandom
+  - set
+  - stringio
+  - time
+  - uri

data/rbi/spotted/client.rbi

@@ -0,0 +1,104 @@
+# typed: strong
+
+module Spotted
+  class Client < Spotted::Internal::Transport::BaseClient
+    DEFAULT_MAX_RETRIES = 2
+
+    DEFAULT_TIMEOUT_IN_SECONDS = T.let(60.0, Float)
+
+    DEFAULT_INITIAL_RETRY_DELAY = T.let(0.5, Float)
+
+    DEFAULT_MAX_RETRY_DELAY = T.let(8.0, Float)
+
+    sig { returns(String) }
+    attr_reader :client_id
+
+    sig { returns(String) }
+    attr_reader :client_secret
+
+    sig { returns(Spotted::Resources::Albums) }
+    attr_reader :albums
+
+    sig { returns(Spotted::Resources::Artists) }
+    attr_reader :artists
+
+    sig { returns(Spotted::Resources::Shows) }
+    attr_reader :shows
+
+    sig { returns(Spotted::Resources::Episodes) }
+    attr_reader :episodes
+
+    sig { returns(Spotted::Resources::Audiobooks) }
+    attr_reader :audiobooks
+
+    sig { returns(Spotted::Resources::Me) }
+    attr_reader :me
+
+    sig { returns(Spotted::Resources::Chapters) }
+    attr_reader :chapters
+
+    sig { returns(Spotted::Resources::Tracks) }
+    attr_reader :tracks
+
+    sig { returns(Spotted::Resources::Search) }
+    attr_reader :search
+
+    sig { returns(Spotted::Resources::Playlists) }
+    attr_reader :playlists
+
+    sig { returns(Spotted::Resources::Users) }
+    attr_reader :users
+
+    sig { returns(Spotted::Resources::Browse) }
+    attr_reader :browse
+
+    sig { returns(Spotted::Resources::AudioFeatures) }
+    attr_reader :audio_features
+
+    sig { returns(Spotted::Resources::AudioAnalysis) }
+    attr_reader :audio_analysis
+
+    sig { returns(Spotted::Resources::Recommendations) }
+    attr_reader :recommendations
+
+    sig { returns(Spotted::Resources::Markets) }
+    attr_reader :markets
+
+    # @api private
+    sig { returns(Spotted::Internal::OAuth2ClientCredentials) }
+    attr_reader :oauth_2_0_state
+
+    # @api private
+    sig { override.returns(T::Hash[String, String]) }
+    private def auth_headers
+    end
+
+    # Creates and returns a new client for interacting with the API.
+    sig do
+      params(
+        client_id: T.nilable(String),
+        client_secret: T.nilable(String),
+        base_url: T.nilable(String),
+        max_retries: Integer,
+        timeout: Float,
+        initial_retry_delay: Float,
+        max_retry_delay: Float
+      ).returns(T.attached_class)
+    end
+    def self.new(
+      # Defaults to `ENV["SPOTIFY_CLIENT_ID"]`
+      client_id: ENV["SPOTIFY_CLIENT_ID"],
+      # Defaults to `ENV["SPOTIFY_CLIENT_SECRET"]`
+      client_secret: ENV["SPOTIFY_CLIENT_SECRET"],
+      # Override the default base URL for the API, e.g.,
+      # `"https://api.example.com/v2/"`. Defaults to `ENV["SPOTTED_BASE_URL"]`
+      base_url: ENV["SPOTTED_BASE_URL"],
+      # Max number of retries to attempt after a failed retryable request.
+      max_retries: Spotted::Client::DEFAULT_MAX_RETRIES,
+      timeout: Spotted::Client::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: Spotted::Client::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: Spotted::Client::DEFAULT_MAX_RETRY_DELAY
+    )
+    end
+  end
+end