rbrainz 0.1.1 → 0.2.0

data/lib/rbrainz/core_ext.rb

@@ -0,0 +1,8 @@
+# $Id: core_ext.rb 132 2007-07-12 19:55:52Z phw $
+#
+# Author::    Nigel Graham (mailto:nigel_graham@rubyforge.org)
+# Copyright:: Copyright (c) 2007, Nigel Graham, Philipp Wolfer
+# License::   RBrainz is free software distributed under a BSD style license.
+#             See LICENSE[file:../LICENSE.html] for permissions.
+
+Dir[File.dirname(__FILE__) + "/core_ext/*.rb"].each { |file| require(file) }

data/lib/rbrainz/core_ext/mbid.rb

@@ -0,0 +1,30 @@
+# $Id: mbid.rb 148 2007-07-19 17:26:33Z phw $
+#
+# Core extensions to add a to_mbid conversion to existing classes.
+# 
+# Author::    Philipp Wolfer (mailto:phw@rubyforge.org)
+# Copyright:: Copyright (c) 2007, Nigel Graham, Philipp Wolfer
+# License::   RBrainz is free software distributed under a BSD style license.
+#             See LICENSE[file:../LICENSE.html] for permissions.
+
+#
+class String
+  # Convert a string into a MusicBrainz::Model::MBID object of the given type.
+  # 
+  # Raises:: MusicBrainz::Model::EntityTypeNotMatchingError
+  def to_mbid(entity_type=nil)
+    ::MusicBrainz::Model::MBID.new(self, entity_type)
+  end
+end
+
+#
+module URI #:nodoc:
+  class HTTP
+    # Create a MusicBrainz::Model::MBID from a HTTP object of the given type.
+    # 
+    # Raises:: MusicBrainz::Model::EntityTypeNotMatchingError
+    def to_mbid(entity_type=nil)
+      ::MusicBrainz::Model::MBID.new(self.to_s, entity_type)
+    end
+  end
+end

data/lib/rbrainz/core_ext/net_http_digest.rb

@@ -0,0 +1,52 @@
+# $Id: net_http_digest.rb 136 2007-07-16 15:45:32Z phw $
+#
+# Author::    Nigel Graham (mailto:nigel_graham@rubyforge.org)
+# Copyright:: Copyright (c) 2007, Nigel Graham, Philipp Wolfer
+# License::   RBrainz is free software distributed under a BSD style license.
+#             See LICENSE[file:../LICENSE.html] for permissions.
+# Notes::     Based on http://textsnippets.com/posts/show/1075 and
+#             http://segment7.net/projects/ruby/snippets/digest_auth.rb
+
+require 'digest/md5'
+require 'net/http'
+
+module Net # :nodoc:
+  module HTTPHeader # :nodoc:
+    @@nonce_count = -1
+    CNONCE = Digest::MD5.new.update("%x" % (Time.now.to_i + rand(65535))).hexdigest
+    def digest_auth(user, password, response)
+      @@nonce_count += 1
+
+      response['www-authenticate'] =~ /^(\w+) (.*)/
+
+      params = {}
+      $2.gsub(/(\w+)="(.*?)"/) { params[$1] = $2 }
+
+      a_1 = "#{user}:#{params['realm']}:#{password}"
+      a_2 = "#{@method}:#{@path}"
+      request_digest = ''
+      request_digest << Digest::MD5.new.update(a_1).hexdigest
+      request_digest << ':' << params['nonce']
+      if params['qop']
+        request_digest << ':' << ('%08x' % @@nonce_count)
+        request_digest << ':' << CNONCE
+        request_digest << ':' << params['qop'] 
+      end
+      request_digest << ':' << Digest::MD5.new.update(a_2).hexdigest
+
+      header = []
+      header << "Digest username=\"#{user}\""
+      header << "realm=\"#{params['realm']}\""
+
+      header << "qop=#{params['qop']}" if params['qop']
+
+      header << "algorithm=MD5"
+      header << "uri=\"#{@path}\""
+      header << "nonce=\"#{params['nonce']}\""
+      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
+    end
+  end
+end

data/lib/rbrainz/core_ext/range.rb

