daapclient 0.1.0 → 0.2.0

data/NOTES

@@ -0,0 +1,33 @@
+= Net::DAAP::Client Release Notes
+
+== 0.2.0
+
+Net::DAAP::Client has a newer, extended interface.  In addition to the song
+list that the database already contained, there is now a list of artists and
+a list of albums that you can access from the database.  The artists contain
+all of the albums associated with that artists, and each album has all the songs
+for that album.  Each artist contains all songs by that artist as well.
+
+For example, to access all songs by one artist, one could do this:
+
+  db.artists.find { |a| a.name == 'Radiohead' '}.songs.each { |s|
+    puts s.name
+  }
+
+Or, to access all of Radiohead's albums, one could do this:
+
+  db.artists.find { |a| a.name == 'Radiohead' '}.albums.each { |a|
+    puts a.name
+  }
+
+An exhaustive example can be seen in the EXAMPLES file.
+
+This version of Net::DAAP::Client relies on digest-m4p which can be obtained
+from the project page here[http://rubyforge.org/frs/?group_id=1155].
+Unfortunately I can't get digest-m4p to build on Windows (I don't have a
+windows machine), so for now digest-m4p only works on Linux and OS X.
+Hopefully someone can send me a patch (hint hint).
+
+Also, because of a bug in RubyGems, digest-m4p cannot be released as a gem
+until I find a workaround, or the new version of RubyGems gets released.
+

data/README

@@ -3,18 +3,14 @@
 This library is used for browsing iTunes DAAP servers.
 
 Most of this is based off the work in the perl version by Richard Clamp which
