spotify-ruby-api 0.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 60c91432332136859f731759d15fa3ac9654b903
+  data.tar.gz: af790a4f8e46f57403794918580f85d82b9caba9
+SHA512:
+  metadata.gz: c50b321d9bcba46221cd4d139e75a0a8f1b4e1d832e5e13c5e17985f6720facde62c9873d04d019f6df00cacd75a177c886d9956a1edb5ecfcba23a9400cf867
+  data.tar.gz: b3f5df2353e907f3f3204db4a74f4982b5b0eba94f2ffa2d1bd6303b2d557148a1f4743fd3305bc3b27ee59cf0d2b76a60bc599d70f134ecec122c1388a826bd

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in spotify-api.gemspec
+gemspec
+
+gem 'json'
+gem 'activesupport'

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Felipe Gadelha Ruoso
+
+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.

data/README.md

@@ -0,0 +1,119 @@
+# Spotify::API
+
+This gem was developed with the purpose of retrieve information from [Spotify](https://spotify.com/) service by using its API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'spotify-ruby-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install spotify-ruby-api
+
+## Usage
+
+require 'spotify'
+
+### Albums
+albums_api = Spotify::API::Albums
+
+albums_api.search_by_id(id: '')    # => Spotify::Models::Full::Album
+albums_api.search_by_ids(ids: [])  # => [Spotify::Models::Full::Album]
+
+tracks = albums_api.tracks(id: '') # => Spotify::Models::Paging
+tracks.items                       # => [Spotify::Models::Simplified::Track]
+
+### Tracks
+tracks_api = Spotify::API::Track
+
+tracks_api.search_by_id(id: '')   # => Spotify::Models::Full::Track
+tracks_api.search_by_ids(ids: '') # => [Spotify::Models::Full::Track]
+
+### Artists
+artists_api = Spotify::API::Artist
+
+artists_api.search_by_id(id: '')   # => Spotify::Models::Full::Artist
+artists_api.search_by_ids(ids: '') # => [Spotify::Models::Full::Artist]
+
+albums = artists_api.albums(id: '') # => Spotify::Models::Paging
+albums.items                        # => Spotify::Models::Simplified::Album
+
+top_tracks = artists_api.top_tracks(id: '') # => Spotify::Models::Paging
+top_tracks.items                            # => Spotify::Models::Full::Track
+
+related_artists = artists_api.related_artists(id: '') # => Spotify::Models::Paging
+related_artists.items                                 # => [Spotify::Models::Full::Artist]
+
+## Todo
+
+The following table shows all API endpoints and if each one is already implemented or not.
+
+| Method | EndPoints                                                      | Implemented? |
+| GET    | /v1/albums/{id}                                                | YES          |
+| GET    | /v1/albums?ids={ids}                                           | YES          |
+| GET    | /v1/albums/{id}/tracks                                         | YES          |
+| GET    | /v1/artists/{id}                                               | YES          |
+| GET    | /v1/artists?ids={ids}                                          | YES          |
+| GET    | /v1/artists/{id}/albums                                        | YES          |
+| GET    | /v1/artists/{id}/top-tracks                                    | YES          |
+| GET    | /v1/artists/{id}/related-artists                               | YES          |
+| GET    | /v1/browse/featured-playlists                                  | NO           |
+| GET    | /v1/browse/new-releases                                        | NO           |
+| GET    | /v1/browse/categories                                          | NO           |
+| GET    | /v1/browse/categories/{id}                                     | NO           |
+| GET    | /v1/browse/categories/{id}/playlists                           | NO           |
+| GET    | /v1/me                                                         | NO           |
+| GET    | /v1/me/following                                               | NO           |
+| PUT    | /v1/me/following                                               | NO           |
+| DELETE | /v1/me/following                                               | NO           |
+| GET    | /v1/me/following/contains                                      | NO           |
+| PUT    | /v1/users/{owner_id}/playlists/{playlist_id}/followers         | NO           |
+| DELETE | /v1/users/{owner_id}/playlists/{playlist_id}/followers         | NO           |
+| PUT    | /v1/me/tracks?ids={ids}                                        | NO           |
+| GET    | /v1/me/tracks                                                  | NO           |
+| DELETE | /v1/me/tracks?ids={ids}                                        | NO           |
+| GET    | /v1/me/tracks/contains?ids={ids}                               | NO           |
+| PUT    | /v1/me/albums?ids={ids}                                        | NO           |
+| GET    | /v1/me/albums                                                  | NO           |
+| DELETE | /v1/me/albums?ids={ids}                                        | NO           |
+| GET    | /v1/me/albums/contains?ids={ids}                               | NO           |
+| GET    | /v1/search?type=album                                          | YES          |
+| GET    | /v1/search?type=artist                                         | YES          |
+| GET    | /v1/search?type=playlist                                       | YES          |
+| GET    | /v1/search?type=track                                          | YES          |
+| GET    | /v1/tracks/{id}                                                | YES          |
+| GET    | /v1/tracks?ids={ids}                                           | YES          |
+| GET    | /v1/users/{user_id}                                            | YES          |
+| GET    | /v1/users/{user_id}/playlists                                  | NO           |
+| GET    | /v1/me/playlists                                               | NO           |
+| GET    | /v1/users/{user_id}/playlists/{playlist_id}                    | NO           |
+| GET    | /v1/users/{user_id}/playlists/{playlist_id}/tracks             | NO           |
+| POST   | /v1/users/{user_id}/playlists                                  | NO           |
+| PUT    | /v1/users/{user_id}/playlists/{playlist_id}                    | NO           |
+| POST   | /v1/users/{user_id}/playlists/{playlist_id}/tracks             | NO           |
+| DELETE | /v1/users/{user_id}/playlists/{playlist_id}/tracks             | NO           |
+| PUT    | /v1/users/{user_id}/playlists/{playlist_id}/tracks             | NO           |
+| PUT    | /v1/users/{user_id}/playlists/{playlist_id}/tracks             | NO           |
+| GET    | /v1/users/{user_id}/playlists/{playlist_id}/followers/contains | NO           |
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+1. Fork it ( https://github.com/felipegruoso/spotify-api/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task default: :spec
+task test:    :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "spotify"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/spotify/api/album.rb

@@ -0,0 +1,164 @@
+module Spotify
+  module API
+
+    class Album < Spotify::API::Base
+
+      #
+      # API endpoint for albums.
+      #
+      ALBUMS_URL = "#{BASE_URL}albums"
+
+      #
+      # Gets the albums related to the given parameters.
+      #
+      # @param [Hash] args the search arguments.
+      # @option [Fixnum] :timeout the max time a request can take.
+      # @option [Fixnum] :retries the number of retries if necessary.
+      #
+      # @return [Spotify::Models::Paging] the extracted albums.
+      #
+      def self.search(args = {})
+        args[:type] = :album
+
+        service_params = args.slice(:timeout, :retries)
+        args           = args.slice(:q, :market, :type, :limit, :offset)
+
+        self.new(service_params).search(args)
+      end
+
+      #
+      # Gets an album.
+      #
+      # @param [Hash] args the search arguments.
+      # @option [Fixnum] :timeout the max time a request can take.
+      # @option [Fixnum] :retries the number of retries if necessary.
+      #
+      # @return [Full::Album] the extracted album.
+      #
+      def self.search_by_id(args = {})
+        service_params = args.slice(:timeout, :retries)
+        args           = args.slice(:id)
+
+        self.new(service_params).search_by_id(args)
+      end
+
+      #
+      # Gets an album.
+      #
+      # @param [Hash] args the search arguments.
+      # @option [Fixnum] :timeout the max time a request can take.
+      # @option [Fixnum] :retries the number of retries if necessary.
+      #
+      # @return [Array<Full::Album>] the extracted album.
+      #
+      def self.search_by_ids(args = {})
+        args[:ids] = Array(args[:ids]).join(',')
+
+        service_params = args.slice(:timeout, :retries)
+        args           = args.slice(:ids)
+
+        self.new(service_params).search_by_ids(args)
+      end
+
+      #
+      # Gets an album.
+      #
+      # @param [Hash] args the search arguments.
+      # @option [Fixnum] :timeout the max time a request can take.
+      # @option [Fixnum] :retries the number of retries if necessary.
+      #
+      # @return [Full::Album] the extracted album.
+      #
+      def self.tracks(args = {})
+        service_params = args.slice(:timeout, :retries)
+        args           = args.slice(:id, :limit, :offset, :market)
+
+        self.new(service_params).tracks(args)
+      end
+
+      #
+      # Gets the albums related to the given parameters.
+      #
+      # @param [Hash] args the search arguments.
+      # @option [Fixnum] :timeout the max time a request can take.
+      # @option [Fixnum] :retries the number of retries if necessary.
+      #
+      # @return [Spotify::Models::Paging] the extracted albums.
+      #
+      def search(args = {})
+        if args[:market].to_s.to_sym == FROM_TOKEN
+          # TODO: Authorization.
+          return Spotify::API::Errors::NOT_AVAILABLE
+        end
+
+        get(SEARCH_URL, args)
+
+        define_response do
+          klass = Spotify::Models::Simplified::Album
+
+          Spotify::Models::Paging.new(response["albums"], klass)
+        end
+      end
+
+      #
+      # Gets an album.
+      #
+      # @param [Hash] args the search arguments.
+      # @option [String] :id the album id.
+      #
+      # @return [Full::Album] the extracted album.
+      #
+      def search_by_id(args = {})
+        url = ALBUMS_URL + '/' + args[:id].to_s
+
+        get(url)
+
+        define_response do
+          Spotify::Models::Full::Album.new(response)
+        end
+      end
+
+      #
+      # Gets several albums.
+      #
+      # @param [Hash] args the search arguments.
+      # @option [String] :ids the artists ids between ",".
+      #
+      # @return [Array<Full::Album>] an array containing
+      #   the extracted albums.
+      #
+      def search_by_ids(args = {})
+        get(ALBUMS_URL, args)
+
+        define_response do
+          response["albums"].map do |album|
+            Spotify::Models::Full::Album.new(album)
+          end
+        end
+      end
+
+      #
+      # Gets the album's tracks.
+      #
+      # @param [Hash] args the search arguments.
+      #
+      # @return [Paging] an array containing album's tracks.
+      #
+      def tracks(args = {})
+        url    = ALBUMS_URL + '/' + args[:id] + '/tracks'
+        params = args.slice(:limit, :offset, :market)
+
+        get(url, params)
+
+        define_response do
+          klass = Spotify::Models::Simplified::Track
+
+          Spotify::Models::Paging.new(response, klass)
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/spotify/api/artist.rb

@@ -0,0 +1,248 @@
+module Spotify
+  module API
+
+    class Artist < Spotify::API::Base
+
+      #
+      # API endpoint for artists.
+      #
+      ARTISTS_URL = "#{BASE_URL}artists"
+
+      #
+      # Gets the artists related to the given parameters.
+      #
+      # @param [Hash] args the search arguments.
+      # @option [Fixnum] :timeout the max time a request can take.
+      # @option [Fixnum] :retries the number of retries if necessary.
+      #
+      # @return [Spotify::Models::Paging] the extracted artists.
+      #
+      def self.search(args = {})
+        args[:type] = :artist
+
+        service_params = args.slice(:timeout, :retries)
+        args           = args.slice(:q, :market, :type, :limit, :offset)
+
+        self.new(service_params).search(args)
+      end
+
+      #
+      # Gets an artist.
+      #
+      # @param [Hash] args the search arguments.
+      # @option [Fixnum] :timeout the max time a request can take.
+      # @option [Fixnum] :retries the number of retries if necessary.
+      #
+      # @return [Full::Artist] the extracted artist.
+      #
+      def self.search_by_id(args = {})
+        service_params = args.slice(:timeout, :retries)
+        args           = args.slice(:id)
+
+        self.new(service_params).search_by_id(args)
+      end
+
+      #
+      # Gets several artists.
+      #
+      # @param [Hash] args the search arguments.
+      # @option [Fixnum] :timeout the max time a request can take.
+      # @option [Fixnum] :retries the number of retries if necessary.
+      #
+      # @return [Array<Full::Artist>] an array containing
+      #   the extracted artists.
+      #
+      def self.search_by_ids(args = {})
+        args[:ids] = Array(args[:ids]).join(',')
+
+        service_params = args.slice(:timeout, :retries)
+        args           = args.slice(:ids)
+
+        self.new(service_params).search_by_ids(args)
+      end
+
+      #
+      # Get an artist's top tracks.
+      #
+      # @param [Hash] args the search arguments.
+      # @option [Fixnum] :timeout the max time a request can take.
+      # @option [Fixnum] :retries the number of retries if necessary.
+      #
+      # @return [Array<Full::Track>] an array containing
+      #   the extracted artist's top tracks.
+      #
+      def self.top_tracks(args = {})
+        args           = args.slice(:id, :country)
+        service_params = args.slice(:timeout, :retries)
+
+        self.new(service_params).top_tracks(args)
+      end
+
+      #
+      # Get an artist's related artists.
+      #
+      # @param [Hash] args the search arguments.
+      # @option [Fixnum] :timeout the max time a request can take.
+      # @option [Fixnum] :retries the number of retries if necessary.
+      #
+      # @return [Array<Full::Artist>] an array containing
+      #   the extracted artist's related artists.
+      #
+      def self.related_artists(args = {})
+        args           = args.slice(:id)
+        service_params = args.slice(:timeout, :retries)
+
+        self.new(service_params).related_artists(args)
+      end
+
+      #
+      # Get an artist's albums.
+      #
+      # @param [Hash] args the search arguments.
+      # @option [Fixnum] :timeout the max time a request can take.
+      # @option [Fixnum] :retries the number of retries if necessary.
+      #
+      # @return [Paging] an array containing the extracted artist's albums.
+      #
+      def self.albums(args = {})
+        args[:album_type] = Array(args[:album_type]).join(',')
+
+        args           = args.slice(:id, :album_type, :market, :limit, :offset)
+        service_params = args.slice(:timeout, :retries)
+
+        self.new(service_params).albums(args)
+      end
+
+      #
+      # Gets the artists related to the given parameters.
+      #
+      # @param [Hash] args the search arguments.
+      # @option [Fixnum] :timeout the max time a request can take.
+      # @option [Fixnum] :retries the number of retries if necessary.
+      #
+      # @return [Spotify::Models::Paging] the extracted artists.
+      #
+      def search(args = {})
+        if args[:market].to_s.to_sym == FROM_TOKEN
+          # TODO: Authorization.
+          return Spotify::API::Errors::NOT_AVAILABLE
+        end
+
+        get(SEARCH_URL, args)
+
+        define_response do
+          klass = Spotify::Models::Full::Artist
+
+          Spotify::Models::Paging.new(response["artists"], klass)
+        end
+      end
+
+      #
+      # Gets an artist.
+      #
+      # @param [Hash] args the search arguments.
+      # @option [String] :id the artist id.
+      #
+      # @return [Full::Artist] the extracted artist.
+      #
+      def search_by_id(args = {})
+        url = ARTISTS_URL + '/' + args[:id].to_s
+
+        get(url)
+
+        define_response do
+          Spotify::Models::Full::Artist.new(response)
+        end
+      end
+
+      #
+      # Gets several artists.
+      #
+      # @param [Hash] args the search arguments.
+      # @option [String] :ids the artists ids between ",".
+      #
+      # @return [Array<Full::Artist>] an array containing
+      #   the extracted artists.
+      #
+      def search_by_ids(args = {})
+        get(ARTISTS_URL, args)
+
+        define_response do
+          response["artists"].map do |artist|
+            Spotify::Models::Full::Artist.new(artist)
+          end
+        end
+      end
+
+      #
+      # Get an artist's top tracks.
+      #
+      # @param [Hash] args the search arguments.
+      # @option [String] :id the artist id.
+      # @option [String] :country the request country.
+      #
+      # @return [Array<Full::Track>] an array containing
+      #   the extracted artist's top tracks.
+      #
+      def top_tracks(args = {})
+        url    = ARTISTS_URL + '/' + args[:id].to_s + '/top-tracks'
+        params = args.slice(:country)
+
+        get(url, params)
+
+        define_response do
+          response["tracks"].map do |track|
+            Spotify::Models::Full::Track.new(track)
+          end
+        end
+      end
+
+      #
+      # Get an artist's related artists.
+      #
+      # @param [Hash] args the search arguments.
+      # @option [Fixnum] :timeout the max time a request can take.
+      # @option [Fixnum] :retries the number of retries if necessary.
+      #
+      # @return [Array<Full::Artist>] an array containing
+      #   the extracted artist's related artists.
+      #
+      def related_artists(args = {})
+        url = ARTISTS_URL + '/' + args[:id].to_s + '/related-artists'
+
+        get(url)
+
+        define_response do
+          response["artists"].map do |artist|
+            Spotify::Models::Full::Artist.new(artist)
+          end
+        end
+      end
+
+      #
+      # Get an artist's albums.
+      #
+      # @param [Hash] args the search arguments.
+      # @option [Fixnum] :timeout the max time a request can take.
+      # @option [Fixnum] :retries the number of retries if necessary.
+      #
+      # @return [Paging] an array containing the extracted artist's
+      #   related artists.
+      #
+      def albums(args = {})
+        url    = ARTISTS_URL + '/' + args[:id].to_s + '/albums'
+        params = args.slice(:album_type, :market, :limit, :offset)
+
+        get(url, params)
+
+        define_response do
+          klass = Spotify::Models::Simplified::Album
+
+          Spotify::Models::Paging.new(response, klass)
+        end
+      end
+
+    end
+
+  end
+end