rbrainz 0.1.0 → 0.1.1

data/lib/rbrainz/webservice/query.rb

@@ -1,4 +1,4 @@
-# $Id: query.rb 4 2007-05-21 02:04:26Z phw $
+# $Id: query.rb 31 2007-05-29 02:38:42Z phw $
 # Copyright (c) 2007, Philipp Wolfer
 # All rights reserved.
 # See LICENSE for permissions.
@@ -16,8 +16,7 @@ module MusicBrainz
       end
       
       def get_artist_by_id(id, include = nil)
-        xml = @webservice.get(Model::Artist.entity_type, id, :include => include)
-        return MBXML.new(xml).get_entity(Model::Artist.entity_type)
+        return get_entity_by_id(Model::Artist.entity_type, id, include)
       end
       
       # TODO: implement
@@ -26,8 +25,7 @@ module MusicBrainz
       end
       
       def get_release_by_id(id, include = nil)
-        xml = @webservice.get(Model::Release.entity_type, id, :include => include)
-        return MBXML.new(xml).get_entity(Model::Release.entity_type)
+        return get_entity_by_id(Model::Release.entity_type, id, include)
       end
       
       # TODO: implement
@@ -36,8 +34,7 @@ module MusicBrainz
       end
       
       def get_track_by_id(id, include = nil)
-        xml = @webservice.get(Model::Track.entity_type, id, :include => include)
-        return MBXML.new(xml).get_entity(Model::Track.entity_type)
+        return get_entity_by_id(Model::Track.entity_type, id, include)
       end
       
       # TODO: implement
@@ -46,8 +43,7 @@ module MusicBrainz
       end
       
       def get_label_by_id(id, include = nil)
-        xml = @webservice.get(Model::Label.entity_type, id, :include => include)
-        return MBXML.new(xml).get_entity(Model::Label.entity_type)
+        return get_entity_by_id(Model::Label.entity_type, id, include)
       end
       
       # TODO: implement
@@ -55,6 +51,14 @@ module MusicBrainz
         raise NotImplementedError.new
       end
       
+      private
+      
+      # Helper method which will return any entity by ID.
+      def get_entity_by_id(entity_type, id, include)
+        xml = @webservice.get(entity_type, id, :include => include)
+        return MBXML.new(xml).get_entity(entity_type)
+      end
+      
     end
 
   end

data/lib/rbrainz/webservice/webservice.rb

@@ -1,4 +1,4 @@
-# $Id: webservice.rb 4 2007-05-21 02:04:26Z phw $
+# $Id: webservice.rb 36 2007-05-29 18:43:36Z phw $
 # Copyright (c) 2007, Philipp Wolfer
 # All rights reserved.
 # See LICENSE for permissions.
@@ -22,7 +22,7 @@ module MusicBrainz
       # Must be implemented by the concrete webservices.
       # TODO: Specify and implement in Webservice.
       def post
-        raise Exception.new('Called abstract method.')
+        raise NotImplementedError.new('Called abstract method.')
       end
       
     end
@@ -31,24 +31,54 @@ module MusicBrainz
     # TODO: Implement authorization.
     class Webservice < IWebservice
     
+      # Timeouts for opening and reading connections (in seconds)
+      attr_accessor :open_timeout, :read_timeout
+    
       def initialize(options = {:host => nil, :port => nil, :path_prefix => nil})
         @host = options[:host] ? options[:host] : 'musicbrainz.org'
         @port = options[:port] ? options[:port] : 80
         @path_prefix = options[:path_prefix] ? options[:path_prefix] : '/ws'
+        @open_timeout = nil
+        @read_timeout = nil
       end
     
       # Query the Webservice with HTTP GET.
-      # TODO: Exception handling.
+      # 
+      # Raises: +RequestError+, +ResourceNotFoundError+, +AuthenticationError+,
+      # +ConnectionError+ 
       def get(entity, id, options = {:include => nil, :filter => nil, :version => 1})
         url = URI.parse(create_uri(entity, id, options))
