rspotify 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d7f28937ceecdffd0ec686f189c65158444bb57
-  data.tar.gz: 77e683c22e6504e964dcb72b52ff96b0fd9afe0f
+  metadata.gz: a915d527294d8772bf9f21e87660fce4241a9beb
+  data.tar.gz: 494e4a78f576a65780077bbd98e2a11aeb610c78
 SHA512:
-  metadata.gz: d07731312cd48df3a44650a99043cc47be1280830d118f63150930a53fe1f6ee7b9f0c4ab9912ceabb7f3eb25df673d863f56e45e1a729f0065f695dbd6dd364
-  data.tar.gz: e952d461b1b57602732edc183c3d8ae09f1382f0fac8e007fa6a10fdb31250e46cae6f32c09aded69d932bdcb363ca51485f5b41c1da3b49797d794c2583910b
+  metadata.gz: 7e604afc1b2830bf9bb3e07b5a9e7e042bb184d61bf2476efee94759c2e3f5fc2163b1cd4c7830343f3bb90d91e48256e92c26573c80ac62b5f34f27f466e7b8
+  data.tar.gz: e7fa3c1792e6f9dbc456758f5677ba9c6b2bdc4795631cd07c7694c2dadeba0a31675719b8a8812f2f019d532d86c300556d770a4b24fc510d2998e52276b2a1

data/README.md

@@ -61,7 +61,7 @@ Find by id:
 
 ```ruby
 arctic_monkeys = RSpotify::Artist.find('7Ln80lUS6He07XvHI8qqHH')
-arctic_monkeys.external_urls['spotify'] #=> "https://open.spotify.com/artist/<id>"
+arctic_monkeys.related_artists #=> (Artist array)
 
 am = RSpotify::Album.find('41vPD50kQ7JeamkxQW7Vuy')
 am.album_type #=> "single"
@@ -111,7 +111,7 @@ You'll may want your application to access an user's Spotify account.
 
 For instance, suppose you want your app to create playlists for the user based on his taste, or to add a feature that syncs user's playlists with some external app.
 
-If so, add the following lines to your application (Remember to [get your credentials](https://developer.spotify.com/my-applications))
+If so, add the following to your application (Remember to [get your credentials](https://developer.spotify.com/my-applications))
 
 ```ruby
 # config/application.rb
@@ -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'
+  provider :spotify, "<your_client_id>", "<your_client_secret>", scope: 'user-read-email playlist-modify-public'
 end
 ```
 
@@ -170,7 +170,7 @@ end
 
 The user's access token is automatically refreshed by RSpotify when needed. This is specially useful if you persist the user data on a database: this way he only needs to log in to Spotify once in his entire use of your application.
 
-RSpotify provides a way to easy persistance:
+RSpotify provides a way to facilitate persistence:
 
 ```ruby
 hash = spotify_user.to_hash

data/lib/rspotify/artist.rb

@@ -68,9 +68,25 @@ 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}.
+    #
+    # @return [Array<Artist>]
+    #
+    # @example
+    #           artist.name #=> "Arctic Monkeys"
+    #           related_artists = artist.related_artists
+    #
+    #           related_artists.size       #=> 20
+    #           related_artists.first.name #=> "Miles Kane"
+    def related_artists
+      return @related_artists unless @related_artists.nil?
+      json = RSpotify.get("artists/#{@id}/related-artists")
+      @related_artists = json['artists'].map { |a| Artist.new a }
+    end
+
     # Returns artist's 10 top tracks by country.
     #
-    # @param country [Symbol] an {http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 ISO 3166-1 alpha-2 country code}
+    # @param country [Symbol] An {http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 ISO 3166-1 alpha-2 country code}
     # @return [Array<Track>]
     #
     # @example

data/lib/rspotify/connection.rb

@@ -15,6 +15,16 @@ module RSpotify
   end
   private_class_method :auth_header
 
+  # Authenticates access to restricted data. Requires {https://developer.spotify.com/my-applications user credentials}.
+  #
+  # @param client_id [String]
+  # @param client_secret [String]
+  #
+  # @example
+  #           RSpotify.authenticate("<your_client_id>", "<your_client_secret>")
+  #
+  #           playlist = RSpotify::Playlist.find('wizzler', '00wHcTN0zQiun4xri9pmvX')
+  #           playlist.name #=> "Movie Soundtrack Masterpieces"
   def self.authenticate(client_id, client_secret)
     @client_id, @client_secret = client_id, client_secret
     request_body = { grant_type: 'client_credentials' }

data/lib/rspotify/version.rb

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

data/spec/lib/rspotify/album_spec.rb

@@ -74,7 +74,7 @@ describe RSpotify::Album do
 
       albums = RSpotify::Album.search('AM', offset: 10)
       expect(albums.size)        .to eq 20
-      expect(albums.map(&:name)) .to include('Melody AM', 'I Am...')
+      expect(albums.map(&:name)) .to include('Melody AM', 'I Am')
 
       albums = RSpotify::Album.search('AM', limit: 10, offset: 10)
       expect(albums.size)        .to eq 10

data/spec/lib/rspotify/artist_spec.rb

@@ -34,6 +34,14 @@ describe RSpotify::Artist do
       expect(top_tracks.first)       .to be_an RSpotify::Track
       expect(top_tracks.map(&:name)) .to include('Do I Wanna Know?', 'R U Mine?', 'Arabella', 'Knee Socks')
     end
+
+    it 'should find artist with correct related artists' do
+      related_artists = @artist.related_artists
+      expect(related_artists)             .to be_an Array
+      expect(related_artists.size)        .to eq 20
+      expect(related_artists.first)       .to be_an RSpotify::Artist
+      expect(related_artists.map(&:name)) .to include('Miles Kane', 'We Are Scientists', 'Razorlight')
+    end
   end
 
   describe 'Artist::find receiving array of ids' do
@@ -69,11 +77,11 @@ describe RSpotify::Artist do
 
       artists = RSpotify::Artist.search('Arctic', offset: 10)
       expect(artists.size)        .to eq 20
-      expect(artists.map(&:name)) .to include('Arctic Flame', 'James Arctic')
+      expect(artists.map(&:name)) .to include('Arctic Light', 'Arctic Night')
 
       artists = RSpotify::Artist.search('Arctic', limit: 10, offset: 10)
       expect(artists.size)        .to eq 10
-      expect(artists.map(&:name)) .to include('Arctic Flame')
+      expect(artists.map(&:name)) .to include('Arctic Light')
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspotify
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Guilherme Sad
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-14 00:00:00.000000000 Z
+date: 2014-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth-oauth2
@@ -172,3 +172,4 @@ test_files:
 - spec/lib/rspotify/user_spec.rb
 - spec/lib/rspotify_spec.rb
 - spec/spec_helper.rb
+has_rdoc: