audioscrobbler 0.0.1

data/test/test_audioscrobbler.rb

@@ -0,0 +1,266 @@
+#!/usr/bin/ruby -w
+#
+# = Name
+# TestAudioscrobbler
+#
+# == Description
+# This file contains a regression test for the Audioscrobbler class, in the
+# unfortunate form of a small, useless implementation of an Audioscrobbler
+# track submission server. :(
+#
+# == Author
+# Daniel Erat <dan-ruby@erat.org>
+#
+# == Copyright
+# Copyright 2005 Daniel Erat
+#
+# == License
+# GNU GPL; see COPYING
+
+require 'audioscrobbler'
+require 'cgi'
+require 'md5'
+require 'test/unit'
+require 'thread'
+require 'time'
+require 'webrick'
+
+# Stores the outcome of handshakes received by a
+# AudioscrobblerHandshakeServlet object.
+class AudioscrobblerHandshakeStatus
+  def initialize
+    clear
+  end
+  attr_accessor :attempts, :successes, :failures
+
+  def clear
+    @attempts = 0
+    @successes = 0
+    @failures = 0
+    self
+  end
+end
+
+
+# Implements the handshake portion of the Audioscrobbler protocol.
+class AudioscrobblerHandshakeServlet < WEBrick::HTTPServlet::AbstractServlet
+  def initialize(server, status, user, challenge, submit_url,
+                 plugin_name='tst', plugin_version=0.1)
+    @status = status
+    @user = user
+    @challenge = challenge
+    @submit_url = submit_url
+    @plugin_name = plugin_name
+    @plugin_version = plugin_version
+    @failure_interval = 1
+  end
+
+  def do_GET(req, res)
+    @status.attempts += 1
+    res['Content-Type'] = "text/plain"
+
+    # Make sure that all of the parameters were supplied and match what we
+    # were expecting.
+    begin
+      if req.query['hs'] != 'true'
+        throw "FAILED Handshake not requested"
+      elsif req.query['p'] != '1.1'
+        throw "FAILED Wrong or missing protocol version"
+      elsif req.query['c'] != @plugin_name
+        throw "FAILED Wrong or missing plugin name"
+      elsif not req.query['v']
+        throw "FAILED Missing plugin version"
+      elsif req.query['u'] != @user
+        throw "BADUSER"
+      end
+
+      # TODO(derat): Test UPDATE responses?
+      @status.successes += 1
+      res.body = "UPTODATE\n#@challenge\n#@submit_url\nINTERVAL 0"
+
+    rescue RuntimeError
+      @status.failures += 1
+      res.body = "#{$!.message}\nINTERVAL #@failure_interval"
+    end
+  end  # do_GET
+end  # AudioscrobblerHandshakeServlet
+
+
+# Stores a submitted track.  Used by AudioscrobblerSubmitStatus.
+class Track
+  def initialize(artist=nil, title=nil, length=nil, start_time=nil,
+                 album=nil, mbid=nil)
+    @artist = artist
+    @title = title
+    @length = length
+    @start_time = start_time
+    @album = album
+    @mbid = mbid
+  end
+  attr_accessor :artist, :title, :length, :start_time, :album, :mbid
+
+  def ==(other)
+    other.class == Track and @artist == other.artist and
+      @title == other.title and @length == other.length and
+      @start_time == other.start_time and @album == other.album and
+      @mbid == other.mbid
+  end
+end
+
+
+# Stores the outcome of track submissions received by a
+# AudioscrobblerSubmitServlet object.
+class AudioscrobblerSubmitStatus
+  def initialize
+    clear
+  end
+  attr_accessor :attempts, :successes, :failures, :tracks
+
+  def clear
+    @attempts = 0
+    @successes = 0
+    @failures = 0
+    @tracks = []
+    self
+  end
+end
+
+
+# Implements the track submission portion of the Audioscrobbler protocol.
+class AudioscrobblerSubmitServlet < WEBrick::HTTPServlet::AbstractServlet
+  def initialize(server, status, user, password, challenge)
+    @status = status
+    @user = user
+    @md5 = MD5.hexdigest(MD5.hexdigest(password) + challenge)
+    @failure_interval = 1
+  end
+
+  # POST is supposed to be used rather than GET.
+  def do_GET(req, res)
+    @status.attempts += 1
+    @status.failures += 1
+    res.body = "FAILED Use POST, not GET\nINTERVAL #@failure_interval"
+  end
+
+  def do_POST(req, res)
+    @status.attempts += 1
+    res['Content-Type'] = "text/plain"
+
+    begin
+      # Make sure that they authenticated correctly.
+      if req.query['u'] != @user
+        raise "BADAUTH"
+      elsif req.query['s'] != @md5
+        raise "BADAUTH"
+      end
+
+      # Handle the track parameters.
+      tracks = []
+      req.query.each_pair do |k, v|
+        if k =~ /^([atbmli])\[(\d+)\]$/
+          track = (tracks[$2.to_i] ||= Track.new)
+          v = CGI.unescape(v)
+          case
+          when $1 == 'a': track.artist = v
+          when $1 == 't': track.title = v
+          when $1 == 'b': track.album = v
+          when $1 == 'm': track.mbid = v
+          when $1 == 'l': track.length = v.to_i
+          when $1 == 'i':
+            # We get start times in a strange format, but it's more
+            # convenient to store them as seconds since the epoch.
+            v =~ /^(\d{4})-(\d{2})-(\d{2}) (\d{2}):(\d{2}):(\d{2})$/
+            track.start_time = Time.gm($1, $2, $3, $4, $5, $6).to_i
+          end
+        end
+      end
+
+      # Make sure that no data was missing from the submitted tracks.
+      tracks.each do |track|
+        if not track
+          raise "FAILED Missing track"
+        elsif not track.artist or not track.title or not track.album or
+              not track.mbid or not track.length or not track.start_time
+          raise "FAILED Missing parameter"
+        elsif track.artist.length == 0 or track.title.length == 0 or
+              track.length == 0 or track.start_time == 0
+          raise "FAILED Empty required parameter"
+        end
+      end
+
+      # Make sure that we didn't get too few or too many tracks.
+      if tracks.length == 0
+        raise "FAILED No tracks supplied"
+      elsif tracks.length > 10
+        raise "FAILED More than 10 tracks supplied"
+      end
+
+      # If we get here, then we didn't find any problems.
+      @status.tracks += tracks
+      @status.successes += 1
+      res.body = "OK\nINTERVAL 0"
+
+    # If we threw an exception, return an error.
+    rescue RuntimeError
+      @status.failures += 1
+      res.body = "#{$!.message}\nINTERVAL #@failure_interval"
+    end
+  end # do_POST
+end  # AudioscrobblerSubmitServlet
+
+
+# Regression test for the Audioscrobbler class.
+class TestAudioscrobbler < Test::Unit::TestCase
+  def test_audioscrobbler
+    @handshake_status = AudioscrobblerHandshakeStatus.new
+    @submit_status = AudioscrobblerSubmitStatus.new
+    # FIXME(derat): Is there some better way to choose a port here?
+    @http_port = 16349
+
+    @server_thread = Thread.new do
+      s = WEBrick::HTTPServer.new(:BindAddress => "127.0.0.1",
+                                  :Port => @http_port)
+      s.mount("/handshake", AudioscrobblerHandshakeServlet, @handshake_status,
+              "username", "challenge", "http://127.0.0.1:#@http_port/submit")
+      s.mount("/submit", AudioscrobblerSubmitServlet, @submit_status,
+              "username", "password", "challenge")
+      trap("INT") { s.shutdown }
+      s.start
+    end
+
+    a = Audioscrobbler.new("username", "password")
+    a.client = "tst"
+    a.version = "1.1"
+    a.handshake_uri = "http://127.0.0.1:#@http_port/handshake"
+    a.verbose = true
+
+    a.start_submitter_thread
+
+    tracks = []
+    tracks.push(Track.new("Beck", "Devil's Haircut", 100, 1128285297,
+      "Odelay", ''))
+    tracks.push(Track.new("Faith No More", "Midlife Crisis", 100, 1128285297,
+      "Angel Dust", ''))
+    tracks.push(Track.new("Hans Zimmer", "Greed", 100, 1128285297,
+      "Broken Arrow", ''))
+    tracks.push(Track.new("M�m", "Sleepswim", 100, 1128285297,
+      "Finally We Are No One", ''))
+
+    tracks.each do |t|
+      a.enqueue(t.artist, t.title, t.length, t.start_time, t.album, t.mbid)
+    end
+
+    # FIXME(derat): This is awful.  I should add functionality to
+    # Audioscrobbler.enqueue to block until an attempt has been made to
+    # submit the just-enqueued track.
+    sleep 3
+
+    assert_equal(@handshake_status.failures, 0)
+    assert(@handshake_status.successes > 0)
+
+    assert_equal(@submit_status.failures, 0)
+    assert(@submit_status.successes > 0)
+
+    assert_equal(@submit_status.tracks, tracks)
+  end  # test_audioscrobbler
+end  # TestAudioscrobbler