-        req = Net::HTTP::Get.new(url.request_uri)
-        res = Net::HTTP.start(url.host, url.port) {|http|
-          http.request(req)
-        }
-        return res.body
+        request = Net::HTTP::Get.new(url.request_uri)
+        connection = Net::HTTP.new(url.host, url.port)
+        
+        # Set timeouts
+        connection.open_timeout = @open_timeout if @open_timeout
+        connection.read_timeout = @read_timeout if @read_timeout
+        
+        # Make the request
+        begin
+          response = connection.start {|http|
+            http.request(request)
+          }
+        rescue Timeout::Error, Errno::ETIMEDOUT
+          raise ConnectionError.new('%s timed out' % url.to_s)
+        end
+        
+        # Handle response errors.
+        if response.is_a? Net::HTTPBadRequest # 400
+          raise RequestError.new(url.to_s)
+        elsif response.is_a? Net::HTTPUnauthorized # 401
+          raise AuthenticationError.new(url.to_s)
+        elsif response.is_a? Net::HTTPNotFound # 404
+          raise ResourceNotFoundError.new(url.to_s)
+        elsif not response.is_a? Net::HTTPSuccess
+          raise ConnectionError.new(response.class.name)
+        end
+        
+        return response.body
       end
       
-      private
+      private # ----------------------------------------------------------------
       
       # Builds a request URI for querying the webservice.
       def create_uri(entity, id, options = {:include => nil, :filter => nil, :version => 1})

data/test/lib/test_entity.rb

@@ -1,4 +1,4 @@
-# $Id$
+# $Id: test_entity.rb 29 2007-05-29 02:03:36Z phw $
 # Copyright (c) 2007, Philipp Wolfer
 # All rights reserved.
 # See LICENSE for permissions.
@@ -50,9 +50,71 @@ module TestEntity
     assert_equal nil, entity.id
   end
 
-  # Relations will get implemented in version 0.1.1
-  #def test_relations
-  #  assert false, 'Unit test for ' + self.class.name + ' not implemented!'
-  #end
+  def test_relations
+    entity = @tested_class.new
+    
+    # Create some test relations
+    artist_rel = Model::Relation.new
+    artist_rel.target = Model::Artist.new
+    artist_rel.type = Model::NS_REL_1 + 'Vocal'
+    artist_rel.direction = Model::Relation::DIR_BACKWARD
+    artist_rel.attributes << 'Guest'
+    artist_rel.attributes << 'Lead'
+    assert_nothing_raised {entity.add_relation artist_rel}
+    
+    track_rel = Model::Relation.new
+    track_rel.target = Model::Track.new
+    track_rel.type = Model::NS_REL_1 + 'Vocal'
+    track_rel.direction = Model::Relation::DIR_FORWARD
+    track_rel.attributes << 'Lead'
+    track_rel.attributes << 'Guest'
+    assert_nothing_raised {entity.add_relation track_rel}
+    
+    url_rel = Model::Relation.new
+    url_rel.target = 'http://www.example.com'
+    url_rel.type = Model::NS_REL_1 + 'OfficialHomepage'
+    assert_nothing_raised {entity.add_relation url_rel}
+    
+    # Get all relations
+    rel_list = []
+    assert_nothing_raised {rel_list = entity.get_relations()}
+    assert_equal 3, rel_list.size
+    assert rel_list.include?(artist_rel)
+    assert rel_list.include?(track_rel)
+    assert rel_list.include?(url_rel)
+  
+    # Get only artist relation by target type
+    assert_nothing_raised {rel_list = entity.get_relations(
+                             :target_type => Model::Relation::TO_ARTIST)}
+    assert_equal 1, rel_list.size
+    assert rel_list.include?(artist_rel)
+    
+    # Get only url relation type
+    assert_nothing_raised {rel_list = entity.get_relations(
+                             :relation_type => Model::NS_REL_1 + 'OfficialHomepage')}
+    assert_equal 1, rel_list.size
+    assert rel_list.include?(url_rel)
+    
+    # Get only artist and track relation by attribute
+    assert_nothing_raised {rel_list = entity.get_relations(
+                             :required_attributes => ['Guest', 'Lead'])}
+    assert_equal 2, rel_list.size
+    assert rel_list.include?(artist_rel)
+    assert rel_list.include?(track_rel)
+    
+    # Get only artist relation by target type
+    assert_nothing_raised {rel_list = entity.get_relations(
+                             :direction => Model::Relation::DIR_BACKWARD)}
+    assert_equal 1, rel_list.size
+    assert rel_list.include?(artist_rel)
+    
+    # Test the target types
+    target_types = entity.relation_target_types
+    assert_equal 3, target_types.size, target_types.inspect
+    [Model::Relation::TO_ARTIST, Model::Relation::TO_TRACK,
+     Model::Relation::TO_URL].each {|type|
+      assert target_types.include?(type), target_types.inspect
+    }
+  end
   
 end

data/test/lib/testing_helper.rb

