rbrainz 0.3.0 → 0.4.0

data/CHANGES

@@ -1,5 +1,10 @@
 = Changelog
 
+== 0.4.0 (2007-12-16)
+* NEW: Complete tagging (folksonomy) support.
+* NEW: Support release event format.
+* NEW: Support for HTTP proxies
+
 == 0.3.0 (2007-08-11)
 * BUG: Relation end date was not set correctly in MBXML.
 * NEW: Allow release type constants to be passed to include and filter objects.
@@ -7,7 +12,6 @@
 * NEW: Methods Release#earliest_release_event and Release#earliest_release_date
 * NEW: Entity#get_relations allows string with or without namespace for
   target_type, relation_type and required_attributes
-* BUG: Corrected constant TYPE_PSEUDO_RELEASE
 
 == 0.2.1 (2007-07-24)
 * Erroneous date strings in the XML are ignored. No error is raised and nil
@@ -49,4 +53,4 @@
 == 0.1.0 (2007-05-23)
 * Initial release
 
-$Id: CHANGES 167 2007-08-11 09:18:30Z phw $
+$Id: CHANGES 192 2007-12-16 00:30:15Z phw $

data/doc/README.rdoc

@@ -71,6 +71,12 @@ should make the usage clear:
  Releases      : #{artist.releases.map{|r| r.title}.uniq.join("\r\n                ")}
  EOF
 
+== Unicode support
+The MusicBrainz webservice returns all data in UTF-8 encoding. RBrainz does
+not change or modify the encoding. So if you are using RBrainz you should be
+aware that all strings returned by RBrainz are UTF-8 encoded as well.
+Furthermore all strings you pass to RBrainz need to be UTF-8 encoded as well.
+
 == The MusicBrainz webservice
 For more information about the MusicBrainz webservice visit the
 following resources:
@@ -94,4 +100,4 @@ RBrainz is Copyright (c) 2007 Philipp Wolfer and Nigel Graham.
 It is free softare distributed under a BSD style license. See
 LICENSE[link:files/LICENSE.html] for details.
 
-$Id: README.rdoc 145 2007-07-19 13:11:44Z phw $
+$Id: README.rdoc 191 2007-12-04 13:30:26Z phw $

data/examples/getrelease.rb

@@ -3,7 +3,7 @@
 # Example script which queries the database for an
 # release and displays the release's data.
 # 
-# $Id: getrelease.rb 160 2007-07-27 13:18:04Z phw $
+# $Id: getrelease.rb 190 2007-12-04 12:51:17Z phw $
 
 # Just make sure we can run this example from the command
 # line even if RBrainz is not yet installed properly.

data/examples/getuser.rb

@@ -1,9 +1,8 @@
 #!/usr/bin/env ruby
 #
-# Example script which queries the database for a
-# User
+# Example script which queries the database for a user.
 # 
-# $Id: getuser.rb 145 2007-07-19 13:11:44Z phw $
+# $Id: getuser.rb 183 2007-10-16 22:13:33Z phw $
 
 # Just make sure we can run this example from the command
 # line even if RBrainz is not yet installed properly.

data/examples/searchreleases.rb

@@ -3,7 +3,7 @@
 # Example script which searches the database for
 # releases and displays the release data.
 # 
-# $Id: searchreleases.rb 160 2007-07-27 13:18:04Z phw $
+# $Id: searchreleases.rb 183 2007-10-16 22:13:33Z phw $
 
 # Just make sure we can run this example from the command
 # line even if RBrainz is not yet installed properly.
@@ -16,7 +16,7 @@ include MusicBrainz
 # Define the search parameters: Search for releases with the
 # title "Paradise Lost" and return a maximum of 10 releases.
 release_filter = Webservice::ReleaseFilter.new(
-  :title  => 'Draconian Times',
+  :artistid => '10bf95b6-30e3-44f1-817f-45762cdc0de0',
   :limit => 10
 )
 
@@ -31,5 +31,6 @@ releases = query.get_releases(release_filter)
 # Display the fetched release titles and the score, which
 # indicates how good the release matches the search parameters.
 releases.each do |entry|
-  print "%s (%i%%)\r\n" % [entry.entity.title, entry.score]
+  print "%s: %s (%i%%)\r\n" % [entry.entity.earliest_release_date,
+                               entry.entity.title, entry.score]
 end

