spotify-api 0.0.5

data/lib/jotify/api.rb

@@ -0,0 +1,137 @@
+#!/usr/bin/env jruby
+require 'rubygems'
+require 'json'
+require 'sinatra/base'
+require File.expand_path(File.dirname(__FILE__) + '/../jotify') unless defined?(Jotify)
+  
+class Sinatra::Application
+  Lock = Mutex.new
+  
+  def jotify
+    Lock.synchronize do
+      @@jotify ||= Jotify.new
+    end
+  end
+  
+  def query(what, p=what) 
+    params[p] ? "#{what}:" + params[p] : '' 
+  end
+end
+
+Sinatra::Application.error ArgumentError do
+  content_type :json
+  {
+    'status' => 'ERROR',
+    'message' => request.env['sinatra.error'].message
+  }.to_json
+end
+  
+Sinatra::Application.get('/tracks') do
+  content_type :json
+  raise ArgumentError, "need name" unless params[:name]
+  
+  res = jotify.search([query(:track, :name), query(:artist), query(:album)].join(' '))
+  {
+    'status'=>'OK', 
+    'result'=> res.tracks.map { |t| t.to_h }
+  }.to_json
+end
+
+Sinatra::Application.get('/albums') do
+  content_type :json
+  raise ArgumentError, "need name" unless params[:name]
+    
+  res = jotify.search([query(:album, :name), query(:artist)].join(' ') )
+  {
+    'status'=>'OK', 
+    'result'=> res.albums.map { |a| a.to_h }
+  }.to_json
+end
+
+Sinatra::Application.get('/artists') do
+  content_type :json
+  raise ArgumentError, "need name" unless params[:name]
+  
+  res = jotify.search(query(:artist, :name))
+  {
+    'status'=>'OK', 
+    'result'=> res.artists.map { |a| a.to_h }
+  }.to_json
+end
+
+Sinatra::Application.get('/playlists') do
+  content_type :json
+  {
+    'status'=>'OK',
+    'result'=> { 'playlists' => jotify.playlists.map do |p| 
+        p.to_h
+      end.each { |h| h.delete(:tracks) }
+    }
+  }.to_json
+end
+
+Sinatra::Application.get('/playlists/:id') do
+  content_type :json  
+  if playlist = jotify.playlist(params[:id])
+    {
+      'status'=>'OK',
+      'result'=>playlist.to_h
+    }.to_json
+  else
+    return 404, { 'status' => 'ERROR', 'message' => 'playlist not found' }.to_json
+  end
+end
+
+Sinatra::Application.post('/playlists') do
+  content_type :json
+  body = request.body.read
+  data = JSON.parse(body)
+  playlist = jotify.create_playlist(data['name'], !!data['collaborative'])
+  if playlist
+    if data['tracks']
+      ids  = data['tracks'].map { |t| t['id'] }
+      unless jotify.set_tracks_on_playlist(playlist, ids)         
+        return 500, 'status' => 'ERROR', 'message' => 'playlist created but tracks could not be added'
+      end
+    end
+    redirect playlist.link, 201 # created
+  else
+    return 500, { 'status' => 'ERROR', 'message' => 'playlist could not be created' }.to_json
+  end
+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)
+  
+  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
+
+
+if __FILE__ == $0
+  Sinatra::Application.run! 
+end

data/lib/jotify/media.rb

@@ -0,0 +1,117 @@
+require 'java'
+require File.expand_path(File.dirname(__FILE__) + '/../jars/jotify.jar')
+
+#Make Jotify's native Java classes a bit more rubyish by implementing some mehods / modules
+module Java
+  module DeFelixbrunsJotifyMedia
+    class Media
+      def inspect
+        self.to_s
+      end  
+  
+      def to_h
+        h = { :id=>self.getId(), :popularity=> popularity.nan? ? 0.0 : popularity.to_f }
+        h[:url] = self.link if self.respond_to?(:link)
+        h
+      end
+    end
+  
+    class Playlist
+      include Enumerable  
+      
+      def each(&block) 
+        tracks.each(&block)
+      end
+      
+      def size
+        tracks.size
+      end
+
+      def collaborative?
+        isCollaborative()
+      end
+      
+      def inspect
+        "[Playlist: #{self.getId()} #{getTracks.to_a}]"
+      end
+
+      def to_h
+        {
+          :id => getId(),
+          :name=> name,
+          :url => link,
+          :tracks => tracks.map { |t| t.to_h },
+          :author => author,
+          :revision => revision,
+          :collaborative => collaborative
+        }
+      end
+      
+      def <<(track)
+        tracks.add(track) if track.is_a?(Track)
+      end
+    end
+  
+    class PlaylistContainer
+      include Enumerable
+      
+      def each(&block) 
+        playlists.each(&block) 
+      end
+      
+      def size() playlists.size end
+        
+      def <<(pl)
+        playlists.add(pl) if pl.is_a?(Playlist)
+      end
+    end
+
+    class Result
+      include Enumerable
+      
+      def each(&block)
+        artists.each(&block)
+        tracks.each(&block)
+        albums.each(&block)
+      end
+      
+      def inspect
+        { :artists=>self.artists.to_a, :albums=>self.albums.to_a, :tracks=>self.tracks.to_a }.inspect
+      end  
+
+      def to_h
+        { 
+          :artists => self.artists.map { |a| a.to_h },
+          :albums => self.albums.map { |a| a.to_h },
+          :tracks => self.tracks.map { |t| t.to_h }
+        }
+      end
+    end
+  
+    class Track
+      def to_h
+        super.merge(:title=>title, :artist=>artist ? artist.name : nil, :album=>album ? album.name : nil)
+      end
+    end
+  
+    class Artist
+      def to_h
+        super.merge(:name=>name)
+      end
+    end
+
+    class Album
+      include Enumerable
+      
+      def each(&block) 
+        tracks.each(&block) 
+      end
+        
+      def to_h
+        super.merge(:name=>name, :artist=>artist ? artist.name : nil, :year=>year, :type=>type)
+      end
+    end
+  end
+end
+
+