@@ -1,4 +1,4 @@
-# $Id$
+# $Id: testing_helper.rb 27 2007-05-28 23:15:21Z phw $
 # Copyright (c) 2007, Philipp Wolfer
 # All rights reserved.
 # See LICENSE for permissions.

data/test/test_alias.rb

@@ -1,4 +1,4 @@
-# $Id$
+# $Id: test_alias.rb 27 2007-05-28 23:15:21Z phw $
 # Copyright (c) 2007, Philipp Wolfer
 # All rights reserved.
 # See LICENSE for permissions.

data/test/test_artist.rb

@@ -1,4 +1,4 @@
-# $Id$
+# $Id: test_artist.rb 30 2007-05-29 02:12:33Z phw $
 # Copyright (c) 2007, Philipp Wolfer
 # All rights reserved.
 # See LICENSE for permissions.
@@ -100,13 +100,6 @@ class TestArtist < Test::Unit::TestCase
     assert_equal 0, artist.releases.size
   end
   
-  # You can pass an array of releases to add them all.
-  def test_add_several_releases_at_once
-    artist = Model::Artist.new
-    assert_nothing_raised {artist.releases = @releases}
-    assert_equal @releases, artist.releases
-  end
- 
   # Many aliases can be added
   def test_add_and_remove_aliases
     artist = Model::Artist.new
@@ -122,11 +115,4 @@ class TestArtist < Test::Unit::TestCase
     assert_equal 0, artist.aliases.size
   end
   
-  # You can pass an array of aliases to add them all.
-  def test_add_several_aliases_at_once
-    artist = Model::Artist.new
-    assert_nothing_raised {artist.aliases = @aliases}
-    assert_equal @aliases, artist.aliases
-  end
- 
 end

data/test/test_artist_filter.rb

@@ -1,4 +1,4 @@
-# $Id$
+# $Id: test_artist_filter.rb 27 2007-05-28 23:15:21Z phw $
 # Copyright (c) 2007, Philipp Wolfer
 # All rights reserved.
 # See LICENSE for permissions.

data/test/test_artist_includes.rb

@@ -1,4 +1,4 @@
-# $Id$
+# $Id: test_artist_includes.rb 27 2007-05-28 23:15:21Z phw $
 # Copyright (c) 2007, Philipp Wolfer
 # All rights reserved.
 # See LICENSE for permissions.

data/test/test_disc.rb

@@ -1,4 +1,4 @@
-# $Id$
+# $Id: test_disc.rb 27 2007-05-28 23:15:21Z phw $
 # Copyright (c) 2007, Philipp Wolfer
 # All rights reserved.
 # See LICENSE for permissions.

data/test/test_incomplete_date.rb

@@ -1,4 +1,4 @@
-# $Id$
+# $Id: test_incomplete_date.rb 27 2007-05-28 23:15:21Z phw $
 # Copyright (c) 2007, Philipp Wolfer
 # All rights reserved.
 # See LICENSE for permissions.

data/test/test_label.rb

@@ -1,4 +1,4 @@
-# $Id$
+# $Id: test_label.rb 30 2007-05-29 02:12:33Z phw $
 # Copyright (c) 2007, Philipp Wolfer
 # All rights reserved.
 # See LICENSE for permissions.
@@ -119,11 +119,4 @@ class TestLabel < Test::Unit::TestCase
     assert_equal 0, label.releases.size
   end
   
-  # You can pass an array of releases to add them all.
-  def test_add_several_releases_at_once
-    label = Model::Label.new
-    assert_nothing_raised {label.releases = @releases}
-    assert_equal @releases, label.releases
-  end
-  
 end

data/test/test_label_filter.rb

@@ -1,4 +1,4 @@
-# $Id$
+# $Id: test_label_filter.rb 27 2007-05-28 23:15:21Z phw $
 # Copyright (c) 2007, Philipp Wolfer
 # All rights reserved.
 # See LICENSE for permissions.

data/test/test_label_includes.rb

@@ -1,4 +1,4 @@
-# $Id$
+# $Id: test_label_includes.rb 27 2007-05-28 23:15:21Z phw $
 # Copyright (c) 2007, Philipp Wolfer
 # All rights reserved.
 # See LICENSE for permissions.

data/test/test_mbid.rb

@@ -1,4 +1,4 @@
-# $Id$
+# $Id: test_mbid.rb 27 2007-05-28 23:15:21Z phw $
 # Copyright (c) 2007, Philipp Wolfer
 # All rights reserved.
 # See LICENSE for permissions.

data/test/test_mbxml.rb

