rspotify 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6af35dbd2125b6c361ceae88fab934a9ab67970b
-  data.tar.gz: 01a9189c5e26c2389bd2a82fe5a85d3f7ddd6dc3
+  metadata.gz: 86ed84fdd85f9e551759817dea9a12460349a4b8
+  data.tar.gz: e455df5cc613e94a65d78af348b6e775a21b2335
 SHA512:
-  metadata.gz: 3627753fbca7a077f97cd15892ec972fca4c4bb4ab90daac149818651b387c75483f5a646dab2cf3d35e6751575e145904edccf7954fa6239cbf32ec474658e7
-  data.tar.gz: e950c1e6fa5bb1e9b3b81478ef0d5fba128e1e1069f10c6075f3beed8bfa2a170cc608598198edbbb96704a73760e2ce0beb2cb36d803183824d23fc3e84bffd
+  metadata.gz: f1c2cad5eaf9f7d00a62ce9a2ef61360779ec5264873e44634c75f291bb034cea5734b1fb5f43d59b7f870603d233d444fc598418ceffd273f2121c58e8444a0
+  data.tar.gz: 4653d34b828be1ae1575771eadbc76c76fd4416f2a08a55e84845cb909d5633ae0751ee3e6fd1bd1bf7819c85a1c80b03bee6ba5b411114390289b93778f9330

data/README.md

@@ -18,9 +18,11 @@ Or install it yourself as:
 
 ## Usage
 
-This gem is pretty new and authentication has not yet been implemented. So far you can access public data such as albums, tracks and artists:
+Directly access public data such as albums, tracks, artists and users:
 
 ```ruby
+require 'rspotify'
+
 tracks = RSpotify::Track.search('Paranoid')
 
 tracks.first.name       #=> "Paranoid"
@@ -40,13 +42,35 @@ artist.genres #=> ["Alternative Rap", "East Coast Rap", "Hardcore Rap", "Hip Hop
 
 album = RSpotify::Album.find('0uZ8zQLHru4BiNTL2PQY91')
 album.album_type #=> "single"
+album.tracks     #=> (Track array)
 
 track = RSpotify::Track.find('2qmxggATKFIeg68guRSG3r')
 track.duration_ms #=> 270800
+track.album       #=> (Album object)
 
 user = RSpotify::User.find('wizzler')
 user.external_urls["spotify"] #=> "https://open.spotify.com/user/wizzler"
 ```
+
+Some data require authentication to be accessed, such as playlists. You can easily get your credentials [here](https://developer.spotify.com/my-applications)
+
+Then just copy and paste them like so:
+
+```ruby
+RSpotify.authenticate("<your_client_id>", "<your_client_secret>")
+
+# Now you can access any public playlist and much more!
+
+playlist = RSpotify::Playlist.find('wizzler', '00wHcTN0zQiun4xri9pmvX')
+playlist.name               #=> "Movie Soundtrack Masterpieces"
+playlist.description        #=> "Iconic soundtracks featured..."
+playlist.followers['total'] #=> 13
+playlist.tracks             #=> (Track array)
+
+my_user = RSpotify::User.find("my_user")
+my_playlists = my_user.playlists #=> (Playlist array)
+```
+
 More documentation will follow
 
 ## Contributing

data/lib/rspotify.rb

@@ -1,24 +1,44 @@
 require 'rspotify/version'
 
+require 'base64'
 require 'json'
 require 'restclient'
 
 module RSpotify
 
-  BASE_URI = 'https://api.spotify.com/v1/'
-  VERBS = %w(get post put delete)
+  API_URI   = 'https://api.spotify.com/v1/'
+  TOKEN_URI = 'https://accounts.spotify.com/api/token'
+  VERBS     = %w(get post put delete)
 
-  autoload :Base,   'rspotify/base'
-  autoload :Artist, 'rspotify/artist'
-  autoload :Album,  'rspotify/album'
-  autoload :Track,  'rspotify/track'
-  autoload :User,   'rspotify/user'
+  autoload :Album,    'rspotify/album'
+  autoload :Artist,   'rspotify/artist'
+  autoload :Base,     'rspotify/base'
+  autoload :Playlist, 'rspotify/playlist'
+  autoload :Track,    'rspotify/track'
+  autoload :User,     'rspotify/user'
+
+  def self.authenticate(client_id, client_secret)
+    request_body = { grant_type: 'client_credentials' }
+    authorization = Base64.strict_encode64 "#{client_id}:#{client_secret}"
+    headers = { 'Authorization' => "Basic #{authorization}" }
+    response = RestClient.post(TOKEN_URI, request_body, headers)
+    @access_token = JSON.parse(response)['access_token']
+    true
+  end
 
   VERBS.each do |verb|
+
     define_singleton_method verb do |path, *params|
-      url = BASE_URI + path
+      url = API_URI + path
       response = RestClient.send(verb, url, *params)
       JSON.parse response
     end
+
+    define_singleton_method "auth_#{verb}" do |path, *params|
+      auth_header = { 'Authorization' => "Bearer #{@access_token}" }
+      params << auth_header
+      send(verb, path, *params)
+    end
+
   end
 end

data/lib/rspotify/album.rb

@@ -18,7 +18,8 @@ module RSpotify
       @name       = options['name']
 
       if options['tracks']
-        @tracks = options['tracks']['items'].map { |t| Track.new (t) }
+        tracks = options['tracks']['items']
+        @tracks = tracks.map { |t| Track.new t }
       end
 
       super(options)

data/lib/rspotify/playlist.rb

@@ -0,0 +1,36 @@
+module RSpotify
+
+  class Playlist < Base
+
+    attr_accessor :collaborative, :description, :followers,
+                  :images, :name, :owner, :public, :tracks
+
+    def self.find(user_id, id)
+      json = RSpotify.auth_get("users/#{user_id}/playlists/#{id}")
+      Playlist.new json
+    end
+
+    def self.search
+      #TODO
+    end
+
+    def initialize(options = {})
+      @collaborative = options['collaborative']
+      @description   = options['description']
+      @followers     = options['followers']
+      @images        = options['images']
+      @name          = options['name']
+      @owner         = options['owner']
+      @public        = options['public']
+      @tracks        = options['tracks']
+
+      super(options)
+    end
+
+    def tracks
+      json = RSpotify.auth_get("users/#{@owner['id']}/playlists/#{@id}/tracks")
+      json['items'].map{ |t| Track.new t['track'] }
+    end
+
+  end
+end

data/lib/rspotify/user.rb

@@ -14,5 +14,10 @@ module RSpotify
       super(options)
     end
 
+    def playlists
+      playlists = RSpotify.auth_get("users/#{@id}/playlists")['items']
+      playlists.map { |p| Playlist.new p }
+    end
+
   end
 end

data/lib/rspotify/version.rb

@@ -1,3 +1,3 @@
 module RSpotify
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspotify
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Guilherme Sad
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-19 00:00:00.000000000 Z
+date: 2014-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest_client
@@ -92,14 +92,17 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- doc/TODO
 - lib/rspotify.rb
 - lib/rspotify/album.rb
 - lib/rspotify/artist.rb
 - lib/rspotify/base.rb
+- lib/rspotify/playlist.rb
 - lib/rspotify/track.rb
 - lib/rspotify/user.rb
 - lib/rspotify/version.rb
 - rspotify.gemspec
+- spec/TODO
 homepage: http://rubygems.org/gems/rspotify
 licenses:
 - MIT
@@ -124,4 +127,5 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A ruby wrapper for the Spotify Web API
-test_files: []
+test_files:
+- spec/TODO