rspotify 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2f691b1533e85a23ec83b8648854b133ee9078b
-  data.tar.gz: 858e2159f410f058f56d6556d43cfc9fb52b1b01
+  metadata.gz: 143c29a98dc6fd1ddcea30f3652f0f90b76b20cf
+  data.tar.gz: 37b43846b4ef02d85492c9c28a37e9508d927124
 SHA512:
-  metadata.gz: a92a533beed2d5bdf7a0a753354d17e5ffb8e0aa598004c053c7f64e1a2f1a95ba8a1b89ef4aaa3b93de2c1e38ffd5e069038f4ea94d11c19b0d9342878e5976
-  data.tar.gz: dbbaad8372512bd4f7f4a549700b9caf126524bf5456cee04b80a18500991a93cc88aec6f90293dfb83cd88ea13ac926be69872328d4b318efd0c4eca1a37cb7
+  metadata.gz: f2e541262d61bc8b5337a29c4a37cf2f19c204ace211767d19579ae936d4107e79ea6a6c7d80d70c6e75356d984388a339a7dfcd9611fedd5b65353363cb2db2
+  data.tar.gz: 8e3fb4b604c933c1b86d3c0a20960350b766110cf81bc8a3b9b18b8959ed044b62356d29bd4e57594c5d12c90b9792a45f573982070ba80ec781141829b44416

data/.gitignore

@@ -1,3 +1,5 @@
 .bundle
+.yardoc
+doc
 pkg
 Gemfile.lock

data/README.md

