rbrainz 0.1.0

data/lib/rbrainz/webservice/query.rb

@@ -0,0 +1,61 @@
+# $Id: query.rb 4 2007-05-21 02:04:26Z phw $
+# Copyright (c) 2007, Philipp Wolfer
+# All rights reserved.
+# See LICENSE for permissions.
+
+require 'rbrainz/webservice/webservice'
+require 'rbrainz/webservice/mbxml'
+
+module MusicBrainz
+  module Webservice
+
+    class Query
+    
+      def initialize(webservice = nil)
+        @webservice = webservice.nil? ? Webservice.new : webservice
+      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)
+      end
+      
+      # TODO: implement
+      def get_artists(filter)
+        raise NotImplementedError.new
+      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)
+      end
+      
+      # TODO: implement
+      def get_releases(filter)
+        raise NotImplementedError.new
+      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)
+      end
+      
+      # TODO: implement
+      def get_tracks(filter)
+        raise NotImplementedError.new
+      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)
+      end
+      
+      # TODO: implement
+      def get_labels(filter)
+        raise NotImplementedError.new
+      end
+      
+    end
+
+  end
+end

data/lib/rbrainz/webservice/webservice.rb

@@ -0,0 +1,69 @@
+# $Id: webservice.rb 4 2007-05-21 02:04:26Z phw $
+# Copyright (c) 2007, Philipp Wolfer
+# All rights reserved.
+# See LICENSE for permissions.
+
+require 'rbrainz/webservice/includes'
+require 'rbrainz/webservice/filter'
+require 'net/http'
+
+module MusicBrainz
+  module Webservice
+
+    class IWebservice
+      
+      # Query the Webservice with HTTP GET.
+      # Must be implemented by the concrete webservices.
+      def get(entity, id, options = {:include => nil, :filter => nil, :version => 1})
+        raise Exception.new('Called abstract method.')
+      end
+      
+      # Query the Webservice with HTTP POST.
+      # Must be implemented by the concrete webservices.
+      # TODO: Specify and implement in Webservice.
+      def post
+        raise Exception.new('Called abstract method.')
+      end
+      
+    end
+    
+    # Webservice class to query the default MusicBrainz server.
+    # TODO: Implement authorization.
+    class Webservice < IWebservice
+    
+      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'
+      end
+    
+      # Query the Webservice with HTTP GET.
+      # TODO: Exception handling.
+      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
+      end
+      
+      private
+      
+      # Builds a request URI for querying the webservice.
+      def create_uri(entity, id, options = {:include => nil, :filter => nil, :version => 1})
+        # Make sure the version is set
+        options[:version] = 1 if options[:version].nil?
+        
+        # Build the URI
+        uri  = 'http://%s:%d%s/%d/%s/%s?type=%s' %
+               [@host, @port, @path_prefix, options[:version], entity, id.uuid, 'xml']
+        uri += '&' + options[:include].to_s unless options[:include].nil?
+        uri += '&' + options[:filter].to_s unless options[:filter].nil?
+        return uri
+      end
+    
+    end
+    
+  end
+end

data/test/lib/test_entity.rb

@@ -0,0 +1,58 @@
+# $Id$
+# Copyright (c) 2007, Philipp Wolfer
+# All rights reserved.
+# See LICENSE for permissions.
+
+require 'test/unit'
+require 'rbrainz/model'
+include MusicBrainz
+
+# Unit test for the entity model.
+# This is only a test module which defines general
+# tests on Entity. The tests should be executed by
+# all subclass tests.
+module TestEntity
+
+  def test_valid_mbid
+    entity = @tested_class.new
+    valid_mbid = Model::MBID.from_uuid(@tested_class.entity_type, '9d30e408-1559-448b-b491-2f8de1583ccf')
+    
+    assert_equal nil, entity.id
+    assert_nothing_raised {entity.id = valid_mbid}
+    assert_equal valid_mbid, entity.id
+  end
+  
+  def test_valid_mbid_from_uuid
+    entity = @tested_class.new
+    valid_mbid = Model::MBID.from_uuid(@tested_class.entity_type, '9d30e408-1559-448b-b491-2f8de1583ccf')
+    
+    assert_equal nil, entity.id
+    assert_nothing_raised {entity.id = valid_mbid.uuid}
+    assert_equal valid_mbid, entity.id
+  end
+  
+  def test_valid_mbid_from_uri
+    entity = @tested_class.new
+    valid_mbid = Model::MBID.from_uuid(@tested_class.entity_type, '9d30e408-1559-448b-b491-2f8de1583ccf')
+    
+    assert_equal nil, entity.id
+    assert_nothing_raised {entity.id = valid_mbid.to_s}
+    assert_equal valid_mbid, entity.id
+  end
+  
+  def test_invalid_mbid_entity_type_not_matching
+    entity = @tested_class.new
+    @invalid_entity_types.each {|type|
+      invalid_mbid = Model::MBID.from_uuid(type, '9d30e408-1559-448b-b491-2f8de1583ccf')
+      assert_raise(Model::EntityTypeNotMatchingError) {entity.id = invalid_mbid}
+      assert_raise(Model::EntityTypeNotMatchingError) {entity.id = invalid_mbid.to_s}
+    }
+    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
+  
+end

