jberkel-spotify-api 0.0.3 → 0.0.4

data/README.md

@@ -14,7 +14,7 @@ At the moment the following features are implemented:
 * list user's playlists 	[GET /playlists]
 * get shared playlist			[GET /playlist/id]
 * create new playlist   	[POST /playlists]
-* add tracks to playlist  [PUT	/playlists/id]
+* update playlists        [PUT	/playlists/id]
 	
 ## Installation
 

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 3
+:patch: 4
 :major: 0
 :minor: 0

data/bin/spotify-api-server

@@ -1,5 +1,5 @@
-#!/usr/bin/env jruby
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+#!/usr/bin/env jruby #--jdb -J-sourcepath -J/Users/jan/projects/jotify/src
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/../lib'))
 
 require 'rubygems'
 require 'jotify'
@@ -23,5 +23,18 @@ while arg = ARGV.shift do
     end
 end
 
+# Taken mostly from
+# http://groups.google.com/group/sinatrarb/t/a5cfc2b77a013a86
+class Sinatra::Reloader < Rack::Reloader
+  def safe_load(file, mtime, stderr = $stderr)
+#    ::Sinatra::Application.reset!
+#    stderr.puts "#{self.class}: reseting routes"
+    super
+  end
+end
+
 #Sinatra::Application.set :environment, :production
+Sinatra::Application.configure(:development) do |app|
+  app.use Sinatra::Reloader
+end
 Sinatra::Application.run! :port=> (port || DEFAULT_PORT).to_i

data/examples/create_playlist.rb

@@ -7,7 +7,7 @@ require 'pp'
 
 puts "creating a new playlist"
 resp = RestClient.post('http://localhost:3000/playlists', {
-  "name"=>'my shiny playlist',
+  "name"=>'my shiny playlist', "collaborative"=>false,
   "tracks" => [ {'id'=>'6qHiOf1BFCQIzAjJsRbMfY'}, {'id'=>'1VaucR6Bsks5Q9bYBsXvuF'} ] 
 }.to_json)
 

data/examples/modify_playlist.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'rest_client'
+require 'json'
+require 'pp'
+
+#spotify:user:jberkel:playlist:51QyZ8kHWdx1wuetLfs571
+#spotify:user:jberkel:playlist:52vlrAr9RdphpgVtP2SAGP (empty)
+#spotify:user:jberkel:playlist:5aZg2QhSogW4Ukw7Q6kjRO
+#spotify:user:jberkel:playlist:1G1BCuefz7bvZdQ5QbGLPR
+#spotify:user:jberkel:playlist:28C9HrzCMmlSReG4mSQeuQ
+#spotify:user:jberkel:playlist:4h9wgIOBjlqMoMD0C7LdDs
+p_id  = '4h9wgIOBjlqMoMD0C7LdDs'
+p_url = "http://localhost:3000/playlists/#{p_id}"
+puts "getting playlist #{p_id}"
+resp = RestClient.get p_url
+playlist = JSON.parse(resp)
+pp playlist
+
+
+existing_songs = playlist['result']['tracks'].map { |t| t['id'] }
+
+
+add_songs = ['1VaucR6Bsks5Q9bYBsXvuF', 'spotify:track:3RIgfgKZm7khbOokcYeFn0']
+#add_songs = ['spotify:track:2jpVApJaYkYGYRL7WQHnvu']
+#add_songs = [ 'spotify:track:4hXA0NkPLFf6mXMxzsQicd' ]
+RestClient.put p_url, {
+  'name' => 'a new name',
+  'collaborative' => false,
+  'tracks' => (existing_songs + add_songs).map { |s| { 'id'=>s } }
+}.to_json

data/lib/jotify.rb

@@ -61,6 +61,8 @@ class Jotify
   end
    
   def create_playlist(name, collaborative=false)
+    raise ArgumentError, "need name" unless name
+    
     playlist = @jotify.playlistCreate(name, collaborative)
     return nil unless playlist
     add_playlist(playlist)
@@ -71,10 +73,27 @@ class Jotify
     @jotify.playlistsAddPlaylist(@jotify.playlists, id.is_a?(Media::Playlist) ? id : playlist(id))
   end
      
-  def add_tracks_to_playlist(playlist, track_ids)
+  def rename_playlist(playlist, name)
+    @jotify.playlistRename(playlist, name)
+  end
+  
+  def set_collaborative_flag(playlist, flag)
+    @jotify.playlistSetCollaborative(playlist, flag)
+  end
+   
+  def set_tracks_on_playlist(playlist, track_ids)
+    #puts "playlist: checksum #{playlist.getChecksum()}"
     tracks = Java::JavaUtil::ArrayList.new
     track_ids.each { |id| tracks.add(Media::Track.new(Jotify.resolve_id(id))) }
