musicbrainz-ruby 0.3.2 → 0.4.0

data/.gitignore

@@ -0,0 +1,5 @@
+pkg
+.DS_Store
+*.swp
+Gemfile.lock
+.rbx

data/.rspec

@@ -0,0 +1,3 @@
+--colour
+--format documentation
+--backtrace

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/README.markdown

@@ -3,9 +3,10 @@ MusicBrainz-ruby
 
 O hai, I [HTTParty][1]'d with ur [web service][2]. No offence, RBrainz gem.
 
-This gem supports authentication, all the GET calls and basic POSTing (not batch POSTs) provided you read the web service documentation and provide the correct parameters. 
+This gem currently only supports the lookup, browse and search GET requests.
+Data submission coming soon.
 
-Returns [Mashes][3] of the metadata tag.
+Returns [Mashes][3] of the metadata tag from MusicBrainz's XML responses.
 
 [1]: https://github.com/jnunemaker/httparty
 [2]: http://wiki.musicbrainz.org/XMLWebService
@@ -18,17 +19,15 @@ Install
 
 Examples
 --------
-    
+
     require 'musicbrainz'
     brainz = MusicBrainz::Client.new('username', 'password')
-    
+
     # Find an artist by id, include artist relations
-    brainz.artist('45d15468-2918-4da4-870b-d6b880504f77', :inc => 'artist-rels')
-    # Search for artists with the term 'Diplo'
-    brainz.artist(nil, :query => 'Diplo')
-    # Tag an Artist
-    brainz.post('tag', :id => '45d15468-2918-4da4-870b-d6b880504f77', :entity => 'artist', :tags => 'post-everything')
-    
+    brainz.artist(:mbid => '45d15468-2918-4da4-870b-d6b880504f77', :inc => 'artist-rels')
+    # Search for artists with the query 'Diplo'
+    brainz.artist(:query => 'Diplo')
+
 MIT License
 ===========
 

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+desc 'Run specs'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = './spec/musicbrainz/*_spec.rb'
+end
+
+task :default => [:spec]

data/lib/musicbrainz.rb

@@ -1,81 +1,3 @@
-require 'rubygems'
-
-gem 'httparty', '~> 0.7.3'
-require 'httparty'
-
-gem 'hashie', '~> 1.0'
-require 'hashie'
-
-module MusicBrainz
-  class Client
-    include HTTParty
-    include Hashie
-
-    base_uri 'musicbrainz.org/ws/1'
-    
-    # Provide your username and password if you need to make authenticated calls
-    def initialize(username = nil, password = nil)
-      self.class.digest_auth username, password
-    end
-
-    def artist(musicbrainz_id = nil, params = {})
-      request("/artist/#{musicbrainz_id}", params)
-    end
-    
-    def release_group(musicbrainz_id = nil, params = {})
-      request("/release-group/#{musicbrainz_id}", params)
-    end
-    
-    def release(musicbrainz_id = nil, params = {})
-      request("/release/#{musicbrainz_id}", params)
-    end
-    
-    def track(musicbrainz_id = nil, params = {})
-      request("/track/#{musicbrainz_id}", params)
-    end
-    
-    def label(musicbrainz_id = nil, params = {})
-      request("/label/#{musicbrainz_id}", params)
-    end
-    
-    def rating(params = {})
-      request('/rating/', params)
-    end
-    
-    def tag(params = {})
-      request('/tag/', params)
-    end
-    
-    def collection(params = {})
-      request('/collection/', params)
-    end
-    
-    # provide a resource you want to post to, and the appropriate parameters
-    def post(resource, params = {})
-      response = self.class.post("/#{resource}/", :body => params)
-      if response.response.is_a? Net::HTTPOK
-        return true
-      else
-        raise response.response.message
-      end
-    end
-    
-    private
-    def request(path, params)
-      options = {:query => {:type => 'xml'}}
-      options[:query].merge!(params)
-      
-      response = self.class.get(path, options)
-      
-      if response.response.is_a? Net::HTTPBadRequest
-        raise ArgumentError, response.parsed_response
-      end
-            
-      if response.response.is_a? Net::HTTPUnauthorized
-        raise response.response.message
-      end
-      
-      Mash.new(response).metadata
-    end
-  end
-end
+require 'musicbrainz/version'
+require 'musicbrainz/request'
+require 'musicbrainz/client'

data/lib/musicbrainz/client.rb

@@ -0,0 +1,97 @@
+require 'httparty'
+require 'hashie'
+
+module MusicBrainz
+  class Client
+    include HTTParty
+    include Hashie
+
+    DEFAULT_USER_AGENT = "musicbrainz-ruby gem #{MusicBrainz::VERSION}"
+
+    base_uri 'musicbrainz.org/ws/2'
+
+    # Provide your username and password to make authenticated calls
+    def initialize(options = {})
+      if options[:username] and options[:password]
+        self.class.digest_auth options[:username], options[:password]
+      end
+      if options[:'User-Agent']
+        self.class.headers 'User-Agent' => options[:'User-Agent']
+      else
+        self.class.headers 'User-Agent' => DEFAULT_USER_AGENT
+      end
+    end
+
+    def artist(params = {})
+      request('artist', params)
+    end
+
+    def label(params = {})
+      request('label', params)
+    end
+
+    def recording(params = {})
+      request('recording', params)
+    end
+
+    def release_group(params = {})
+      request('release-group', params)
+    end
+
+    def work(params = {})
+      request('work', params)
+    end
+
+    def release(params = {})
+      request('release', params)
+    end
+
+    def recording(params = {})
+      request('recording', params)
+    end
+
+    def rating(params = {})
+      request('rating', params)
+    end
+
+    def tag(params = {})
+      request('tag', params)
+    end
+
+    def collection(params = {})
+      request('collection', params)
+    end
+
+    def discid(params = {})
+      request('discid', params)
+    end
+
+    def puid(params = {})
+      request('puid', params)
+    end
+
+    def isrc(params = {})
+      request('isrc', params)
+    end
+
+    def iswc(params = {})
+      request('iswc', params)
+    end
+
+    private
+    def request(resource, params)
+      request = Request.new(resource, params)
+      response = self.class.get(request.path, request.options)
+
+      if response.response.is_a? Net::HTTPBadRequest
+        raise ArgumentError, response.parsed_response
+      end
+
+      if response.response.is_a? Net::HTTPUnauthorized
+        raise response.response.message
+      end
+
+      Mash.new(response).metadata
+    end
+  end
+end

data/lib/musicbrainz/request.rb

@@ -0,0 +1,29 @@
+module MusicBrainz
+  class Request
+
+    UNIQUE_IDENTIFIERS = %q{discid puid isrc iswc}
+
+    def initialize(resource, params)
+      @resource   = resource
+      @params     = params
+      @id         = nil
+
+      if UNIQUE_IDENTIFIERS.include?(resource)
+        @id = params.delete(resource.to_sym)
+      elsif params.has_key?(:mbid)
+        @id = params.delete(:mbid)
+      end
+    end
+
+    def path
+      path = "/#{@resource}/#{@id}"
+    end
+
+    def options
+      options = {}
+      options[:query] = @params unless @params.empty?
+      options
+    end
+
+  end
+end

data/lib/musicbrainz/version.rb

@@ -0,0 +1,3 @@
+module MusicBrainz
+  VERSION = '0.4.0'
+end

data/musicbrainz-ruby.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'musicbrainz/version'
+
+Gem::Specification.new do |s|
+  s.name = %q{musicbrainz-ruby}
+  s.version = MusicBrainz::VERSION
+
+  s.authors = ['Robin Tweedie']
+  s.date = %q{2011-02-02}
+  s.email = %q{robin@songkick.com}
+  s.summary = %q{Simple Ruby wrapper for MusicBrainz XML Web Service}
+  s.description = %q{Simple Ruby wrapper for MusicBrainz XML Web Service}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency(%q<httparty>, ["~> 0.8.0"])
+  s.add_runtime_dependency(%q<hashie>, ["~> 1.1.0"])
+  s.add_development_dependency(%q<rspec>, [">= 2.4"])
+  s.add_development_dependency(%q<fakeweb>, [">= 1.3"])
+end

