Merge branch 'toc_string'

see pull request #36

Conflicts:
	test_discid.py

Author: JonnyJD

discid/disc.py

@@ -18,6 +18,7 @@
 """Disc class
 """
 
+import re
 from ctypes import c_int, c_void_p, c_char_p, c_uint
 
 from discid.libdiscid import _LIB, FEATURES
@@ -204,6 +205,23 @@ def _get_submission_url(self):
         result = _LIB.discid_get_submission_url(self._handle)
         return _decode(result)
 
+    try:
+        _LIB.discid_get_toc_string.argtypes = (c_void_p, )
+        _LIB.discid_get_toc_string.restype = c_char_p
+    except AttributeError:
+        pass
+    def _get_toc_string(self):
+        """The TOC suitable as value of the `toc parameter`
+        when accessing the MusicBrainz Web Service.
+        """
+        assert self._success
+        try:
+            result = _LIB.discid_get_toc_string(self._handle)
+        except AttributeError:
+            return None
+        else:
+            return _decode(result)
+
     _LIB.discid_get_first_track_num.argtypes = (c_void_p, )
     _LIB.discid_get_first_track_num.restype = c_int
     def _get_first_track_num(self):
@@ -279,6 +297,30 @@ def submission_url(self):
             url = url.replace("/bare/cdlookup.html", "/cdtoc/attach")
             return url
 
+    @property
+    def toc_string(self):
+        """The TOC suitable as value of the `toc parameter`
+        when accessing the MusicBrainz Web Service.
+
+        This is a :obj:`unicode` or :obj:`str <python:str>` object
+        and enables fuzzy searching when the actual Disc ID is not found.
+
+        Note that this is the unencoded value, which still contains spaces.
+
+        .. seealso:: `MusicBrainz Web Service <http://musicbrainz.org/doc/Development/XML_Web_Service/Version_2#discid>`_
+        """
+        toc_string = self._get_toc_string()
+        if toc_string is None and self.submission_url:
+            # probably an old version of libdiscid (< 0.6.0)
+            # gather toc string from submission_url
+            match = re.search("toc=([0-9+]+)", self.submission_url)
+            if match is None:
+                raise ValueError("can't get toc string from submission url")
+            else:
+                return match.group(1).replace("+", " ")
+        else:
+            return toc_string
+
     @property
     def first_track_num(self):
         """Number of the first track"""

doc/api.rst

@@ -33,6 +33,7 @@ Disc object
    .. autoattribute:: id
    .. autoattribute:: freedb_id
    .. autoattribute:: submission_url
+   .. autoattribute:: toc_string
    .. autoattribute:: first_track_num
    .. autoattribute:: last_track_num
    .. autoattribute:: sectors

test_discid.py

@@ -100,6 +100,9 @@ def test_put_success(self):
             self.assertEqual(track.seconds,
                              math.floor((track.sectors / 75.0) + 0.5))
             self.assertEqual(type(track.seconds), int)
+        toc_string = ["1", disc.last_track_num, disc.sectors] + track_offsets
+        toc_string = " ".join(map(str, toc_string))
+        self.assertEqual(disc.toc_string, toc_string)
 
 
 class TestDisc(unittest.TestCase):
@@ -121,6 +124,7 @@ def test_read_simple(self):
         self.assertEqual(len(disc.id), 28, "Invalid Disc ID")
         self.assertEqual(len(disc.freedb_id), 8, "Invalid FreeDB Disc ID")
         self.assertTrue(disc.submission_url, "Invalid submission url")
+        self.assertTrue(disc.toc_string, "Invalid toc string")
         self.assertEqual(disc.last_track_num, len(disc.tracks),
                         "Wrong amount of tracks")
         self.assertEqual(disc.sectors,
@@ -142,6 +146,7 @@ def test_read_simple(self):
         disc_id = disc.id
         freedb_id = disc.freedb_id
         submission_url = disc.submission_url
+        toc_string = disc.toc_string
         first = disc.first_track_num
         last = disc.last_track_num
         sectors = disc.sectors
@@ -154,6 +159,8 @@ def test_read_simple(self):
                          "different freedb id after put")
         self.assertEqual(disc.submission_url, submission_url,
                          "different submission_url after put")
+        self.assertEqual(disc.toc_string, toc_string,
+                         "different toc_string after put")
         self.assertEqual(disc.first_track_num, first,
                          "different first track after put")
         self.assertEqual(disc.last_track_num, last,
@@ -171,6 +178,7 @@ def test_read_features(self):
         disc = discid.read(features=["mcn", "isrc"]) # read from default drive
         self.assertEqual(len(disc.id), 28, "Invalid Disc ID")
         self.assertTrue(disc.submission_url, "Invalid submission url")
+        self.assertTrue(disc.toc_string, "Invalid toc string")
 
         if "mcn" in discid.FEATURES:
             self.assertTrue(disc.mcn is not None)