Added tests for simple GetPassage

MyCapytain/resolvers/cts/__init__.py

@@ -1,65 +0,0 @@
-from MyCapytain.resolvers.prototypes import Resolver
-from MyCapytain.resources.texts.api.cts import Text, Passage
-from MyCapytain.retrievers.cts5 import CTS
-
-
-class HttpCTSResolver(Resolver):
-    def __init__(self, endpoint):
-        if not isinstance(endpoint, CTS):
-            raise TypeError("Endpoint should be a CTS Endpoint object")
-        self.__endpoint__ = endpoint
-
-    @property
-    def endpoint(self):
-        """ CTS Endpoint of the resolver
-
-        :return: CTS Endpoint
-        :rtype: CTS
-        """
-        return self.__endpoint__
-
-    def getPassage(self, textId, subreference=None, prevnext=False, metadata=False):
-        """ Retrieve a text node from the API
-
-        :param textId: Text Identifier
-        :param subreference: Passage Reference
-        :param prevnext: Retrieve graph representing previous and next passage
-        :param metadata: Retrieve metadata about the passage and the text
-        :return: Passage
-        :rtype: Passage
-        """
-        text = Text(
-            urn=textId,
-            retriever=self.endpoint
-        )
-        if metadata or prevnext:
-            return text.getPassagePlus(reference=subreference)
-        else:
-            return text.getPassage(reference=subreference)
-
-    def getSiblings(self, textId, subreference):
-        """ Retrieve the siblings of a textual node
-
-        :param textId: Text Identifier
-        :param subreference: Passage Reference
-        :return: (str, str)
-        """
-        text = Text(
-            urn=textId,
-            retriever=self.endpoint
-        )
-        return text.getPrevNextUrn(subreference)
-
-    def getSiblings(self, textId, subreference):
-        """ Retrieve the siblings of a textual node
-
-        :param textId: Text Identifier
-        :param subreference: Passage Reference
-        :return: (str, str)
-        """
-        text = Text(
-            urn=textId,
-            retriever=self.endpoint
-        )
-        return text.getPrevNextUrn(subreference)
-

MyCapytain/resolvers/cts/api.py

@@ -0,0 +1,80 @@
+from MyCapytain.resolvers.prototypes import Resolver
+from MyCapytain.resources.texts.api.cts import Text, Passage
+from MyCapytain.resources.collections.cts import TextInventory
+from MyCapytain.retrievers.cts5 import CTS
+
+
+class HttpCTSResolver(Resolver):
+    def __init__(self, endpoint):
+        if not isinstance(endpoint, CTS):
+            raise TypeError("Endpoint should be a CTS Endpoint object")
+        self.__endpoint__ = endpoint
+
+    @property
+    def endpoint(self):
+        """ CTS Endpoint of the resolver
+
+        :return: CTS Endpoint
+        :rtype: CTS
+        """
+        return self.__endpoint__
+
+    def getPassage(self, textId, subreference=None, prevnext=False, metadata=False):
+        """ Retrieve a text node from the API
+
+        :param textId: Text Identifier
+        :param subreference: Passage Reference
+        :param prevnext: Retrieve graph representing previous and next passage
+        :param metadata: Retrieve metadata about the passage and the text
+        :return: Passage
+        :rtype: Passage
+        """
+        text = Text(
+            urn=textId,
+            retriever=self.endpoint
+        )
+        if metadata or prevnext:
+            return text.getPassagePlus(reference=subreference)
+        else:
+            return text.getPassage(reference=subreference)
+
+    def getSiblings(self, textId, subreference):
+        """ Retrieve the siblings of a textual node
+
+        :param textId: Text Identifier
+        :param subreference: Passage Reference
+        :return: (str, str)
+        """
+        text = Text(
+            urn=textId,
+            retriever=self.endpoint
+        )
+        return text.getPrevNextUrn(subreference)
+
+    def getReffs(self, textId, level=1, subreference=None):
+        """ Retrieve the siblings of a textual node
+
+        :param textId: Text Identifier
+        :param level: Depth for retrieval
+        :param subreference: Passage Reference
+        :return: (str, str)
+        """
+        text = Text(
+            urn=textId,
+            retriever=self.endpoint
+        )
+        return text.getReffs(level, subreference)
+
+    def getMetadata(self, objectId=None, **filters):
+        """ Request metadata about a text or a collection
+
+        :param textId: Object Identifier to filter on
+        :param filters: Kwargs parameters. URN and Inv are available
+        :return: Collection
+        """
+        if objectId is not None:
+            filters["urn"] = objectId
+
+        ti = TextInventory()
+        ti.parse(self.endpoint.getCapabilities(**filters))
+        return ti

MyCapytain/resolvers/prototypes.py

@@ -29,11 +29,12 @@ def getSiblings(self, textId, subreference):
         """
         raise NotImplementedError()
 
-    def getChildren(self, textId, reference=None, depth=None):
+    def getReffs(self, textId, level=1, subreference=None):
         """ Retrieve the siblings of a textual node
 
         :param textId: Text Identifier
