audioscrobbler 0.1.0 → 0.1.1

data/audioscrobbler.gemspec

@@ -1,7 +1,7 @@
 require 'rubygems'
 SPEC = Gem::Specification.new do |s|
   s.name          = "audioscrobbler"
-  s.version       = "0.1.0"
+  s.version       = "0.1.1"
   s.author        = "Daniel Erat"
   s.email         = "dan-ruby@erat.org"
   s.homepage      = "http://www.erat.org/ruby/"

data/lib/audioscrobbler.rb

@@ -22,20 +22,29 @@
 # GNU GPL; see COPYING
 #
 # == Changes
-# 0.0.1  Initial release
-# 0.0.2  Upgraded from v1.1 to v1.2 of the Audioscrobbler protocol.  This means:
+# 0.0.1  20051002
+#        Initial release
+# 0.0.2  20070826
+#        Upgraded from v1.1 to v1.2 of the Audioscrobbler protocol.  This means:
 #        - "Now Playing" notifications
 #        - callers should now submit when tracks stop playing instead of as
 #          soon as the submission criteria is met
 #        - track numbers can be submitted
 #        Also added a race condition that I haven't bothered fixing (I
 #        think I'm the only person using this library?).
-# 0.1.0  Catch an exception when the server gives us a bogus now-playing
+# 0.1.0  20071011
+#        Catch an exception when the server gives us a bogus now-playing
 #        URL, as happened to me yesterday. :-P
+# 0.1.1  20071030
+#        Merge patches from Patrick Sinclair <Patrick.Sinclair@bbc.co.uk>
+#        adding HTTP proxy support and improving logging.  Add validation
+#        of now-playing tracks' metadata, similar to what was already
+#        being done for submitted tracks.
 
 require "cgi"
 require "md5"
 require "net/http"
+require "logger"
 require "thread"
 require "uri"
 
@@ -110,12 +119,13 @@ class Audioscrobbler
   # @param password  Audioscrobbler account password
   # @param filename  file used for on-disk storage of not-yet-submitted
   #                  tracks
+  # @param proxy     optional HTTP proxy to use for outgoing connections
   #
-  def initialize(username, password, filename=nil)
+  def initialize(username, password, filename=nil, proxy=nil)
     @username = username
     @password = password
     @queue = SubmissionQueue.new(filename)
-    @verbose = false
+    @logger = Logger.new($stdout)
     @client = DEFAULT_CLIENT
     @version = DEFAULT_VERSION
 
@@ -128,10 +138,57 @@ class Audioscrobbler
     @submit_url = nil
     @now_playing_url = nil
     @submit_interval_sec = DEFAULT_SUBMIT_INTERVAL_SEC
+
+    @proxy = {}
+    if proxy
+      uri = URI.parse(proxy)
+      @proxy[:host], @proxy[:port] = uri.host, uri.port
+      if uri.userinfo
+        @proxy[:username], @proxy[:password] = uri.userinfo.split(':', 1)
+      end
+    end
   end
-  attr_accessor :username, :password, :verbose
+  attr_accessor :username, :password, :logger
   attr_accessor :client, :version, :handshake_url
 
+  ##
+  # Backwards-compatability methods to control the logging level.
+  def verbose=(v)
+    @logger.sev_threshold = v ? Logger::DEBUG : Logger::WARN
+  end
+  def verbose
+    @logger.sev_threshold == Logger::DEBUG
+  end
+
+  ##
+  # Checks that a track's metadata meets the Audioscrobbler submission
+  # rules, in case the caller isn't already doing this.
+  #
+  # @param artist      artist name
+  # @param title       track name
+  # @param length      track length
+  # @param start_time  track start time, as UTC unix time
+  #
+  def valid_metadata?(artist, title, length, start_time)
+    if not length or length < 30
+      @logger.warn("Track \"#{artist} - #{title}\" is #{length} " \
+                   "second(s) long (min is 30 seconds)")
+      return false
+    elsif not artist or artist == ''
+      @logger.warn("Track is missing artist tag (title is \"#{title}\")")
+      return false
+    elsif not title or title == ''
+      @logger.warn("Track is missing title tag (artist is \"#{artist}\")")
+      return false
+    elsif not start_time or start_time <= 0
+      @logger.warn("Track \"#{artist} - #{title}\" has bogus start time " \
+                   "#{start_time}")
+      return false
+    end
+    true
+  end
+  private :valid_metadata?
+
   ##
   # Update the backoff interval after handshake failure.  If we haven't
   # failed yet, we wait a minute; otherwise, we wait twice as long as last
@@ -140,7 +197,7 @@ class Audioscrobbler
   # @param message  string logged to stderr if verbose logging is enabled
   #
   def handle_handshake_failure(message)
-    vlog(message)
+    @logger.debug(message)
     if @handshake_backoff_sec < 60
       @handshake_backoff_sec = 60
     elsif @handshake_backoff_sec < 2 * 60 * 60
