Add missing valid seach parameters

We were missing search parameters for event, instrument, and place which
means that any query for these items with a named field would fail.
Also missing a few (new?) fields for some existing types.
Added tests for all searches to ensure that named fields work
as expected, and errors for invalid fields work.

Signed-off-by: Alastair Porter <alastair@porter.net.nz>

Author: alastair

musicbrainzngs/compat.py

@@ -43,7 +43,7 @@
 						HTTPHandler, build_opener, HTTPError, URLError
 	from httplib import BadStatusLine, HTTPException
 	from urlparse import urlunparse
-	from urllib import urlencode
+	from urllib import urlencode, quote_plus
 
 	bytes = str
 	unicode = unicode
@@ -54,7 +54,7 @@
 								HTTPHandler, build_opener
 	from urllib.error import HTTPError, URLError
 	from http.client import HTTPException, BadStatusLine
-	from urllib.parse import urlunparse, urlencode
+	from urllib.parse import urlunparse, urlencode, quote_plus
 
 	unicode = str
 	bytes = bytes

musicbrainzngs/musicbrainz.py

@@ -109,25 +109,37 @@
     ],
     'area': [
         'aid', 'area', 'alias', 'begin', 'comment', 'end', 'ended',
-        'iso', 'iso1', 'iso2', 'iso3', 'type'
+        'iso', 'iso1', 'iso2', 'iso3', 'sortname', 'type'
     ],
     'artist': [
         'arid', 'artist', 'artistaccent', 'alias', 'begin', 'comment',
         'country', 'end', 'ended', 'gender', 'ipi', 'sortname', 'tag', 'type',
         'area', 'beginarea', 'endarea'
     ],
+    'event': [
+        'alias', 'aid', 'area', 'arid', 'artist', 'comment', 'eid', 'event',
+        'pid', 'place', 'type', 'tag'
+    ],
+    'instrument': [
+        'alias', 'comment', 'description', 'iid', 'instrument',
+        'type', 'tag'
+    ],
     'label': [
         'alias', 'begin', 'code', 'comment', 'country', 'end', 'ended',
         'ipi', 'label', 'labelaccent', 'laid', 'sortname', 'type', 'tag',
         'area'
     ],
+    'place': [
+        'pid', 'address', 'alias', 'area', 'begin', 'comment', 'end', 'ended',
+        'lat', 'long', 'place', 'placeaccent', 'type'
+    ],
     'recording': [
         'arid', 'artist', 'artistname', 'creditname', 'comment',
         'country', 'date', 'dur', 'format', 'isrc', 'number',
         'position', 'primarytype', 'qdur', 'recording',
         'recordingaccent', 'reid', 'release', 'rgid', 'rid',
-        'secondarytype', 'status', 'tnum', 'tracks', 'tracksrelease',
-        'tag', 'type', 'video'
+        'secondarytype', 'status', 'tid', 'tnum', 'tracks',
+        'tracksrelease', 'tag', 'type', 'video'
     ],
     'release-group': [
         'arid', 'artist', 'artistname', 'comment', 'creditname',
@@ -144,7 +156,7 @@
         'tracksmedium', 'type'
     ],
     'series': [
-        'alias', 'comment', 'sid', 'series', 'type'
+        'alias', 'comment', 'sid', 'series', 'type', 'tag'
     ],
     'work': [
         'alias', 'arid', 'artist', 'comment', 'iswc', 'lang', 'tag',

test/test_mbxml_search.py

@@ -1,56 +1,11 @@
 import unittest
 import os
-import musicbrainzngs
 from musicbrainzngs import mbxml
-from test import _common
 
 
 DATA_DIR = os.path.join(os.path.dirname(__file__), "data")
 
 
-class UrlTest(unittest.TestCase):
-    """ Test that the correct URL is generated when a search query is made """
-
-    def setUp(self):
-        self.opener = _common.FakeOpener("<response/>")
-        musicbrainzngs.compat.build_opener = lambda *args: self.opener
-
-        musicbrainzngs.set_useragent("a", "1")
-        musicbrainzngs.set_rate_limit(False)
-
-    def testSearchArtist(self):
-        musicbrainzngs.search_artists("Dynamo Go")
-        self.assertEqual("http://musicbrainz.org/ws/2/artist/?query=Dynamo+Go", self.opener.get_url())
-
-    def testSearchEvent(self):
-        musicbrainzngs.search_events("woodstock")
-        self.assertEqual("http://musicbrainz.org/ws/2/event/?query=woodstock", self.opener.get_url())
-
-    def testSearchLabel(self):
-        musicbrainzngs.search_labels("Waysafe")
-        self.assertEqual("http://musicbrainz.org/ws/2/label/?query=Waysafe", self.opener.get_url())
-
-    def testSearchPlace(self):
-        musicbrainzngs.search_places("Fillmore")
-        self.assertEqual("http://musicbrainz.org/ws/2/place/?query=Fillmore", self.opener.get_url())
-
-    def testSearchRelease(self):
-        musicbrainzngs.search_releases("Affordable Pop Music")
-        self.assertEqual("http://musicbrainz.org/ws/2/release/?query=Affordable+Pop+Music", self.opener.get_url())
-
-    def testSearchReleaseGroup(self):
-        musicbrainzngs.search_release_groups("Affordable Pop Music")
-        self.assertEqual("http://musicbrainz.org/ws/2/release-group/?query=Affordable+Pop+Music", self.opener.get_url())
-
-    def testSearchRecording(self):
-        musicbrainzngs.search_recordings("Thief of Hearts")
-        self.assertEqual("http://musicbrainz.org/ws/2/recording/?query=Thief+of+Hearts", self.opener.get_url())
-
-    def testSearchWork(self):
-        musicbrainzngs.search_works("Fountain City")
-        self.assertEqual("http://musicbrainz.org/ws/2/work/?query=Fountain+City", self.opener.get_url())
-
-
 class SearchArtistTest(unittest.TestCase):
     def testFields(self):
         fn = os.path.join(DATA_DIR, "search-artist.xml")
@@ -64,6 +19,7 @@ def testFields(self):
         # so check for it here
         self.assertEqual("100", one["ext:score"])
 
+
 class SearchReleaseTest(unittest.TestCase):
     def testFields(self):
         fn = os.path.join(DATA_DIR, "search-release.xml")
@@ -79,6 +35,7 @@ def testFields(self):
         self.assertEqual(1, one["medium-count"])
         self.assertEqual("CD", one["medium-list"][0]["format"])
 
+
 class SearchReleaseGroupTest(unittest.TestCase):
     def testFields(self):
         fn = os.path.join(DATA_DIR, "search-release-group.xml")
@@ -89,6 +46,7 @@ def testFields(self):
         one = res["release-group-list"][0]
         self.assertEqual("100", one["ext:score"])
 
+
 class SearchWorkTest(unittest.TestCase):
     def testFields(self):
         fn = os.path.join(DATA_DIR, "search-work.xml")
@@ -99,6 +57,7 @@ def testFields(self):
         one = res["work-list"][0]
         self.assertEqual("100", one["ext:score"])
 
+
 class SearchLabelTest(unittest.TestCase):
     def testFields(self):
         fn = os.path.join(DATA_DIR, "search-label.xml")
@@ -109,6 +68,7 @@ def testFields(self):
         one = res["label-list"][0]
         self.assertEqual("100", one["ext:score"])
 
+
 class SearchRecordingTest(unittest.TestCase):
     def testFields(self):
         fn = os.path.join(DATA_DIR, "search-recording.xml")
@@ -119,6 +79,7 @@ def testFields(self):
         one = res["recording-list"][0]
         self.assertEqual("100", one["ext:score"])
 
+
 class SearchInstrumentTest(unittest.TestCase):
     def testFields(self):
         fn = os.path.join(DATA_DIR, "search-instrument.xml")
@@ -131,6 +92,7 @@ def testFields(self):
         end = res["instrument-list"][-1]
         self.assertEqual("29", end["ext:score"])
 
+
 class SearchPlaceTest(unittest.TestCase):
     def testFields(self):
         fn = os.path.join(DATA_DIR, "search-place.xml")
@@ -144,6 +106,7 @@ def testFields(self):
         self.assertEqual("63", two["ext:score"])
         self.assertEqual("Southampton", two["disambiguation"])
 
+
 class SearchEventTest(unittest.TestCase):
     def testFields(self):
         fn = os.path.join(DATA_DIR, "search-event.xml")

test/test_search.py

@@ -0,0 +1,135 @@
+import unittest
+
+import musicbrainzngs
+from test import _common
+
+
+class SearchUrlTest(unittest.TestCase):
+    """ Test that the correct URL is generated when a search query is made """
+
+    def setUp(self):
+        self.opener = _common.FakeOpener("<response/>")
+        musicbrainzngs.compat.build_opener = lambda *args: self.opener
+
+        musicbrainzngs.set_useragent("a", "1")
+        musicbrainzngs.set_rate_limit(False)
+
+    def test_search_annotations(self):
+        musicbrainzngs.search_annotations("Pieds")
+        self.assertEquals("http://musicbrainz.org/ws/2/annotation/?query=Pieds", self.opener.get_url())
+
+        # Query fields
+        musicbrainzngs.search_annotations(entity="bdb24cb5-404b-4f60-bba4-7b730325ae47")
+        # TODO: We escape special characters and then urlencode all query parameters, which may
+        # not be necessary, but MusicBrainz accepts it and appears to return the same value as without
+        expected_query = 'entity:(bdb24cb5\-404b\-4f60\-bba4\-7b730325ae47)'
+        expected = 'http://musicbrainz.org/ws/2/annotation/?query=%s' % musicbrainzngs.compat.quote_plus(expected_query)
+        self.assertEquals(expected, self.opener.get_url())
+
+        # Invalid query field
+        with self.assertRaises(musicbrainzngs.InvalidSearchFieldError):
+            musicbrainzngs.search_annotations(foo="value")
+
+    def test_search_artists(self):
+        musicbrainzngs.search_artists("Dynamo Go")
+        self.assertEqual("http://musicbrainz.org/ws/2/artist/?query=Dynamo+Go", self.opener.get_url())
+
+        musicbrainzngs.search_artists(artist="Dynamo Go")
+        expected_query = 'artist:(dynamo go)'
+        expected = 'http://musicbrainz.org/ws/2/artist/?query=%s' % musicbrainzngs.compat.quote_plus(expected_query)
+        self.assertEquals(expected, self.opener.get_url())
+
+        # Invalid query field
+        with self.assertRaises(musicbrainzngs.InvalidSearchFieldError):
+            musicbrainzngs.search_artists(foo="value")
+
+    def test_search_events(self):
+        musicbrainzngs.search_events("woodstock")
+        self.assertEqual("http://musicbrainz.org/ws/2/event/?query=woodstock", self.opener.get_url())
+
+        musicbrainzngs.search_events(event="woodstock")
+        expected_query = 'event:(woodstock)'
+        expected = 'http://musicbrainz.org/ws/2/event/?query=%s' % musicbrainzngs.compat.quote_plus(expected_query)
+        self.assertEquals(expected, self.opener.get_url())
+
+        # Invalid query field
+        with self.assertRaises(musicbrainzngs.InvalidSearchFieldError):
+            musicbrainzngs.search_events(foo="value")
+
+    def test_search_labels(self):
+        musicbrainzngs.search_labels("Waysafe")
+        self.assertEqual("http://musicbrainz.org/ws/2/label/?query=Waysafe", self.opener.get_url())
+
+        musicbrainzngs.search_labels(label="Waysafe")
+        expected_query = 'label:(waysafe)'
+        expected = 'http://musicbrainz.org/ws/2/label/?query=%s' % musicbrainzngs.compat.quote_plus(expected_query)
+        self.assertEquals(expected, self.opener.get_url())
+
+        # Invalid query field
+        with self.assertRaises(musicbrainzngs.InvalidSearchFieldError):
+            musicbrainzngs.search_labels(foo="value")
+
+    def test_search_places(self):
+        musicbrainzngs.search_places("Fillmore")
+        self.assertEqual("http://musicbrainz.org/ws/2/place/?query=Fillmore", self.opener.get_url())
+
+        musicbrainzngs.search_places(place="Fillmore")
+        expected_query = 'place:(fillmore)'
+        expected = 'http://musicbrainz.org/ws/2/place/?query=%s' % musicbrainzngs.compat.quote_plus(expected_query)
+        self.assertEquals(expected, self.opener.get_url())
+
+        # Invalid query field
+        with self.assertRaises(musicbrainzngs.InvalidSearchFieldError):
+            musicbrainzngs.search_places(foo="value")
+
+    def test_search_releases(self):
+        musicbrainzngs.search_releases("Affordable Pop Music")
+        self.assertEqual("http://musicbrainz.org/ws/2/release/?query=Affordable+Pop+Music", self.opener.get_url())
+
+        musicbrainzngs.search_releases(release="Affordable Pop Music")
+        expected_query = 'release:(affordable pop music)'
+        expected = 'http://musicbrainz.org/ws/2/release/?query=%s' % musicbrainzngs.compat.quote_plus(expected_query)
+        self.assertEquals(expected, self.opener.get_url())
+
+        # Invalid query field
+        with self.assertRaises(musicbrainzngs.InvalidSearchFieldError):
+            musicbrainzngs.search_releases(foo="value")
+
+    def test_search_release_groups(self):
+        musicbrainzngs.search_release_groups("Affordable Pop Music")
+        self.assertEqual("http://musicbrainz.org/ws/2/release-group/?query=Affordable+Pop+Music", self.opener.get_url())
+
+        musicbrainzngs.search_release_groups(releasegroup="Affordable Pop Music")
+        expected_query = 'releasegroup:(affordable pop music)'
+        expected = 'http://musicbrainz.org/ws/2/release-group/?query=%s' % musicbrainzngs.compat.quote_plus(expected_query)
+        self.assertEquals(expected, self.opener.get_url())
+
+        # Invalid query field
+        with self.assertRaises(musicbrainzngs.InvalidSearchFieldError):
+            musicbrainzngs.search_release_groups(foo="value")
+
+    def test_search_recordings(self):
+        musicbrainzngs.search_recordings("Thief of Hearts")
+        self.assertEqual("http://musicbrainz.org/ws/2/recording/?query=Thief+of+Hearts", self.opener.get_url())
+
+        musicbrainzngs.search_recordings(recording="Thief of Hearts")
+        expected_query = 'recording:(thief of hearts)'
+        expected = 'http://musicbrainz.org/ws/2/recording/?query=%s' % musicbrainzngs.compat.quote_plus(expected_query)
+        self.assertEquals(expected, self.opener.get_url())
+
+        # Invalid query field
+        with self.assertRaises(musicbrainzngs.InvalidSearchFieldError):
+            musicbrainzngs.search_recordings(foo="value")
+
+    def test_search_works(self):
+        musicbrainzngs.search_works("Fountain City")
+        self.assertEqual("http://musicbrainz.org/ws/2/work/?query=Fountain+City", self.opener.get_url())
+
+        musicbrainzngs.search_works(work="Fountain City")
+        expected_query = 'work:(fountain city)'
+        expected = 'http://musicbrainz.org/ws/2/work/?query=%s' % musicbrainzngs.compat.quote_plus(expected_query)
+        self.assertEquals(expected, self.opener.get_url())
+
+        # Invalid query field
+        with self.assertRaises(musicbrainzngs.InvalidSearchFieldError):
+            musicbrainzngs.search_works(foo="value")