spotify-api-sdk 1.0.0

data/lib/spotify_web_api/http/auth/o_auth2.rb

@@ -0,0 +1,146 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # Utility class for OAuth 2 authorization and token management.
+  class OAuth2 < CoreLibrary::HeaderAuth
+    include CoreLibrary
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'AuthorizationCodeAuth: OAuthToken is undefined or expired.'
+    end
+
+    # Initialization constructor.
+    def initialize(authorization_code_auth_credentials, config)
+      auth_params = {}
+      @_o_auth_client_id = authorization_code_auth_credentials.o_auth_client_id unless
+        authorization_code_auth_credentials.nil? || authorization_code_auth_credentials.o_auth_client_id.nil?
+      @_o_auth_client_secret = authorization_code_auth_credentials.o_auth_client_secret unless
+        authorization_code_auth_credentials.nil? || authorization_code_auth_credentials.o_auth_client_secret.nil?
+      @_o_auth_redirect_uri = authorization_code_auth_credentials.o_auth_redirect_uri unless
+        authorization_code_auth_credentials.nil? || authorization_code_auth_credentials.o_auth_redirect_uri.nil?
+      @_o_auth_token = authorization_code_auth_credentials.o_auth_token unless
+        authorization_code_auth_credentials.nil? || authorization_code_auth_credentials.o_auth_token.nil?
+      @_o_auth_scopes = authorization_code_auth_credentials.o_auth_scopes unless
+        authorization_code_auth_credentials.nil? || authorization_code_auth_credentials.o_auth_scopes.nil?
+      @_config = config
+      @_o_auth_api = OAuthAuthorizationController.new(config)
+      auth_params['Authorization'] = "Bearer #{@_o_auth_token.access_token}" unless @_o_auth_token.nil?
+
+      super auth_params
+    end
+
+    # Validates the oAuth token.
+    # @return [Boolean] true if the token is present and not expired.
+    def valid
+      !@_o_auth_token.nil? && !token_expired?(@_o_auth_token)
+    end
+
+    # Builds and returns an authorization URL.
+    # The user is expected to obtain an authorization code from this URL and then call the
+    # fetch token function with that authorization code.
+    # @param [String] state An opaque state string.
+    # @param [Hash] additional_params Any additional query parameters to be added to the URL.
+    # @return [String] additional_params The authorization URL.
+    def get_authorization_url(state: nil, additional_params: nil)
+      auth_url = @_config.get_base_uri(Server.AUTH_SERVER)
+      auth_url += '/authorize'
+      query_params = {
+        'response_type' => 'code',
+        'client_id' => @_o_auth_client_id,
+        'redirect_uri' => @_o_auth_client_id
+      }
+      query_params['scope'] = Array(@_o_auth_scopes).compact.join(' ') if @_o_auth_scopes
+      query_params['state'] = state if state
+      query_params.merge!(additional_params) if additional_params
+      auth_url = APIHelper.append_url_with_query_parameters(auth_url,
+                                                            query_params)
+      APIHelper.clean_url(auth_url)
+    end
+
+    # Builds the basic auth header for endpoints in the OAuth Authorization Controller.
+    # @return [String] The value of the Authentication header.
+    def build_basic_auth_header
+      "Basic #{AuthHelper.get_base64_encoded_value(@_o_auth_client_id, @_o_auth_client_secret)}"
+    end
+
+    # Fetches the token.
+    # @param [String] auth_code The authentication code.
+    # @param [Hash] additional_params Any additional form parameters.
+    # @return [OAuthToken] The oAuth token instance.
+    def fetch_token(auth_code, additional_params: nil)
+      token = @_o_auth_api.request_token(
+        build_basic_auth_header,
+        auth_code,
+        @_o_auth_redirect_uri,
+        _field_parameters: additional_params
+      ).data
+      if token.respond_to?('expires_in') && !token.expires_in.nil?
+        token.expiry = AuthHelper.get_token_expiry(token.expires_in, Time.now.utc.to_i)
+      end
+      token
+    end
+
+    # Checks if OAuth token has expired.
+    # @param [OAuthToken] token The oAuth token instance.
+    # @return [Boolean] true if the token is present and not expired.
+    def token_expired?(token)
+      token.respond_to?('expiry') && AuthHelper.token_expired?(token.expiry)
+    end
+
+    # Refreshes OAuth token.
+    # @param [Hash] additional_params Any additional form parameters.
+    # @return [OAuthToken] The oAuth token instance.
+    def refresh_token(additional_params: nil)
+      token = @_o_auth_api.refresh_token(
+        OAuth2.build_basic_auth_header,
+        @_o_auth_token.refresh_token,
+        scope: !@_o_auth_scopes.nil? ? Array(@_o_auth_scopes).compact.join(' ') : nil,
+        _field_parameters: additional_params
+      ).data
+      if token.respond_to?('expires_in') && !token.expires_in.nil?
+        token.expiry = AuthHelper.get_token_expiry(token.expires_in, Time.now.utc.to_i)
+      end
+      token
+    end
+  end
+
+  # Data class for AuthorizationCodeAuthCredentials.
+  class AuthorizationCodeAuthCredentials
+    attr_reader :o_auth_client_id, :o_auth_client_secret, :o_auth_redirect_uri,
+                :o_auth_token, :o_auth_scopes
+
+    def initialize(o_auth_client_id:, o_auth_client_secret:,
+                   o_auth_redirect_uri:, o_auth_token: nil, o_auth_scopes: nil)
+      raise ArgumentError, 'o_auth_client_id cannot be nil' if o_auth_client_id.nil?
+      raise ArgumentError, 'o_auth_client_secret cannot be nil' if o_auth_client_secret.nil?
+      raise ArgumentError, 'o_auth_redirect_uri cannot be nil' if o_auth_redirect_uri.nil?
+
+      @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
+
+    def clone_with(o_auth_client_id: nil, o_auth_client_secret: nil,
+                   o_auth_redirect_uri: nil, o_auth_token: nil,
+                   o_auth_scopes: nil)
+      o_auth_client_id ||= self.o_auth_client_id
+      o_auth_client_secret ||= self.o_auth_client_secret
+      o_auth_redirect_uri ||= self.o_auth_redirect_uri
+      o_auth_token ||= self.o_auth_token
+      o_auth_scopes ||= self.o_auth_scopes
+
+      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
+  end
+end