@@ -0,0 +1,28 @@
+# $Id: range.rb 136 2007-07-16 15:45:32Z phw $
+#
+# Author::    Nigel Graham (mailto:nigel_graham@rubyforge.org)
+# Copyright:: Copyright (c) 2007, Nigel Graham, Philipp Wolfer
+# License::   RBrainz is free software distributed under a BSD style license.
+#             See LICENSE[file:../LICENSE.html] for permissions.
+
+require File.dirname(__FILE__) + '/range/equality'
+
+class Range  #:nodoc:
+  include MusicBrainz::CoreExtensions::Range::Equality
+
+  alias :old_eql? :eql?
+  def eql?(b)
+    if b.kind_of? ::Range
+      self.begin == b.begin && self.open_end == b.open_end
+    else
+      self.begin == b && self.open_end == b.succ
+    end
+  end
+  remove_method :==
+  alias :== :eql?
+
+  alias :old_include? :include?
+  def include?(b)
+    self.started_by?(b) || self.contains?(b) || self.eql?(b) || self.finished_by?(b)
+  end
+end

data/lib/rbrainz/core_ext/range/equality.rb

@@ -0,0 +1,232 @@
+# $Id: equality.rb 137 2007-07-17 08:00:06Z phw $
+#
+# Author::    Nigel Graham (mailto:nigel_graham@rubyforge.org)
+# Copyright:: Copyright (c) 2007, Nigel Graham, Philipp Wolfer
+# License::   RBrainz is free software distributed under a BSD style license.
+#             See LICENSE[file:../LICENSE.html] for permissions.
+
+module MusicBrainz
+  module CoreExtensions # :nodoc:
+    module Range #:nodoc:
+    
+      ##
+      # Mixin module with equality operations for ranges.
+      # The built-in Range class is currently missing functions to compare a 
+      # Range with another Range. There exist 13 disjoint equality operations for ranges.
+      # This mixin implements them all and a few extra operations for commonly used combinations.
+      #
+      module Equality
+      
+        # <tt>a.before?(b)</tt> is true, if _a_ ends before the beginning of _b_.
+        # Same as <tt>b.after?(a)</tt>.
+        # 
+        #  |A------|
+        #            |B------|
+        def before?(b)
+          if b.kind_of? ::Range
+            self.open_end < b.begin
+          else
+            self.open_end < b
+          end
+        end
+        alias :< :before?
+
+        # <tt>a.after?(b)</tt> is true, if _a_ begins after the end of _b_.
+        # Same as <tt>b.before?(a)</tt>.
+        # 
+        #            |A------|
+        #  |B------|
+        def after?(b)
+          if b.kind_of? ::Range
+            b.open_end < self.begin
+          else
+            b.succ < self.begin
+          end
+        end
+        alias :> :after?
+
+=begin comment
+Allready exists in Range so we can't define it in the module
+        def eql?(b)
+          if b.kind_of? ::Range
+            puts "Range class eql?"
+            self.begin == b.begin && self.open_end == b.open_end
+          else
+            puts "b.class eql?"
+            self.begin == b && self.open_end == b.succ
+          end
+        end
+        alias :== :eql?
+=end
+
+        # <tt>a.meets_beginning_of?(b)</tt> is true, if _b_ begins exactly at the end of _a_.
+        # Same as <tt>b.meets_end_of?(a)</tt>.
+        # 
+        #  |A------|
+        #          |B------|
+        def meets_beginning_of?(b)
+          if b.kind_of? ::Range
+            self.open_end == b.begin
+          else
+            self.open_end == b
+          end
+        end
+
+        # <tt>a.meets_end_of?(b)</tt> is true, if _b_ ends exactly at the beginning of _a_.
+        # Same as <tt>b.meets_beginning_of?(a)</tt>.
+        # 
+        #          |A------|
+        #  |B------|
+        def meets_end_of?(b)
+          if b.kind_of? ::Range
+            b.open_end == self.begin
+          else
+            b.succ == self.begin
+          end
+        end
+
+        # <tt>a.overlaps_beginning_of?(b)</tt> is true, if _a_ overlaps the beginning of _b_.
+        # Same as <tt>b.overlaps_end_of?(a)</tt>.
+        # 
+        #  |A------|
+        #       |B------|
+        def overlaps_beginning_of?(b)
+          if b.kind_of? ::Range
+            self.begin < b.begin && self.open_end < b.open_end && b.begin < self.open_end
+          else
+            false
+          end
+        end
+
+        # <tt>a.overlaps_end_of?(b)</tt> is true, if _a_ overlaps the end of _b_.
+        # Same as <tt>b.overlaps_beginning_of?(a)</tt>.
+        # 
+        #       |A------|
+        #  |B------|
+        def overlaps_end_of?(b)
+          if b.kind_of? ::Range
+            b.begin < self.begin && b.open_end < self.open_end && self.begin < b.open_end
+          else
+            false
+          end
+        end
+
+        # <tt>a.during?(b)</tt> is true, if _a_ fits completely into _b_.
+        # Same as <tt>b.contains?(a)</tt>.
+        # 
+        #     |A------|
+        #  |B------------|
+        def during?(b)
+          if b.kind_of? ::Range
+            b.begin < self.begin && self.open_end < b.open_end
+          else
+            false
+          end
+        end
+
+        # <tt>a.contains?(b)</tt> is true, if _b_ fits completely into _a_.
+        # Same as <tt>b.during?(a)</tt>.
+        # 
+        #  |A------------|
+        #     |B------|
+        def contains?(b)
+          if b.kind_of? ::Range
+            self.begin < b.begin && b.open_end < self.open_end
+          else
+            self.begin < b && b.succ < self.open_end
+          end
+        end
+
+        # <tt>a.starts?(b)</tt> is true, if _a_ and _b_ have the same beginning
+        # but _b_ lasts longer than _a_.
+        # Same as <tt>b.started_by?(a)</tt>.
+        # 
+        #  |A------|
+        #  |B-----------|
+        def starts?(b)
+          if b.kind_of? ::Range
+            self.begin == b.begin && self.open_end < b.open_end
+          else
+            false
+          end
+        end
+
+        # <tt>a.started_by?(b)</tt> is true, if _a_ and _b_ have the same
+        # beginning but _a_ lasts longer than _b_.
+        # Same as <tt>b.starts?(a)</tt>.
+        # 
+        #  |A-----------|
+        #  |B------|
+        def started_by?(b)
+          if b.kind_of? ::Range
+            b.begin == self.begin && b.open_end < self.open_end
+          else
+            b == self.begin && b.succ < self.open_end
+          end
+        end
+
+        # <tt>a.finishes?(b)</tt> is true, if _a_ and _b_ have the same
+        # end but _a_ begins after _b_.
+        # Same as <tt>b.finished_by?(a)</tt>.
+        # 
+        #       |A------|
+        #  |B-----------|
+        def finishes?(b)
+          if b.kind_of? ::Range
+            b.begin < self.begin && self.open_end == b.open_end
+          else
+            false
+          end
+        end
+
+        # <tt>a.finished_by?(b)</tt> is true, if _a_ and _b_ have the same
+        # end but _b_ begins after _a_.
+        # Same as <tt>b.finishes?(a)</tt>.
+        # 
+        #  |A-----------|
+        #       |B------|
+        def finished_by?(b)
+          if b.kind_of? ::Range
+            self.begin < b.begin && b.open_end == self.open_end
+          else
+            self.begin < b && b.succ == self.open_end
+          end
+        end
+
+        # <tt>a <= b</tt> is the same as
+        # <tt>a.before?(b) or a.meets_beginning_of?(b)</tt>
+        def <=(b)
+          self.before?(b) || self.meets_beginning_of?(b)
+        end
+
+        # <tt>a >= b</tt> is the same as
+        # <tt>a.after?(b) or a.meets_end_of?(b)</tt>
+        def >=(b)
+          self.after?(b) || self.meets_end_of?(b)
+        end
+
+        # <tt>a.between?(b)</tt> is the same as
+        # <tt>a.starts?(b) or a.during?(b) or a.finishes?(b)</tt>
+        def between?(b)
+          self.starts?(b) || self.during?(b) || self.finishes?(b)
+        end
+
+=begin comment
+Allready exists in Range so we can't define it in the module
+        def include?(b)
+          self.started_by?(b) || self.contains?(b) || self.eql?(b) || self.finished_by?(b)
+        end
+=end
+
+        protected
+        def open_end # :nodoc:
+          if self.exclude_end?
+            self.end
+          else
+            self.end.succ
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rbrainz/data/countrynames.rb

