rbrainz 0.1.0

data/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) 2007, Philipp Wolfer
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+3. Neither the name of the RBrainz project nor the names of the
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README

@@ -0,0 +1,11 @@
+RBrainz - Ruby MusicBrainz library
+
+See doc/README.rdoc for details about RBrainz.
+
+To generate the complete RBrainz documentation run
+ rake rdoc
+ 
+The documentation will be stored in doc/api.
+
+Copyright (c) 2007, Philipp Wolfer
+Licensing information can be found in the file LICENSE.

data/Rakefile

@@ -0,0 +1,110 @@
+# $Id: Rakefile 4 2007-05-21 02:04:26Z phw $
+# Copyright (c) 2007, Philipp Wolfer
+# All rights reserved.
+# See LICENSE for permissions.
+ 
+# Rakefile for RBrainz
+
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+# Packaging tasks: -------------------------------------------------------
+
+PKG_NAME = 'rbrainz'
+PKG_VERSION = '0.1.0'
+PKG_FILES = FileList[
+  "Rakefile", "LICENSE", "README", "TODO",
+  "doc/README.rdoc",
+  "examples/**/*",
+  "lib/**/*.rb",
+  "test/**/*.rb",
+  "test/test-data/**/*"
+]
+
+spec = Gem::Specification.new do |spec|
+  spec.platform = Gem::Platform::RUBY
+  spec.summary = 'Ruby library for the MusicBrainz XML webservice.'
+  spec.name = PKG_NAME
+  spec.version = PKG_VERSION
+  spec.requirements << 'none'
+  spec.require_path = 'lib'
+  spec.autorequire = 'rbrainz'
+  spec.files = PKG_FILES
+  spec.description = <<EOF
+    RBrainz is a Ruby client library to access the MusicBrainz XML
+    webservice written in pure Ruby.
+    
+    RBrainz follows the design of python-musicbrainz2, the reference
+    implementation for a MusicBrainz client library. Developers used to
+    python-musicbrainz2 should already know most of RBrainz' interface.
+    However, RBrainz differs from python-musicbrainz2 wherever it makes
+    the library more Ruby like or easier to use.
+    
+    RBrainz supports the MusicBrainz XML Metadata Version 1.1, including
+    support for labels and extended release events.
+EOF
+  spec.author = 'Philipp Wolfer' 
+  spec.email = 'phw@rubyforge.org'
+  spec.homepage = 'http://rbrainz.rubyforge.org'
+  spec.rubyforge_project = 'rbrainz'
+  spec.has_rdoc = true
+  spec.extra_rdoc_files = ['doc/README.rdoc']
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar_gz= true
+end
+
+# Test tasks: ------------------------------------------------------------
+
+desc "Run the unit and functional tests"
+task :test => [:test_units, :test_functional]
+
+desc "Run just the unit tests"
+Rake::TestTask.new(:test_units) do |test|
+  test.test_files = FileList['test/test*.rb']
+  test.libs = ['lib', 'test/lib']
+  test.warning = true
+end
+
+desc "Run just the functional tests"
+Rake::TestTask.new(:test_functional) do |test|
+  test.test_files = FileList['test/functional*.rb']
+  test.libs = ['lib', 'test/lib']
+  test.warning = true
+end
+
+# Documentation tasks: ---------------------------------------------------
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.title    = "RBrainz %s" % PKG_VERSION
+  rdoc.main     = 'doc/README.rdoc'
+  rdoc.rdoc_dir = 'doc/api'
+  rdoc.rdoc_files.include('doc/README.rdoc', 'lib/**/*.rb',
+                          'LICENSE', 'TODO')
+  rdoc.options << '--inline-source' << '--line-numbers'
+end
+
+# Other tasks: -----------------------------------------------------------
+
+def egrep(pattern)
+  Dir['**/*.rb'].each do |fn|
+    count = 0
+    open(fn) do |f|
+      while line = f.gets
+	count += 1
+	if line =~ pattern
+	  puts "#{fn}:#{count}:#{line}"
+	end
+      end
+    end
+  end
+end
+
+desc "Look for TODO and FIXME tags in the code"
+task :todo do
+  egrep /#.*(FIXME|TODO)/
+end

data/TODO