data/examples/tag.rb

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+#
+# Example script showing the use of folksonomy tagging with RBrainz.
+# It asks the user for his username and password and a MBID and queries the
+# MusicBrainz server for the tags, the user has applied to the entitity with
+# the given MBID. Afterwards the user can submit new tags.
+# 
+# $Id: getuser.rb 145 2007-07-19 13:11:44Z phw $
+
+# Just make sure we can run this example from the command
+# line even if RBrainz is not yet installed properly.
+$: << 'lib/' << '../lib/'
+
+# Load RBrainz and include the MusicBrainz namespace.
+require 'rbrainz'
+include MusicBrainz
+
+# Get the username and password
+print 'Username: ' unless ARGV[0]
+username = ARGV[0] ? ARGV[0] : STDIN.gets.strip
+print 'Password: ' unless ARGV[1]
+password = ARGV[1] ? ARGV[1] : STDIN.gets.strip
+
+# Ask for a MBID to tag.
+print 'Enter a MBID: '
+mbid = Model::MBID.new(STDIN.gets.strip)
+
+ws = Webservice::Webservice.new(:username=>username, :password=>password) 
+
+# Create a new Query object which will provide
+# us an interface to the MusicBrainz web service.
+query = Webservice::Query.new(ws, :client_id => 'RBrainz test ' + RBRAINZ_VERSION)
+
+# Read and print the current tags for the given MBID
+tags = query.get_user_tags(mbid)
+print 'Current tags: '
+puts tags.to_a.join(', ')
+
+# Ask the user for new tags and submit them
+print 'Enter new tags: '
+new_tags = STDIN.gets.strip
+query.submit_user_tags(mbid, new_tags)

data/lib/rbrainz/core_ext/net_http_digest.rb

@@ -1,4 +1,4 @@
-# $Id: net_http_digest.rb 136 2007-07-16 15:45:32Z phw $
+# $Id: net_http_digest.rb 182 2007-10-16 14:46:17Z nigel_graham $
 #
 # Author::    Nigel Graham (mailto:nigel_graham@rubyforge.org)
 # Copyright:: Copyright (c) 2007, Nigel Graham, Philipp Wolfer
@@ -14,11 +14,47 @@ module Net # :nodoc:
   module HTTPHeader # :nodoc:
     @@nonce_count = -1
     CNONCE = Digest::MD5.new.update("%x" % (Time.now.to_i + rand(65535))).hexdigest
+    
+    def select_auth(user,password,response)
+      response['www-authenticate'] =~ /^(\w+) (.*)/
+      auth_type = $1
+      case auth_type
+        when 'Digest'
+          digest_auth(user,password,response)
+          return true
+        when 'Basic'
+          basic_auth(user,password)
+          return true
+      end
+      return false
+    end
+    
+    def proxy_select_auth(user, password, response)
+      response['proxy-authenticate'] =~ /^(\w+) (.*)/
+      auth_type = $1
+      case auth_type
+        when 'Digest'
+          proxy_digest_auth(user,password,response)
+          return true
+        when 'Basic'
+          proxy_basic_auth(user,password)
+          return true
+      end
+      return false
+    end
+    
     def digest_auth(user, password, response)
+      @header['Authorization'] = digest_encode(response['www-authenticate'], user, password)
+    end
+    
+    def proxy_digest_auth(user, password, response)
+      @header['Proxy-Authorization'] = digest_encode(response['proxy-authenticate'], user, password)
+    end
+    
+    def digest_encode(authenticate, user, password)
       @@nonce_count += 1
-
-      response['www-authenticate'] =~ /^(\w+) (.*)/
-
+      authenticate =~ /^(\w+) (.*)/
+      
       params = {}
       $2.gsub(/(\w+)="(.*?)"/) { params[$1] = $2 }
 
@@ -46,7 +82,8 @@ module Net # :nodoc:
       header << "nc=#{'%08x' % @@nonce_count}" if params['qop']
       header << "cnonce=\"#{CNONCE}\"" if params['qop']
       header << "response=\"#{Digest::MD5.new.update(request_digest).hexdigest}\""
-      @header['Authorization'] = header
+      
+      return header
     end
   end
 end

data/lib/rbrainz/model/collection.rb

@@ -1,4 +1,4 @@
-# $Id: collection.rb 130 2007-07-12 18:55:24Z nigel_graham $
+# $Id: collection.rb 172 2007-08-24 11:19:19Z phw $
 #
 # Author::    Philipp Wolfer (mailto:phw@rubyforge.org)
 # Copyright:: Copyright (c) 2007, Nigel Graham, Philipp Wolfer
@@ -42,9 +42,10 @@ module MusicBrainz
         end
       end
       
-      # Add a new element to this collection.
+      # Add a new element to this collection. Returns self.
       def <<(entry)
         @entries << entry
+        self # return self to allow something like collection << a << b
       end
       
       # Delete an element from the collection.