data/spec/integration_spec.rb

@@ -0,0 +1,54 @@
+#!/usr/bin/env jruby -S spec
+require File.join(File.dirname(__FILE__), 'spec_helper')
+require 'jotify'
+
+# WARNING: these specs need a valid spotify (premium) account, otherwise they will fail
+describe "Integration" do
+  
+  before(:all) do
+    @jotify = Jotify.new
+  end
+  
+  after(:all) do
+    @jotify.close rescue nil
+  end
+    
+  describe "searching" do
+    it "should return a result for a search" do
+      result = @jotify.search("artist:Air")
+      result.should be_a(Jotify::Media::Result)
+      
+      result.artists.should_not be_empty      
+      most_popular = result.artists.to_a.sort(&Jotify::ByPopularity).first
+      most_popular.name.should == 'Air'
+
+      result = @jotify.search("album:Moon Safari")
+      result.albums.should_not be_empty
+      most_popular = result.albums.to_a.sort(&Jotify::ByPopularity).first
+      most_popular.name.should == 'Moon Safari' 
+      most_popular.artist.name.should == 'Air'
+    end
+  end
+  
+
+  describe "playlists" do
+    
+    before do
+      @playlists = @jotify.playlists
+      @playlists.should_not be_empty
+    end
+    
+    it "should return name and id, not tracks (GH-3)" do
+      @playlists.each do |pl|
+        puts pl.inspect
+        pl.name.should_not be_nil
+       
+        pl.tracks.each do |t|
+          t.getId().should_not be_nil
+          t.getName().should be_nil
+        end
+      end      
+    end
+  end
+  
+end

data/spec/jotify/api_spec.rb