-    @jotify.playlistAddTracks(playlist, tracks, 0)    
+  
+    # delete old tracks
+    if playlist.tracks.size > 0
+      raise "could not remove tracks" unless @jotify.playlistRemoveTracks(playlist, 0, playlist.tracks.size)
+    end
+   
+   return true if track_ids.empty?
+   
+   @jotify.playlistAddTracks(playlist, tracks, playlist.tracks.size)    
   end
   
   def self.resolve_id(id)

data/lib/jotify/api.rb

@@ -61,10 +61,12 @@ end
 
 Sinatra::Application.get('/playlists') do
   content_type :json
-  #playlists = jotify.playlists
   {
     'status'=>'OK',
-    'result'=> { 'playlists' => jotify.playlists.map { |p| p.to_h } }
+    'result'=> { 'playlists' => jotify.playlists.map do |p| 
+        p.to_h
+      end.each { |h| h.delete(:tracks) }
+    }
   }.to_json
 end
 
@@ -84,11 +86,11 @@ Sinatra::Application.post('/playlists') do
   content_type :json
   body = request.body.read
   data = JSON.parse(body)
-  playlist = jotify.create_playlist(data['name'], data['collaborative'])
+  playlist = jotify.create_playlist(data['name'], !!data['collaborative'])
   if playlist
     if data['tracks']
       ids  = data['tracks'].map { |t| t['id'] }
-      unless jotify.add_tracks_to_playlist(playlist, ids)         
+      unless jotify.set_tracks_on_playlist(playlist, ids)         
         return 500, 'status' => 'ERROR', 'message' => 'playlist created but tracks could not be added'
       end
     end
@@ -101,18 +103,32 @@ end
 Sinatra::Application.put('/playlists/:id') do
   content_type :json
   playlist = jotify.playlist(params[:id])
+  
   return 404, { 'status' => 'ERROR', 'message' => 'playlist not found' }.to_json unless playlist
   body = request.body.read
   data = JSON.parse(body)
-  raise ArgumentError, "invalid format" unless data.is_a?(Hash) && data['tracks'].is_a?(Array)
-  ids  = data['tracks'].map { |t| t['id'] }
-  return 200, { 'status' => 'OK', 'message' => 'not modified' }.to_json if ids.empty?
   
-  if jotify.add_tracks_to_playlist(playlist, ids)
-    return 200, { 'status' => 'OK', 'message' => "successfully added #{ids.size} tracks" }.to_json
-  else
-    return 500, { 'status' => 'ERROR', 'message' => 'could not add to playlist' }.to_json
-  end  
+  raise ArgumentError, "invalid format" unless data.is_a?(Hash)
+  
+  if data.has_key?('name') && data['name'] != playlist.name
+    unless jotify.rename_playlist(playlist, data['name'])
+      return 500, { 'status' => 'ERROR', 'message' => 'could rename playlist' }.to_json
+    end
+  end
+  
+  if data.has_key?('collaborative') && data['collaborative'] != playlist.collaborative?
+    unless jotify.set_collaborative_flag(playlist, data['collaborative'])
+      return 500, { 'status' => 'ERROR', 'message' => 'could not change collaborative flag' }.to_json
+    end
+  end
+  
+  if data['tracks'].is_a?(Array)
+    ids  = data['tracks'].map { |t| t['id'] }
+    unless jotify.set_tracks_on_playlist(playlist, ids)
+      return 500, { 'status' => 'ERROR', 'message' => 'could update tracks' }.to_json
+    end  
+  end
+  return 200, { 'status' => 'OK', 'message' => "update successful" }.to_json
 end
 
 

data/lib/jotify/media.rb

@@ -27,6 +27,10 @@ module Java
         tracks.size
       end
 
+      def collaborative?
+        isCollaborative()
+      end
+      
       def inspect
         "[Playlist: #{self.getId()} #{getTracks.to_a}]"
       end

data/spec/jotify/api_spec.rb

@@ -99,7 +99,7 @@ describe 'Api' do
               "id"=>"4d921ebcdd8c80f32ce1ed5acafbb9c8",
               "url"=>"http://open.spotify.com/user/test/playlist/2mnbxTkghYtlHMdX3jdP9C",                     
               "name"=>"my shiny playlist",