@@ -1,12 +1,14 @@
-# $Id: countrynames.rb 4 2007-05-21 02:04:26Z phw $
-# Copyright (c) 2007, Philipp Wolfer
-# All rights reserved.
-# See LICENSE for permissions.
+# $Id: countrynames.rb 141 2007-07-17 14:21:12Z phw $
+#
+# Author::    Philipp Wolfer (mailto:phw@rubyforge.org)
+# Copyright:: Copyright (c) 2007, Nigel Graham, Philipp Wolfer
+# License::   RBrainz is free software distributed under a BSD style license.
+#             See LICENSE[file:../LICENSE.html] for permissions.
 
 module MusicBrainz
   module Data
   
-    # List of country names.
+    # See Utils#get_country_name
     COUNTRY_NAMES = {
     	'BD' => 'Bangladesh',
     	'BE' => 'Belgium',

data/lib/rbrainz/data/languagenames.rb

@@ -1,12 +1,15 @@
-# $Id: languagenames.rb 4 2007-05-21 02:04:26Z phw $
-# Copyright (c) 2007, Philipp Wolfer
-# All rights reserved.
-# See LICENSE for permissions.
+# $Id: languagenames.rb 141 2007-07-17 14:21:12Z phw $
+#
+# Author::    Philipp Wolfer (mailto:phw@rubyforge.org)
+# Copyright:: Copyright (c) 2007, Nigel Graham, Philipp Wolfer
+# License::   RBrainz is free software distributed under a BSD style license.
+#             See LICENSE[file:../LICENSE.html] for permissions.
 
 module MusicBrainz
   module Data
 
-	LANGUAGE_NAMES = {
+	# See Utils#get_language_name
+    LANGUAGE_NAMES = {
 		'ART' => 'Artificial (Other)',
 		'ROH' => 'Raeto-Romance',
 		'SCO' => 'Scots',

data/lib/rbrainz/data/releasetypenames.rb

@@ -0,0 +1,34 @@
+# $Id: releasetypenames.rb 141 2007-07-17 14:21:12Z phw $
+#
+# Author::    Philipp Wolfer (mailto:phw@rubyforge.org)
+# Copyright:: Copyright (c) 2007, Nigel Graham, Philipp Wolfer
+# License::   RBrainz is free software distributed under a BSD style license.
+#             See LICENSE[file:../LICENSE.html] for permissions.
+
+require 'rbrainz/model/release'
+
+module MusicBrainz
+  module Data
+  
+    # See Utils#get_release_type_name
+    RELEASE_TYPE_NAMES = {
+    	Model::Release::TYPE_ALBUM          => 'Album',
+    	Model::Release::TYPE_AUDIOBOOK      => 'Audiobook',
+    	Model::Release::TYPE_BOOTLEG        => 'Bootleg',
+    	Model::Release::TYPE_COMPILATION    => 'Compilation',
+        Model::Release::TYPE_EP             => 'EP',
+        Model::Release::TYPE_INTERVIEW      => 'Interview',
+        Model::Release::TYPE_LIVE           => 'Live',
+        Model::Release::TYPE_NONE           => 'None',
+        Model::Release::TYPE_OFFICIAL       => 'Official',
+        Model::Release::TYPE_OTHER          => 'Other',
+        Model::Release::TYPE_PROMOTION      => 'Promotion',
+        Model::Release::TYPE_PSEUDO_RELEASE => 'Pseudo-Release',
+        Model::Release::TYPE_REMIX          => 'Remix',
+        Model::Release::TYPE_SINGLE         => 'Single', 
+        Model::Release::TYPE_SOUNDTRACK     => 'Soundtrack',
+        Model::Release::TYPE_SPOKENWORD     => 'Spokenword'
+    }
+
+  end
+end

data/lib/rbrainz/data/scriptnames.rb

@@ -1,12 +1,15 @@
-# $Id: scriptnames.rb 4 2007-05-21 02:04:26Z phw $
-# Copyright (c) 2007, Philipp Wolfer
-# All rights reserved.
-# See LICENSE for permissions.
+# $Id: scriptnames.rb 141 2007-07-17 14:21:12Z phw $
+#
+# Author::    Philipp Wolfer (mailto:phw@rubyforge.org)
+# Copyright:: Copyright (c) 2007, Nigel Graham, Philipp Wolfer
+# License::   RBrainz is free software distributed under a BSD style license.
+#             See LICENSE[file:../LICENSE.html] for permissions.
 
 module MusicBrainz
   module Data
 
-    scriptNames = {
+    # See Utils#get_script_name
+    SCRIPT_NAMES = {
     	'Yiii' => 'Yi',
     	'Tel' => 'Telug',
     	'Taml' => 'Tamil',