spotify-api 0.0.5

data/.gitignore

@@ -0,0 +1,3 @@
+pkg
+coverage
+.DS_Store

data/CHANGELOG

@@ -0,0 +1,12 @@
+== 0.0.4 / 2009-08-08
+  * Fixes
+
+== 0.0.3 / 2009-08-07
+ * POST /playlists uses json
+
+== 0.0.2 / 2009-08-05
+ * Fix option parser bug
+
+== 0.0.1 / 2009-08-04
+ * First release to github
+

data/LICENSE

@@ -0,0 +1,24 @@
+Copyright (c) 2009, Jan Berkel
+All rights reserved.
+ 
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of spotify-api nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
+ 
+THIS SOFTWARE IS PROVIDED BY Jan Berkel 'AS IS'' AND ANY
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL David R. MacIver BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,74 @@
+
+# Spotify-API
+
+I got tired of waiting for Spotify to release their API (if they release it), so decided to roll my own based on the awesome
+work done by [#hack.se](http://despotify.se) (despotify) and Felix Bruns who created a Java port of despotify called 
+[jotify](http://jotify.felixbruns.de/). Add JRuby, Sinatra and some glue to the mix and you (almost) have an API.
+
+*Important*: in order to use this API you'll need a premium spotify account! This API is as unofficial as it gets and *NOT* supported
+by Spotify in any way.
+
+At the moment the following features are implemented:
+
+* searching 							[GET /(albums|tracks|artists)?name=Foo]
+* list user's playlists 	[GET /playlists]
+* get shared playlist			[GET /playlist/id]
+* create new playlist   	[POST /playlists]
+* update playlists        [PUT	/playlists/id]
+	
+## Installation
+
+Prerequisites: *Java 6+*, JRuby 1.3.x.
+
+    $ jruby -S gem sources -a http://gems.github.com # (you only have to do this once)
+    $ jruby -S gem install jberkel-spotify-api
+    $ jruby -S spotify-api-server --account login:password
+    == Sinatra/0.9.4 has taken the stage on 3000 for development with backup from WEBrick
+    [2009-08-04 01:21:03] INFO  WEBrick 1.3.1
+    [2009-08-04 01:21:03] INFO  ruby 1.8.6 (2009-07-24) [java]
+    [2009-08-04 01:21:03] INFO  WEBrick::HTTPServer#start: pid=12162 port=3000
+
+    $ curl http://localhost:3000/playlists | jsonpretty
+    {
+      "result": {
+        "playlists": [
+          {
+            "name": "my shiny playlist",
+            "author": "jberkel",
+            "url": "http:\/\/open.spotify.com\/user\/jberkel\/playlist\/5EXLGE7HPVPjvlxPmIfrDe",
+            "revision": 2,
+            "id": "b9fe3dcf88945d146ef18117faa61ab4",
+            "collaborative": false
+          }
+        ]
+      },
+      "status": "OK"
+    }
+		
+See examples directory for usage.
+
+## Credits
+
+Contains code from the jotify project:
+
+Copyright (c) 2009, Felix Bruns <felixbruns@web.de>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+	 * Redistributions of source code must retain the above copyright
+	   notice, this list of conditions and the following disclaimer.
+	 * Redistributions in binary form must reproduce the above copyright
+	   notice, this list of conditions and the following disclaimer in the
+	   documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHORS ''AS IS'' AND ANY
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/Rakefile

@@ -0,0 +1,41 @@
+require 'rubygems'
+require 'rake/testtask'
+require 'spec/rake/spectask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "spotify-api"
+    gem.summary = "an api for spotify, based on jotify"
+    gem.email = "jan.berkel@gmail.com"
+    gem.homepage = "http://github.com/jberkel/spotify-api"
+    gem.description = "an api for spotify, based on jotify"
+    gem.authors = ["Jan Berkel"]
+    gem.add_dependency "rack"
+    gem.add_dependency "rack-test"
+    gem.add_dependency "sinatra"
+    gem.add_dependency "json-jruby"    
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+Spec::Rake::SpecTask.new do |t|
+  t.rcov = false
+  t.spec_files = FileList["spec/**/*_spec.rb"].delete_if { |f| f =~ /integration/ }
+  t.libs << "./lib"
+end
+
+desc "runs specs with rcov"
+Spec::Rake::SpecTask.new('spec:coverage') do |t|
+  t.rcov = true
+  t.spec_files = FileList["spec/**/*_spec.rb"].delete_if { |f| f =~ /integration/ }
+  t.libs << "./lib"
+  t.rcov_opts = ['--exclude', 'spec/.*rb,\(__.+__\)']
+end
+
+Spec::Rake::SpecTask.new(:integration) do |t|
+  t.rcov = false
+  t.spec_files = FileList["spec/**/*_spec.rb"].select { |f| f =~ /integration/ }
+  t.libs << "./lib"
+end

data/VERSION.yml

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

data/bin/spotify-api-server

@@ -0,0 +1,40 @@
+#!/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'
+require 'jotify/api'
+
+DEFAULT_PORT = port = 3000
+
+def usage
+  STDERR.puts "#{File.basename($0)} [-p <port>] [--account <login>:<password>]"
+  exit(1)
+end
+
+while arg = ARGV.shift do
+    case arg
+      when '-p', '--port': port = ARGV.shift
+      when '--account':
+        login, password = ARGV.shift.to_s.split(':')
+        raise ArgumentError, "you need to specify both login and password!" unless login and password
+        Jotify.credentials = { :username=>login, :password=>password }
+      when '-h', '--help': usage
+    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/lastfm.rb

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+ 
+require 'rubygems'
+require 'httparty'
+ 
+#A demo Last.fm API client, implemented 
+#using httparty (http://github.com/jnunemaker/httparty/)
+class Lastfm
+  include HTTParty
+ 
+  base_uri 'ws.audioscrobbler.com'
+  default_params :api_key => "PUT_API_KEY_HERE"
+ 
+  class <<self 
+    def loved_tracks(user_id)
+      query('user.getLovedTracks', :user=>user_id, :limit=>10)['lovedtracks']['track'].map do |r|
+          { 'artist' => r['artist']['name'], 'title'=>r['name'], 'mbid' => r['mbid'] }
+      end
+    end
+ 
+    def recent_tracks(user_id)
+      query('user.getRecentTracks', :user=>user_id, :limit=>100)['recenttracks']['track'].map do |r|
+          { 'artist' => r['artist'], 'title'=>r['name'], 'mbid' => r['mbid'] }
+      end
+    end
+
+    def top_tracks(user_id, period='overall')
+      unless ['overall', '7day', '3month', '6month', '12month'].include?(period)
+        raise ArgumentError, "invalid period"
+      end
+       
+      query('user.getTopTracks', :period=>period, :user=>user_id)['toptracks']['track'].map do |r|
+        { 'artist' => r['artist']['name'], 'title'=>r['name'], 'mbid' => r['mbid'] }
+      end
+    end
+  
+    def query(method, args={})
+     result = get("/2.0/", :query => { :method => method }.merge(args))
+     raise result['lfm']['error'] if result['lfm'] && result['lfm']['status'] == 'failed'
+     result['lfm']
+    end
+  end
+end

data/examples/lastfm2spotify.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+require File.join(File.dirname(__FILE__), *%w[lastfm])
+require File.join(File.dirname(__FILE__), *%w[spotify])
+
+# a demo app which grabs tracks from last.fm and creates a spotify 
+# playlist
+if __FILE__ == $0
+  username = ARGV.shift or raise "#{$0} <username> [period=overall|7day|3month|6month|12month]"
+  period   = ARGV.shift || '7day'
+  
+  puts "fetching last.fm tracks (period=#{period})"
+  tracks = Lastfm.top_tracks(username, period).map do |track|
+    Spotify.tracks(track["title"], track["artist"]).first
+  end.flatten.compact
+  
+  #puts "found tracks: #{tracks.inspect}"
+  puts "creating playlist with #{tracks.size} tracks"
+  puts Spotify.create_playlist(username, tracks.map { |t| t['id'] })  
+end

data/examples/spotify.rb

@@ -0,0 +1,86 @@
+#!/usr/bin/env ruby
+ 
+require 'rubygems'
+require 'httparty'
+require 'json'
+require 'pp'
+ 
+#A demo spotify API client, implemented 
+#using httparty (http://github.com/jnunemaker/httparty/)
+class Spotify
+  include HTTParty
+  
+  base_uri 'localhost:3000'
+  
+  def self.get_or_bail(path, params={})
+    resp = get(path, :query=>params)
+    raise resp.inspect if resp["status"] != "OK"
+    resp["result"]
+  end
+  
+  def self.artists(name)
+    get_or_bail("/artists", {:name => name})
+  end
+  
+  def self.tracks(name, artist=nil)
+    q = { :name => name }
+    q.merge!(:artist=>artist) if artist    
+    get_or_bail("/tracks", q)
+  end
+  
+  def self.albums(name, artist=nil)
+    q = { :name => name }
+    q.merge!(:artist=>artist) if artist
+    get_or_bail("/albums", q)
+  end
+  
+  def self.playlist(id)
+    get_or_bail("/playlists", :id=>id)
+  end
+  
+  def self.playlists
+    get_or_bail("/playlists")
+  end
+
+  def self.update_playlist(id, name=nil, track_ids=[])  
+    data = {}
+    data["tracks"] = track_ids.map { |id| { 'id' => id } } unless tracks_ids.empty?
+    data["name"]   = name if name
+    
+    resp = put("/playlists/#{id}", :body => data.to_json)
+    raise resp.inspect if resp['status'] != 'OK'
+  end
+  
+  def self.create_playlist(name, track_ids=[])
+    resp = post("/playlists", :body => {      
+       :name => name,
+       :tracks => track_ids.map { |id| { 'id' => id } }
+     }.to_json)
+     
+    if resp.code == 201
+      location = resp.headers['location']
+      "201 created (#{location})"
+    else
+      raise resp.inspect
+    end
+  end
+end
+
+if __FILE__ == $0
+  if ARGV.empty?
+    STDERR.puts "#{$0} [list|create|search]"
+    exit(1)
+  end
+  
+  pp case cmd = ARGV.shift
+    when "list"
+      Spotify.playlists
+    when "create"
+      raise ArgumentError, "#{$0} create <name>" unless name = ARGV.shift        
+      Spotify.create_playlist(name)
+    when "search"
+      raise ArgumentError, "#{$0} search <what>" unless what = ARGV.shift      
+      Spotify.albums(what)
+    else raise ArgumentError, "invalid command: #{cmd}"
+  end  
+end

data/lib/jotify.rb

@@ -0,0 +1,128 @@
+require 'java'
+require File.expand_path(File.dirname(__FILE__) + '/jars/jotify.jar')
+
+class Jotify          
+
+  module Media    
+    import 'de.felixbruns.jotify.media.Playlist'
+    import 'de.felixbruns.jotify.media.PlaylistContainer'    
+    import 'de.felixbruns.jotify.media.Result'
+    import 'de.felixbruns.jotify.media.Track'
+    import 'de.felixbruns.jotify.media.Artist'
+    import 'de.felixbruns.jotify.media.Album'
+  end
+  
+  import 'de.felixbruns.jotify.gui.util.JotifyPreferences'
+  import 'de.felixbruns.jotify.util.SpotifyURI'
+
+  ByPopularity = Proc.new { |a,b| b.popularity <=> a.popularity }
+  
+  [:close, :search].each do |m|
+    define_method(m) do |*args|
+      @jotify.send(m, *args)
+    end
+  end
+
+  def initialize(jotify_impl=Java::DeFelixbrunsJotify::JotifyPool.new(4))
+    @jotify  = jotify_impl
+    
+    credentials = Jotify.credentials
+    @jotify.login(credentials[:username], credentials[:password])
+    
+    at_exit do
+      begin
+        @jotify.close 
+      rescue Exception => e
+      end
+    end
+
+    if block_given?
+      begin
+        yield self
+      ensure
+        close
+      end
+    end
+  end
+
+  def playlists
+    @jotify.playlists.map { |p| playlist(p.getId()) }
+  end
+
+  def playlist(id, resolve_tracks=false)
+    playlist = @jotify.playlist(Jotify.resolve_id(id))
+    if resolve_tracks && !playlist.tracks.empty?
+     res = @jotify.browse(playlist.tracks)
+     res.tracks.each_with_index do |t,i|
+       playlist.tracks.set(i, t)
+     end
+    end
+    playlist
+  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)
+    playlist
+  end
+    
+  def add_playlist(id)
+    @jotify.playlistsAddPlaylist(@jotify.playlists, id.is_a?(Media::Playlist) ? id : playlist(id))
+  end
+     
+  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))) }
+  
+    # 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)
+    case id
+      when /\Ahttp:\/\/open\.spotify\.com/: SpotifyURI.to_hex(id[id.rindex('/')+1..-1])
+      when /spotify:/: SpotifyURI.to_hex(id[id.rindex(':')+1..-1])
+      when /\A[0-9a-f]{32}\Z/: id
+      when /\A[a-zA-Z0-9]{22}\Z/: SpotifyURI.to_hex(id)
+    else 
+      raise "invalid id: #{id}"
+    end
+  end
+   
+  def self.credentials
+    prefs = JotifyPreferences.getInstance()
+    prefs.load()
+    { 
+     :username => prefs.getString("login.username"),
+     :password => prefs.getString("login.password")
+    }       
+  end
+   
+  def self.credentials=(creds)
+    prefs = JotifyPreferences.getInstance()
+    prefs.load()
+    prefs.setString("login.username", creds[:username])
+    prefs.setString("login.password", creds[:password])
+    prefs.save() or raise "could not save login details"
+  end
+end
+
+require File.expand_path(File.dirname(__FILE__) + '/jotify/media')