@@ -23,35 +23,55 @@ Directly access Spotify public data such as albums, tracks, artists and users:
 ```ruby
 require 'rspotify'
 
-tracks = RSpotify::Track.search('Do I wanna know?')
+artists = RSpotify::Artist.search('Arctic Monkeys')
 
-tracks.first.name       #=> "Do I Wanna Know?"
-tracks.first.popularity #=> 86
+arctic_monkeys = artists.first
+arctic_monkeys.popularity      #=> 74
+arctic_monkeys.genres          #=> ["Alternative Pop/Rock", "Indie", ...]
+arctic_monkeys.top_tracks[:US] #=> (Track array)
 
-artists = tracks.first.artists
-artists.first.name #=> "Arctic Monkeys"
-artists.first.uri  #=> "spotify:artist:7Ln80lUS6He07XvHI8qqHH"
+albums = arctic_monkeys.albums
+albums.first.name #=> "AM"
 
-album = tracks.first.album
-album.name   #=> "AM"
-album.images #=> (Image array)
+am = albums.first
+am.release_date      #=> "2013-09-10"
+am.images            #=> (Image array)
+am.available_markets #=> ["AR", "BO", "BR", ...]
 
-# Find by id
-artist = RSpotify::Artist.find('5K4W6rqBFWDnAN6FQUkS6x')
-artist.genres          #=> ["Alternative Rap", "East Coast Rap", ...]
-artist.top_tracks[:US] #=> (Track array)
+tracks = am.tracks
+tracks.first.name #=> "Do I Wanna Know?"
 
-album = RSpotify::Album.find('0uZ8zQLHru4BiNTL2PQY91')
-album.album_type #=> "single"
-album.tracks     #=> (Track array)
+do_i_wanna_know = tracks.first
+do_i_wanna_know.duration_ms  #=> 272386
+do_i_wanna_know.track_number #=> 1
+do_i_wanna_know.preview_url  #=> "https://p.scdn.co/mp3-preview/<id>"
 
-track = RSpotify::Track.find('2qmxggATKFIeg68guRSG3r')
-track.duration_ms #=> 270800
-track.album       #=> (Album object)
+# You can search within other types too
+albums = RSpotify::Album.search('The Wall')
+tracks = RSpotify::Track.search('Thriller')
+```
+
+If you prefer, you can find them directly by id:
+
+```ruby
+arctic_monkeys = RSpotify::Artist.find('7Ln80lUS6He07XvHI8qqHH')
+arctic_monkeys.external_urls['spotify'] #=> "https://open.spotify.com/artist/<id>"
+
+am = RSpotify::Album.find('41vPD50kQ7JeamkxQW7Vuy')
+am.album_type #=> "single"
+
+do_i_wanna_know = RSpotify::Track.find('2UzMpPKPhbcC8RbsmuURAZ')
+do_i_wanna_know.album #=> (Album object)
+
+wizzler = RSpotify::User.find('wizzler')
+wizzler.uri #=> "spotify:user:wizzler"
 
-user = RSpotify::User.find('wizzler')
-user.href                     #=> "https://api.spotify.com/v1/users/wizzler"
-user.external_urls["spotify"] #=> "https://open.spotify.com/user/wizzler"
+# Or find several objects at once:
+
+ids = %w(2UzMpPKPhbcC8RbsmuURAZ 7Jzsc04YpkRwB1zeyM39wE)
+
+my_tracks = RSpotify::Track.find(ids)
+my_tracks.size #=> 2
 ```
 
 Some data require authentication to be accessed, such as playlists. You can easily get your credentials [here](https://developer.spotify.com/my-applications).
@@ -73,7 +93,17 @@ my_user = RSpotify::User.find("my_user")
 my_playlists = my_user.playlists #=> (Playlist array)
 ```
 
-More documentation will follow
+RSpotify focuses on objects behaviour so you can forget the API and worry about your tracks, artists and so on.
+
+It is possible to write things like `playlist.tracks.sort_by(&:popularity).last.album` without having to think what API calls must be done. RSpotify fills the gaps for you.
+
+Full documentation can be found [here](http://rdoc.info/github/guilhermesad/rspotify/master/frames). (Will be complete in the next few days)
+
+## Notes
+
+This gem uses [client credentials](https://developer.spotify.com/web-api/authorization-guide/#client_credentials_flow) to authenticate your access. This means you can get all public data you want, but it's not possible to access private playlists or to create new ones. For that you would want to use [authorization code flow](https://developer.spotify.com/web-api/authorization-guide/#authorization_code_flow).
+
+RSpotify focuses on simplicity of use and straight access to data, so the authorization code flow is not supported at the moment. If you really feel the need to use it, please leave a issue for it to be implemented.
 
 ## Contributing
 

data/lib/rspotify/album.rb

@@ -2,8 +2,8 @@ module RSpotify
 
   class Album < Base
 
-    def self.find(id)
-      super(id, 'album')
+    def self.find(ids)
+      super(ids, 'album')
     end
 
     def self.search(query, limit = 20, offset = 0)

data/lib/rspotify/artist.rb

@@ -2,8 +2,8 @@ module RSpotify
 
   class Artist < Base
 
-    def self.find(id)
-      super(id, 'artist')
+    def self.find(ids)
+      super(ids, 'artist')
     end
 
     def self.search(query, limit = 20, offset = 0)
@@ -20,10 +20,16 @@ module RSpotify
       super(options)
     end
 
+    def albums
+      return @albums unless @albums.nil?
+      json = RSpotify.get("artists/#{@id}/albums")
+      @albums = json['items'].map { |a| Album.new a }
+    end
+
     def top_tracks(country)
       return @top_tracks[country] unless @top_tracks[country].nil?
       json = RSpotify.get("artists/#{@id}/top-tracks?country=#{country}")
-      @top_tracks[country] = json['tracks'].map{ |t| Track.new t }
+      @top_tracks[country] = json['tracks'].map { |t| Track.new t }
     end
   end
 end

data/lib/rspotify/base.rb

@@ -2,12 +2,22 @@ module RSpotify
 
   class Base
 
-    def self.find(id, type)
+    def self.find(ids, type)
       pluralized_type = "#{type}s"
+      path = pluralized_type.dup
       type_class = eval type.capitalize
 
-      json = RSpotify.get "#{pluralized_type}/#{id}"
-      type_class.new json
+      case ids.class.to_s
+      when 'Array'
+        path << "?ids=#{ids.join ','}"
+        json = RSpotify.get path
+        json[pluralized_type].map { |t| type_class.new t }
+      when 'String'
+        id = ids
+        path << "/#{id}"
+        json = RSpotify.get path
+        type_class.new json
+      end
     end
 
     def self.search(query, type, limit = 20, offset = 0)

data/lib/rspotify/track.rb

@@ -2,8 +2,8 @@ module RSpotify
 
   class Track < Base
 
-    def self.find(id)
-      super(id, 'track')
+    def self.find(ids)
+      super(ids, 'track')
     end
 
     def self.search(query, limit = 20, offset = 0)

data/lib/rspotify/user.rb

@@ -3,6 +3,10 @@ module RSpotify
   class User < Base
 
     def self.find(id)
+      if id.is_a? Array
+        warn 'Spotify API does not support finding several users simultaneously'
+        return false
+      end
       super(id, 'user')
     end
 

data/lib/rspotify/version.rb

@@ -1,3 +1,3 @@
 module RSpotify
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

data/rspotify.gemspec

@@ -18,8 +18,9 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'rest_client', '~> 1.7'
 
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'fakeweb', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'yard'
 end

data/spec/lib/rspotify/album_spec.rb

@@ -1,7 +1,7 @@
 describe RSpotify::Album do
 
-  describe 'Album#find' do
-    
+  describe 'Album::find receiving id as a string' do
+
     before(:each) do
       # Get Arctic Monkeys's AM album as a testing sample
       @album = RSpotify::Album.find('5bU1XKYxHhEwukllT20xtk')
@@ -41,7 +41,24 @@ describe RSpotify::Album do
     end
   end
 
-  describe 'Album#search' do
+  describe 'Album::find receiving array of ids' do
+    it 'should find the right albums' do
+      ids = ['2agWNCZl5Ts9W05mij8EPh']
+      albums = RSpotify::Album.find(ids)
+      expect(albums)            .to be_an Array
+      expect(albums.size)       .to eq 1
+      expect(albums.first.name) .to eq 'The Next Day Extra'
+
+      ids << '3JquYMWj5wrzuZCNAvOYN9'
+      albums = RSpotify::Album.find(ids)
+      expect(albums)            .to be_an Array
+      expect(albums.size)       .to eq 2
+      expect(albums.first.name) .to eq 'The Next Day Extra'
+      expect(albums.last.name)  .to eq 'A Beard Of Stars (Deluxe Edition)'
+    end
+  end
+
+  describe 'Album::search' do
     it 'should search for the right albums' do
       albums = RSpotify::Album.search('AM')
       expect(albums)             .to be_an Array

data/spec/lib/rspotify/artist_spec.rb

@@ -1,6 +1,7 @@
 describe RSpotify::Artist do
 
-  describe 'Artist#find' do
+  describe 'Artist::find receiving id as a string' do
+
     before(:each) do
       # Get Arctic Monkeys as a testing sample
       @artist = RSpotify::Artist.find('7Ln80lUS6He07XvHI8qqHH')
@@ -18,6 +19,14 @@ describe RSpotify::Artist do
       expect(@artist.uri)                      .to eq      'spotify:artist:7Ln80lUS6He07XvHI8qqHH'
     end
 
+    it 'should find artist with correct albums' do
+      albums = @artist.albums
+      expect(albums)             .to be_an Array
+      expect(albums.size)        .to eq 20
+      expect(albums.first)       .to be_an RSpotify::Album
+      expect(albums.map(&:name)) .to include('AM', 'Suck It and See', 'Suck It and See Sampler' , 'Humbug')
+    end
+
     it 'should find artist with correct top tracks' do
       top_tracks = @artist.top_tracks(:US)
       expect(top_tracks)             .to be_an Array
@@ -27,7 +36,24 @@ describe RSpotify::Artist do
     end
   end
 
-  describe 'Artist#search' do
+  describe 'Artist::find receiving array of ids' do
+    it 'should find the right artists' do
+      ids = ['0oSGxfWSnnOXhD2fKuz2Gy']
+      artists = RSpotify::Artist.find(ids)
+      expect(artists)            .to be_an Array
+      expect(artists.size)       .to eq 1
+      expect(artists.first.name) .to eq 'David Bowie'
+
+      ids << '3dBVyJ7JuOMt4GE9607Qin'
+      artists = RSpotify::Artist.find(ids)
+      expect(artists)            .to be_an Array
+      expect(artists.size)       .to eq 2
+      expect(artists.first.name) .to eq 'David Bowie'
+      expect(artists.last.name)  .to eq 'T. Rex'
+    end
+  end
+
+  describe 'Artist::search' do
     it 'should search for the right artists' do
       artists = RSpotify::Artist.search('Arctic')
       expect(artists)             .to be_an Array

data/spec/lib/rspotify/playlist_spec.rb

@@ -1,6 +1,6 @@
 describe RSpotify::Playlist do
 
-  describe 'Playlist#find' do
+  describe 'Playlist::find' do
     
     before(:each) do
       # Keys generated specifically for the tests. Should be removed in the future

data/spec/lib/rspotify/track_spec.rb

@@ -1,6 +1,6 @@
 describe RSpotify::Track do
 
-  describe 'Track#find' do
+  describe 'Track::find receiving id as a string' do
     
     before(:each) do
       # Get Arctic Monkeys's "Do I Wanna Know?" track as a testing sample
@@ -40,7 +40,24 @@ describe RSpotify::Track do
     end
   end
 
-  describe 'Track#search' do
+  describe 'Track::find receiving array of ids' do
+    it 'should find the right tracks' do
+      ids = ['4oI9kesyxHUr8fqiLd6uO9']
+      tracks = RSpotify::Track.find(ids)
+      expect(tracks)            .to be_an Array
+      expect(tracks.size)       .to eq 1
+      expect(tracks.first.name) .to eq 'The Next Day'
+
+      ids << '7D8BAYkrR9peCB9XSKCADc'
+      tracks = RSpotify::Track.find(ids)
+      expect(tracks)            .to be_an Array
+      expect(tracks.size)       .to eq 2
+      expect(tracks.first.name) .to eq 'The Next Day'
+      expect(tracks.last.name)  .to eq 'Sunday'
+    end
+  end
+
+  describe 'Track::search' do
     it 'should search for the right tracks' do
       tracks = RSpotify::Track.search('Wanna Know')
       expect(tracks)             .to be_an Array

data/spec/lib/rspotify/user_spec.rb

@@ -1,6 +1,6 @@
 describe RSpotify::User do
 
-  describe 'User#find' do
+  describe 'User::find' do
 
     before(:each) do
       # Get wizzler user as a testing sample

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspotify
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Guilherme Sad
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-22 00:00:00.000000000 Z
+date: 2014-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest_client
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,19 +81,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: fakeweb
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 description: 
 email:
 - gorgulhoguilherme@gmail.com
@@ -94,7 +108,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- doc/TODO
 - lib/rspotify.rb
 - lib/rspotify/album.rb
 - lib/rspotify/artist.rb
@@ -143,3 +156,4 @@ test_files:
 - spec/lib/rspotify/user_spec.rb
 - spec/lib/rspotify_spec.rb
 - spec/spec_helper.rb
+has_rdoc: