Transliteration update

- Removed TransliterationParameters and unit test
- Updated example to use DocumentParameters
- Updated unit test to use DocumentParameters

Author: Chris Park

examples/transliteration.py

@@ -8,20 +8,16 @@
 import json
 import os
 
-from rosette.api import API, TransliterationParameters, RosetteException
+from rosette.api import API, DocumentParameters, RosetteException
 
 
 def run(key, altUrl='https://api.rosette.com/rest/v1/'):
     # Create an API instance
     api = API(user_key=key, service_url=altUrl)
 
     transliteration_data = "Some random text"
-    params = TransliterationParameters()
+    params = DocumentParameters()
     params["content"] = transliteration_data
-    params["sourceLanguage"] = "eng"
-    params["sourceScript"] = "Latn"
-    params["targetLanguage"] = "zho"
-    params["targetScript"] = "Hani"
 
     try:
         return api.transliterate(params)

rosette/api.py

@@ -295,32 +295,6 @@ def validate(self):
                     repr(option))
 
 
-class TransliterationParameters(_DocumentParamSetBase):
-    """Parameter object for C{transliteration} endpoint.
-    Required:
-    C{content} Textual content
-    C{sourceLanguage} Source language code
-    C{sourceScript} Source language script
-    C{targetLanguage} Target language code
-    C{targetScript} Target language script
-    """
-
-    def __init__(self):
-        self.use_multipart = False
-        _DocumentParamSetBase.__init__(self, ("content", "sourceLanguage", "sourceScript",
-                                              "targetLanguage", "targetScript"))
-
-    def validate(self):
-        """Internal. Do not use."""
-        for option in ("content", "sourceLanguage", "sourceScript", "targetLanguage",
-                       "targetScript"):
-            if self[option] is None:
-                raise RosetteException(
-                    "missingParameter",
-                    "Required Transliteration parameter, " + option + ", not supplied",
-                    repr(option))
-
-
 class EndpointCaller:
     """L{EndpointCaller} objects are invoked via their instance methods to obtain results
     from the Rosette server described by the L{API} object from which they
@@ -949,6 +923,6 @@ def syntax_dependencies(self, parameters):
     def transliteration(self, parameters):
         """
         Transliterate given context
-        @type parameters: L{TransliterationParameters}
+        @type parameters: L{DocumentParameters}
         @return: A python dictionary containing the results of the transliteration"""
         return EndpointCaller(self, self.endpoints['TRANSLITERATION']).call(parameters)

tests/test_rosette_api.py

@@ -680,61 +680,6 @@ def test_the_syntax_dependencies_endpoint(api, json_response, doc_params):
 
 # Test the transliteration endpoint
 
-
-def test_for_transliteration_required_parameters(api, json_response):
-    """Test transliteration parameters"""
-    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/transliteration",
-                           body=json_response, status=200, content_type="application/json")
-
-    params = TransliterationParameters()
-    params["content"] = "Random text"
-
-    with pytest.raises(RosetteException) as e_rosette:
-        result = api.transliteration(params)
-
-    assert e_rosette.value.status == 'missingParameter'
-    assert e_rosette.value.message == ('Required Transliteration parameter, '
-                                       'sourceLanguage, not supplied')
-
-    params["sourceLanguage"] = "eng"
-
-    with pytest.raises(RosetteException) as e_rosette:
-        result = api.transliteration(params)
-
-    assert e_rosette.value.status == 'missingParameter'
-    assert e_rosette.value.message == ('Required Transliteration parameter, '
-                                       'sourceScript, not supplied')
-
-    params["sourceScript"] = "Latn"
-
-    with pytest.raises(RosetteException) as e_rosette:
-        result = api.transliteration(params)
-
-    assert e_rosette.value.status == 'missingParameter'
-    assert e_rosette.value.message == ('Required Transliteration parameter, '
-                                       'targetLanguage, not supplied')
-
-    params["targetLanguage"] = "zho"
-
-    with pytest.raises(RosetteException) as e_rosette:
-        result = api.transliteration(params)
-
-    assert e_rosette.value.status == 'missingParameter'
-    assert e_rosette.value.message == ('Required Transliteration parameter, '
-                                       'targetScript, not supplied')
-
-    params["targetScript"] = "Hani"
-
-    result = api.transliteration(params)
-    assert result["name"] == "Rosette API"
-
-    httpretty.disable()
-    httpretty.reset()
-
-
 def test_the_transliteration_endpoint(api, json_response):
     """Test the transliteration endpoint"""
     httpretty.enable()
@@ -743,12 +688,8 @@ def test_the_transliteration_endpoint(api, json_response):
     httpretty.register_uri(httpretty.POST, "https://api.rosette.com/rest/v1/transliteration",
                            body=json_response, status=200, content_type="application/json")
 
-    params = TransliterationParameters()
+    params = DocumentParameters()
     params["content"] = "Some test content"
-    params["sourceLanguage"] = "eng"
-    params["sourceScript"] = "Latn"
-    params["targetLanguage"] = "zho"
-    params["targetScript"] = "Hani"
     result = api.transliteration(params)
     assert result["name"] == "Rosette API"
     httpretty.disable()