@@ -183,10 +240,15 @@ class Audioscrobbler
     end
     url = @handshake_url + '?' + arg_pairs.join('&')
 
-    vlog("Beginning handshake with #@handshake_url")
+    @logger.debug("Beginning handshake with #@handshake_url")
 
     begin
-      data = Net::HTTP.get_response(URI.parse(url)).body
+      uri = URI.parse(url)
+      data = Net::HTTP.start(uri.host, uri.port,
+                             @proxy[:host], @proxy[:port],
+                             @proxy[:username], @proxy[:password]) do |http|
+        http.get(uri.request_uri).body
+      end
     rescue Exception
       handle_handshake_failure(
         "Read of #@handshake_url for handshake failed: #{$!}")
@@ -222,8 +284,8 @@ class Audioscrobbler
     # Create our response based on the server's challenge and
     # save the submission URL.
     @session_id, @now_playing_url, @submit_url = lines[1,3]
-    vlog("Got session ID #@session_id, submission URL " \
-         "#@submit_url, and now-playing URL #@now_playing_url")
+    @logger.debug("Got session ID #@session_id, submission URL " \
+                  "#@submit_url, and now-playing URL #@now_playing_url")
 
     @handshake_backoff_sec = 0
     @hard_failures = 0
@@ -246,7 +308,7 @@ class Audioscrobbler
         # Might as well re-check in case more tracks have shown up
         # during the handshake.
         tracks = @queue.peek(MAX_TRACKS_IN_SUBMISSION)
-        vlog("Submitting #{tracks.length} track(s)")
+        @logger.debug("Submitting #{tracks.length} track(s)")
 
         # Construct our argument list.
         args = { "s" => @session_id }
@@ -269,36 +331,40 @@ class Audioscrobbler
         begin
           url = URI.parse(@submit_url)
           headers = { 'Content-Type' => 'application/x-www-form-urlencoded' }
-          data = Net::HTTP.start(url.host, url.port) do |http|
+          data = Net::HTTP.start(url.host, url.port,
+                                 @proxy[:host], @proxy[:port],
+                                 @proxy[:username], @proxy[:password]) do |http|
             http.post(url.path, body, headers).body
           end
         rescue Exception
-          vlog("Submission failed -- couldn't read #@submit_url: #{$!}")
+          @logger.warn("Submission failed -- couldn't read " \
+                       "#@submit_url: #{$!}")
         else
           # Check whether the submission was successful.
           lines = data.split("\n")
           if not lines[0]
-            vlog("Submission failed -- got empty response")
+            @logger.warn("Submission failed -- got empty response")
           elsif lines[0] == "OK"
-            vlog("Submission was successful")
+            @logger.debug("Submission was successful")
             @queue.delete(tracks.length)
           elsif lines[0] == "BADSESSION"
-            vlog("Submission failed -- session is invalid")
+            @logger.warn("Submission failed -- session is invalid")
             # Unset the session ID so we'll re-handshake.
             @session_id = nil
           else
-            vlog("Submission failed -- got unknown response \"#{lines[0]}\"")
+            @logger.warn("Submission failed -- got unknown response " \
+                         "\"#{lines[0]}\"")
             @hard_failures += 1
           end
         end
 
         if @hard_failures >= 3
-          vlog("Got #@hard_failures failures; re-handshaking")
+          @logger.warn("Got #@hard_failures failures; re-handshaking")
           @session_id = nil
         end
 
-        vlog("Sleeping #@submit_interval_sec sec before checking for " \
-             "more tracks")
+        @logger.debug("Sleeping #@submit_interval_sec sec before checking " \
+                      "for more tracks")
         sleep(@submit_interval_sec)
       end
     end
@@ -317,7 +383,12 @@ class Audioscrobbler
   #
   def report_now_playing(artist, title, length, album="", mbid="",
                          track_num='')
-    vlog("Reporting \"#{artist} - #{title}\" as now-playing")
+    @logger.debug("Reporting \"#{artist} - #{title}\" as now-playing")
+
+    if not valid_metadata?(artist, title, length, Time.now.to_i)
+      @logger.warn("Ignoring track with invalid metadata for now-playing")
+      return false
+    end
 
     # FIXME(derat): Huge race condition here between us and the submission
     # thread, but I am to lazy to fix it right now.
@@ -342,23 +413,26 @@ class Audioscrobbler
     begin
       url = URI.parse(@now_playing_url)
     rescue Exception
-      vlog("Submission failed -- couldn't parse now-playing " +
-           "URL \"#@now_playing_url\"")
+      @logger.warn("Submission failed -- couldn't parse now-playing " +
+                   "URL \"#@now_playing_url\"")
     else
       headers = { 'Content-Type' => 'application/x-www-form-urlencoded' }
       begin
-        data = Net::HTTP.start(url.host, url.port) do |http|
+        data = Net::HTTP.start(url.host, url.port,
+                               @proxy[:host], @proxy[:port],
+                               @proxy[:username], @proxy[:password]) do |http|
           http.post(url.path, body, headers).body
         end
       rescue Exception