data/spec/fixtures/artist_bad_request.txt

@@ -0,0 +1,2 @@
+Must specify a least one parameter (other than 'limit', 'offset' or empty 'query') for collections query.
+For usage, please see: http://musicbrainz.org/development/mmd

data/spec/fixtures/artist_by_id_diplo.xml

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="UTF-8"?><metadata xmlns="http://musicbrainz.org/ns/mmd-1.0#"><artist id="a56bd8f9-8ef8-4d63-89a4-794ed1360dd2" type="Person"><name>Diplo</name><sort-name>Diplo</sort-name><life-span begin="1978-11-10"/></artist></metadata>

data/spec/fixtures/artist_search_diplo.xml

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="UTF-8"?><metadata xmlns="http://musicbrainz.org/ns/mmd-1.0#" xmlns:ext="http://musicbrainz.org/ns/ext-1.0#"><artist-list offset="0" count="11"><artist type="Person" id="a56bd8f9-8ef8-4d63-89a4-794ed1360dd2" ext:score="100"><name>Diplo</name><sort-name>Diplo</sort-name><life-span begin="1978-11-10"/></artist><artist type="Group" id="e190ee5c-ddb9-402f-9f7b-809ed299b810" ext:score="50"><name>Diplo &amp; Dr Evil</name><sort-name>Diplo &amp; Dr Evil</sort-name></artist><artist type="Group" id="76abfb6b-5103-43ae-8304-0347a6f16097" ext:score="50"><name>Diplo &amp; Tripledouble</name><sort-name>Diplo &amp; Tripledouble</sort-name></artist><artist type="Group" id="f43d5e3c-e423-44ea-b4e3-a8508c88b874" ext:score="50"><name>Diplo &amp; Santogold</name><sort-name>Diplo &amp; Santogold</sort-name><life-span begin="2008"/></artist><artist type="Group" id="ed09875a-3bb0-44f2-8b51-24e7dc8cec49" ext:score="50"><name>Diplo &amp; Laidback Luke</name><sort-name>Diplo &amp; Laidback Luke</sort-name></artist><artist type="Unknown" id="961f11d7-bbee-4369-b49c-82b63cb8c325" ext:score="50"><name>Tiësto &amp; Diplo</name><sort-name>Tiësto &amp; Diplo</sort-name></artist><artist type="Unknown" id="9c9bc7d4-a4e2-4673-b074-921efe7ca0e2" ext:score="50"><name>Diplo &amp; $mall ¢hange</name><sort-name>Diplo &amp; $mall ¢hange</sort-name></artist><artist type="Group" id="d3eb024d-ea69-4d80-8cff-98095b9340b9" ext:score="50"><name>Diplo &amp; Lil Jon</name><sort-name>Diplo &amp; Lil Jon</sort-name></artist><artist type="Group" id="efb1ea9c-b886-4f95-9be6-3681ae13ed29" ext:score="50"><name>Tiesto vs. Diplo</name><sort-name>Tiesto vs. Diplo</sort-name></artist><artist type="Group" id="7b3201e2-c217-4df5-a92f-00c24a6fa063" ext:score="43"><name>Diplo &amp; Martina Topley-Bird</name><sort-name>Diplo &amp; Topley-Bird, Martina</sort-name></artist><artist type="Group" id="19f253de-109b-4086-98bf-65987edca55c" ext:score="17"><name>Hollertronix</name><sort-name>Hollertronix</sort-name></artist></artist-list></metadata>

data/spec/fixtures/rating_auth_required.html