data/lib/spotify_web_api/http/http_call_back.rb

@@ -0,0 +1,10 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # HttpCallBack allows defining callables for pre and post API calls.
+  class HttpCallBack < CoreLibrary::HttpCallback
+  end
+end

data/lib/spotify_web_api/http/http_method_enum.rb

@@ -0,0 +1,10 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # HTTP Methods Enumeration.
+  class HttpMethodEnum < CoreLibrary::HttpMethod
+  end
+end

data/lib/spotify_web_api/http/http_request.rb

@@ -0,0 +1,10 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # Represents a single Http Request.
+  class HttpRequest < CoreLibrary::HttpRequest
+  end
+end

data/lib/spotify_web_api/http/http_response.rb

@@ -0,0 +1,10 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # Http response received.
+  class HttpResponse < CoreLibrary::HttpResponse
+  end
+end

data/lib/spotify_web_api/models/album_base.rb

@@ -0,0 +1,168 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # AlbumBase Model.
+  class AlbumBase < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of the album.
+    # @return [AlbumTypeEnum]
+    attr_accessor :album_type
+
+    # The number of tracks in the album.
+    # @return [Integer]
+    attr_accessor :total_tracks
+
+    # The markets in which the album is available: [ISO 3166-1 alpha-2 country
+    # codes](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). _**NOTE**: an
+    # album is considered available in a market when at least 1 of its tracks is
+    # available in that market._
+    # @return [Array[String]]
+    attr_accessor :available_markets
+
+    # Known external URLs for this album.
+    # @return [ExternalUrlObject]
+    attr_accessor :external_urls
+
+    # A link to the Web API endpoint providing full details of the album.
+    # @return [String]
+    attr_accessor :href
+
+    # The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+    # album.
+    # @return [String]
+    attr_accessor :id
+
+    # The cover art for the album in various sizes, widest first.
+    # @return [Array[ImageObject]]
+    attr_accessor :images
+
+    # The name of the album. In case of an album takedown, the value may be an
+    # empty string.
+    # @return [String]
+    attr_accessor :name
+
+    # The date the album was first released.
+    # @return [String]
+    attr_accessor :release_date
+
+    # The precision with which `release_date` value is known.
+    # @return [ReleaseDatePrecisionEnum]
+    attr_accessor :release_date_precision
+
+    # Included in the response when a content restriction is applied.
+    # @return [AlbumRestrictionObject]
+    attr_accessor :restrictions
+
+    # The object type.
+    # @return [Type2Enum]
+    attr_accessor :type
+
+    # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for
+    # the album.
+    # @return [String]
+    attr_accessor :uri
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['album_type'] = 'album_type'
+      @_hash['total_tracks'] = 'total_tracks'
+      @_hash['available_markets'] = 'available_markets'
+      @_hash['external_urls'] = 'external_urls'
+      @_hash['href'] = 'href'
+      @_hash['id'] = 'id'
+      @_hash['images'] = 'images'
+      @_hash['name'] = 'name'
+      @_hash['release_date'] = 'release_date'
+      @_hash['release_date_precision'] = 'release_date_precision'
+      @_hash['restrictions'] = 'restrictions'
+      @_hash['type'] = 'type'
+      @_hash['uri'] = 'uri'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        restrictions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(album_type = nil, total_tracks = nil,
+                   available_markets = nil, external_urls = nil, href = nil,
+                   id = nil, images = nil, name = nil, release_date = nil,
+                   release_date_precision = nil, type = nil, uri = nil,
+                   restrictions = SKIP)
+      @album_type = album_type
+      @total_tracks = total_tracks
+      @available_markets = available_markets
+      @external_urls = external_urls
+      @href = href
+      @id = id
+      @images = images
+      @name = name
+      @release_date = release_date
+      @release_date_precision = release_date_precision
+      @restrictions = restrictions unless restrictions == SKIP
+      @type = type
+      @uri = uri
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      album_type = hash.key?('album_type') ? hash['album_type'] : nil
+      total_tracks = hash.key?('total_tracks') ? hash['total_tracks'] : nil
+      available_markets =
+        hash.key?('available_markets') ? hash['available_markets'] : nil
+      external_urls = ExternalUrlObject.from_hash(hash['external_urls']) if hash['external_urls']
+      href = hash.key?('href') ? hash['href'] : nil
+      id = hash.key?('id') ? hash['id'] : nil
+      # Parameter is an array, so we need to iterate through it
+      images = nil
+      unless hash['images'].nil?
+        images = []
+        hash['images'].each do |structure|
+          images << (ImageObject.from_hash(structure) if structure)
+        end
+      end
+
+      images = nil unless hash.key?('images')
+      name = hash.key?('name') ? hash['name'] : nil
+      release_date = hash.key?('release_date') ? hash['release_date'] : nil
+      release_date_precision =
+        hash.key?('release_date_precision') ? hash['release_date_precision'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      uri = hash.key?('uri') ? hash['uri'] : nil
+      restrictions = AlbumRestrictionObject.from_hash(hash['restrictions']) if
+        hash['restrictions']
+
+      # Create object from extracted values.
+      AlbumBase.new(album_type,
+                    total_tracks,
+                    available_markets,
+                    external_urls,
+                    href,
+                    id,
+                    images,
+                    name,
+                    release_date,
+                    release_date_precision,
+                    type,
+                    uri,
+                    restrictions)
+    end
+  end
+end

data/lib/spotify_web_api/models/album_group_enum.rb

@@ -0,0 +1,29 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # This field describes the relationship between the artist and the album.
+  class AlbumGroupEnum
+    ALBUM_GROUP_ENUM = [
+      # TODO: Write general description for ALBUM
+      ALBUM = 'album'.freeze,
+
+      # TODO: Write general description for SINGLE
+      SINGLE = 'single'.freeze,
+
+      # TODO: Write general description for COMPILATION
+      COMPILATION = 'compilation'.freeze,
+
+      # TODO: Write general description for APPEARS_ON
+      APPEARS_ON = 'appears_on'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ALBUM_GROUP_ENUM.include?(value)
+    end
+  end
+end

data/lib/spotify_web_api/models/album_object.rb

@@ -0,0 +1,247 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # AlbumObject Model.
+  class AlbumObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of the album.
+    # @return [AlbumTypeEnum]
+    attr_accessor :album_type
+
+    # The number of tracks in the album.
+    # @return [Integer]
+    attr_accessor :total_tracks
+
+    # The markets in which the album is available: [ISO 3166-1 alpha-2 country
+    # codes](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). _**NOTE**: an
+    # album is considered available in a market when at least 1 of its tracks is
+    # available in that market._
+    # @return [Array[String]]
+    attr_accessor :available_markets
+
+    # Known external URLs for this album.
+    # @return [ExternalUrlObject]
+    attr_accessor :external_urls
+
+    # A link to the Web API endpoint providing full details of the album.
+    # @return [String]
+    attr_accessor :href
+
+    # The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+    # album.
+    # @return [String]
+    attr_accessor :id
+
+    # The cover art for the album in various sizes, widest first.
+    # @return [Array[ImageObject]]
+    attr_accessor :images
+
+    # The name of the album. In case of an album takedown, the value may be an
+    # empty string.
+    # @return [String]
+    attr_accessor :name
+
+    # The date the album was first released.
+    # @return [String]
+    attr_accessor :release_date
+
+    # The precision with which `release_date` value is known.
+    # @return [ReleaseDatePrecisionEnum]
+    attr_accessor :release_date_precision
+
+    # Included in the response when a content restriction is applied.
+    # @return [AlbumRestrictionObject]
+    attr_accessor :restrictions
+
+    # The object type.
+    # @return [Type2Enum]
+    attr_accessor :type
+
+    # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for
+    # the album.
+    # @return [String]
+    attr_accessor :uri
+
+    # The artists of the album. Each artist object includes a link in `href` to
+    # more detailed information about the artist.
+    # @return [Array[SimplifiedArtistObject]]
+    attr_accessor :artists
+
+    # The tracks of the album.
+    # @return [PagingSimplifiedTrackObject]
+    attr_accessor :tracks
+
+    # The copyright statements of the album.
+    # @return [Array[CopyrightObject]]
+    attr_accessor :copyrights
+
+    # Known external IDs for the album.
+    # @return [ExternalIdObject]
+    attr_accessor :external_ids
+
+    # A list of the genres the album is associated with. If not yet classified,
+    # the array is empty.
+    # @return [Array[String]]
+    attr_accessor :genres
+
+    # The label associated with the album.
+    # @return [String]
+    attr_accessor :label
+
+    # The popularity of the album. The value will be between 0 and 100, with 100
+    # being the most popular.
+    # @return [Integer]
+    attr_accessor :popularity
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['album_type'] = 'album_type'
+      @_hash['total_tracks'] = 'total_tracks'
+      @_hash['available_markets'] = 'available_markets'
+      @_hash['external_urls'] = 'external_urls'
+      @_hash['href'] = 'href'
+      @_hash['id'] = 'id'
+      @_hash['images'] = 'images'
+      @_hash['name'] = 'name'
+      @_hash['release_date'] = 'release_date'
+      @_hash['release_date_precision'] = 'release_date_precision'
+      @_hash['restrictions'] = 'restrictions'
+      @_hash['type'] = 'type'
+      @_hash['uri'] = 'uri'
+      @_hash['artists'] = 'artists'
+      @_hash['tracks'] = 'tracks'
+      @_hash['copyrights'] = 'copyrights'
+      @_hash['external_ids'] = 'external_ids'
+      @_hash['genres'] = 'genres'
+      @_hash['label'] = 'label'
+      @_hash['popularity'] = 'popularity'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        restrictions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(album_type = nil, total_tracks = nil,
+                   available_markets = nil, external_urls = nil, href = nil,
+                   id = nil, images = nil, name = nil, release_date = nil,
+                   release_date_precision = nil, type = nil, uri = nil,
+                   artists = nil, tracks = nil, copyrights = nil,
+                   external_ids = nil, genres = nil, label = nil,
+                   popularity = nil, restrictions = SKIP)
+      @album_type = album_type
+      @total_tracks = total_tracks
+      @available_markets = available_markets
+      @external_urls = external_urls
+      @href = href
+      @id = id
+      @images = images
+      @name = name
+      @release_date = release_date
+      @release_date_precision = release_date_precision
+      @restrictions = restrictions unless restrictions == SKIP
+      @type = type
+      @uri = uri
+      @artists = artists
+      @tracks = tracks
+      @copyrights = copyrights
+      @external_ids = external_ids
+      @genres = genres
+      @label = label
+      @popularity = popularity
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      album_type = hash.key?('album_type') ? hash['album_type'] : nil
+      total_tracks = hash.key?('total_tracks') ? hash['total_tracks'] : nil
+      available_markets =
+        hash.key?('available_markets') ? hash['available_markets'] : nil
+      external_urls = ExternalUrlObject.from_hash(hash['external_urls']) if hash['external_urls']
+      href = hash.key?('href') ? hash['href'] : nil
+      id = hash.key?('id') ? hash['id'] : nil
+      # Parameter is an array, so we need to iterate through it
+      images = nil
+      unless hash['images'].nil?
+        images = []
+        hash['images'].each do |structure|
+          images << (ImageObject.from_hash(structure) if structure)
+        end
+      end
+
+      images = nil unless hash.key?('images')
+      name = hash.key?('name') ? hash['name'] : nil
+      release_date = hash.key?('release_date') ? hash['release_date'] : nil
+      release_date_precision =
+        hash.key?('release_date_precision') ? hash['release_date_precision'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      uri = hash.key?('uri') ? hash['uri'] : nil
+      # Parameter is an array, so we need to iterate through it
+      artists = nil
+      unless hash['artists'].nil?
+        artists = []
+        hash['artists'].each do |structure|
+          artists << (SimplifiedArtistObject.from_hash(structure) if structure)
+        end
+      end
+
+      artists = nil unless hash.key?('artists')
+      tracks = PagingSimplifiedTrackObject.from_hash(hash['tracks']) if hash['tracks']
+      # Parameter is an array, so we need to iterate through it
+      copyrights = nil
+      unless hash['copyrights'].nil?
+        copyrights = []
+        hash['copyrights'].each do |structure|
+          copyrights << (CopyrightObject.from_hash(structure) if structure)
+        end
+      end
+
+      copyrights = nil unless hash.key?('copyrights')
+      external_ids = ExternalIdObject.from_hash(hash['external_ids']) if hash['external_ids']
+      genres = hash.key?('genres') ? hash['genres'] : nil
+      label = hash.key?('label') ? hash['label'] : nil
+      popularity = hash.key?('popularity') ? hash['popularity'] : nil
+      restrictions = AlbumRestrictionObject.from_hash(hash['restrictions']) if
+        hash['restrictions']
+
+      # Create object from extracted values.
+      AlbumObject.new(album_type,
+                      total_tracks,
+                      available_markets,
+                      external_urls,
+                      href,
+                      id,
+                      images,
+                      name,
+                      release_date,
+                      release_date_precision,
+                      type,
+                      uri,
+                      artists,
+                      tracks,
+                      copyrights,
+                      external_ids,
+                      genres,
+                      label,
+                      popularity,
+                      restrictions)
+    end
+  end
+end

data/lib/spotify_web_api/models/album_restriction_object.rb

@@ -0,0 +1,53 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # AlbumRestrictionObject Model.
+  class AlbumRestrictionObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The reason for the restriction. Albums may be restricted if the content is
+    # not available in a given market, to the user's subscription type, or when
+    # the user's account is set to not play explicit content.
+    # Additional reasons may be added in the future.
+    # @return [ReasonEnum]
+    attr_accessor :reason
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['reason'] = 'reason'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        reason
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(reason = SKIP)
+      @reason = reason unless reason == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      reason = hash.key?('reason') ? hash['reason'] : SKIP
+
+      # Create object from extracted values.
+      AlbumRestrictionObject.new(reason)
+    end
+  end
+end