-              "tracks"=>[], "author"=>"test", "revision"=>-1, "collaborative"=>false
+              "author"=>"test", "revision"=>-1, "collaborative"=>false
             ] 
           }
         }
@@ -134,7 +134,7 @@ describe 'Api' do
     end
     
     
-    describe "create/update" do
+    describe "create" do    
       it "should create a playlist when posting to /playlists" do
         @jotify.should_receive(:create_playlist).with('my shiny playlist', true).and_return(@playlist)
         post '/playlists', { 'name' => 'my shiny playlist', 'collaborative' => true }.to_json
@@ -144,7 +144,7 @@ describe 'Api' do
 
       it "should create a playlist and adding tracks when posting to /playlists" do
         @jotify.should_receive(:create_playlist).with('my shiny playlist', true).and_return(@playlist)
-        @jotify.should_receive(:add_tracks_to_playlist).with(@playlist, ['1','2']).and_return(true)
+        @jotify.should_receive(:set_tracks_on_playlist).with(@playlist, ['1','2']).and_return(true)
    
         post '/playlists', { 'name' => 'my shiny playlist', 
           'collaborative' => true,
@@ -153,7 +153,7 @@ describe 'Api' do
         last_response.status.should == 201
         last_response.headers['Location'].should == 'http://open.spotify.com/user/test/playlist/2mnbxTkghYtlHMdX3jdP9C'
       end
-
+      
 
       it "should return 500 if playlist could not be created" do
         @jotify.should_receive(:create_playlist).with('my shiny playlist', true).and_return(nil)
@@ -162,15 +162,36 @@ describe 'Api' do
         json_response.should == {"status"=>"ERROR", "message"=>"playlist could not be created"}
       end
 
+    end
     
+    describe "update" do
       it "should update playlist when putting to /playlists/id" do
         @jotify.should_receive(:playlist).with("foo").and_return(@playlist)
-        @jotify.should_receive(:add_tracks_to_playlist).with(@playlist, ['1','2']).and_return(true)
+        @jotify.should_receive(:set_tracks_on_playlist).with(@playlist, ['1','2']).and_return(true)
         put '/playlists/foo', { 'tracks' => [ {'id'=>'1' }, { 'id'=>'2' } ] }.to_json
         last_response.should be_ok
-        json_response.should == {'status'=>'OK', 'message'=>'successfully added 2 tracks'}
+        json_response.should == {'status'=>'OK', 'message'=>'update successful'}
+      end
+      
+      it "should change the name of the playlist" do
+        @jotify.should_receive(:playlist).with("foo").and_return(@playlist)
+        @jotify.should_receive(:rename_playlist).with(@playlist, 'new').and_return(true)
+                
+        put '/playlists/foo', { 'name' => 'new' }.to_json
+        last_response.should be_ok
+        json_response.should == {'status'=>'OK', 'message'=>'update successful'}                
       end
       
+      it "should change the collaborative flag of the playlist" do
+        @jotify.should_receive(:playlist).with("foo").and_return(@playlist)
+        @jotify.should_receive(:set_collaborative_flag).with(@playlist, true).and_return(true)
+                
+        put '/playlists/foo', { 'collaborative' => true }.to_json
+        last_response.should be_ok
+        json_response.should == {'status'=>'OK', 'message'=>'update successful'}                
+      end
+      
+      
       it "should return 404 if playlist to update cannot be found" do
         @jotify.should_receive(:playlist).with("foo").and_return(nil)
         put '/playlists/foo', { 'tracks' => [ {'id'=>'1' }, { 'id'=>'2' } ] }.to_json
@@ -180,20 +201,20 @@ describe 'Api' do
       
       it "should return 500 if playlist could not be updated" do
         @jotify.should_receive(:playlist).with("foo").and_return(@playlist)
-        @jotify.should_receive(:add_tracks_to_playlist).with(@playlist, ['1','2']).and_return(false)
+        @jotify.should_receive(:set_tracks_on_playlist).with(@playlist, ['1','2']).and_return(false)
         put '/playlists/foo', { 'tracks' => [ {'id'=>'1' }, { 'id'=>'2' } ] }.to_json
         last_response.status.should == 500
-        json_response.should == {"status"=>"ERROR", "message"=>"could not add to playlist"}         
+        json_response.should == {"status"=>"ERROR", "message"=>"could update tracks"}         
       end
             
-      it "should return 403 if invalid data is supplied" do
-        @jotify.should_receive(:playlist).with("foo").and_return(@playlist)
-        lambda { put '/playlists/foo', { 'foo' => 'bar' }.to_json }.should raise_error(ArgumentError)
-      end
+      # it "should return 403 if invalid data is supplied" do
+      #      @jotify.should_receive(:playlist).with("foo").and_return(@playlist)
+      #      lambda { put '/playlists/foo', { 'foo' => 'bar' }.to_json }.should raise_error(ArgumentError)
+      # end
       
-      it "shouldn't do anything if no track ids supplied" do
+      it "shouldn't do anything if no data supplied" do
         @jotify.should_receive(:playlist).with("foo").and_return(@playlist)
-        put '/playlists/foo', { 'tracks' => [] }.to_json
+        put '/playlists/foo', {}.to_json
         last_response.should be_ok
       end
     end

data/spec/jotify_spec.rb

@@ -18,7 +18,7 @@ describe Jotify do
     }.each { |id, expected| Jotify.resolve_id(id).should == expected }
   end
   