@@ -0,0 +1,14 @@
+<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
+<HTML><HEAD>
+<TITLE>401 Authorization Required</TITLE>
+</HEAD><BODY>
+<H1>Authorization Required</H1>
+This server could not verify that you
+are authorized to access the document
+requested.  Either you supplied the wrong
+credentials (e.g., bad password), or your
+browser doesn't understand how to supply
+the credentials required.<P>
+<HR>
+<ADDRESS>Apache/1.3.33 Server at musicbrainz.org Port 80</ADDRESS>
+</BODY></HTML>

data/spec/fixtures/rating_by_id.xml

@@ -0,0 +1 @@
+<metadata><user-rating>5</user-rating></metadata>

data/spec/musicbrainz/client_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+describe MusicBrainz::Client do
+  let(:client){ MusicBrainz::Client.new }
+  subject { client }
+
+  it 'provides access to the core resources' do
+    resources = [:artist, :label, :recording, :release, :release_group, :work]
+    should respond_to(*resources).with(1).argument
+  end
+
+  it 'provides access to the non-core resources' do
+    should respond_to(:rating, :tag, :collection).with(1).argument
+  end
+
+  it 'provides access to the unique identifier lookups' do
+    should respond_to(:discid, :puid, :isrc, :iswc).with(1).argument
+  end
+
+  it 'specifies a User-Agent in the headers' do
+    expected = /musicbrainz-ruby gem/
+    subject.class.default_options[:headers]['User-Agent'].should =~ expected
+  end
+
+  context 'when a User-Agent is provided' do
+    let(:user_agent) { 'Herp Derp v1.2.3' }
+    let(:client)     { MusicBrainz::Client.new(:'User-Agent' => user_agent) }
+
+    it 'specifies the provided User-Agent in the headers' do
+      subject.class.default_options[:headers]['User-Agent'].should == user_agent
+    end
+  end
+
+  context 'when making a bad request' do
+    subject { client.artist } # request has no parameters
+
+    it 'raises an error' do
+      lambda {subject}.should raise_error(ArgumentError, /Must specify a least one parameter/)
+    end
+  end
+
+  context 'when requesting resources requiring authentication' do
+    let(:mbid) { '4bd31567-70a8-4007-9ac6-3c68c7fc3d45' }
+    subject { client.rating(:id => mbid, :entity => 'artist') }
+
+    context 'and the resource is requested without authentication' do
+      it 'raises an error' do
+        lambda {subject}.should raise_error(RuntimeError, /Authorization Required/)
+      end
+    end
+
+    context 'and the resource is requested with authentication' do
+      let(:client) do
+        MusicBrainz::Client.new(:username => 'user', :password => 'password')
+      end
+
+      it 'returns the resource' do
+        subject.user_rating.should == "5"
+      end
+    end
+  end
+
+  context 'when searching for a resource' do
+    subject { client.artist(:query => 'Diplo') }
+
+    it 'returns a list of resources' do
+      subject.artist_list.artist.should be_kind_of(Array)
+      subject.artist_list.artist.size.should == 11
+    end
+  end
+
+  context 'when fetching a resource by MusicBrainz id' do
+    subject { client.artist(:mbid => 'a56bd8f9-8ef8-4d63-89a4-794ed1360dd2') }
+
+    it 'returns a single resource' do
+      subject.artist.should be_kind_of(Hashie::Mash)
+      subject.artist.name.should == 'Diplo'
+    end
+  end
+
+end