-        :param reference: Passage Reference
-        :return: Graph
+        :param level: Depth for retrieval
+        :param subreference: Passage Reference
+        :return: (str, str)
         """
         raise NotImplementedError()

MyCapytain/resources/texts/api/cts.py

@@ -106,9 +106,6 @@ def getReffs(self, level=1, reference=None):
         """
         if hasattr(self, "__depth__"):
             level = level + self.depth
-        if not reference:
-            if hasattr(self, "reference"):
-                reference = self.reference
 
         return self.getValidReff(level, reference)
 

tests/resolvers/cts/test_api.py

@@ -0,0 +1,102 @@
+from MyCapytain.resolvers.cts.api import HttpCTSResolver
+from MyCapytain.retrievers.cts5 import CTS
+from MyCapytain.common.utils import xmlparser, Mimetypes, NS
+from MyCapytain.resources.prototypes.text import Passage
+
+from unittest import TestCase
+from mock import MagicMock
+
+
+with open("tests/testing_data/cts/getpassage.xml") as f:
+    GET_PASSAGE = xmlparser(f)
+with open("tests/testing_data/cts/getpassageplus.xml") as f:
+    GET_PASSAGE_PLUS = xmlparser(f)
+with open("tests/testing_data/cts/getprevnexturn.xml") as f:
+    NEXT_PREV = xmlparser(f)
+with open("tests/testing_data/cts/getValidReff.1.1.xml") as f:
+    GET_VALID_REFF = xmlparser(f)
+with open("tests/testing_data/cts/getCapabilities.xml") as f:
+    GET_CAPABILITIES = xmlparser(f)
+
+
+class TestHttpCTSResolver(TestCase):
+    def setUp(self):
+        self.resolver = HttpCTSResolver(CTS("http://localhost"))
+        self.resolver.endpoint.getPassagePlus = MagicMock(return_value=GET_PASSAGE_PLUS)
+        self.resolver.endpoint.getPassage = MagicMock(return_value=GET_PASSAGE)
+        self.resolver.endpoint.getPrevNextUrn = MagicMock(return_value=NEXT_PREV)
+        self.resolver.endpoint.getValidReff = MagicMock(return_value=GET_VALID_REFF)
+        self.resolver.endpoint.getCapabilities = MagicMock(return_value=GET_CAPABILITIES)
+
+    def test_getPassage_full(self):
+        """ Test that we can get a full text """
+        passage = self.resolver.getPassage("urn:cts:latinLit:phi1294.phi002.perseus-lat2")
+
+        # We check we made a reroute to GetPassage request
+        self.resolver.endpoint.getPassage.assert_called_with(
+            urn="urn:cts:latinLit:phi1294.phi002.perseus-lat2"
+        )
+        self.assertIsInstance(
+            passage, Passage,
+            "GetPassage should always return passages objects"
+        )
+
+        children = list(passage.getReffs())
+
+        # We check the passage is able to perform further requests and is well instantiated
+        self.resolver.endpoint.getValidReff.assert_called_with(
+            urn="urn:cts:latinLit:phi1294.phi002.perseus-lat2",
+            level=1
+        )
+        self.assertEqual(
+            children[0], 'urn:cts:latinLit:phi1294.phi002.perseus-lat2:1.1.1',
+            "Resource should be string identifiers"
+        )
+
+        self.assertIn(
+            "Hic est quem legis ille, quem requiris,", passage.export(output=Mimetypes.PLAINTEXT),
+            "Export Text should work correctly"
+        )
+
+        self.assertEqual(
+            passage.export(output=Mimetypes.ETREE).xpath(".//tei:l[@n='1']/text()", namespaces=NS, magic_string=False),
+            ["Hic est quem legis ille, quem requiris, "],
+            "Export to Etree should give an Etree or Etree like object"
+        )
+
+    def test_getPassage_subreference(self):
+        """ Test that we can get a subreference text passage"""
+        passage = self.resolver.getPassage("urn:cts:latinLit:phi1294.phi002.perseus-lat2", "1.1")
+
+        # We check we made a reroute to GetPassage request
+        self.resolver.endpoint.getPassage.assert_called_with(
+            urn="urn:cts:latinLit:phi1294.phi002.perseus-lat2:1.1"
+        )
+        self.assertIsInstance(
+            passage, Passage,
+            "GetPassage should always return passages objects"
+        )
+
+        children = list(passage.getReffs())
+
+        # We check the passage is able to perform further requests and is well instantiated
+        self.resolver.endpoint.getValidReff.assert_called_with(
+            urn="urn:cts:latinLit:phi1294.phi002.perseus-lat2:1.1",
+            level=1
+        )
+        self.assertEqual(
+            children[0], 'urn:cts:latinLit:phi1294.phi002.perseus-lat2:1.1.1',
+            "Resource should be string identifiers"
+        )
+
+        self.assertIn(
+            "Hic est quem legis ille, quem requiris,", passage.export(output=Mimetypes.PLAINTEXT),
+            "Export Text should work correctly"
+        )
+
+        self.assertEqual(
+            passage.export(output=Mimetypes.ETREE).xpath(".//tei:l[@n='1']/text()", namespaces=NS, magic_string=False),
+            ["Hic est quem legis ille, quem requiris, "],
+            "Export to Etree should give an Etree or Etree like object"
+        )
+