-        vlog("Submission failed -- couldn't read #@now_playing_url: #{$!}")
+        @logger.warn("Submission failed -- couldn't read " \
+                     "#@now_playing_url: #{$!}")
       else
         data.chomp!
         if data == "OK"
-          vlog("Now-playing report was successful")
+          @logger.debug("Now-playing report was successful")
           success = true
         else
-          vlog("Now-playing report failed -- got \"#{data}\"")
+          @logger.warn("Now-playing report failed -- got \"#{data}\"")
         end
       end
     end
@@ -367,6 +441,9 @@ class Audioscrobbler
 
   ##
   # Enqueue a track for submission.
+  # Returns true if track was successfully queued and false otherwise
+  # (currently, it only fails if the track's metadata didn't meet the
+  # Audioscrobbler submission rules).
   #
   # @param artist      artist name
   # @param title       track name
@@ -378,44 +455,14 @@ class Audioscrobbler
   #
   def enqueue(artist, title, length, start_time, album="", mbid="",
               track_num=nil)
-    if not length or length < 30
-      log("Ignoring #{artist} - #{title}, as it is #{length} second(s) " \
-          "long (min is 30 seconds)")
-      return
-    elsif not artist or artist == ''
-      log("Ignoring #{title}, as it is missing an artist tag")
-      return
-    elsif not title or title == ''
-      log("Ignoring #{artist}, as it is missing a title tag")
-      return
-    elsif not start_time or start_time <= 0
-      log("Ignoring #{artist} - #{title} with bogus start time #{start_time}")
-      return
+    if not valid_metadata?(artist, title, length, start_time)
+      @logger.warn("Ignoring track with invalid metadata for submission")
+      return false
     end
-
     @queue.append(artist, title, length, start_time, album, mbid, track_num)
+    true
   end
 
-  ##
-  # Log a message, along with the current time, to stderr.
-  #
-  # @param message  message to log
-  #
-  def log(message)
-    STDERR.puts(Time.now.strftime("%Y-%m-%d %H:%M:%S") + " " + message.to_s)
-  end
-  private :log
-
-  ##
-  # Only log if verbose logging is enabled.
-  #
-  # @param message  message to log
-  #
-  def vlog(message)
-    log(message) if @verbose
-  end
-  private :vlog
-
   ##
   # A synchronized, backed-up-to-disk queue holding tracks for submission.
   # The synchronization is only sufficient for a single reader and writer.

data/test/test_audioscrobbler.rb

@@ -312,8 +312,7 @@ class TestAudioscrobbler < Test::Unit::TestCase
     a.client = "tst"
     a.version = "1.1"
     a.handshake_url = "http://127.0.0.1:#@http_port/handshake"
-    a.verbose = false
-
+    a.logger.sev_threshold = Logger::UNKNOWN
     a.start_submitter_thread
 
     tracks = []
@@ -332,16 +331,25 @@ class TestAudioscrobbler < Test::Unit::TestCase
                                'Airdrawndagger', 'def', 7))
 
     tracks.each do |t|
-      a.enqueue(t.artist, t.title, t.length, t.start_time, t.album, t.mbid,
-                t.track_num)
+      assert(a.enqueue(t.artist, t.title, t.length, t.start_time, t.album,
+                       t.mbid, t.track_num))
     end
 
     sleep 0.1  # avoid race condition :-/
     now_playing.each do |t|
-      a.report_now_playing(t.artist, t.title, t.length, t.album, t.mbid,
-                           t.track_num)
+      assert(a.report_now_playing(t.artist, t.title, t.length, t.album, t.mbid,
+                                  t.track_num))
     end
 
+    # This is lame, but since we have everything set up already, we might
+    # as well make sure that we're not able to submit tracks with broken
+    # metadata.  The four things we check are missing artists, missing
+    # titles, tracks shorter than 30 seconds, and invalid start times.
+    assert(!a.report_now_playing('', 'Title', 60, Time.now.to_i))
+    assert(!a.report_now_playing('Artist', '', 60, Time.now.to_i))
+    assert(!a.enqueue('Artist', 'Title', 25, Time.now.to_i))
+    assert(!a.enqueue('Artist', 'Title', 60, 0))
+
     # 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.
@@ -389,7 +397,7 @@ class TestAudioscrobbler < Test::Unit::TestCase
     a.client = "tst"
     a.version = "1.1"
     a.handshake_url = "http://127.0.0.1:#@http_port/handshake"
-    a.verbose = false
+    a.logger.sev_threshold = Logger::UNKNOWN
     a.start_submitter_thread
 
     assert(!a.report_now_playing('artist', 'title', 100, 'album', 'mbid', 1))

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.3
 specification_version: 1
 name: audioscrobbler
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
-date: 2007-10-11 00:00:00 -07:00
+  version: 0.1.1
+date: 2007-10-30 00:00:00 -07:00
 summary: Library to submit music playlists to Last.fm
 require_paths: 
 - lib