data/test/lib/testing_helper.rb

@@ -0,0 +1,13 @@
+# $Id$
+# Copyright (c) 2007, Philipp Wolfer
+# All rights reserved.
+# See LICENSE for permissions.
+
+# Usefull helper methods which are used in different test classes.
+
+# Converts a query string into a hash.
+def query_string_to_hash query_string
+  Hash[*query_string.scan(/(.+?)=(.*?)(?:&|$)/).flatten].each_value {|v|
+    v.gsub!(/%([0-9a-f]{2})/i) { [$1.hex].pack 'C' }
+  }
+end

data/test/test-data/README

@@ -0,0 +1,13 @@
+MusicBrainz Web Service XML Examples
+------------------------------------
+
+This directory contains example XML code for testing an implementation.
+
+Implementations MUST be able to parse the XML in the 'valid' directory.
+It is perfect, schema-compliant XML.
+
+The 'invalid' directory contains all kinds of invalid XML. Implementations
+are not expected to parse those files. They MAY, however.
+
+--
+$Id: README 33 2006-01-30 09:50:19Z matt $

data/test/test-data/invalid/artist/basic_1.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!-- invalid, not wellformed -->
+
+<metadata xmlns="http://musicbrainz.org/ns/mmd-1.0#">
+
+    <artist-list>
+	<artist>   <!-- tag not closed -->
+
+    </artist-list>
+
+</metadata>

data/test/test-data/invalid/artist/basic_2.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!-- namespace error -->
+
+<mmd:metadata xmlns:mmd="http://musicbrainz.org/ns/mmd-1.0#">
+
+    <mmd:artist-list>
+	<xy:artist id="UUID"/>   <!-- undeclared namespace -->
+
+    </mmd:artist-list>
+
+</mmd:metadata>

data/test/test-data/invalid/artist/empty_2.xml

@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!-- invalid, not even the root element is present -->

data/test/test-data/invalid/artist/empty_3.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!-- invalid, namespace is missing -->
+
+<metadata>
+
+</metadata>

data/test/test-data/invalid/artist/search_result_1.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- invalid, because "score" must not be in the default namespace -->
+<metadata xmlns="http://musicbrainz.org/ns/mmd-1.0#">
+    <artist-list>
+        <artist id="c0b2500e-0cef-4130-869d-732b23ed9df5" score="100">
+            <name>Tori Amos</name>
+            <sort-name>Amos, Tori</sort-name>
+            <life-span begin="1963-08-22"/>
+        </artist>
+    </artist-list>
+</metadata>

data/test/test-data/valid/artist/Tchaikovsky-1.xml