@@ -0,0 +1,222 @@
+#!/usr/bin/env jruby -S spec
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+require 'jotify/api'
+require 'rack/test'
+require 'sinatra'
+
+set :environment, :test
+
+describe 'Api' do
+  
+  def app() Sinatra::Application end
+  
+  def json_response
+    last_response.content_type.should == 'application/json'      
+    JSON.parse(last_response.body)    
+  end
+
+  
+  before do  
+    @jotify = jotify = mock('Jotify')
+    Sinatra::Application.send(:define_method, :jotify) { jotify }
+  end
+  
+  describe "/artists" do
+    it "searches by artist name" do
+      res = Jotify::Media::Result.new
+      res.artists.add(Jotify::Media::Artist.new('4d921ebcdd8c80f32ce1ed5acafbb9c8', 'The Kinks'))
+      @jotify.stub!(:search).and_return(res)
+      get '/artists', :name=>'The Kinks'
+      last_response.should be_ok
+      json_response.should == {"status"=>"OK", "result"=>
+        [{"id"=>"4d921ebcdd8c80f32ce1ed5acafbb9c8", "popularity"=>0.0, "url"=>"http://open.spotify.com/artist/2mnbxTkghYtlHMdX3jdP9C", "name"=>"The Kinks"}]
+      }
+    end      
+    
+    it "should return an error message if no name is specified" do
+      lambda { get '/artists' }.should raise_error(ArgumentError)
+    end
+  end
+  
+  describe "/tracks" do
+     it "searches by track name" do
+       res = Jotify::Media::Result.new
+       res.tracks.add(Jotify::Media::Track.new('4d921ebcdd8c80f32ce1ed5acafbb9c8'))
+       @jotify.stub!(:search).and_return(res)
+       get '/tracks', :name=>'Waterloo Sunset'
+       last_response.should be_ok
+       json_response.should == {"status"=>"OK", "result"=>
+         [{"id"=>"4d921ebcdd8c80f32ce1ed5acafbb9c8", "popularity"=>0.0, "url"=>"http://open.spotify.com/track/2mnbxTkghYtlHMdX3jdP9C", "title"=>nil, "artist"=>nil, "album"=>nil}]
+       }
+     end
+           
+     it "should return an error message if no name is specified" do
+       lambda { get '/tracks' }.should raise_error(ArgumentError)
+     end
+  end
+  
+  describe "/albums" do
+    it "searches by album name" do
+      res = Jotify::Media::Result.new
+      res.albums.add(Jotify::Media::Album.new('4d921ebcdd8c80f32ce1ed5acafbb9c8', 
+      'Something Else', 
+      Jotify::Media::Artist.new('4d921ebcdd8c80f32ce1ed5acafbb9c8', 'The Kinks')))
+      
+      @jotify.stub!(:search).and_return(res)
+      get '/albums', :name=>'Something Else'
+      last_response.should be_ok
+      json_response.should == {"status"=>"OK", "result"=>
+        [{"id"=>"4d921ebcdd8c80f32ce1ed5acafbb9c8",
+          "popularity"=>0.0, 
+          "url"=>"http://open.spotify.com/album/2mnbxTkghYtlHMdX3jdP9C", 
+          "name"=>"Something Else", 
+          "artist"=>"The Kinks", "year"=>-1, "type"=>nil}]
+      }
+    end      
+    
+    it "should return an error message if no name is specified" do
+      lambda { get '/albums' }.should raise_error(ArgumentError)
+    end    
+  end
+  
+  describe "/playlists" do
+    before do 
+      #String id, String name, String author, boolean collaborative
+      @playlist = Jotify::Media::Playlist.new("4d921ebcdd8c80f32ce1ed5acafbb9c8", "my shiny playlist", "test", false)
+
+    end
+      
+    describe "get" do  
+      
+      it "should get all playlists created by the user" do
+        @jotify.should_receive(:playlists).and_return( [@playlist] )
+        get '/playlists'
+        last_response.should be_ok
+        json_response.should == {"status"=>"OK",
+          "result"=> { 
+            "playlists" => [
+              "id"=>"4d921ebcdd8c80f32ce1ed5acafbb9c8",
+              "url"=>"http://open.spotify.com/user/test/playlist/2mnbxTkghYtlHMdX3jdP9C",                     
+              "name"=>"my shiny playlist",
+              "author"=>"test", "revision"=>-1, "collaborative"=>false
+            ] 
+          }
+        }
+      end
+      
+      
+      it "should retrieve a playlist by id" do
+        @jotify.should_receive(:playlist).with("4d921ebcdd8c80f32ce1ed5acafbb9c8").and_return(@playlist)
+        get '/playlists/4d921ebcdd8c80f32ce1ed5acafbb9c8'
+        last_response.should be_ok
+        json_response.should == {"status"=>"OK",
+         "result"=>{
+            "id"=>"4d921ebcdd8c80f32ce1ed5acafbb9c8",
+            "url"=>"http://open.spotify.com/user/test/playlist/2mnbxTkghYtlHMdX3jdP9C",                     
+            "name"=>"my shiny playlist",
+            "tracks"=>[], "author"=>"test", "revision"=>-1, "collaborative"=>false}
+        }
+      end
+    
+      it "should except a base62 string as id" do
+        @jotify.should_receive(:playlist).with("2mnbxTkghYtlHMdX3jdP9C").and_return(@playlist)
+        get '/playlists/2mnbxTkghYtlHMdX3jdP9C'
+        last_response.should be_ok
+      end
+    
+      it "should return 404 for non-existing playlist" do
+        @jotify.should_receive(:playlist).with("unknown").and_return(nil)
+        get '/playlists/unknown'
+        last_response.status.should == 404
+        json_response.should == {"status"=>"ERROR", "message"=>"playlist not found"}
+      end
+    end
+    
+    
+    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
+        last_response.status.should == 201
+        last_response.headers['Location'].should == 'http://open.spotify.com/user/test/playlist/2mnbxTkghYtlHMdX3jdP9C'
+      end
+
+      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(:set_tracks_on_playlist).with(@playlist, ['1','2']).and_return(true)
+   
+        post '/playlists', { 'name' => 'my shiny playlist', 
+          'collaborative' => true,
+          'tracks' =>  [ {'id'=>'1' }, { 'id'=>'2' } ] 
+          }.to_json
+        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)
+        post '/playlists', { :name => 'my shiny playlist', :collaborative =>true }.to_json
+        last_response.status.should == 500
+        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(: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'=>'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
+        last_response.status.should == 404
+        json_response.should == {"status"=>"ERROR", "message"=>"playlist not found"} 
+      end
+      
+      it "should return 500 if playlist could not be updated" do
+        @jotify.should_receive(:playlist).with("foo").and_return(@playlist)
+        @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 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 "shouldn't do anything if no data supplied" do
+        @jotify.should_receive(:playlist).with("foo").and_return(@playlist)
+        put '/playlists/foo', {}.to_json
+        last_response.should be_ok
+      end
+    end
+  end
+end