data/test/test_queue.rb

@@ -0,0 +1,86 @@
+#!/usr/bin/ruby -w
+#
+# = Name
+# TestPlayedTrack, TestSubmissionQueue
+#
+# == Description
+# This file contains unit tests for the PlayedTrack and SubmissionQueue
+# components of the Audioscrobbler class.
+#
+# == Author
+# Daniel Erat <dan-ruby@erat.org>
+#
+# == Copyright
+# Copyright 2005 Daniel Erat
+#
+# == License
+# GNU GPL; see COPYING
+
+require 'audioscrobbler'
+require 'tempfile'
+require 'test/unit'
+
+class Audioscrobbler
+  class SubmissionQueue
+    class TestPlayedTrack < Test::Unit::TestCase
+      def test_members
+        t = PlayedTrack.new(
+          'Cylob', 'Stomping FM', 100, 1128285297, 'Lobster Tracks', nil)
+        assert_equal(t.artist, 'Cylob')
+        assert_equal(t.title, 'Stomping FM')
+        assert_equal(t.length, 100)
+        assert_equal(t.start_time, 1128285297)
+        assert_equal(t.album, 'Lobster Tracks')
+        assert_equal(t.mbid, '')  # nil should be converted to ''
+      end
+
+      def test_serialization
+        t = PlayedTrack.new(
+          'Katamari Damacy', 'WANDA WANDA', 100, 1128285297, 'OST', 'blah')
+        assert_equal(t,
+          PlayedTrack.deserialize(t.serialize))
+
+        t = PlayedTrack.new(
+          'Def Leppard', 'Photograph', 100, 1128285297, nil, 'blah')
+        assert_equal(t,
+          PlayedTrack.deserialize(t.serialize))
+      end
+    end  # class TestPlayedTrack
+  end  # class SubmissionQueue
+
+  class TestSubmissionQueue < Test::Unit::TestCase
+    def setup
+      file = Tempfile.new('audioscrobbler_test_queue')
+      @filename = file.path
+      file.close
+    end
+
+    def test_it
+      q = SubmissionQueue.new(@filename)
+
+      q.append('Kraftwerk', 'Computer Love', 100, 1128285297,
+        'Computer World', nil)
+      q.append('Iron Maiden', 'Aces High', 100, 1128285297,
+        'Powerslave', nil)
+      q.append('Herbie Hancock', 'Cantaloupe Island', 100, 1128285297,
+        'Empyrean Isles', nil)
+
+      # Create a new queue, pointing at the same backup file.
+      q = SubmissionQueue.new(@filename)
+
+      tracks = q.peek(1)
+      assert_equal(tracks.length, 1)
+      assert_equal(tracks[0].artist, 'Kraftwerk')
+
+      q.delete(1)
+      tracks = q.peek(5)
+      assert_equal(tracks.length, 2)
+      assert_equal(tracks[0].artist, 'Iron Maiden')
+      assert_equal(tracks[1].artist, 'Herbie Hancock')
+    end
+
+    def teardown
+      File.delete(@filename) if File.exists?(@filename)
+    end
+  end  # class TestSubmissionQueue
+end  # class AudioScrobbler

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11
+specification_version: 1
+name: audioscrobbler
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+date: 2005-10-02 00:00:00 -07:00
+summary: Library to submit music playlists to Last.fm
+require_paths: 
+  - lib
+email: dan-ruby@erat.org
+homepage: http://www.erat.org/ruby/
+rubyforge_project: 
+description: 
+autorequire: audioscrobbler
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+    - 
+      - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+authors: 
+  - Daniel Erat
+files: 
+  - MANIFEST
+  - COPYING
+  - INSTALL
+  - setup.rb
+  - README
+  - lib
+  - test
+  - audioscrobbler.gemspec
+  - lib/audioscrobbler.rb
+  - test/test_audioscrobbler.rb
+  - test/test_queue.rb
+test_files: 
+  - test/test_audioscrobbler.rb
+  - test/test_queue.rb
+rdoc_options: []
+extra_rdoc_files: []
+executables: []
+extensions: []
+requirements: []
+dependencies: []