@@ -0,0 +1,90 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<metadata xmlns="http://musicbrainz.org/ns/mmd-1.0#">
+    <artist id="9ddd7abc-9e1b-471d-8031-583bc6bc8be9" type="Person">
+        <name>Пётр Ильич Чайковский</name>
+        <sort-name>Tchaikovsky, Pyotr Ilyich</sort-name>
+        <life-span begin="1840-05-07" end="1893-11-06"/>
+        <alias-list>
+            <alias>Tchaikovsky</alias>  
+            <alias>Peter Ilyich Tchaikovsky</alias>  
+            <alias>Peter Tchaikovsky</alias>  
+            <alias>Tschaikowsky</alias>  
+            <alias>Peter Tschaikowsky</alias>  
+            <alias>Piotr Ilyich Tchaikovsky</alias>  
+            <alias>Piotr Tchaikovsky</alias>  
+            <alias>Peter Iljitsch Tschaikowsky</alias>  
+            <alias>Tchaikovsky, Peter Ilyich</alias>  
+            <alias>Peter Ilyitch Tchaikovsky</alias>  
+            <alias>Pjotr Ilyich Tchaikovsky</alias>  
+            <alias>Peter I. Tschaikowsky</alias>  
+            <alias>Pyotr Tchaikovsky</alias>  
+            <alias>P. I. Tchaikovsky</alias>  
+            <alias>Peter Ilich Tchaikovsky</alias>  
+            <alias>Tchaikovsky, P.I.</alias>  
+            <alias>Tsjaikovski</alias>  
+            <alias>Tchaikovsky, Pyotr Ilyich</alias>  
+            <alias>Tjajkovskij</alias>  
+            <alias>Piotr Ilyitch Tchaikovsky</alias>  
+            <alias>Tsjajkovskij</alias>  
+            <alias>Peter Ilyich Tchaikovski</alias>  
+            <alias>Peter I. Tchaikovsky</alias>  
+            <alias>Tchaikovsky, Peter I.</alias>  
+            <alias>Tchaikowsky</alias>  
+            <alias>Peter Ilyich Tschaikowsky</alias>  
+            <alias>Peter Iljitsch Tschaikowski</alias>  
+            <alias>Pyotr Il'Yich Tchaikovsky</alias>  
+            <alias>Tchiakovsky, Pyotr Ilich (1840-1893)</alias>  
+            <alias>Tchaikovsky, Peter Ilyich (1840-93)</alias>  
+            <alias>Tchaikovsky, Peter Ilyitch</alias>  
+            <alias>Pyotr Ilyitch Tchaikovsky</alias>  
+            <alias>Tsaikovski</alias>  
+            <alias>Pytor Ilyich Tchaikovsky</alias>  
+            <alias>Piotr Ilyich Tchaikowsky</alias>  
+            <alias>Tchaikovsky - Philharmonic Orchestra</alias>  
+            <alias>Peter Iljitsch Tschaikowsky (1840 - 1893)</alias>  
+            <alias>Peter Tschaikovsky</alias>  
+            <alias>Peter Ilych Tschaikowsky</alias>  
+            <alias>Pyotr II'yich Tchaikovsky</alias>  
+            <alias>Pytor Tchaikovsky</alias>  
+            <alias>Pyotr Ilyich Tchaikovsky</alias>  
+            <alias>Чайковский, Петр Ильич</alias>  
+            <alias>Чайковский, Пётр Ильич</alias>  
+            <alias>Петр Ильич Чайковский</alias>  
+            <alias>Пётр Ильич Чайковский</alias>  
+            <alias>Tchaikovsky, Peter Il'yich</alias>  
+            <alias>Tchaikovsky, Pjotr Ilyich (1840 - 1893)  	</alias>  
+            <alias>Piotr Illitch Tchaïkovsky</alias>  
+            <alias>Piotr Ilic Ciaikovsky</alias>  
+            <alias>Pyotr Illyich Tchaikovsky</alias>  
+            <alias>Tchaikovsky, Piotr Ilich (1840-1893)</alias>  
+            <alias>Peter Ilyich Tchaikovshy</alias>  
+            <alias>Pyotr Ilyich Tchaikovsly</alias>  
+            <alias>Peter Ilych Tchaikovsky</alias>  
+            <alias>차이코프스키</alias>  
+            <alias>Piotr Ilitch Tchaïkovski</alias>  
+            <alias>Chaikovsky, P. I.</alias>  
+            <alias>Pjotr Iljitsch Tschaikowsky</alias>  
+            <alias>Ciaikosvsky</alias>  
+            <alias>Tchaikovsky 1841-1893</alias>  
+            <alias>Tchaïkovki</alias>  
+            <alias>Piotr Ilych Chaikovsky</alias>  
+            <alias>Pjotr Iljitsj Tsjaikovski</alias>  
+            <alias>Pyotor Ilyich Tschaikovsky</alias>  
+            <alias>Peter Iljitsj Tsjaikovski</alias>  
+            <alias>P. I. Tchaikovskij</alias>  
+            <alias>Piotr Ilich Tchaikovsky</alias>  
+            <alias>Peter Iljitsch Tchaikovsky</alias>  
+            <alias>Tchaikovisky</alias>  
+            <alias>Tchaikovsy</alias>  
+            <alias>Tchailovisky</alias>  
+            <alias>Tchaikovskyes</alias>  
+            <alias>Tchaikovskys</alias>  
+            <alias>Tchaikoskvy</alias>  
+            <alias>Piotr Il'yich Tchaikovsky</alias>  
+            <alias>Tchaikowski</alias>  
+            <alias>Piotr Iljič Čajkovskij</alias>  
+            <alias>Tchaikivsky</alias>  
+            <alias>Pyotor Tchaikovsky</alias>  
+        </alias-list>
+    </artist>
+</metadata>

