spotify-api-sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 71d2212384a72b7ecd0ad0744af52b6ef68ac50835ffb47da97348163c6c83e1
+  data.tar.gz: c8eef64c44514d78405c6785fb7ea17d91d66ecf7b72c85632387dbfd9b3726b
+SHA512:
+  metadata.gz: 3ce3bef8ef90c1e032214562eaa8c2e31fc7fbcf07bf8fa0c854ed1ec3e447303819e2dff86b9bb0c3d2299a6765037fad3c50e0d2fd26ef3bdf4102853ef288
+  data.tar.gz: e62a110b19a3d24d130369e0939efee4b60020fabeae9d6a07d9148ac3ce7d74a9d53714425788e7b37f081994a88fca9db4c42e1be82603a5d31c15a3759d69

data/LICENSE

@@ -0,0 +1,30 @@
+This SDK was generated by APIMATIC.
+
+License:
+========
+The MIT License (MIT)
+http://opensource.org/licenses/MIT
+
+Copyright (c) 2014 - 2023 APIMATIC Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+Trade Mark:
+==========
+APIMATIC is a trade mark for APIMATIC Limited

data/README.md

@@ -0,0 +1,107 @@
+
+# Getting Started with Spotify Web API
+
+## Introduction
+
+You can use Spotify's Web API to discover music and podcasts, manage your Spotify library, control audio playback, and much more. Browse our available Web API endpoints using the sidebar at left, or via the navigation bar on top of this page on smaller screens.
+
+In order to make successful Web API requests your app will need a valid access token. One can be obtained through <a href="https://developer.spotify.com/documentation/general/guides/authorization-guide/">OAuth 2.0</a>.
+
+The base URI for all Web API requests is `https://api.spotify.com/v1`.
+
+Need help? See our <a href="https://developer.spotify.com/documentation/web-api/guides/">Web API guides</a> for more information, or visit the <a href="https://community.spotify.com/t5/Spotify-for-Developers/bd-p/Spotify_Developer">Spotify for Developers community forum</a> to ask questions and connect with other developers.
+
+## Install the Package
+
+Install the gem from the command line:
+
+```ruby
+gem install spotify-api-sdk -v 1.0.0
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'spotify-api-sdk', '1.0.0'
+```
+
+For additional gem details, see the [RubyGems page for the spotify-api-sdk gem](https://rubygems.org/gems/spotify-api-sdk/versions/1.0.0).
+
+## Initialize the API Client
+
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/spotify-api-ruby-sdk/tree/1.0.0/doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| `environment` | `Environment` | The API environment. <br> **Default: `Environment.PRODUCTION`** |
+| `connection` | `Faraday::Connection` | The Faraday connection object passed by the SDK user for making requests |
+| `adapter` | `Faraday::Adapter` | The Faraday adapter object passed by the SDK user for performing http requests |
+| `timeout` | `Float` | The value to use for connection timeout. <br> **Default: 60** |
+| `max_retries` | `Integer` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
+| `retry_interval` | `Float` | Pause in seconds between retries. <br> **Default: 1** |
+| `backoff_factor` | `Float` | The amount to multiply each successive retry's interval amount by in order to provide backoff. <br> **Default: 2** |
+| `retry_statuses` | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
+| `retry_methods` | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
+| `http_callback` | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
+| `authorization_code_auth_credentials` | [`AuthorizationCodeAuthCredentials`](https://www.github.com/sdks-io/spotify-api-ruby-sdk/tree/1.0.0/doc/auth/oauth-2-authorization-code-grant.md) | The credential object for OAuth 2 Authorization Code Grant |
+
+The API client can be initialized as follows:
+
+```ruby
+client = SpotifyWebApi::Client.new(
+  authorization_code_auth_credentials: AuthorizationCodeAuthCredentials.new(
+    o_auth_client_id: 'OAuthClientId',
+    o_auth_client_secret: 'OAuthClientSecret',
+    o_auth_redirect_uri: 'OAuthRedirectUri',
+    o_auth_scopes: [
+      OAuthScopeEnum::APP_REMOTE_CONTROL,
+      OAuthScopeEnum::PLAYLIST_READ_PRIVATE
+    ]
+  ),
+  environment: Environment::PRODUCTION
+)
+```
+
+API calls return an `ApiResponse` object that includes the following fields:
+
+| Field | Description |
+|  --- | --- |
+| `status_code` | Status code of the HTTP response |
+| `reason_phrase` | Reason phrase of the HTTP response |
+| `headers` | Headers of the HTTP response as a Hash |
+| `raw_body` | The body of the HTTP response as a String |
+| `request` | HTTP request info |
+| `errors` | Errors, if they exist |
+| `data` | The deserialized body of the HTTP response |
+
+## Authorization
+
+This API uses the following authentication schemes.
+
+* [`oauth_2_0 (OAuth 2 Authorization Code Grant)`](https://www.github.com/sdks-io/spotify-api-ruby-sdk/tree/1.0.0/doc/auth/oauth-2-authorization-code-grant.md)
+
+## List of APIs
+
+* [Albums](https://www.github.com/sdks-io/spotify-api-ruby-sdk/tree/1.0.0/doc/controllers/albums.md)
+* [Artists](https://www.github.com/sdks-io/spotify-api-ruby-sdk/tree/1.0.0/doc/controllers/artists.md)
+* [Audiobooks](https://www.github.com/sdks-io/spotify-api-ruby-sdk/tree/1.0.0/doc/controllers/audiobooks.md)
+* [Categories](https://www.github.com/sdks-io/spotify-api-ruby-sdk/tree/1.0.0/doc/controllers/categories.md)
+* [Chapters](https://www.github.com/sdks-io/spotify-api-ruby-sdk/tree/1.0.0/doc/controllers/chapters.md)
+* [Episodes](https://www.github.com/sdks-io/spotify-api-ruby-sdk/tree/1.0.0/doc/controllers/episodes.md)
+* [Genres](https://www.github.com/sdks-io/spotify-api-ruby-sdk/tree/1.0.0/doc/controllers/genres.md)
+* [Markets](https://www.github.com/sdks-io/spotify-api-ruby-sdk/tree/1.0.0/doc/controllers/markets.md)
+* [Player](https://www.github.com/sdks-io/spotify-api-ruby-sdk/tree/1.0.0/doc/controllers/player.md)
+* [Playlists](https://www.github.com/sdks-io/spotify-api-ruby-sdk/tree/1.0.0/doc/controllers/playlists.md)
+* [Search](https://www.github.com/sdks-io/spotify-api-ruby-sdk/tree/1.0.0/doc/controllers/search.md)
+* [Shows](https://www.github.com/sdks-io/spotify-api-ruby-sdk/tree/1.0.0/doc/controllers/shows.md)
+* [Tracks](https://www.github.com/sdks-io/spotify-api-ruby-sdk/tree/1.0.0/doc/controllers/tracks.md)
+* [Users](https://www.github.com/sdks-io/spotify-api-ruby-sdk/tree/1.0.0/doc/controllers/users.md)
+
+## Classes Documentation
+
+* [Utility Classes](https://www.github.com/sdks-io/spotify-api-ruby-sdk/tree/1.0.0/doc/utility-classes.md)
+* [HttpResponse](https://www.github.com/sdks-io/spotify-api-ruby-sdk/tree/1.0.0/doc/http-response.md)
+* [HttpRequest](https://www.github.com/sdks-io/spotify-api-ruby-sdk/tree/1.0.0/doc/http-request.md)
+

data/lib/spotify_web_api/api_helper.rb

@@ -0,0 +1,10 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # API utility class
+  class APIHelper < CoreLibrary::ApiHelper
+  end
+end

data/lib/spotify_web_api/client.rb

@@ -0,0 +1,154 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  #  spotify_web_api client class.
+  class Client
+    include CoreLibrary
+    attr_reader :config, :auth_managers
+
+    # Returns the configured authentication oauth_2_0 instance.
+    def oauth_2_0
+      @auth_managers['oauth_2_0']
+    end
+
+    # Access to albums controller.
+    # @return [AlbumsController] Returns the controller instance.
+    def albums
+      @albums ||= AlbumsController.new @global_configuration
+    end
+
+    # Access to artists controller.
+    # @return [ArtistsController] Returns the controller instance.
+    def artists
+      @artists ||= ArtistsController.new @global_configuration
+    end
+
+    # Access to audiobooks controller.
+    # @return [AudiobooksController] Returns the controller instance.
+    def audiobooks
+      @audiobooks ||= AudiobooksController.new @global_configuration
+    end
+
+    # Access to categories controller.
+    # @return [CategoriesController] Returns the controller instance.
+    def categories
+      @categories ||= CategoriesController.new @global_configuration
+    end
+
+    # Access to chapters controller.
+    # @return [ChaptersController] Returns the controller instance.
+    def chapters
+      @chapters ||= ChaptersController.new @global_configuration
+    end
+
+    # Access to episodes controller.
+    # @return [EpisodesController] Returns the controller instance.
+    def episodes
+      @episodes ||= EpisodesController.new @global_configuration
+    end
+
+    # Access to genres controller.
+    # @return [GenresController] Returns the controller instance.
+    def genres
+      @genres ||= GenresController.new @global_configuration
+    end
+
+    # Access to markets controller.
+    # @return [MarketsController] Returns the controller instance.
+    def markets
+      @markets ||= MarketsController.new @global_configuration
+    end
+
+    # Access to player controller.
+    # @return [PlayerController] Returns the controller instance.
+    def player
+      @player ||= PlayerController.new @global_configuration
+    end
+
+    # Access to playlists controller.
+    # @return [PlaylistsController] Returns the controller instance.
+    def playlists
+      @playlists ||= PlaylistsController.new @global_configuration
+    end
+
+    # Access to search controller.
+    # @return [SearchController] Returns the controller instance.
+    def search
+      @search ||= SearchController.new @global_configuration
+    end
+
+    # Access to shows controller.
+    # @return [ShowsController] Returns the controller instance.
+    def shows
+      @shows ||= ShowsController.new @global_configuration
+    end
+
+    # Access to tracks controller.
+    # @return [TracksController] Returns the controller instance.
+    def tracks
+      @tracks ||= TracksController.new @global_configuration
+    end
+
+    # Access to users controller.
+    # @return [UsersController] Returns the controller instance.
+    def users
+      @users ||= UsersController.new @global_configuration
+    end
+
+    # Access to o_auth_authorization controller.
+    # @return [OAuthAuthorizationController] Returns the controller instance.
+    def o_auth_authorization
+      @o_auth_authorization ||= OAuthAuthorizationController.new @global_configuration
+    end
+
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 60,
+      max_retries: 0, retry_interval: 1, backoff_factor: 2,
+      retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+      retry_methods: %i[get put], http_callback: nil,
+      environment: Environment::PRODUCTION, o_auth_client_id: nil,
+      o_auth_client_secret: nil, o_auth_redirect_uri: nil, o_auth_token: nil,
+      o_auth_scopes: nil, authorization_code_auth_credentials: nil, config: nil
+    )
+      @config = if config.nil?
+                  Configuration.new(
+                    connection: connection, adapter: adapter, timeout: timeout,
+                    max_retries: max_retries, retry_interval: retry_interval,
+                    backoff_factor: backoff_factor,
+                    retry_statuses: retry_statuses,
+                    retry_methods: retry_methods, http_callback: http_callback,
+                    environment: environment,
+                    o_auth_client_id: o_auth_client_id,
+                    o_auth_client_secret: o_auth_client_secret,
+                    o_auth_redirect_uri: o_auth_redirect_uri,
+                    o_auth_token: o_auth_token, o_auth_scopes: o_auth_scopes,
+                    authorization_code_auth_credentials: authorization_code_auth_credentials
+                  )
+                else
+                  config
+                end
+
+      @global_configuration = GlobalConfiguration.new(client_configuration: @config)
+                                                 .base_uri_executor(@config.method(:get_base_uri))
+                                                 .global_errors(BaseController::GLOBAL_ERRORS)
+                                                 .user_agent(BaseController.user_agent)
+
+      initialize_auth_managers(@global_configuration)
+      @global_configuration = @global_configuration.auth_managers(@auth_managers)
+    end
+
+    # Initializes the auth managers hash used for authenticating API calls.
+    # @param [GlobalConfiguration] global_config The global configuration of the SDK)
+    def initialize_auth_managers(global_config)
+      @auth_managers = {}
+      http_client_config = global_config.client_configuration
+      %w[oauth_2_0].each { |auth| @auth_managers[auth] = nil }
+      @auth_managers['oauth_2_0'] = OAuth2.new(
+        http_client_config.authorization_code_auth_credentials, global_config
+      )
+    end
+  end
+end

data/lib/spotify_web_api/configuration.rb

@@ -0,0 +1,180 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # An enum for SDK environments.
+  class Environment
+    ENVIRONMENT = [
+      PRODUCTION = 'production'.freeze
+    ].freeze
+  end
+
+  # An enum for API servers.
+  class Server
+    SERVER = [
+      DEFAULT = 'default'.freeze,
+      AUTH_SERVER = 'auth server'.freeze
+    ].freeze
+  end
+
+  # All configuration including auth info and base URI for the API access
+  # are configured in this class.
+  class Configuration < CoreLibrary::HttpClientConfiguration
+    def o_auth_client_id
+      @authorization_code_auth_credentials.o_auth_client_id
+    end
+
+    def o_auth_client_secret
+      @authorization_code_auth_credentials.o_auth_client_secret
+    end
+
+    def o_auth_redirect_uri
+      @authorization_code_auth_credentials.o_auth_redirect_uri
+    end
+
+    def o_auth_token
+      @authorization_code_auth_credentials.o_auth_token
+    end
+
+    def o_auth_scopes
+      @authorization_code_auth_credentials.o_auth_scopes
+    end
+
+    # The attribute readers for properties.
+    attr_reader :environment, :authorization_code_auth_credentials
+
+    class << self
+      attr_reader :environments
+    end
+
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 60,
+      max_retries: 0, retry_interval: 1, backoff_factor: 2,
+      retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+      retry_methods: %i[get put], http_callback: nil,
+      environment: Environment::PRODUCTION, o_auth_client_id: nil,
+      o_auth_client_secret: nil, o_auth_redirect_uri: nil, o_auth_token: nil,
+      o_auth_scopes: nil, authorization_code_auth_credentials: nil
+    )
+
+      super connection: connection, adapter: adapter, timeout: timeout,
+            max_retries: max_retries, retry_interval: retry_interval,
+            backoff_factor: backoff_factor, retry_statuses: retry_statuses,
+            retry_methods: retry_methods, http_callback: http_callback
+
+      # Current API environment
+      @environment = String(environment)
+
+      # OAuth 2 Client ID
+      @o_auth_client_id = o_auth_client_id
+
+      # OAuth 2 Client Secret
+      @o_auth_client_secret = o_auth_client_secret
+
+      # OAuth 2 Redirection endpoint or Callback Uri
+      @o_auth_redirect_uri = o_auth_redirect_uri
+
+      # Object for storing information about the OAuth token
+      @o_auth_token = if o_auth_token.is_a? OAuthToken
+                        OAuthToken.from_hash o_auth_token.to_hash
+                      else
+                        o_auth_token
+                      end
+
+      # List of scopes that apply to the OAuth token
+      @o_auth_scopes = o_auth_scopes
+
+      # Initializing OAuth 2 Authorization Code Grant credentials with the provided auth parameters
+      @authorization_code_auth_credentials = create_auth_credentials_object(
+        o_auth_client_id, o_auth_client_secret, o_auth_redirect_uri,
+        o_auth_token, o_auth_scopes, authorization_code_auth_credentials
+      )
+
+      # The Http Client to use for making requests.
+      set_http_client CoreLibrary::FaradayClient.new(self)
+    end
+
+    def clone_with(connection: nil, adapter: nil, timeout: nil,
+                   max_retries: nil, retry_interval: nil, backoff_factor: nil,
+                   retry_statuses: nil, retry_methods: nil, http_callback: nil,
+                   environment: nil, o_auth_client_id: nil,
+                   o_auth_client_secret: nil, o_auth_redirect_uri: nil,
+                   o_auth_token: nil, o_auth_scopes: nil,
+                   authorization_code_auth_credentials: nil)
+      connection ||= self.connection
+      adapter ||= self.adapter
+      timeout ||= self.timeout
+      max_retries ||= self.max_retries
+      retry_interval ||= self.retry_interval
+      backoff_factor ||= self.backoff_factor
+      retry_statuses ||= self.retry_statuses
+      retry_methods ||= self.retry_methods
+      http_callback ||= self.http_callback
+      environment ||= self.environment
+      authorization_code_auth_credentials = create_auth_credentials_object(
+        o_auth_client_id, o_auth_client_secret, o_auth_redirect_uri,
+        o_auth_token, o_auth_scopes,
+        authorization_code_auth_credentials || self.authorization_code_auth_credentials
+      )
+
+      Configuration.new(
+        connection: connection, adapter: adapter, timeout: timeout,
+        max_retries: max_retries, retry_interval: retry_interval,
+        backoff_factor: backoff_factor, retry_statuses: retry_statuses,
+        retry_methods: retry_methods, http_callback: http_callback,
+        environment: environment,
+        authorization_code_auth_credentials: authorization_code_auth_credentials
+      )
+    end
+
+    def create_auth_credentials_object(o_auth_client_id, o_auth_client_secret,
+                                       o_auth_redirect_uri, o_auth_token,
+                                       o_auth_scopes,
+                                       authorization_code_auth_credentials)
+      return authorization_code_auth_credentials if o_auth_client_id.nil? &&
+                                                    o_auth_client_secret.nil? &&
+                                                    o_auth_redirect_uri.nil? &&
+                                                    o_auth_token.nil? &&
+                                                    o_auth_scopes.nil?
+
+      warn('The \'o_auth_client_id\', \'o_auth_client_secret\', \'o_auth_redir'\
+           'ect_uri\', \'o_auth_token\', \'o_auth_scopes\' params are deprecat'\
+           'ed. Use \'authorization_code_auth_credentials\' param instead.')
+
+      unless authorization_code_auth_credentials.nil?
+        return authorization_code_auth_credentials.clone_with(
+          o_auth_client_id: o_auth_client_id,
+          o_auth_client_secret: o_auth_client_secret,
+          o_auth_redirect_uri: o_auth_redirect_uri,
+          o_auth_token: o_auth_token,
+          o_auth_scopes: o_auth_scopes
+        )
+      end
+
+      AuthorizationCodeAuthCredentials.new(
+        o_auth_client_id: o_auth_client_id,
+        o_auth_client_secret: o_auth_client_secret,
+        o_auth_redirect_uri: o_auth_redirect_uri, o_auth_token: o_auth_token,
+        o_auth_scopes: o_auth_scopes
+      )
+    end
+
+    # All the environments the SDK can run in.
+    ENVIRONMENTS = {
+      Environment::PRODUCTION => {
+        Server::DEFAULT => 'https://api.spotify.com/v1',
+        Server::AUTH_SERVER => 'https://accounts.spotify.com'
+      }
+    }.freeze
+
+    # Generates the appropriate base URI for the environment and the server.
+    # @param [Configuration::Server] server The server enum for which the base URI is
+    # required.
+    # @return [String] The base URI.
+    def get_base_uri(server = Server::DEFAULT)
+      ENVIRONMENTS[environment][server].clone
+    end
+  end
+end