-  it "should add tracks to playlist" do    
+  it "should set tracks on playlist" do    
     @playlist = Jotify::Media::Playlist.new
     @jotify_impl.should_receive(:playlistAddTracks) do |playlist, tracks, pos|
       playlist.should be_a(Jotify::Media::Playlist)
@@ -27,6 +27,33 @@ describe Jotify do
       tracks.should be_an(Java::JavaUtil::List)
       tracks.size.should == 1
     end
-    @jotify.add_tracks_to_playlist(@playlist, ['4d921ebcdd8c80f32ce1ed5acafbb9c8'])
+    @jotify.set_tracks_on_playlist(@playlist, ['4d921ebcdd8c80f32ce1ed5acafbb9c8'])
   end    
+  
+  it "should remove tracks before setting tracks on playlist" do    
+     @playlist = Jotify::Media::Playlist.new
+     @playlist << empty_track
+     @jotify_impl.should_receive(:playlistRemoveTracks).and_return(true)
+     @jotify_impl.should_receive(:playlistAddTracks) do |playlist, tracks, pos|
+       playlist.should be_a(Jotify::Media::Playlist)
+       #playlist.should == @playlist
+       pos.should == 1
+       tracks.should be_an(Java::JavaUtil::List)
+       tracks.size.should == 1
+     end
+     @jotify.set_tracks_on_playlist(@playlist, ['4d921ebcdd8c80f32ce1ed5acafbb9c8'])
+   end
+   
+  it "should rename the playlist" do
+   @playlist = Jotify::Media::Playlist.new
+   @jotify_impl.should_receive(:playlistRename).with(anything(), 'new').and_return(true)
+   @jotify.rename_playlist(@playlist, 'new').should == true
+  end
+   
+   
+  it "should rename the playlist" do
+    @playlist = Jotify::Media::Playlist.new
+    @jotify_impl.should_receive(:playlistSetCollaborative).with(anything(), true).and_return(true)
+    @jotify.set_collaborative_flag(@playlist, true).should == true
+  end
 end

data/spotify-api.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{spotify-api}
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jan Berkel"]
-  s.date = %q{2009-08-07}
+  s.date = %q{2009-08-08}
   s.default_executable = %q{spotify-api-server}
   s.description = %q{an api for spotify, based on jotify}
   s.email = %q{jan.berkel@gmail.com}
@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
      "bin/spotify-api-server",
      "examples/create_playlist.rb",
      "examples/list_playlists.rb",
+     "examples/modify_playlist.rb",
      "examples/search.rb",
      "lib/jars/jotify.jar",
      "lib/jotify.rb",
@@ -50,6 +51,7 @@ Gem::Specification.new do |s|
      "spec/spec_helper.rb",
      "examples/create_playlist.rb",
      "examples/list_playlists.rb",
+     "examples/modify_playlist.rb",
      "examples/search.rb"
   ]
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jberkel-spotify-api
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Jan Berkel
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-07 00:00:00 -07:00
+date: 2009-08-08 00:00:00 -07:00
 default_executable: spotify-api-server
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -71,6 +71,7 @@ files:
 - bin/spotify-api-server
 - examples/create_playlist.rb
 - examples/list_playlists.rb
+- examples/modify_playlist.rb
 - examples/search.rb
 - lib/jars/jotify.jar
 - lib/jotify.rb
@@ -117,4 +118,5 @@ test_files:
 - spec/spec_helper.rb
 - examples/create_playlist.rb
 - examples/list_playlists.rb
+- examples/modify_playlist.rb
 - examples/search.rb