rspotify 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a915d527294d8772bf9f21e87660fce4241a9beb
-  data.tar.gz: 494e4a78f576a65780077bbd98e2a11aeb610c78
+  metadata.gz: 3fd61ef8b246df135f26baba22ee01c8c8b95aea
+  data.tar.gz: 2e9b132363b9250147ef8e1f94dd6c5a1ed4b79f
 SHA512:
-  metadata.gz: 7e604afc1b2830bf9bb3e07b5a9e7e042bb184d61bf2476efee94759c2e3f5fc2163b1cd4c7830343f3bb90d91e48256e92c26573c80ac62b5f34f27f466e7b8
-  data.tar.gz: e7fa3c1792e6f9dbc456758f5677ba9c6b2bdc4795631cd07c7694c2dadeba0a31675719b8a8812f2f019d532d86c300556d770a4b24fc510d2998e52276b2a1
+  metadata.gz: c30d2c943bd75df12a5215cb1f459bbef43298c740513f0757a0b0e49475047ef6e5758c47f5a98a25972e1f6ce6afb10cac8d43d6ab807c6e66bc08e9d2bad6
+  data.tar.gz: ec69eab471a3dbd4149f48bc2d319c229a3333671467f74bae73cb13b2db3c4367a2bd0d1fe676e1c7a630e3c45a61e29aad5df24e3133112c6bcc62e22d940f

data/README.md

@@ -123,7 +123,7 @@ RSpotify::authenticate("<your_client_id>", "<your_client_secret>")
 # config/initializers/omniauth.rb
 
 Rails.application.config.middleware.use OmniAuth::Builder do
-  provider :spotify, "<your_client_id>", "<your_client_secret>", scope: 'user-read-email playlist-modify-public'
+  provider :spotify, "<your_client_id>", "<your_client_secret>", scope: 'user-read-email playlist-modify-public user-library-read user-library-modify'
 end
 ```
 
@@ -153,7 +153,7 @@ class UsersController < ApplicationController
     spotify_user = RSpotify::User.new(request.env['omniauth.auth'])
     # Now you can access user's private data, create playlists and much more
 
-    # Access private data (Check doc for all attributes)
+    # Access private data
     spotify_user.country #=> "US"
     spotify_user.email   #=> "example@email.com"
 
@@ -164,6 +164,13 @@ class UsersController < ApplicationController
     tracks = RSpotify::Track.search('Know')
     playlist.add_tracks!(tracks)
     playlist.tracks.first.name #=> "Somebody That I Used To Know"
+
+    # Access and modify user's music library
+    spotify_user.save_tracks!(tracks)
+    spotify_user.saved_tracks.size #=> 20
+    spotify_user.remove_tracks!(tracks)
+
+    # Check doc for more
   end
 end
 ```

data/lib/rspotify/artist.rb

@@ -68,7 +68,7 @@ module RSpotify
       @albums = json['items'].map { |a| Album.new a }
     end
 
-    # Returns array of similar artists. Similarity is based on analysis of the Spotify community’s {http://news.spotify.com/se/2010/02/03/related-artists listening history}.
+    # Returns array of similar artists. Similarity is based on analysis of the Spotify community’s {http://news.spotify.com/se/2010/02/03/related-artists listening history}
     #
     # @return [Array<Artist>]
     #

data/lib/rspotify/connection.rb

@@ -7,7 +7,7 @@ module RSpotify
   API_URI       = 'https://api.spotify.com/v1/'
   AUTHORIZE_URI = 'https://accounts.spotify.com/authorize'
   TOKEN_URI     = 'https://accounts.spotify.com/api/token'
-  VERBS         = %w(get post)
+  VERBS         = %w(get post put delete)
 
   def self.auth_header
     authorization = Base64.strict_encode64 "#{@client_id}:#{@client_secret}"
@@ -15,7 +15,7 @@ module RSpotify
   end
   private_class_method :auth_header
 
-  # Authenticates access to restricted data. Requires {https://developer.spotify.com/my-applications user credentials}.
+  # Authenticates access to restricted data. Requires {https://developer.spotify.com/my-applications user credentials}
   #
   # @param client_id [String]
   # @param client_secret [String]
@@ -34,14 +34,12 @@ module RSpotify
   end
 
   VERBS.each do |verb|
-    # RSpotify::{get,post}
     define_singleton_method verb do |path, *params|
       url = API_URI + path
       response = RestClient.send(verb, url, *params)
       JSON.parse response unless response.empty?
     end
 
-    # RSpotify::auth_{get,post}
     define_singleton_method "auth_#{verb}" do |path, *params|
       auth_header = { 'Authorization' => "Bearer #{@client_token}" }
       params << auth_header