@@ -93,6 +94,7 @@ module MusicBrainz
       end
       alias to_ary to_a
       
+      # Duplicate this collection.
       def dup
         Collection.new(self.count, self.offset, @entries)
       end

data/lib/rbrainz/model/duration.rb

@@ -0,0 +1,96 @@
+
+# Represents a duration in milliseconds.
+class Duration < Numeric
+
+	def initialize(milliseconds=0)
+		@ms = milliseconds.to_i
+	end
+
+	def days
+		to_i / 86400000
+	end
+
+	def hours
+		to_i / 3600000 % 24
+	end
+
+	def minutes
+		to_i / 60000 % 60
+	end
+
+	def seconds
+		to_i / 1000 % 60
+	end
+
+	def milliseconds
+		to_i % 1000
+	end
+
+	def to_i
+		@ms
+	end
+
+	def to_f
+		@ms.to_f
+	end
+
+	def coerce(numeric)
+		if numeric.is_a?(Integer)
+			[numeric, to_i]
+		else
+			[Float.induced_from(numeric), to_f]
+		end
+	end
+
+#	def method_missing(m, *args)
+#		if ['%'.to_sym, '+'.to_sym, '-'.to_sym, '*'.to_sym, '/'.to_sym].include?(m)
+#			self.class.new(@ms.send(m, *args))
+#		end
+#	end
+
+	def <=> other
+		to_i <=> other
+	end
+	
+	def % other
+		Duration.new(to_i % other)
+	end
+
+	def + other
+		Duration.new(to_i + other)
+	end
+
+	def - other
+		Duration.new(to_i - other)
+	end
+
+	def * other
+		Duration.new(to_i * other)
+	end
+
+	def / other
+		Duration.new(to_i / other)
+	end
+
+	def ** other
+		Duration.new(to_i ** other)
+	end
+
+end
+
+require 'delegate'
+
+#class Duration < DelegateClass(Fixnum)
+#
+#	def x_method_missing(m, *args, &block)
+#		if block_given?
+#			result = super m, *args
+#		else
+#			result = super m, *args, &block
+#		end
+#		result.is_a?(Integer) ? Duration.new(result) : result
+#	end
+#
+#end
+
+

data/lib/rbrainz/model/relation.rb

@@ -1,4 +1,4 @@
-# $Id: relation.rb 151 2007-07-24 08:36:27Z phw $
+# $Id: relation.rb 173 2007-08-24 15:11:11Z phw $
 #
 # Author::    Philipp Wolfer (mailto:phw@rubyforge.org)
 # Copyright:: Copyright (c) 2007, Nigel Graham, Philipp Wolfer
@@ -55,6 +55,9 @@ module MusicBrainz
       attr_accessor :direction
       
       # The relation's target object.
+      # 
+      # The target can either be an object of the type Model::Entity
+      # or a URL if the type of the relation is TO_URL.
       attr_reader :target
       
       # The list of attributes describing this relation.
@@ -87,8 +90,8 @@ module MusicBrainz
       
       # Set the target of this relation.
       # 
-      # The _target_ can either be a object of the type Model::Entity
-      # or a URL.
+      # The _target_ can either be an object of the type Model::Entity
+      # or a URL if the type of the relation is TO_URL.
       def target=(target)
         if target.is_a? Entity
           @target = target

data/lib/rbrainz/model/release.rb

@@ -1,4 +1,4 @@
-# $Id: release.rb 167 2007-08-11 09:18:30Z phw $
+# $Id: release.rb 190 2007-12-04 12:51:17Z phw $
 #
 # Author::    Philipp Wolfer (mailto:phw@rubyforge.org)
 # Copyright:: Copyright (c) 2007, Nigel Graham, Philipp Wolfer
@@ -73,7 +73,7 @@ module MusicBrainz
       TYPE_BOOTLEG        = NS_MMD_1 + 'Bootleg'
       # A pseudo-release is a duplicate release for translation/transliteration
       # purposes.
-      TYPE_PSEUDO_RELEASE = NS_MMD_1 + 'Pseudo-Release'
+      TYPE_PSEUDO_RELEASE = NS_MMD_1 + 'PseudoRelease'
       
       # See Entity::ENTITY_TYPE.
       ENTITY_TYPE = :release # :nodoc:
@@ -161,8 +161,8 @@ module MusicBrainz
       # Returns the earliest release date as an IncompleteDate.
       # 
       # This favours complete dates. For example, '2006-09' is
-	  # returned if there is '2000', too. If there is no release
-	  # event associated with this release, +nil+ is returned.
+      # returned if there is '2000', too. If there is no release
+      # event associated with this release, +nil+ is returned.
       # 
       # See:: earliest_release_date
       def earliest_release_event