data/test/test-data/valid/artist/Tori_Amos_1.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<metadata xmlns="http://musicbrainz.org/ns/mmd-1.0#">
+    <artist id="c0b2500e-0cef-4130-869d-732b23ed9df5" type="Person">
+        <name>Tori Amos</name>
+        <sort-name>Amos, Tori</sort-name>
+        <life-span begin="1963-08-22"/>
+    </artist>
+</metadata>

data/test/test-data/valid/artist/Tori_Amos_2.xml

@@ -0,0 +1,53 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<metadata xmlns="http://musicbrainz.org/ns/mmd-1.0#">
+    <artist id="c0b2500e-0cef-4130-869d-732b23ed9df5" type="Person">
+        <name>Tori Amos</name>
+        <sort-name>Amos, Tori</sort-name>
+        <life-span begin="1963-08-22"/>
+        <release-list>
+            <release id="a7ccb022-f437-4492-8eee-8f85d85cdb96" type="Album Official">
+                <title>Strange Little Girls</title>
+                <asin>B00005NKYQ</asin>
+                <release-event-list>
+                    <event date="2001-09-14" country="BE"/>
+                    <event date="2001-09-14" country="FI"/>
+                    <event date="2001-09-14" country="IE"/>
+                    <event date="2001-09-14" country="IT"/>
+                    <event date="2001-09-14" country="NL"/>
+                    <event date="2001-09-17" country="AU"/>
+                    <event date="2001-09-17" country="DE"/>
+                    <event date="2001-09-17" country="GB"/>
+                    <event date="2001-09-18" country="CA"/>
+                    <event date="2001-09-18" country="SE"/>
+                    <event date="2001-09-18" country="US"/>
+                    <event date="2001-09-27" country="JP"/>
+                </release-event-list>
+                <disc-list count="3"/>
+            </release>
+            <release id="9cbf7040-dbdc-403c-940f-7562d9712514" type="Album Official">
+                <title>To Venus and Back (disc 1: Orbiting)</title>
+                <asin>B00001IVJS</asin>
+                <artist id="c0b2500e-0cef-4130-869d-732b23ed9df5"/>
+                <release-event-list>
+                    <event date="1999-09-20" country="DE"/>
+                    <event date="1999-09-20" country="GB"/>
+                    <event date="1999-09-21" country="US"/>
+                </release-event-list>
+                <disc-list count="2"/>
+            </release>
+            <release id="290e10c5-7efc-4f60-ba2c-0dfc0208fbf5" type="Album Official">
+                <title>Under the Pink</title>
+                <asin>B000002IXU</asin>
+                <artist id="c0b2500e-0cef-4130-869d-732b23ed9df5"/>
+                <release-event-list>
+                    <event date="1994-01-28" country="DE"/>
+                    <event date="1994-01-31" country="GB"/>
+                    <event date="1994-02-01" country="US"/>
+                    <event date="1994-02-25" country="JP"/>
+                    <event date="1994-11" country="AU"/>
+                </release-event-list>
+                <disc-list count="4"/>
+            </release>
+        </release-list>
+    </artist>
+</metadata>

data/test/test-data/valid/artist/Tori_Amos_3.xml

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<metadata xmlns="http://musicbrainz.org/ns/mmd-1.0#">
+    <artist id="c0b2500e-0cef-4130-869d-732b23ed9df5" type="Person">
+        <name>Tori Amos</name>
+        <sort-name>Amos, Tori</sort-name>
+        <life-span begin="1963-08-22"/>
+	<relation-list target-type="Artist">
+	    <relation type="Married"
+		      direction="backward"
+		      target="07538f3d-81d5-4c04-923e-4542b8ac9dbc"
+		      begin="1998">
+	        <artist id="07538f3d-81d5-4c04-923e-4542b8ac9dbc" type="Person">
+		     <name>Mark Hawley</name>
+		     <sort-name>Hawley, Mark</sort-name>
+		</artist>
+	    </relation>
+        </relation-list>
+        <relation-list target-type="Url">
+	    <relation type="Discography"
+		      target="http://www.yessaid.com/albums.html"/>
+	    <relation type="Wikipedia"
+		      target="http://en.wikipedia.org/wiki/Tori_Amos"/>
+	</relation-list>
+    </artist>
+</metadata>