-can be found here:
-
-http://search.cpan.org/~rclamp/
+can be found here[http://search.cpan.org/~rclamp/].
 
 Ruby version is by Aaron Patterson <aaronp@rubyforge.org>
 
 == Installation
 
 Make sure that Digest::M4P is installed before using this package.  Digest::M4P
-is available on the daap client ruby forge site:
-
-http://rubyforge.org/frs/?group_id=1155
+is available on the daap client ruby forge site here[http://rubyforge.org/frs/?group_id=1155].
 
 Digest::M4P has not been turned in to a Ruby gem as of this writing.
 
@@ -22,33 +18,13 @@ After that, just install the gem:
 
   sudo gem install daapclient
 
-Also, check out the project page:
-
-http://rubyforge.org/projects/daapclient
+Also, check out the project page here[http://rubyforge.org/projects/daapclient].
 
 == Example Usage
 
-  require 'net/daap'
-  require 'fileutils'
-  
-  daap = Net::DAAP::Client.new('localhost')
-  
-  daap.connect do |dsn|
-    daap.databases do |db|
-      puts "All songs in the database"
-      db.songs do |song|
-        filename = "#{song.artist} - #{song.name}.#{song.format}"
-        directory = "db/#{song.album}"
-        FileUtils::mkdir_p(directory)
-  
-        File.open("#{directory}/#{filename}", "w") do |f|
-          song.get { |str| f.write str }
-        end
-      end
-    end
-  end
-
-== Acknowledgements
+See the EXAMPLES[link://files/EXAMPLES.html] file
+
+== Acknowledgments
 
 The library is mostly a port of the Perl library, and owes most of its
 communication logic to the original Perl version by Richard Clamp.
@@ -62,5 +38,5 @@ favorite language!  ;-)
 
 == License
 
-This library is distributed under the GPL.  Please see the LICENSE file.
+This library is distributed under the GPL.  Please see the LICENSE[link://files/LICENSE.html] file.
 

data/lib/net/daap.rb

@@ -1,10 +1,14 @@
 require 'net/http'
 require 'digest/m4p'
 require 'digest/md5'
+require 'logger'
 require 'net/daap/dmap'
+require 'net/daap/artist'
+require 'net/daap/album'
 require 'net/daap/song'
 require 'net/daap/playlist'
 require 'net/daap/database'
+require 'net/daap/daap_version'
 
 
 module Net
@@ -46,22 +50,29 @@ module Net
 # and each Database can have many Playlist, and many Song.  See DAAP for a
 # code example.
     class Client
+      attr_accessor :log
       attr_reader :dmap
 
 # Create a new Client and pass in the host where the client will connect.
       def initialize(server_host)
         @server_host = server_host
         @server_port = 3689
-        @debug = 0
+        @validator   = nil
+        @log         = Logger.new(nil)
+        @session_id  = nil
+        @request_id  = nil
+        yield self if block_given?
       end
 
 # Connects to the iTunes server.  This method should be called right after
 # construction.  See DAAP for an example.
       def connect
+        @log.info("Connecting to #{@server_host}:#{@server_port}")
         @http_client = Net::HTTP.start(@server_host, @server_port)
         find_validator
         @dmap = Net::DAAP::DMAP.new(:daap => self)
         load_server_info
+        @log.info("Now connected")
         @connected = 1
         if block_given?
           yield @dsn
@@ -73,15 +84,18 @@ module Net
 
 # Returns the databases found on the iTunes server.
       def databases
-        return error("Not connected, can't fetch databases") unless @connected
+        unless @connected
+          errstr = "Not connected, can't fetch databases"
+          @log.error(errstr)
+          raise errstr
+        end
 
         listings = @dmap.find(do_get("databases"),
                             "daap.serverdatabases/dmap.listing")
         # FIXME check the value of listing
         @databases = []
         unpack_listing(listings) do |value|
-          db = Database.new(  :db_info  => value,
-                              :daap     => self )
+          db = Database.new( value.merge(:daap => self) )
           if block_given?
             yield db
           else
@@ -92,19 +106,20 @@ module Net
       end
 
       def do_get(request, &block)
-        debug("do_get")
+        @log.debug("do_get called")
         url = String.new('/' + request)
         if @session_id
           url += url =~ /\?/ ?  "&" : "?"
           url += "session-id=#{@session_id}"
         end
 
-        if @revision && request != "logout"
-          url += "&revision-number=#{@revision}"
-        end
-        debug(url)
+        #if @revision && request != "logout"
+        #  url += "&revision-number=#{@revision}"
+        #end
+        @log.debug("Fetching url: #{url}")
 
         res = @http_client.get(url, request_headers(url), nil, &block)
+        @log.debug("Done Fetching url: #{url}")
 
         content_type = res.header['content-type']
         if request !~ /(?:\/items\/\d+\.|logout)/ && content_type !~ /dmap/
@@ -115,8 +130,8 @@ module Net
       end
 
       def get_song(request, &block)
-        @request_id = 1 unless @request_id
-        @request_id += 1 if @request_id
+        @log.debug("Downloading a song")
+        @request_id = @request_id.nil? ? 2 : @request_id + 1
         do_get(request, &block)
       end
 
@@ -132,17 +147,19 @@ module Net
 
 # Disconnects from the DAAP server
       def disconnect
+        @log.info("Disconnecting")
         do_get("logout")
       end
+
       private
       def load_server_info
         flat_list = @dmap.flat_list(do_get("server-info"))
         @dsn = flat_list['/dmap.serverinforesponse/dmap.itemname']
 
-        debug("Connected to share '#{@dsn}'")
+        @log.debug("Connected to share '#{@dsn}'")
         @session_id = @dmap.find(do_get("login"),
                 "dmap.loginresponse/dmap.sessionid")
-        debug("My id is #{@session_id}")
+        @log.debug("My id is #{@session_id}")
         @dsn
       end
 
@@ -157,23 +174,20 @@ module Net
         headers
       end
 
+      # Figure out what protocol version to use
       def find_validator
+        @log.info("Determining DAAP version")
         res = @http_client.get('/server-info')
         server = res.header['daap-server']
 
         if server =~ /^iTunes\/4.2/
           @validator = DAAPv2.new
+          @log.info("Found DAAPv2")
         end
 
         if server =~ /^iTunes/
           @validator = DAAPv3.new
-        end
-      end
-
-      def debug(message)
-        if @debug == 1
-          print "DEBUG: "
-          p message
+          @log.info("Found DAAPv3")
         end
       end
     end

data/lib/net/daap/album.rb

@@ -0,0 +1,16 @@
+module Net
+  module DAAP
+# This class contains album information returned from the DAAP server.
+    class Album
+      attr_reader :name, :artist, :songs
+
+      alias :to_s :name
+
+      def initialize(args)
+        @name   = args[:name] || args['daap.songalbum']
+        @artist = args[:artist]
+        @songs  = []
+      end
+    end
+  end
+end

data/lib/net/daap/artist.rb

@@ -0,0 +1,16 @@
+module Net
+  module DAAP
+# This class contains artist information returned from the DAAP server.
+    class Artist
+      attr_reader :name, :albums, :songs
+
+      alias :to_s :name
+
+      def initialize(args)
+        @name   = args[:name] || args['daap.songartist']
+        @albums = []
+        @songs  = []
+      end
+    end
+  end
+end

data/lib/net/daap/daap_version.rb

@@ -0,0 +1,7 @@
+# DO NOT EDIT
+# This file is auto-generated by build scripts
+module Net
+  module DAAP
+    Version = '0.2.0'
+  end
+end

data/lib/net/daap/database.rb

@@ -1,30 +1,39 @@
+class Module
+  def attr_blockreader(*syms)
+    syms.each do |sym|
+      class_eval %{ def #{sym.to_s}
+                      if block_given?
+                        @#{sym.to_s}.each \{ |s| yield s \}
+                      end
+                      @#{sym.to_s}
+                    end
+                  }
+    end
+  end
+end
+
 module Net
   module DAAP
 # This class contains a database found on an iTunes server.
     class Database
       attr_reader :persistentid, :name, :containercount, :id, :itemcount
-      attr_reader :playlists, :songs
+      attr_blockreader :songs, :artists, :albums
+
       @@SONG_ATTRIBUTES = %w{ dmap.itemid dmap.itemname dmap.persistentid
                              daap.songalbum daap.songartist daap.songformat
                                                             daap.songsize }
 
       def initialize(args)
-        info = args[:db_info]
-        @persistentid   = info['dmap.persistentid']
-        @name           = info['dmap.itemname']
-        @containercount = info['dmap.containercount']
-        @id             = info['dmap.itemid']
-        @itemcount      = info['dmap.itemcount']
+        @persistentid   = args['dmap.persistentid']
+        @name           = args['dmap.itemname']
+        @containercount = args['dmap.containercount']
+        @id             = args['dmap.itemid']
+        @itemcount      = args['dmap.itemcount']
         @daap           = args[:daap]
-        @songs          = load_songs
-      end
-
-# Returns the songs associated with this database
-      def songs
-        if block_given?
-          @songs.each { |s| yield s }
-        end
-        @songs
+        @songs          = []
+        @artists        = []
+        @albums         = []
+        load_songs
       end
 
 # Returns the playlists associated with this database
@@ -36,14 +45,13 @@ module Net
 
         playlists = []
         @daap.unpack_listing(listings) do |value|
+          playlist = Playlist.new( value.merge( 
+                                    :daap     => @daap,
+                                    :db       => self ))
           if block_given?
-            yield      Playlist.new( :pl_info  => value,
-                                     :daap     => @daap,
-                                     :db       => self )
+            yield playlist
           else
-            playlists << Playlist.new( :pl_info  => value,
-                                       :daap     => @daap,
-                                       :db       => self )
+            playlists << playlist
           end
         end
         playlists
@@ -56,13 +64,32 @@ module Net
 
         listings = @daap.dmap.find(@daap.do_get(path),
                              "daap.databasesongs/dmap.listing")
-        songs = []
+        artist_hash = {}
+        album_hash  = {}
         @daap.unpack_listing(listings) do |value|
-          songs << Song.new( :song_info => value,
-                             :daap      => @daap,
-                             :db        => self )
+          artist  = artist_hash[value['daap.songartist']] ||= Artist.new(value)
+          album   = album_hash[value['daap.songalbum']]   ||= Album.new(
+                              :name   => value['daap.songalbum'],
+                              :artist => artist )
+
+          song = Song.new(  value.merge(
+                            :daap      => @daap,
+                            :db        => self,
+                            :artist    => artist,
+                            :album     => album))
+
+          album.songs   << song
+          artist.songs  << song
+          @songs        << song
         end
-        songs
+
+        # Add each album to its artist
+        album_hash.each_value do |value|
+          value.artist.albums << value
+          @albums << value
+        end
+
+        artist_hash.each_value { |v| @artists << v }
       end
     end
   end

data/lib/net/daap/dmap.rb

@@ -4,8 +4,9 @@ module Net
 # structures.
     class DMAP
       def initialize(args)
-        @daap = args[:daap]
-        load_types
+        @daap           = args[:daap]
+        @big_endian     = "Ruby".unpack("i")[0] != 2036495698 ? true : false
+        @type_to_unpack = find_type
         update_content_codes
       end
 
@@ -24,9 +25,9 @@ module Net
       end
 
       private
-      def type_to_unpack
+      def find_type
         types = nil
-        if big_endian?
+        if @big_endian
           types = {
             1     => 'c',
             3     => 'S',
@@ -52,11 +53,6 @@ module Net
         types
       end
 
-      def big_endian?
-        return @big_endian if @big_endian
-        @big_endian = "Ruby".unpack("i")[0] != 2036495698 ? true : false
-      end
-
       def update_content_codes
         content_codes = unpack(@daap.do_get("content-codes"))
         mccr = seek(content_codes, "dmap.contentcodesresponse")
@@ -70,10 +66,8 @@ module Net
           end
           type = 9  if id == 'mcnm'
           type = 42 if id == 'pfdt'
-          @types[id] = { 'NAME' => name, 'ID' => id, 'TYPE' => type }
+          @@types[id] = { 'NAME' => name, 'ID' => id, 'TYPE' => type }
         end
-        #@types = short
-        @types
       end
 
       def flat_list_traverse(struct, list = [], prefix = '')
@@ -94,12 +88,10 @@ module Net
       def unpack(buffer = nil)
         tags = []
 
-        buffer = @code unless buffer
-
         while(buffer.length > 0)
           tag, len = nil, nil
 
-          if big_endian?
+          if @big_endian
             tag, len = buffer.unpack("a4L")
           else
             tag, len = buffer.unpack("a4N")
@@ -109,22 +101,22 @@ module Net
 
           buffer[0...8+len] = ''
 
-          type = @types[tag]['TYPE']
+          type = @@types[tag]['TYPE']
 
           if type == 12
             data = unpack(data)
           elsif type == 7
-            n1, n2 = big_endian? ? data.unpack("L2") : data.unpack("N2")
+            n1, n2 = @big_endian ? data.unpack("L2") : data.unpack("N2")
             data = n1 << 32
             data += n2
           else
-            data = data.unpack(type_to_unpack()[type])
+            data = data.unpack(@type_to_unpack[type])
           end
 
           if data.class == Array && data.length == 1 && data[0].class != Array || type == 11
-            tmp = [ @types[tag]['NAME'], data[0]]
+            tmp = [ @@types[tag]['NAME'], data[0]]
           else
-            tmp = [ @types[tag]['NAME'], data]
+            tmp = [ @@types[tag]['NAME'], data]
           end
 
           tags << tmp
@@ -148,9 +140,7 @@ module Net
         return struct
       end
 
-
-      def load_types
-      @types = 
+      @@types = 
           {
             'abal' => {
                         'ID' => 'abal',
@@ -598,7 +588,6 @@ module Net
                         'TYPE' => 11
                       }
           }
-        end
     end
   end
 end