RCB-542 1.9 release (#77)

* Added runtime version

- Removed deprecated methods and messages
- Added method for returning User-Agent string
- Added unit test for User-Agent string
- Removed deprecated tests

* WS-1272 Multilingual example

* Example updates

* Update multilingual to True

Author: cp2boston

examples/entities.py

@@ -15,7 +15,7 @@ def run(key, alt_url='https://api.rosette.com/rest/v1/'):
     """ Run the example """
     # Create an API instance
     api = API(user_key=key, service_url=alt_url)
-    entities_text_data = "Bill Murray will appear in new Ghostbusters film: Dr. Peter Venkman was spotted filming a cameo in Boston this… http://dlvr.it/BnsFfS"
+    entities_text_data = "The Securities and Exchange Commission today announced the leadership of the agency’s trial unit.  Bridget Fitzpatrick has been named Chief Litigation Counsel of the SEC and David Gottesman will continue to serve as the agency’s Deputy Chief Litigation Counsel. Since December 2016, Ms. Fitzpatrick and Mr. Gottesman have served as Co-Acting Chief Litigation Counsel.  In that role, they were jointly responsible for supervising the trial unit at the agency’s Washington D.C. headquarters as well as coordinating with litigators in the SEC’s 11 regional offices around the country."
     params = DocumentParameters()
     params["content"] = entities_text_data
     params["genre"] = "social-media"

examples/language_multilingual.py

@@ -0,0 +1,41 @@
+# -*- coding: utf-8 -*-
+"""
+Example code to call Rosette API to determine the language of a piece of text.
+"""
+from __future__ import print_function
+
+import argparse
+import json
+import os
+
+from rosette.api import API, DocumentParameters, RosetteException
+
+
+def run(key, alt_url='https://api.rosette.com/rest/v1/'):
+    """ Run the example """
+    # Create an API instance
+    api = API(user_key=key, service_url=alt_url)
+
+    language_multilingual_data = "On Thursday, as protesters gathered in Washington D.C., the United States Federal Communications Commission under Chairman Ajit Pai voted 3-2 to overturn a 2015 decision, commonly called Net Neutrality, that forbade Internet service providers (ISPs) such as Verizon, Comcast, and AT&T from blocking individual websites or charging websites or customers more for faster load times.  Quatre femmes ont été nommées au Conseil de rédaction de la loi du Qatar. Jeudi, le décret royal du Qatar a annoncé que 28 nouveaux membres ont été nommés pour le Conseil de la Choura du pays.  ذكرت مصادر أمنية يونانية، أن 9 موقوفين من منظمة \"د هـ ك ب ج\" الذين كانت قد أوقفتهم الشرطة اليونانية في وقت سابق كانوا يخططون لاغتيال الرئيس التركي رجب طيب أردوغان."
+    params = DocumentParameters()
+    params["content"] = language_multilingual_data
+    api.set_custom_headers("X-RosetteAPI-App", "python-app")
+    api.set_option('multilingual', True)
+
+    try:
+        return api.language(params)
+    except RosetteException as exception:
+        print(exception)
+
+
+PARSER = argparse.ArgumentParser(formatter_class=argparse.ArgumentDefaultsHelpFormatter,
+                                 description='Calls the ' +
+                                 os.path.splitext(os.path.basename(__file__))[0] + ' endpoint')
+PARSER.add_argument('-k', '--key', help='Rosette API Key', required=True)
+PARSER.add_argument('-u', '--url', help="Alternative API URL",
+                    default='https://api.rosette.com/rest/v1/')
+
+if __name__ == '__main__':
+    ARGS = PARSER.parse_args()
+    RESULT = run(ARGS.key, ARGS.url)
+    print(json.dumps(RESULT, indent=2, ensure_ascii=False, sort_keys=True).encode("utf8"))

examples/morphology_complete.py

@@ -16,7 +16,7 @@ def run(key, alt_url='https://api.rosette.com/rest/v1/'):
     # Create an API instance
     api = API(user_key=key, service_url=alt_url)
 
-    morphology_complete_data = "The quick brown fox jumped over the lazy dog. Yes he did."
+    morphology_complete_data = "The quick brown fox jumped over the lazy dog. 👍🏾 Yes he did. B)"
     params = DocumentParameters()
     params["content"] = morphology_complete_data
     try:

examples/name_deduplication.py

@@ -16,7 +16,7 @@ def run(key, alt_url='https://api.rosette.com/rest/v1/'):
     # Create an API instance
     api = API(user_key=key, service_url=alt_url)
 
-    name_dedupe_data = 'John Smith,Johnathon Smith,Fred Jones'
+    name_dedupe_data = "Alice Terry,Alice Thierry,Betty Grable,Betty Gable,Norma Shearer,Norm Shearer,Brigitte Helm,Bridget Helem,Judy Holliday,Julie Halliday"
     threshold = 0.75
     params = NameDeduplicationParameters()
     params["names"] = name_dedupe_data.split(',')

examples/relationships.py

@@ -15,7 +15,7 @@ def run(key, alt_url='https://api.rosette.com/rest/v1/'):
     """ Run the example """
     # Create an API instance
     api = API(user_key=key, service_url=alt_url)
-    relationships_text_data = "Bill Gates, Microsoft's former CEO, is a philanthropist."
+    relationships_text_data = "FLIR Systems is headquartered in Oregon and produces thermal imaging, night vision, and infrared cameras and sensor systems.  According to the SEC’s order instituting a settled administrative proceeding, FLIR entered into a multi-million dollar contract to provide thermal binoculars to the Saudi government in November 2008.  Timms and Ramahi were the primary sales employees responsible for the contract, and also were involved in negotiations to sell FLIR’s security cameras to the same government officials.  At the time, Timms was the head of FLIR’s Middle East office in Dubai."
     params = DocumentParameters()
     params["content"] = relationships_text_data
     api.set_option('accuracyMode', 'PRECISION')

examples/sentences.py

@@ -16,7 +16,7 @@ def run(key, alt_url='https://api.rosette.com/rest/v1/'):
     # Create an API instance
     api = API(user_key=key, service_url=alt_url)
 
-    sentences_data = "This land is your land. This land is my land\nFrom California to the New York island;\nFrom the red wood forest to the Gulf Stream waters\n\nThis land was made for you and Me.\n\nAs I was walking that ribbon of highway,\nI saw above me that endless skyway:\nI saw below me that golden valley:\nThis land was made for you and me."
+    sentences_data = "This land is your land. This land is my land, from California to the New York island; from the red wood forest to the Gulf Stream waters. This land was made for you and Me. As I was walking that ribbon of highway, I saw above me that endless skyway: I saw below me that golden valley: This land was made for you and me."
     params = DocumentParameters()
     params["content"] = sentences_data
 

examples/transliteration.py

@@ -16,7 +16,7 @@ def run(key, alt_url='https://api.rosette.com/rest/v1/'):
     # Create an API instance
     api = API(user_key=key, service_url=alt_url)
 
-    transliteration_data = "Some random text"
+    transliteration_data = "ana r2ye7 el gam3a el sa3a 3 el 3asr"
     params = DocumentParameters()
     params["content"] = transliteration_data
 

rosette/api.py

@@ -26,6 +26,7 @@
 import re
 import warnings
 import requests
+import platform
 
 _BINDING_VERSION = '1.8.2'
 _GZIP_BYTEARRAY = bytearray([0x1F, 0x8b, 0x08])
@@ -82,50 +83,6 @@ def __str__(self):
         return sst + ": " + self.message + ":\n  " + self.response_message
 
 
-class _PseudoEnum(object):
-    """ Base class for MorphologyOutput """
-
-    def __init__(self):
-        pass
-
-    @classmethod
-    def validate(cls, value, name):
-        """ validation method """
-        values = []
-        for (key, value) in vars(cls).items():
-            if not key.startswith("__"):
-                values += [value]
-
-        # this is still needed to make sure that the parameter NAMES are known.
-        # If python didn't allow setting unknown values, this would be a
-        # language error.
-        if value not in values:
-            raise RosetteException(
-                "unknownVariable",
-                "The value supplied for " +
-                name +
-                " is not one of " +
-                ", ".join(values) +
-                ".",
-                repr(value))
-
-
-class MorphologyOutput(_PseudoEnum):
-    """ Class to provide Morphology sub-endpoints """
-
-    def __init__(self):
-        warnings.warn('MorphologyOutput to be removed in version 1.9.0. '
-                      'Please use API.morphology_output',
-                      DeprecationWarning)
-        _PseudoEnum.__init__()
-
-    LEMMAS = "lemmas"
-    PARTS_OF_SPEECH = "parts-of-speech"
-    COMPOUND_COMPONENTS = "compound-components"
-    HAN_READINGS = "han-readings"
-    COMPLETE = "complete"
-
-
 class _DocumentParamSetBase(object):
 
     def __init__(self, repertoire):
@@ -582,6 +539,7 @@ def __init__(
         self.url_parameters = {}
         self.max_pool_size = 1
         self.session = requests.Session()
+        self.user_agent_string = 'RosetteAPIPython/' + _BINDING_VERSION + '/' + platform.python_version()
 
         self.morphology_output = {
             'LEMMAS': 'lemmas',
@@ -617,6 +575,10 @@ def __del__(self):
         except ReferenceError:
             pass
 
+    def get_user_agent_string(self):
+        """ Return the User-Agent string """
+        return self.user_agent_string
+
     def _set_pool_size(self):
         adapter = requests.adapters.HTTPAdapter(
             pool_maxsize=self.max_pool_size)
@@ -632,7 +594,7 @@ def _make_request(self, operation, url, data, headers):
         @param data: request data
         @param headers: request headers
         """
-        headers['User-Agent'] = "RosetteAPIPython/" + _BINDING_VERSION
+        headers['User-Agent'] = self.get_user_agent_string()
 
         message = None
         code = "unknownError"
@@ -718,31 +680,12 @@ def post_http(self, url, data, headers):
 
         return _ReturnObject(_my_loads(rdata, response_headers), status)
 
-    def getPoolSize(self):
-        """
-        Returns the maximum pool size, which is the returned x-rosetteapi-concurrency value
-        """
-        warnings.warn('Method renamed to API.get_pool_size(). To be removed in version 1.9.0',
-                      DeprecationWarning)
-        return self.get_pool_size()
-
     def get_pool_size(self):
         """
         Returns the maximum pool size, which is the returned x-rosetteapi-concurrency value
         """
         return int(self.max_pool_size)
 
-    def setOption(self, name, value):
-        """
-        Sets an option
-
-        @param name: name of option
-        @param value: value of option
-        """
-        warnings.warn('Method renamed to API.set_option().  To be removed in version 1.9.0',
-                      DeprecationWarning)
-        return self.set_option(name, value)
-
     def set_option(self, name, value):
         """
         Sets an option
@@ -755,18 +698,6 @@ def set_option(self, name, value):
         else:
             self.options[name] = value
 
-    def getOption(self, name):
-        """
-        Gets an option
-
-        @param name: name of option
-
-        @return: value of option
-        """
-        warnings.warn('Method renamed to API.get_option().  To be removed in version 1.9.0',
-                      DeprecationWarning)
-        return self.get_option(name)
-
     def get_option(self, name):
         """
         Gets an option
@@ -780,31 +711,12 @@ def get_option(self, name):
         else:
             return None
 
-    def clearOptions(self):
-        """
-        Clears all options
-        """
-        warnings.warn('Method renamed to API.clear_options().  To be removed in version 1.9.0',
-                      DeprecationWarning)
-        self.clear_options()
-
     def clear_options(self):
         """
         Clears all options
         """
         self.options.clear()
 
-    def setUrlParameter(self, name, value):
-        """
-        Sets a URL parameter
-
-        @param name: name of parameter
-        @param value: value of parameter
-        """
-        warnings.warn('Method renamed to API.set_url_parameter().  To be removed in version 1.9.0',
-                      DeprecationWarning)
-        return self.set_url_parameter(name, value)
-
     def set_url_parameter(self, name, value):
         """
         Sets a URL parameter
@@ -817,18 +729,6 @@ def set_url_parameter(self, name, value):
         else:
             self.url_parameters[name] = value
 
-    def getUrlParameter(self, name):
-        """
-        Gets a URL parameter
-
-        @param name: name of parameter
-
-        @return: value of parameter
-        """
-        warnings.warn('Method renamed to API.get_url_parameter().  To be removed in version 1.9.0',
-                      DeprecationWarning)
-        return self.get_url_parameter(name)
-
     def get_url_parameter(self, name):
         """
         Gets a URL parameter
@@ -842,31 +742,12 @@ def get_url_parameter(self, name):
         else:
             return None
 
-    def clearUrlParameters(self):
-        """
-        Clears all options
-        """
-        warnings.warn('Method renamed to API.clear_url_parameters(). '
-                      'To be removed in version 1.9.0',
-                      DeprecationWarning)
-        self.clear_url_parameters()
-
     def clear_url_parameters(self):
         """
         Clears all options
         """
         self.url_parameters.clear()
 
-    def setCustomHeaders(self, name, value):
-        """
-        Sets custom headers
-
-        @param headers: array of custom headers to be set
-        """
-        warnings.warn('Method renamed to API.set_custom_headers().  To be removed in version 1.9.0',
-                      DeprecationWarning)
-        return self.set_custom_headers(name, value)
-
     def set_custom_headers(self, name, value):
         """
         Sets custom headers
@@ -878,29 +759,12 @@ def set_custom_headers(self, name, value):
         else:
             self.custom_headers[name] = value
 
-    def getCustomHeaders(self):
-        """
-        Get custom headers
-        """
-        warnings.warn('Method renamed to API.get_custom_headers().  To be removed in version 1.9.0',
-                      DeprecationWarning)
-        return self.get_custom_headers()
-
     def get_custom_headers(self):
         """
         Get custom headers
         """
         return self.custom_headers
 
-    def clearCustomHeaders(self):
-        """
-        Clears custom headers
-        """
-        warnings.warn('Method renamed to API.clear_custom_headers(). '
-                      'To be removed in version 1.9.0',
-                      DeprecationWarning)
-        self.clear_custom_headers()
-
     def clear_custom_headers(self):
         """
         Clears custom headers