Merge pull request #110 from rosette-api/RCB-622-param-fix

RCB-622: fix calling by map

Author: asoosprecognox

rosette/api.py

@@ -86,7 +86,7 @@ def __str__(self):
         return sst + ": " + self.message + ":\n  " + self.response_message
 
 
-class _DocumentParamSetBase(object):
+class _RequestParametersBase(object):
 
     def __init__(self, repertoire):
         self.__params = {}
@@ -135,7 +135,7 @@ def _byteify(value):  # py 3 only
     return byte_array
 
 
-class DocumentParameters(_DocumentParamSetBase):
+class DocumentParameters(_RequestParametersBase):
     """Parameter object for all operations requiring input other than
     translated_name.
     Two fields, C{content} and C{inputUri}, are set via
@@ -152,7 +152,7 @@ class DocumentParameters(_DocumentParamSetBase):
 
     def __init__(self):
         """Create a L{DocumentParameters} object."""
-        _DocumentParamSetBase.__init__(
+        _RequestParametersBase.__init__(
             self, ("content", "contentUri", "language", "profileId"))
         self.file_name = ""
         self.use_multipart = False
@@ -199,7 +199,7 @@ def load_document_string(self, content_as_string):
         self["content"] = content_as_string
 
 
-class NameTranslationParameters(_DocumentParamSetBase):
+class NameTranslationParameters(_RequestParametersBase):
     """Parameter object for C{name-translation} endpoint.
     The following values may be set by the indexing (i.e.,C{ parms["name"]}) operator.
     The values are all strings (when not C{None}).
@@ -227,7 +227,7 @@ class NameTranslationParameters(_DocumentParamSetBase):
 
     def __init__(self):
         self.use_multipart = False
