rspotify 1.10.1 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 746c93e4929aee391922cfc5443d922647189a5d
-  data.tar.gz: 5cc0425b5c7e21262f18bf6a138aa9aa395a5541
+  metadata.gz: 5bb4cfacaa5e965c3790ff69e4fa1772779535c2
+  data.tar.gz: 937b66b4e61e143ea789c566618b01236d6f4739
 SHA512:
-  metadata.gz: 6415dc6b2d4eaaa51afc3614a3251836202fb21e803c8cc570f69aa2dd1d796524a4849463c6de6a630bca78a828cd9ccf59ec173b937f5a1a7fcccfdaff75af
-  data.tar.gz: 43fa01bce310d84ca9788bc5b5b1ece98198093429b5ff794ad17df882579cf016f609aafb5b74ce70648f783843f1da9525d29f2c33b065f95fea2e620417fb
+  metadata.gz: 41e73ebfca07ffc53660f3c8e27d1172941bc092df5059206351823ad01571d9390068ca270c181dc3750c87d3fbf79ab038383731f324f12dcd9224be828551
+  data.tar.gz: 8cf584d541243c000a268c4fdc21ea87beb24fae06617298d6f69a49b22b632656939c81eb0d7542e529e7a43554b4219e2facee8e119c4fd3fb1d05fe50906e

data/README.md

@@ -181,8 +181,9 @@ class UsersController < ApplicationController
     spotify_user.saved_tracks.size #=> 20
     spotify_user.remove_tracks!(tracks)
 
-    # Follow artists and other Spotify users
-    spotify_user.follow(artists)
+    # Use Spotify Follow features
+    spotify_user.follow(playlist)
+    spotify_user.follows?(artists)
     spotify_user.unfollow(users)
 
     # Check doc for more

data/lib/rspotify/user.rb

@@ -106,38 +106,61 @@ module RSpotify
       Playlist.new User.oauth_post(@id, url, request_data)
     end
 
-    # Add the current user as a follower of one or more artists or other Spotify users. This method
-    # is only available when the current user has granted access to the *user-follow-modify* scope.
+    # Add the current user as a follower of one or more artists, other Spotify users or a playlist. Following artists or users require the *user-follow-modify*
+    # scope. Following a playlist publicly requires the *playlist-modify-public* scope; following it privately requires the *playlist-modify-private* scope.
+    # 
+    # @note Scopes you provide for playlists determine only whether the current user can themselves follow the playlist publicly or privately (i.e. show others what they are following), not whether the playlist itself is public or private.
     #
-    # @param followed [Array<User>, Array<Artist>] The users or artists to follow
-    # @return [Array<User>, Array<Artist>]
+    # @param followed [Artist, Array<Artist>, User, Array<User>, Playlist] The artists, users or playlist to follow
+    # @param public [Boolean] If true the playlist will be included in user's public playlists, if false it will remain private.
+    # @return [Artist, Array<Artist>, User, Array<User>, Playlist]
     #
     # @example
     #           artists = RSpotify::Artist.search('John')
     #           user.follow(artists)
-    def follow(followed)
-      type = followed.first.type
-      ids  = followed.map(&:id).join(',')
-      url = "me/following?type=#{type}&ids=#{ids}"
+    #
+    #           playlist = RSpotify::Playlist.search('Movie').first
+    #           user.follow(playlist, public: false)
+    def follow(followed, public: true)
+      if followed.is_a? Array
+        ids = followed.map(&:id).join(',')
+        type = followed.first.type
+      else
+        ids = followed.id
+        type = followed.type
+      end
+
+      if type == 'playlist'
+        request_body = { public: public }
+        url = "users/#{followed.owner.id}/playlists/#{followed.id}/followers"
+      else
+        request_body = {}
+        url = "me/following?type=#{type}&ids=#{ids}"
+      end
 
-      User.oauth_put(@id, url, {})
+      User.oauth_put(@id, url, request_body.to_json)
       followed
     end
 
     # Check to see if the current user is following one or more artists or other Spotify users. This method
     # is only available when the current user has granted access to the *user-follow-read* scope.
     #
-    # @param followed [Array<User>, Array<Artist>] The users or artists to check
+    # @param followed [Artist, Array<Artist>, User, Array<User>] The users or artists to check
     # @return [Array<Boolean>]
     #
     # @example
     #           artists = RSpotify::Artist.search('John')
     #           user.follows?(artists) #=> [true, false, true...]
     def follows?(followed)
-      type = followed.first.type
-      ids  = followed.map(&:id).join(',')
-      url = "me/following/contains?type=#{type}&ids=#{ids}"
+      if followed.is_a? Array
+        ids = followed.map(&:id).join(',')
+        type = followed.first.type
+      else
+        ids = followed.id
+        type = followed.type
+      end
 
+      url = "me/following/contains?type=#{type}&ids=#{ids}"
       User.oauth_get(@id, url)
     end
 
@@ -239,19 +262,34 @@ module RSpotify
       Hash[pairs]
     end
 
-    # Remove the current user as a follower of one or more artists or other Spotify users. This method
-    # is only available when the current user has granted access to the *user-follow-modify* scope.
+    # Remove the current user as a follower of one or more artists, other Spotify users or a playlist. Unfollowing artists or users require the *user-follow-modify* scope.
+    # Unfollowing a publicly followed playlist requires the *playlist-modify-public* scope; unfollowing a privately followed playlist requires the *playlist-modify-private* scope.
+    # 
+    # @note Note that the scopes you provide for playlists relate only to whether the current user is following the playlist publicly or privately (i.e. showing others what they are following), not whether the playlist itself is public or private.
     #
-    # @param followed [Array<User>, Array<Artist>] The users or artists to unfollow
-    # @return [Array<User>, Array<Artist>]
+    # @param unfollowed [Artist, Array<Artist>, User, Array<User>, Playlist] The artists, users or playlist to unfollow
+    # @return [Artist, Array<Artist>, User, Array<User>, Playlist]
     #
     # @example
     #           artists = RSpotify::Artist.search('John')
     #           user.unfollow(artists)
+    #
+    #           playlist = RSpotify::Playlist.search('Movie').first
+    #           user.unfollow(playlist)
     def unfollow(unfollowed)
-      type = unfollowed.first.type
-      ids  = unfollowed.map(&:id).join(',')
-      url = "me/following?type=#{type}&ids=#{ids}"
+      if unfollowed.is_a? Array
+        ids = unfollowed.map(&:id).join(',')
+        type = unfollowed.first.type
+      else
+        ids = unfollowed.id
+        type = unfollowed.type
+      end
+
+      url = if type == 'playlist'
+        "users/#{unfollowed.owner.id}/playlists/#{unfollowed.id}/followers"
+      else
+        "me/following?type=#{type}&ids=#{ids}"
+      end
 
       User.oauth_delete(@id, url)
       unfollowed

data/lib/rspotify/version.rb

@@ -1,3 +1,3 @@
 module RSpotify
-  VERSION = '1.10.1'
+  VERSION = '1.11.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspotify
 version: !ruby/object:Gem::Version
-  version: 1.10.1
+  version: 1.11.0
 platform: ruby
 authors:
 - Guilherme Sad
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-15 00:00:00.000000000 Z
+date: 2015-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth-oauth2