@@ -176,7 +176,7 @@ module MusicBrainz
         return earliest_event
       end
       
-      # Returns the earliest release event or +nil+.
+      # Returns the date of the earliest release event or +nil+.
       # 
       # See:: earliest_release_event
       def earliest_release_date
@@ -190,7 +190,7 @@ module MusicBrainz
       def to_s
         title.to_s
       end
-      
+            
     end
     
   end    

data/lib/rbrainz/model/release_event.rb

@@ -1,4 +1,4 @@
-# $Id: release_event.rb 151 2007-07-24 08:36:27Z phw $
+# $Id: release_event.rb 189 2007-11-26 00:10:49Z phw $
 #
 # Author::    Philipp Wolfer (mailto:phw@rubyforge.org)
 # Copyright:: Copyright (c) 2007, Nigel Graham, Philipp Wolfer
@@ -18,10 +18,29 @@ module MusicBrainz
     # 'UK' or 'FR'). The dates are instances of IncompleteDate or strings which
     # must have the format 'YYYY', 'YYYY-MM' or 'YYYY-MM-DD'.
     #
+    # The format of the release medium is a URI that can be compared to the
+    # constants on this class (FORMAT_CD, FORMAT_DVD and others).
+    #
     # See:: http://musicbrainz.org/doc/ReleaseEvent.
     #
     class ReleaseEvent
     
+      FORMAT_CD           = NS_MMD_1 + 'CD'
+      FORMAT_DVD          = NS_MMD_1 + 'DVD'
+      FORMAT_SACD         = NS_MMD_1 + 'SACD'
+      FORMAT_DUALDISC     = NS_MMD_1 + 'DualDisc'
+      FORMAT_LASERDISC    = NS_MMD_1 + 'LaserDisc'
+      FORMAT_MINIDISC     = NS_MMD_1 + 'MiniDisc'
+      FORMAT_VINYL        = NS_MMD_1 + 'Vinyl'
+      FORMAT_CASSETTE     = NS_MMD_1 + 'Cassette'
+      FORMAT_CARTRIDGE    = NS_MMD_1 + 'Cartridge'
+      FORMAT_REEL_TO_REEL = NS_MMD_1 + 'ReelToReel'
+      FORMAT_DAT          = NS_MMD_1 + 'DAT'
+      FORMAT_DIGITAL      = NS_MMD_1 + 'Digital'
+      FORMAT_WAX_CYLINDER = NS_MMD_1 + 'WaxCylinder'
+      FORMAT_PIANO_ROLL   = NS_MMD_1 + 'PianoRoll'
+      FORMAT_OTHER        = NS_MMD_1 + 'Other'
+    
       # The country in which an album was released.
       # A string containing a ISO 3166 country code like
       # 'GB', 'US' or 'DE'.
@@ -42,6 +61,9 @@ module MusicBrainz
       # The release date. An instance of IncompleteDate.
       attr_reader :date
       
+      # The media format of the release (e.g. CD or Vinyl).
+      attr_accessor :format
+      
       def initialize(country=nil, date=nil)
         self.country = country
         self.date    = date

data/lib/rbrainz/model/scored_collection.rb

@@ -1,4 +1,4 @@
-# $Id: scored_collection.rb 136 2007-07-16 15:45:32Z phw $
+# $Id: scored_collection.rb 172 2007-08-24 11:19:19Z phw $
 #
 # Author::    Philipp Wolfer (mailto:phw@rubyforge.org)
 # Copyright:: Copyright (c) 2007, Nigel Graham, Philipp Wolfer
@@ -55,7 +55,7 @@ module MusicBrainz
         return map {|entry| entry.entity}
       end
       
-      # Add a new entry to the collection.
+      # Add a new entry to the collection. . Returns self.
       # 
       # You may either add a ScoredCollection::Entry, just an Model::Entity
       # or an object responding to +first+ and +last+ where +first+ must
@@ -68,6 +68,9 @@ module MusicBrainz
       #  collection << Model::ScoredCollection::Entry.new(artist, 100)
       #  collection << [artist, 100]
       #  collection << artist
+      #  
+      #  # Add several entities in one line
+      #  collection << artist_one << artist_two
       def <<(entry)
         super wrap(entry)
       end
@@ -80,6 +83,11 @@ module MusicBrainz
       def []=(index, entry)
         super wrap(entry)
       end
+
+      # Convert this ScoredCollection into a Collection without the scores.      
+      def to_collection
+        Collection.new(count, offset, entities)
+      end
       
       private #-----------------------------------------------------------------