-        _DocumentParamSetBase.__init__(
+        _RequestParametersBase.__init__(
             self,
             ("name",
              "targetLanguage",
@@ -248,7 +248,7 @@ def validate(self):
                     repr(option))
 
 
-class AddressSimilarityParameters(_DocumentParamSetBase):
+class AddressSimilarityParameters(_RequestParametersBase):
     """Parameter object for C{address-similarity} endpoint.
 
     C{address1} and C{address2} are required.
@@ -271,7 +271,7 @@ class AddressSimilarityParameters(_DocumentParamSetBase):
 
     def __init__(self):
         self.use_multipart = False
-        _DocumentParamSetBase.__init__(self, ("address1", "address2", "parameters"))
+        _RequestParametersBase.__init__(self, ("address1", "address2", "parameters"))
 
     def validate(self):
         """Internal. Do not use."""
@@ -283,7 +283,7 @@ def validate(self):
                     repr(option))
 
 
-class NameSimilarityParameters(_DocumentParamSetBase):
+class NameSimilarityParameters(_RequestParametersBase):
     """Parameter object for C{name-similarity} endpoint.
 
     C{name1} and C{name2} are required.
@@ -313,7 +313,7 @@ class NameSimilarityParameters(_DocumentParamSetBase):
 
     def __init__(self):
         self.use_multipart = False
-        _DocumentParamSetBase.__init__(self, ("name1", "name2", "parameters"))
+        _RequestParametersBase.__init__(self, ("name1", "name2", "parameters"))
 
     def validate(self):
         """Internal. Do not use."""
@@ -325,7 +325,7 @@ def validate(self):
                     repr(option))
 
 
-class NameDeduplicationParameters(_DocumentParamSetBase):
+class NameDeduplicationParameters(_RequestParametersBase):
     """Parameter object for C{name-deduplication} endpoint.
     Required:
     C{names} A list of C{name} objects
@@ -334,7 +334,7 @@ class NameDeduplicationParameters(_DocumentParamSetBase):
 
     def __init__(self):
         self.use_multipart = False
-        _DocumentParamSetBase.__init__(self, ("names", "threshold"))
+        _RequestParametersBase.__init__(self, ("names", "threshold"))
 
     def validate(self):
         """Internal. Do not use."""
@@ -438,7 +438,7 @@ def ping(self):
         response = self.api.get_http(url, headers=headers)
         return self.__finish_result(response, "ping")
 
-    def call(self, parameters):
+    def call(self, parameters, paramtype=None):
         """Invokes the endpoint to which this L{EndpointCaller} is bound.
         Passes data and metadata specified by C{parameters} to the server
         endpoint to which this L{EndpointCaller} object is bound.  For all
@@ -455,24 +455,26 @@ def call(self, parameters):
         @param parameters: An object specifying the data,
         and possible metadata, to be processed by the endpoint.  See the
         details for those object types.
-        @type parameters: For C{name-translation}, L{NameTranslationParameters},
-        otherwise L{DocumentParameters} or L{str}
+        @type parameters: Parameters types or L{str} for document request.
+        @param paramtype: Required parameters type.
         @return: A python dictionary expressing the result of the invocation.
         """
+        if paramtype and not isinstance(parameters, paramtype):
+            raise RosetteException(
+                "incompatible",
+                "The parameters must be " + str(paramtype),
+                self.suburl)
 
-        if not isinstance(parameters, _DocumentParamSetBase):
-            if self.suburl != self.api.endpoints['NAME_SIMILARITY'] \
-                    and self.suburl != self.api.self.api.endpoints['NAME_TRANSLATION'] \
-                    and self.suburl != self.api.self.api.endpoints['NAME_DEDUPLICATION'] \
-                    and self.suburl != self.api.self.api.endpoints['ADDRESS_SIMILARITY']:
-                text = parameters
-                parameters = DocumentParameters()
-                parameters['content'] = text
-            else:
-                raise RosetteException(
-                    "incompatible",
-                    "Text-only input only works for DocumentParameter endpoints",
-                    self.suburl)
+        if type(parameters) == str:
+            text = parameters
+            parameters = DocumentParameters()
+            parameters['content'] = text
+
+        if not paramtype and not isinstance(parameters, DocumentParameters):
+            raise RosetteException(
+                "incompatible",
+                "The parameters must be string or DocumentParameters",
+                self.suburl)
 
         self.use_multipart = parameters.use_multipart
         url = self.service_url + self.suburl
@@ -915,7 +917,7 @@ def address_similarity(self, parameters):
         and possible metadata, to be processed by the name matcher.
         @type parameters: L{AddressSimilarityParameters}
         @return: A python dictionary containing the results of name matching."""
-        return EndpointCaller(self, self.endpoints['ADDRESS_SIMILARITY']).call(parameters)
+        return EndpointCaller(self, self.endpoints['ADDRESS_SIMILARITY']).call(parameters, AddressSimilarityParameters)
 
     def name_translation(self, parameters):
         """
@@ -925,7 +927,7 @@ def name_translation(self, parameters):
         and possible metadata, to be processed by the name translator.
         @type parameters: L{NameTranslationParameters}
         @return: A python dictionary containing the results of name translation."""
-        return EndpointCaller(self, self.endpoints['NAME_TRANSLATION']).call(parameters)
+        return EndpointCaller(self, self.endpoints['NAME_TRANSLATION']).call(parameters, NameTranslationParameters)
 
     def translated_name(self, parameters):
         """ deprecated
@@ -944,7 +946,7 @@ def name_similarity(self, parameters):
         and possible metadata, to be processed by the name matcher.
         @type parameters: L{NameSimilarityParameters}
         @return: A python dictionary containing the results of name matching."""
-        return EndpointCaller(self, self.endpoints['NAME_SIMILARITY']).call(parameters)
+        return EndpointCaller(self, self.endpoints['NAME_SIMILARITY']).call(parameters, NameSimilarityParameters)
 
     def matched_name(self, parameters):
         """ deprecated
@@ -962,7 +964,7 @@ def name_deduplication(self, parameters):
         as a threshold
         @type parameters: L{NameDeduplicationParameters}
         @return: A python dictionary containing the results of de-duplication"""
-        return EndpointCaller(self, self.endpoints['NAME_DEDUPLICATION']).call(parameters)
+        return EndpointCaller(self, self.endpoints['NAME_DEDUPLICATION']).call(parameters, NameDeduplicationParameters)
 
     def text_embedding(self, parameters):
         """ deprecated

tests/test_rosette_api.py

@@ -65,6 +65,12 @@ def doc_params():
     params['content'] = 'Sample test string'
     return params
 
+@pytest.fixture
+def doc_map():
+    """ fixture for a simple map of doc request """
+    return {'content': 'Simple test string'}
+
+
 # Of Note: httpretty provides a short hand decorator, @httpretty.activate, that wraps the decorated
 # function with httpretty.enable() and ends it with httpretty.disable().  However, when combined
 # with pytest fixtures, the passed in fixture arguments are ignored, resulting in a TypeError.
@@ -211,32 +217,40 @@ def test_the_max_pool_size(json_response, doc_params):
 # Test the language endpoint
 
 
-def test_the_language_endpoint(api, json_response, doc_params):
+def test_the_language_endpoint(api, json_response, doc_params, doc_map):
     """Test language endpoint"""
     httpretty.enable()
-    httpretty.register_uri(httpretty.POST, "https://api.rosette.com/rest/v1/info",
-                           body=json_response, status=200, content_type="application/json")
     httpretty.register_uri(httpretty.POST, "https://api.rosette.com/rest/v1/language",
                            body=json_response, status=200, content_type="application/json")
 
     result = api.language(doc_params)
     assert result["name"] == "Rosette"
+
+    with pytest.raises(RosetteException) as e_rosette:
+        result = api.language(doc_map)
+    assert e_rosette.value.status == 'incompatible'
+
     httpretty.disable()
     httpretty.reset()
 
 # Test the sentences endpoint
 
 
-def test_the_sentences_endpoint(api, json_response, doc_params):
+def test_the_sentences_endpoint(api, json_response, doc_params, doc_map):
     """Test the sentences endpoint"""
     httpretty.enable()
-    httpretty.register_uri(httpretty.POST, "https://api.rosette.com/rest/v1/info",
-                           body=json_response, status=200, content_type="application/json")
     httpretty.register_uri(httpretty.POST, "https://api.rosette.com/rest/v1/sentences",
                            body=json_response, status=200, content_type="application/json")
 
     result = api.sentences(doc_params)
     assert result["name"] == "Rosette"
+
+    with pytest.raises(RosetteException) as e_rosette:
+        result = api.sentences(doc_map)
+
+    assert e_rosette.value.status == 'incompatible'
+
+
     httpretty.disable()
     httpretty.reset()
 
@@ -246,8 +260,6 @@ def test_the_sentences_endpoint(api, json_response, doc_params):
 def test_the_tokens_endpoint(api, json_response, doc_params):
     """Test the tokens endpoint"""
     httpretty.enable()
-    httpretty.register_uri(httpretty.POST, "https://api.rosette.com/rest/v1/info",
-                           body=json_response, status=200, content_type="application/json")
     httpretty.register_uri(httpretty.POST, "https://api.rosette.com/rest/v1/tokens",
                            body=json_response, status=200, content_type="application/json")
 
@@ -403,6 +415,29 @@ def test_the_multipart_operation(api, json_response, doc_params, tmpdir):
     httpretty.disable()
     httpretty.reset()
 
+
+def test_incompatible_type(api, json_response):
+    """Test the name translation endpoint"""
+    httpretty.enable()
+    httpretty.register_uri(httpretty.POST, "https://api.rosette.com/rest/v1/info",
+                           body=json_response, status=200, content_type="application/json")
+    httpretty.register_uri(httpretty.POST, "https://api.rosette.com/rest/v1/sentences",
+                           body=json_response, status=200, content_type="application/json")
+
+    params = NameTranslationParameters()
+    params["name"] = "some data to translate"
+    params["entityType"] = "PERSON"
+    params["targetLanguage"] = "eng"
+    params["targetScript"] = "Latn"
+
+    # oops, called sentences
+    with pytest.raises(RosetteException) as e_rosette:
+        api.sentences(params)
+
+    httpretty.disable()
+    httpretty.reset()
+
+
 # Test the name translation endpoint
 
 
@@ -426,7 +461,33 @@ def test_the_name_translation_endpoint(api, json_response):
 
 # Test the name similarity endpoint
 
+def test_the_name_requests_with_text(api, json_response):
+    """Test the name similarity with text"""
+    httpretty.enable()
+    httpretty.register_uri(httpretty.POST, "https://api.rosette.com/rest/v1/info",
+                           body=json_response, status=200, content_type="application/json")
+    httpretty.register_uri(httpretty.POST, "https://api.rosette.com/rest/v1/name-similarity",
+                           body=json_response, status=200, content_type="application/json")
+    with pytest.raises(RosetteException) as e_rosette:
+        result = api.name_similarity("should fail")
+    assert e_rosette.value.status == 'incompatible'
+
+    with pytest.raises(RosetteException) as e_rosette:
+        result = api.name_translation("should fail")
+    assert e_rosette.value.status == 'incompatible'
+
+    with pytest.raises(RosetteException) as e_rosette:
+        result = api.name_deduplication("should fail")
+    assert e_rosette.value.status == 'incompatible'
+
+    with pytest.raises(RosetteException) as e_rosette:
+        result = api.address_similarity("should fail")
+    assert e_rosette.value.status == 'incompatible'
+
+    httpretty.disable()
+    httpretty.reset()
 
+ 
 def test_the_name_similarity_single_parameters(api, json_response):
     """Test the name similarity parameters"""
     httpretty.enable()