@@ -1,4 +1,4 @@
-# $Id$
+# $Id: test_mbxml.rb 33 2007-05-29 14:48:47Z phw $
 # Copyright (c) 2007, Philipp Wolfer
 # All rights reserved.
 # See LICENSE for permissions.
@@ -107,7 +107,25 @@ class TestMBXML < Test::Unit::TestCase
     mbxml = Webservice::MBXML.new IO.read(DATA_PATH + 'artist/Tori_Amos_3.xml')
     artist = mbxml.get_entity(:artist)
     
-    assert false, 'Test not implemented'
+    assert_equal 'c0b2500e-0cef-4130-869d-732b23ed9df5', artist.id.uuid
+    assert_equal Model::Artist::TYPE_PERSON, artist.type
+    assert_equal 'Tori Amos', artist.name
+    assert_equal 'Amos, Tori', artist.sort_name
+    assert_equal '1963-08-22', artist.begin_date.to_s
+    
+    artist_rels = artist.get_relations(:target_type => Model::Relation::TO_ARTIST)
+    assert_equal 1, artist_rels.size
+    assert_equal Model::NS_REL_1 + 'Married', artist_rels[0].type
+    assert_equal Model::Relation::DIR_BACKWARD, artist_rels[0].direction
+    assert_equal Model::IncompleteDate.new('1998'), artist_rels[0].begin_date
+    assert artist_rels[0].target.is_a?(Model::Artist)
+    
+    url_rels = artist.get_relations(:target_type => Model::Relation::TO_URL)
+    assert_equal 2, url_rels.size
+    assert_equal Model::NS_REL_1 + 'Discography', url_rels[0].type
+    assert_equal 'http://www.yessaid.com/albums.html', url_rels[0].target
+    assert_equal Model::NS_REL_1 + 'Wikipedia', url_rels[1].type
+    assert_equal 'http://en.wikipedia.org/wiki/Tori_Amos', url_rels[1].target
   end
 
   def test_artist_tori_amos_4
@@ -283,7 +301,17 @@ class TestMBXML < Test::Unit::TestCase
     mbxml = Webservice::MBXML.new IO.read(DATA_PATH + 'track/Silent_All_These_Years_2.xml')
     track = mbxml.get_entity(:track)
     
-    assert false, 'Test not implemented'
+    assert_equal 'd6118046-407d-4e06-a1ba-49c399a4c42f', track.id.uuid
+    assert_equal 'Silent All These Years', track.title
+    assert_equal 253466, track.duration
+    assert_equal 'c0b2500e-0cef-4130-869d-732b23ed9df5', track.artist.id.uuid
+    
+    track_rels = track.get_relations(:target_type => Model::Relation::TO_TRACK)
+    assert_equal 1, track_rels.size, track.get_relations.inspect
+    assert_equal Model::NS_REL_1 + 'Cover', track_rels[0].type
+    assert_equal Model::Relation::DIR_BACKWARD, track_rels[0].direction
+    assert track_rels[0].target.is_a?(Model::Track)
+    assert_equal '5bcd4eaa-fae7-465f-9f03-d005b959ed02', track_rels[0].target.artist.id.uuid
   end
 
   def test_track_silent_all_these_years_3
@@ -313,11 +341,18 @@ class TestMBXML < Test::Unit::TestCase
     assert_equal '42ab76ea-5d42-4259-85d7-e7f2c69e4485', track.puids[6]
   end
 
+  # This test is similiar to silent_all_these_years_3, but it includes an
+  # schema exctension which mustn't disturb the parsing.
   def test_track_silent_all_these_years_5
     mbxml = Webservice::MBXML.new IO.read(DATA_PATH + 'track/Silent_All_These_Years_5.xml')
     track = mbxml.get_entity(:track)
     
-    assert false, 'Test not implemented'
+    assert_equal 'd6118046-407d-4e06-a1ba-49c399a4c42f', track.id.uuid
+    assert_equal 'Silent All These Years', track.title
+    assert_equal 253466, track.duration
+    assert_equal 7, track.puids.size
+    assert_equal 'c2a2cee5-a8ca-4f89-a092-c3e1e65ab7e6', track.puids[0]
+    assert_equal '42ab76ea-5d42-4259-85d7-e7f2c69e4485', track.puids[6]
   end
 
   def test_label_search

data/test/test_query.rb

@@ -1,4 +1,4 @@
-# $Id$
+# $Id: test_query.rb 27 2007-05-28 23:15:21Z phw $
 # Copyright (c) 2007, Philipp Wolfer
 # All rights reserved.
 # See LICENSE for permissions.