data/spec/musicbrainz/request_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe MusicBrainz::Request do
+  let(:resource) { 'artist' }
+  let(:params)   { Hash.new }
+  subject        { MusicBrainz::Request.new(resource, params) }
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+require 'rubygems'
+
+gem 'fakeweb', '~> 1.3.0'
+require 'fakeweb'
+
+dir = File.expand_path(File.dirname(__FILE__))
+require File.join(dir, '..', 'lib', 'musicbrainz')
+
+FakeWeb.allow_net_connect = false
+
+base = MusicBrainz::Client.base_uri
+{:artist_search_diplo => base + '/artist/?query=Diplo',
+ :artist_by_id_diplo  => base + '/artist/a56bd8f9-8ef8-4d63-89a4-794ed1360dd2'
+}.each do |fixture, url|
+  path = File.join(dir, 'fixtures', "#{fixture}.xml")
+  body = File.read(path) if File.file?(path)
+  content_type = 'text/xml; charset=utf-8'
+  FakeWeb.register_uri(:get, url, :body => body, :content_type => content_type)
+  FakeWeb.register_uri(:head, url, :content_type => content_type)
+end
+
+bad_request = 'http://musicbrainz.org/ws/2/artist/'
+body = File.read(File.join dir, 'fixtures', "artist_bad_request.txt")
+FakeWeb.register_uri(:get, bad_request, :body => body, :status => ['400', 'Bad Request'])
+FakeWeb.register_uri(:head, bad_request, :status => ['400', 'Bad Request'])
+
+rating_request = 'http://musicbrainz.org/ws/2/rating/?id=4bd31567-70a8-4007-9ac6-3c68c7fc3d45&entity=artist'
+error_body = File.read(File.join dir, 'fixtures', "rating_auth_required.html")
+rating_body = File.read(File.join dir, 'fixtures', "rating_by_id.xml")
+FakeWeb.register_uri(:get, rating_request, [{:body => error_body, :status => ["401", "Authorization Required"]},
+                                            {:body => rating_body, :content_type => 'text/xml; charset=utf-8'}])
+FakeWeb.register_uri(:head, rating_request, [{:status => ["401", "Authorization Required"]},
+                                             {:content_type => 'text/xml; charset=utf-8'}])

metadata

@@ -1,129 +1,114 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: musicbrainz-ruby
-version: !ruby/object:Gem::Version 
-  hash: 23
+version: !ruby/object:Gem::Version
+  version: 0.4.0
   prerelease: 
-  segments: 
-  - 0
-  - 3
-  - 2
-  version: 0.3.2
 platform: ruby
-authors: 
+authors:
 - Robin Tweedie
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-02-02 00:00:00 +00:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: httparty
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70317351955220 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 0
-        - 7
-        - 3
-        version: 0.7.3
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: hashie
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70317351955220
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: &70317351954660 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 1
-        - 0
-        version: "1.0"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70317351954660
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70317351954140 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 2
-        - 4
-        version: "2.4"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.4'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: fakeweb
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *70317351954140
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: &70317351953380 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 1
-        - 3
-        version: "1.3"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.3'
   type: :development
-  version_requirements: *id004
-description: 
+  prerelease: false
+  version_requirements: *70317351953380
+description: Simple Ruby wrapper for MusicBrainz XML Web Service
 email: robin@songkick.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- README.markdown
-files: 
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
 - README.markdown
+- Rakefile
 - lib/musicbrainz.rb
-has_rdoc: true
-homepage: https://github.com/dwo/musicbrainz-ruby
+- lib/musicbrainz/client.rb
+- lib/musicbrainz/request.rb
+- lib/musicbrainz/version.rb
+- musicbrainz-ruby.gemspec
+- spec/fixtures/artist_bad_request.txt
+- spec/fixtures/artist_by_id_diplo.xml
+- spec/fixtures/artist_search_diplo.xml
+- spec/fixtures/rating_auth_required.html
+- spec/fixtures/rating_by_id.xml
+- spec/musicbrainz/client_spec.rb
+- spec/musicbrainz/request_spec.rb
+- spec/spec_helper.rb
+homepage: 
 licenses: []
-
 post_install_message: 
-rdoc_options: 
-- --main
-- README.markdown
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.4.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Simple Ruby wrapper for MusicBrainz XML Web Service
-test_files: []
-
+test_files:
+- spec/fixtures/artist_bad_request.txt
+- spec/fixtures/artist_by_id_diplo.xml
+- spec/fixtures/artist_search_diplo.xml
+- spec/fixtures/rating_auth_required.html
+- spec/fixtures/rating_by_id.xml
+- spec/musicbrainz/client_spec.rb
+- spec/musicbrainz/request_spec.rb
+- spec/spec_helper.rb