data/lib/rspotify/playlist.rb

@@ -55,7 +55,7 @@ module RSpotify
     # 
     # @param tracks [Array<Track>] Tracks to be added. Maximum: 100 per request
     # @param position [Integer, NilClass] The position to insert the tracks, a zero-based index. Default: tracks are appended to the playlist
-    # @return [NilClass]
+    # @return [Array<Track>] The tracks added
     #
     # @example
     #           tracks = RSpotify::Track.search('Know', 30)
@@ -79,6 +79,7 @@ module RSpotify
       
       User.oauth_post(@owner.id, url, {})
       @tracks = nil
+      tracks
     end
 
     # When an object is obtained undirectly, Spotify usually returns a simplified version of it.

data/lib/rspotify/user.rb

@@ -56,7 +56,6 @@ module RSpotify
     end
     private_class_method :oauth_header
 
-    # User::oauth_{get,post}
     RSpotify::VERBS.each do |verb|
       define_singleton_method "oauth_#{verb}" do |user_id, path, *params|
         params << oauth_header(user_id)
@@ -114,8 +113,75 @@ module RSpotify
     #           playlists.first.class #=> RSpotify::Playlist
     #           playlists.first.name  #=> "Movie Soundtrack Masterpieces"
     def playlists
-      playlists = RSpotify.auth_get("users/#{@id}/playlists")['items']
-      playlists.map { |p| Playlist.new p }
+      json = RSpotify.auth_get("users/#{@id}/playlists")
+      json['items'].map { |p| Playlist.new p }
+    end
+
+    # Remove tracks from the user’s “Your Music” library.
+    #
+    # @param tracks [Array<Track>] The tracks to remove. Maximum: 50.
+    # @return [Array<Track>] The tracks removed.
+    #
+    # @example
+    #           tracks = user.saved_tracks
+    #
+    #           user.saved_tracks.size #=> 20
+    #           user.remove_tracks!(tracks)
+    #           user.saved_tracks.size #=> 0
+    def remove_tracks!(tracks)
+      tracks_ids = tracks.map(&:id)
+      url = "me/tracks?ids=#{tracks_ids.join ','}"
+      User.oauth_delete(@id, url)
+      tracks
+    end
+
+    # Save tracks to the user’s “Your Music” library.
+    #
+    # @param tracks [Array<Track>] The tracks to save. Maximum: 100.
+    # @return [Array<Track>] The tracks saved.
+    #
+    # @example
+    #           tracks = RSpotify::Track.search('Know')
+    #
+    #           user.saved_tracks.size #=> 0
+    #           user.save_tracks!(tracks)
+    #           user.saved_tracks.size #=> 20
+    def save_tracks!(tracks)
+      tracks_ids = tracks.map(&:id)
+      url = "me/tracks"
+      request_body = tracks_ids.inspect
+      User.oauth_put(@id, url, request_body)
+      tracks
+    end
+
+    # Returns the tracks saved in the Spotify user’s “Your Music” library
+    #
+    # @param limit  [Integer] Maximum number of tracks to return. Minimum: 1. Maximum: 50. Default: 20.
+    # @param offset [Integer] The index of the first track to return. Use with limit to get the next set of tracks. Default: 0.
+    # @return [Array<Track>]
+    #
+    # @example
+    #           tracks = user.saved_tracks
+    #           tracks.size       #=> 20
+    #           tracks.first.name #=> "Do I Wanna Know?"
+    def saved_tracks(limit: 20, offset: 0)
+      url = "me/tracks?limit=#{limit}&offset=#{offset}"
+      json = User.oauth_get(@id, url)
+      json['items'].map { |t| Track.new t['track'] }
+    end
+
+    # Check if tracks are already saved in the Spotify user’s “Your Music” library
+    #
+    # @param tracks [Array<Track>] The tracks to check. Maximum: 50.
+    # @return [Array<Boolean>] Array of booleans, in the same order in which the tracks were specified.
+    #
+    # @example
+    #           tracks = RSpotify::Track.search('Know')
+    #           user.saved_tracks?(tracks) #=> [true, false, true...]
+    def saved_tracks?(tracks)
+      tracks_ids = tracks.map(&:id)
+      url = "me/tracks/contains?ids=#{tracks_ids.join ','}"
+      User.oauth_get(@id, url)
     end
 
     # Returns a hash containing all user attributes

data/lib/rspotify/version.rb

@@ -1,3 +1,3 @@
 module RSpotify
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspotify
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Guilherme Sad
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-26 00:00:00.000000000 Z
+date: 2014-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth-oauth2