@@ -0,0 +1,24 @@
+=TODO
+
+==Short term tasks
+* Support relationships (0.1.1)
+* Query collections (0.1.2)
+* Support for the score parameter in search result. Could be implemented
+  a little bit like in PythonMusicBrainz2, but more flexible. Maybe a result
+  object over which one can iterate to retrieve all results witch the
+  corresponding score. (0.1.2)
+   result.each {|entity, score|
+     ...
+   }
+* Support for the offset parameter for queries on collections
+  to retrieve results below the 100 results limit. Could be easily integrated
+  into the result object (see previous point). (0.1.2)
+* Make it easier to create MBID objects or allow usage of ID strings
+  where it makes life easier.
+
+==Longer term tasks
+* Calculation of disc IDs (0.3.0)
+* User authentication (0.4.0)
+* Querying of user information (0.4.0)
+* PUID submission
+* Full text search (lucene search queries).

data/doc/README.rdoc

@@ -0,0 +1,68 @@
+=RBrainz - Ruby MusicBrainz library
+RBrainz is a Ruby client library to access the MusicBrainz XML webservice,
+which can be used to query the MusicBrainz database.
+
+RBrainz is written in pure Ruby and follows the design of
+PythonMusicBrainz2[http://musicbrainz.org/doc/PythonMusicBrainz2],
+the reference implementation for a MusicBrainz client library. Developers
+used to PythonMusicBrainz2 should already know most of RBrainz' interface.
+However, RBrainz differs from PythonMusicBrainz2 wherever it makes the
+library more Ruby like or easier to use.
+
+RBrainz supports the MusicBrainz XML Metadata Version 1.1, including support
+for labels and extended release events.
+
+==Installation
+===Installing with RubyGems
+The easiest way to install the latest release of RBrainz is using
+RubyGems[http://rubygems.org] by executing the following command:
+ gem install rbrainz
+ 
+===Manual installation
+Not supported, yet.
+
+==Basic usage
+The most important classes in this library are the model classes
+MusicBrainz::Model::Artist, MusicBrainz::Model::Release,
+MusicBrainz::Model::Track and MusicBrainz::Model::Label
+together with MusicBrainz::Webservice::Query. The Query class
+provides an easy to use interface to query the MusicBrainz webservice.
+It will always return one of the model classes above or an
+array of those classes. The example below should make the usage clear:
+
+ require 'rbrainz'
+ include MusicBrainz
+ 
+ # Create an MBID object which represents a MusicBrainz artist ID.
+ mbid = Model::MBID.from_uuid(:artist, 'c0b2500e-0cef-4130-869d-732b23ed9df5')
+
+ # With the ArtistInclude object we can control what kind of information
+ # the MusicBrainz server will include in its answer.
+ artist_includes = Webservice::ArtistIncludes.new(
+   :aliases      => true,
+   :releases     => ['Album', 'Official'],
+   :artist_rels  => true,
+   :release_rels => true,
+   :track_rels   => true,
+   :label_rels   => true,
+   :url_rels     => true
+ )
+ 
+ # Query the webservice for the artist with the above ID
+ # The result will contain all the information specified
+ # in artist_includes.
+ q = Webservice::Query.new
+ artist = q.get_artist_by_id(mbid, artist_includes)
+
+==The MusicBrainz webservice
+For more information about the MusicBrainz webservice visit the
+following resources:
+- MusicBrainzXMLWebService[http://musicbrainz.org/doc/XMLWebService]
+- MusicBrainzXMLMetaData[http://musicbrainz.org/doc/MusicBrainzXMLMetaData]
+
+==License
+RBrainz is Copyright (c) 2007 Philipp Wolfer.
+It is free softare distributed under a BSD style license. See
+LICENSE[link:files/LICENSE.html] for details.
+
+$Id: README.rdoc 5 2007-05-21 16:51:22Z phw $

data/examples/getartist.rb

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+#
+# Example script which queries the database for an
+# artist and displays the artist's data.
+# 
+# $Id: getartist.rb 16 2007-05-23 15:49:06Z 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
+
+# The artist's MusicBrainz ID.
+# Either read it from the command line as the first
+# parameter or use a default one for demonstration.
+id = $*[0] ? $*[0] : '10bf95b6-30e3-44f1-817f-45762cdc0de0'
+
+# Generate a new artist MBID object from the ID:
+mbid = Model::MBID.from_uuid(:artist, id)
+
+# Define what information about the artist
+# should be included in the result.
+# In this case the artist's aliases and all
+# the official albums by this artist will be
+# fetched.
+artist_includes = Webservice::ArtistIncludes.new(
+  :aliases => true,
+  :releases => ['Album', 'Official']
+)
+
+# Create a new Query object which will provide
+# us an interface to the MusicBrainz webservice.
+query = Webservice::Query.new
+
+# Now query the MusicBrainz database for the artist
+# with the MBID defined above.
+artist = query.get_artist_by_id(mbid, artist_includes)
+
+# Display the fetched artist data together with all
+# unique release titles.
+print <<EOF
+ID            : #{artist.id.uuid}
+Name          : #{artist.name}
+Sort name     : #{artist.sort_name}
+Disambiguation: #{artist.disambiguation}
+Type          : #{artist.type}
+Begin date    : #{artist.begin_date}
+End date      : #{artist.end_date}
+Aliases       : #{artist.aliases.join('; ')}
+Releases      : #{artist.releases.map{|r| r.title}.uniq.join("\r\n                ")}
+EOF

data/lib/rbrainz.rb

@@ -0,0 +1,11 @@
+# $Id: rbrainz.rb 4 2007-05-21 02:04:26Z phw $
+# Copyright (c) 2007, Philipp Wolfer
+# All rights reserved.
+# See LICENSE for permissions.
+
+# This is actually just a convenient shortcut that allows
+# the user to use RBrainz by just using <tt>require 'rbrainz'</tt>.
+# This will include the whole RBrainz webservice library, which 
+# should be ok most of the time.
+
+require 'rbrainz/webservice'

data/lib/rbrainz/data/countrynames.rb

@@ -0,0 +1,259 @@
+# $Id: countrynames.rb 4 2007-05-21 02:04:26Z phw $
+# Copyright (c) 2007, Philipp Wolfer
+# All rights reserved.
+# See LICENSE for permissions.
+
+module MusicBrainz
+  module Data
+  
+    # List of country names.
+    COUNTRY_NAMES = {
+    	'BD' => 'Bangladesh',
+    	'BE' => 'Belgium',
+    	'BF' => 'Burkina Faso',
+    	'BG' => 'Bulgaria',
+    	'BB' => 'Barbados',
+    	'WF' => 'Wallis and Futuna Islands',
+    	'BM' => 'Bermuda',
+    	'BN' => 'Brunei Darussalam',
+    	'BO' => 'Bolivia',
+    	'BH' => 'Bahrain',
+    	'BI' => 'Burundi',
+    	'BJ' => 'Benin',
+    	'BT' => 'Bhutan',
+    	'JM' => 'Jamaica',
+    	'BV' => 'Bouvet Island',
+    	'BW' => 'Botswana',
+    	'WS' => 'Samoa',
+    	'BR' => 'Brazil',
+    	'BS' => 'Bahamas',
+    	'BY' => 'Belarus',
+    	'BZ' => 'Belize',
+    	'RU' => 'Russian Federation',
+    	'RW' => 'Rwanda',
+    	'RE' => 'Reunion',
+    	'TM' => 'Turkmenistan',
+    	'TJ' => 'Tajikistan',
+    	'RO' => 'Romania',
+    	'TK' => 'Tokela',
+    	'GW' => 'Guinea-Bissa',
+    	'GU' => 'Guam',
+    	'GT' => 'Guatemala',
+    	'GR' => 'Greece',
+    	'GQ' => 'Equatorial Guinea',
+    	'GP' => 'Guadeloupe',
+    	'JP' => 'Japan',
+    	'GY' => 'Guyana',
+    	'GF' => 'French Guiana',
+    	'GE' => 'Georgia',
+    	'GD' => 'Grenada',
+    	'GB' => 'United Kingdom',
+    	'GA' => 'Gabon',
+    	'SV' => 'El Salvador',
+    	'GN' => 'Guinea',
+    	'GM' => 'Gambia',
+    	'GL' => 'Greenland',
+    	'GI' => 'Gibraltar',
+    	'GH' => 'Ghana',
+    	'OM' => 'Oman',
+    	'TN' => 'Tunisia',
+    	'JO' => 'Jordan',
+    	'HT' => 'Haiti',
+    	'HU' => 'Hungary',
+    	'HK' => 'Hong Kong',
+    	'HN' => 'Honduras',
+    	'HM' => 'Heard and Mc Donald Islands',
+    	'VE' => 'Venezuela',
+    	'PR' => 'Puerto Rico',
+    	'PW' => 'Pala',
+    	'PT' => 'Portugal',
+    	'SJ' => 'Svalbard and Jan Mayen Islands',
+    	'PY' => 'Paraguay',
+    	'IQ' => 'Iraq',
+    	'PA' => 'Panama',
+    	'PF' => 'French Polynesia',
+    	'PG' => 'Papua New Guinea',
+    	'PE' => 'Per',
+    	'PK' => 'Pakistan',
+    	'PH' => 'Philippines',
+    	'PN' => 'Pitcairn',
+    	'PL' => 'Poland',
+    	'PM' => 'St. Pierre and Miquelon',
+    	'ZM' => 'Zambia',
+    	'EH' => 'Western Sahara',
+    	'EE' => 'Estonia',
+    	'EG' => 'Egypt',
+    	'ZA' => 'South Africa',
+    	'EC' => 'Ecuador',
+    	'IT' => 'Italy',
+    	'VN' => 'Viet Nam',
+    	'SB' => 'Solomon Islands',
+    	'ET' => 'Ethiopia',
+    	'SO' => 'Somalia',
+    	'ZW' => 'Zimbabwe',
+    	'SA' => 'Saudi Arabia',
+    	'ES' => 'Spain',
+    	'ER' => 'Eritrea',
+    	'MD' => 'Moldova, Republic of',
+    	'MG' => 'Madagascar',
+    	'MA' => 'Morocco',
+    	'MC' => 'Monaco',
+    	'UZ' => 'Uzbekistan',
+    	'MM' => 'Myanmar',
+    	'ML' => 'Mali',
+    	'MO' => 'Maca',
+    	'MN' => 'Mongolia',
+    	'MH' => 'Marshall Islands',
+    	'MK' => 'Macedonia, The Former Yugoslav Republic of',
+    	'MU' => 'Mauritius',
+    	'MT' => 'Malta',
+    	'MW' => 'Malawi',
+    	'MV' => 'Maldives',
+    	'MQ' => 'Martinique',
+    	'MP' => 'Northern Mariana Islands',
+    	'MS' => 'Montserrat',
+    	'MR' => 'Mauritania',
+    	'UG' => 'Uganda',
+    	'MY' => 'Malaysia',
+    	'MX' => 'Mexico',
+    	'IL' => 'Israel',
+    	'FR' => 'France',
+    	'IO' => 'British Indian Ocean Territory',
+    	'SH' => 'St. Helena',
+    	'FI' => 'Finland',
+    	'FJ' => 'Fiji',
+    	'FK' => 'Falkland Islands (Malvinas)',
+    	'FM' => 'Micronesia, Federated States of',
+    	'FO' => 'Faroe Islands',
+    	'NI' => 'Nicaragua',
+    	'NL' => 'Netherlands',
+    	'NO' => 'Norway',
+    	'NA' => 'Namibia',
+    	'VU' => 'Vanuat',
+    	'NC' => 'New Caledonia',
+    	'NE' => 'Niger',
+    	'NF' => 'Norfolk Island',
+    	'NG' => 'Nigeria',
+    	'NZ' => 'New Zealand',
+    	'ZR' => 'Zaire',
+    	'NP' => 'Nepal',
+    	'NR' => 'Naur',
+    	'NU' => 'Niue',
+    	'CK' => 'Cook Islands',
+    	'CI' => 'Cote d\'Ivoire',
+    	'CH' => 'Switzerland',
+    	'CO' => 'Colombia',
+    	'CN' => 'China',
+    	'CM' => 'Cameroon',
+    	'CL' => 'Chile',
+    	'CC' => 'Cocos (Keeling) Islands',
+    	'CA' => 'Canada',
+    	'CG' => 'Congo',
+    	'CF' => 'Central African Republic',
+    	'CZ' => 'Czech Republic',
+    	'CY' => 'Cyprus',
+    	'CX' => 'Christmas Island',
+    	'CR' => 'Costa Rica',
+    	'CV' => 'Cape Verde',
+    	'CU' => 'Cuba',
+    	'SZ' => 'Swaziland',
+    	'SY' => 'Syrian Arab Republic',
+    	'KG' => 'Kyrgyzstan',
+    	'KE' => 'Kenya',
+    	'SR' => 'Suriname',
+    	'KI' => 'Kiribati',
+    	'KH' => 'Cambodia',
+    	'KN' => 'Saint Kitts and Nevis',
+    	'KM' => 'Comoros',
+    	'ST' => 'Sao Tome and Principe',
+    	'SI' => 'Slovenia',
+    	'KW' => 'Kuwait',
+    	'SN' => 'Senegal',
+    	'SM' => 'San Marino',
+    	'SL' => 'Sierra Leone',
+    	'SC' => 'Seychelles',
+    	'KZ' => 'Kazakhstan',
+    	'KY' => 'Cayman Islands',
+    	'SG' => 'Singapore',
+    	'SE' => 'Sweden',
+    	'SD' => 'Sudan',
+    	'DO' => 'Dominican Republic',
+    	'DM' => 'Dominica',
+    	'DJ' => 'Djibouti',
+    	'DK' => 'Denmark',
+    	'VG' => 'Virgin Islands (British)',
+    	'DE' => 'Germany',
+    	'YE' => 'Yemen',
+    	'DZ' => 'Algeria',
+    	'US' => 'United States',
+    	'UY' => 'Uruguay',
+    	'YT' => 'Mayotte',
+    	'UM' => 'United States Minor Outlying Islands',
+    	'LB' => 'Lebanon',
+    	'LC' => 'Saint Lucia',
+    	'LA' => 'Lao People\'s Democratic Republic',
+    	'TV' => 'Tuval',
+    	'TW' => 'Taiwan',
+    	'TT' => 'Trinidad and Tobago',
+    	'TR' => 'Turkey',
+    	'LK' => 'Sri Lanka',
+    	'LI' => 'Liechtenstein',
+    	'LV' => 'Latvia',
+    	'TO' => 'Tonga',
+    	'LT' => 'Lithuania',
+    	'LU' => 'Luxembourg',
+    	'LR' => 'Liberia',
+    	'LS' => 'Lesotho',
+    	'TH' => 'Thailand',
+    	'TF' => 'French Southern Territories',
+    	'TG' => 'Togo',
+    	'TD' => 'Chad',
+    	'TC' => 'Turks and Caicos Islands',
+    	'LY' => 'Libyan Arab Jamahiriya',
+    	'VA' => 'Vatican City State (Holy See)',
+    	'VC' => 'Saint Vincent and The Grenadines',
+    	'AE' => 'United Arab Emirates',
+    	'AD' => 'Andorra',
+    	'AG' => 'Antigua and Barbuda',
+    	'AF' => 'Afghanistan',
+    	'AI' => 'Anguilla',
+    	'VI' => 'Virgin Islands (U.S.)',
+    	'IS' => 'Iceland',
+    	'IR' => 'Iran (Islamic Republic of)',
+    	'AM' => 'Armenia',
+    	'AL' => 'Albania',
+    	'AO' => 'Angola',
+    	'AN' => 'Netherlands Antilles',
+    	'AQ' => 'Antarctica',
+    	'AS' => 'American Samoa',
+    	'AR' => 'Argentina',
+    	'AU' => 'Australia',
+    	'AT' => 'Austria',
+    	'AW' => 'Aruba',
+    	'IN' => 'India',
+    	'TZ' => 'Tanzania, United Republic of',
+    	'AZ' => 'Azerbaijan',
+    	'IE' => 'Ireland',
+    	'ID' => 'Indonesia',
+    	'UA' => 'Ukraine',
+    	'QA' => 'Qatar',
+    	'MZ' => 'Mozambique',
+    	'BA' => 'Bosnia and Herzegovina',
+    	'CD' => 'Congo, The Democratic Republic of the',
+    	'CS' => 'Serbia and Montenegro',
+    	'HR' => 'Croatia',
+    	'KP' => 'Korea (North), Democratic People\'s Republic of',
+    	'KR' => 'Korea (South), Republic of',
+    	'SK' => 'Slovakia',
+    	'SU' => 'Soviet Union (historical, 1922-1991)',
+    	'TL' => 'East Timor',
+    	'XC' => 'Czechoslovakia (historical, 1918-1992)',
+    	'XE' => 'Europe',
+    	'XG' => 'East Germany (historical, 1949-1990)',
+    	'XU' => '[Unknown Country]',
+    	'XW' => '[Worldwide]',
+    	'YU' => 'Yugoslavia (historical, 1918-1992)',
+    }
+
+  end
+end