data/test/test_relation.rb

@@ -0,0 +1,116 @@
+# $Id: test_relation.rb 33 2007-05-29 14:48:47Z phw $
+# Copyright (c) 2007, Philipp Wolfer
+# All rights reserved.
+# See LICENSE for permissions.
+
+require 'test/unit'
+require 'rbrainz/model'
+include MusicBrainz
+
+# Unit test for the Relation model.
+class TestRelation < Test::Unit::TestCase
+
+  def setup
+    @target_entity = Model::Artist.new
+    @target_entity.id = Model::MBID.from_uuid :artist, '727ad90b-7ef4-48d2-8f16-c34016544822'
+  end
+
+  def teardown
+  end
+  
+  def test_new_relation
+    disc = nil
+    assert_nothing_raised {disc = Model::Relation.new}
+  end
+  
+  def test_type
+    relation = Model::Relation.new
+    assert relation.type.nil?
+    assert_nothing_raised {relation.type = Model::NS_REL_1 + 'Performer'}
+    assert_equal Model::NS_REL_1 + 'Performer', relation.type
+  end
+
+  def test_direction
+    relation = Model::Relation.new
+    assert relation.direction.nil?
+    [Model::Relation::DIR_BACKWARD, Model::Relation::DIR_FORWARD,
+     Model::Relation::DIR_BOTH].each {|dir|
+      assert_nothing_raised {relation.direction = dir}
+      assert_equal dir, relation.direction
+    }
+  end
+
+  def test_begin_date
+    relation = Model::Relation.new
+    date = Model::IncompleteDate.new '1988-04-18'
+    assert_nothing_raised {relation.begin_date}
+    assert_equal nil, relation.begin_date
+    assert_nothing_raised {relation.begin_date = date}
+    assert_equal date, relation.begin_date
+    
+    # It should be able to supply a date as a string,
+    # but Relation should convert it to an IncompleteDate.
+    assert_nothing_raised {relation.begin_date = '1988-04-20'}
+    assert_equal Model::IncompleteDate.new('1988-04-20'), relation.begin_date
+  end
+
+  def test_end_date
+    relation = Model::Relation.new
+    date = Model::IncompleteDate.new '1988-04-18'
+    assert_nothing_raised {relation.end_date}
+    assert_equal nil, relation.end_date
+    assert_nothing_raised {relation.end_date = date}
+    assert_equal date, relation.end_date
+    
+    # It should be able to supply a date as a string,
+    # but Relation should convert it to an IncompleteDate.
+    assert_nothing_raised {relation.end_date = '1988-04-20'}
+    assert_equal Model::IncompleteDate.new('1988-04-20'), relation.end_date
+  end
+  
+  def test_target
+    relation = Model::Relation.new
+    assert relation.target.nil?
+    assert_nothing_raised {relation.target = @target_entity}
+    assert_equal @target_entity, relation.target
+    assert_nothing_raised {relation.target = 'http://www.example.com'}
+    assert_equal 'http://www.example.com', relation.target
+  end
+  
+  # Target type is read-only and is automatically set
+  # when the target is set.
+  def test_target_type
+    relation = Model::Relation.new
+    assert relation.target_type.nil?
+    assert_raise(NoMethodError) {relation.target_type = Model::Relation::TO_RELEASE}
+    
+    relation.target = Model::Artist.new
+    assert_equal Model::Relation::TO_ARTIST, relation.target_type
+    
+    relation.target = Model::Release.new
+    assert_equal Model::Relation::TO_RELEASE, relation.target_type
+    
+    relation.target = Model::Track.new
+    assert_equal Model::Relation::TO_TRACK, relation.target_type
+    
+    relation.target = Model::Label.new
+    assert_equal Model::Relation::TO_LABEL, relation.target_type
+    
+    relation.target = 'http://www.example.com'
+    assert_equal Model::Relation::TO_URL, relation.target_type
+  end
+
+  def test_attributes
+    relation = Model::Relation.new
+    assert_equal 0, relation.attributes.size
+    assert_nothing_raised {relation.attributes << Model::NS_REL_1 + 'Lead'}
+    assert_equal 1, relation.attributes.size
+    assert_nothing_raised {relation.attributes.delete(Model::NS_REL_1 + 'Lead')}
+    assert_equal 0, relation.attributes.size
+  end
+  
+  # The to_s method could return a readable representation of the relation.
+  #def test_to_string
+  #end
+   
+end