Merge branch 'develop'

Author: seth-mg

.gitignore

@@ -7,6 +7,9 @@
 ehthumbs.db
 Thumbs.db
 
+# VS Code
+.vscode
+
 # Jetbrains
 **/.idea/*
 !**/.idea/runConfigurations/

.travis.yml

@@ -0,0 +1,60 @@
+
+
+def versions = [3.7, 3.8, 3.9, 3.10, 3.11]
+
+def runSonnarForPythonVersion(sourceDir, ver){
+    mySonarOpts="-Dsonar.sources=/source -Dsonar.host.url=${env.SONAR_HOST_URL} -Dsonar.login=${env.SONAR_AUTH_TOKEN}"
+    if("${env.CHANGE_ID}" != "null"){
+        mySonarOpts = "$mySonarOpts -Dsonar.pullrequest.key=${env.CHANGE_ID} -Dsonar.pullrequest.branch=${env.BRANCH_NAME}"
+    } else {
+        mySonarOpts = "$mySonarOpts -Dsonar.branch.name=${env.BRANCH_NAME}"
+    } 
+    if ("${env.CHANGE_BRANCH}" != "null") {
+        mySonarOpts="$mySonarOpts -Dsonar.pullrequest.base=${env.CHANGE_TARGET} -Dsonar.pullrequest.branch=${env.CHANGE_BRANCH}"
+    }
+
+    // Only run Sonar once.
+    if(ver == 3.11) {
+        sonarExec="cd /root/ && \
+                   wget -q https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-4.8.0.2856-linux.zip && \
+                   unzip -q sonar-scanner-cli-4.8.0.2856-linux.zip && \
+                   cd /source && \
+                   /root/sonar-scanner-4.8.0.2856-linux/bin/sonar-scanner ${mySonarOpts}"
+    } else {
+        sonarExec="echo Skipping Sonar for this version."
+    }
+
+    sh "docker run \
+            --pull always \
+            --rm --volume ${sourceDir}:/source \
+            python:${ver}-slim \
+            bash -c \"apt-get update && \
+            apt-get install -y wget unzip && \
+            pip3 install tox && \
+            cd /source && \
+            tox && \
+            ${sonarExec}\""
+}
+
+node ("docker-light") {
+    def sourceDir = pwd()
+    try {
+        stage("Clean up") {
+            step([$class: 'WsCleanup'])
+        }
+        stage("Checkout Code") {
+            checkout scm
+        }
+        stage("Build & Test") {
+            withSonarQubeEnv {
+                
+                versions.each { ver ->
+                    runSonnarForPythonVersion(sourceDir, ver)
+                }
+            }
+        }
+    } catch (e) {
+        currentBuild.result = "FAILED"
+        throw e
+    }
+}

CI.Jenkinsfile

@@ -47,7 +47,7 @@ To test changes you have made to the binding, you can use a pre-configured Docke
 git clone git@github.com:rosette-api/python.git
 cd python
 # Modify the binding...
-docker run -e API_KEY=$API_KEY -v $(pwd):/source rosetteapi/docker-python
+docker run -e API_KEY=$API_KEY -v $(pwd):/source rosette/docker-python
 ```
 
 Optional parameters for the `docker run` execution are:

DEVELOPER.md

@@ -15,8 +15,8 @@ node ("docker-light") {
             echo "${env.ALT_URL}"
             def useUrl = ("${env.ALT_URL}" == "null") ? "${env.BINDING_TEST_URL}" : "${env.ALT_URL}"
             withEnv(["API_KEY=${env.ROSETTE_API_KEY}", "ALT_URL=${useUrl}"]) {
-                sh "docker pull rosetteapi/docker-python"
-                sh "docker run --rm -e API_KEY=${API_KEY} -e ALT_URL=${ALT_URL} -v ${SOURCEDIR}:/source rosetteapi/docker-python"
+                sh "docker pull rosette/docker-python"
+                sh "docker run --rm -e API_KEY=${API_KEY} -e ALT_URL=${ALT_URL} -v ${SOURCEDIR}:/source rosette/docker-python"
             }
         }
         slack(true)

Jenkinsfile

@@ -2,7 +2,6 @@
 
 ---
 
-[![Build Status](https://travis-ci.org/rosette-api/python.svg?branch=develop)](https://travis-ci.org/rosette-api/python)
 [![PyPI version](https://badge.fury.io/py/rosette-api.svg)](https://badge.fury.io/py/rosette-api)
 [![Python Versions](https://img.shields.io/pypi/pyversions/rosette-api.svg?color=dark%20green&label=Python%20Versions)](https://img.shields.io/pypi/pyversions/rosette-api.svg?color=dark%20green&label=Python%20Versions)
 

README.md

@@ -1,5 +1,5 @@
 application:
-  image: rosetteapi/docker-python
+  image: rosette/docker-python
   environment:
     - API_KEY=$API_KEY
     - HTTP_PROXY=http://squid:3128

docker-compose.yml

@@ -55,9 +55,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '1.24.0'
+version = '1.25.1'
 # The full version, including alpha/beta/rc tags.
-release = '1.24.0'
+release = '1.25.1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/source/conf.py

@@ -18,6 +18,7 @@ def run(key, alt_url='https://api.rosette.com/rest/v1/'):
     params = AddressSimilarityParameters()
     params["address1"] = {"houseNumber": "1600", "road": "Pennsylvania Ave NW", "city": "Washington", "state": "DC", "postCode": "20500"}
     params["address2"] = "160 Pennsilvana Avenue, Washington, D.C., 20500"
+    #params["parameters"] = {"houseNumberAddressFieldWeight": "0.9"}
 
     try:
         return api.address_similarity(params)

examples/address_similarity.py

@@ -20,6 +20,8 @@ def run(key, alt_url='https://api.rosette.com/rest/v1/'):
     params = NameSimilarityParameters()
     params["name1"] = {"text": matched_name_data1, "language": "eng", "entityType": "PERSON"}
     params["name2"] = {"text": matched_name_data2, "entityType": "PERSON"}
+    #params["parameters"] = {"conflictScore": "0.9", "deletionScore": "0.2"}
+
     try:
         return api.name_similarity(params)
     except RosetteException as exception:

examples/name_similarity.py

@@ -12,4 +12,4 @@
 limitations under the License.
 """
 
-__version__ = '1.24.0'
+__version__ = '1.25.1'

rosette/__init__.py

@@ -30,7 +30,7 @@
 
 _APPLICATION_JSON = 'application/json'
 _BINDING_LANGUAGE = 'python'
-_BINDING_VERSION = '1.24.0'
+_BINDING_VERSION = '1.25.1'
 _CONCURRENCY_HEADER = 'x-rosetteapi-concurrency'
 _CUSTOM_HEADER_PREFIX = 'X-RosetteAPI-'
 _CUSTOM_HEADER_PATTERN = re.compile('^' + _CUSTOM_HEADER_PREFIX)
@@ -113,7 +113,7 @@ def serialize(self, options):
         """serialize keys with values"""
         self.validate()
         values = {}
-        for (key, val) in self.__params.items():
+        for key, val in self.__params.items():
             if val is None:
                 continue
             else:
@@ -153,14 +153,12 @@ class DocumentParameters(_DocumentParamSetBase):
     def __init__(self):
         """Create a L{DocumentParameters} object."""
         _DocumentParamSetBase.__init__(
-            self, ("content", "contentUri", "genre", "language", "profileId"))
+            self, ("content", "contentUri", "language", "profileId"))
         self.file_name = ""
         self.use_multipart = False
 
     def validate(self):
         """Internal. Do not use."""
-        if self["genre"] is not None:
-            warnings.warn("genre is deprecated and will be removed in the next release.")
         if self["content"] is None:
             if self["contentUri"] is None:
                 raise RosetteException(
@@ -214,7 +212,7 @@ class NameTranslationParameters(_DocumentParamSetBase):
 
     C{targetLangauge} The language into which the name is to be translated.
 
-    C{entityType} The entity type (TBD) of the name.
+    C{entityType} The entity type of the name.  PERSON (default), LOCATION, or ORGANIZATION
 
     C{sourceLanguageOfOrigin} The language of origin of the name.
 
@@ -242,7 +240,7 @@ def __init__(self):
 
     def validate(self):
         """Internal. Do not use."""
-        for option in ("name", "targetLanguage"):  # required
+        for option in "name", "targetLanguage":  # required
             if self[option] is None:
                 raise RosetteException(
                     "missingParameter",
@@ -252,23 +250,32 @@ def validate(self):
 
 class AddressSimilarityParameters(_DocumentParamSetBase):
     """Parameter object for C{address-similarity} endpoint.
-    All are required.
+
+    C{address1} and C{address2} are required.
+
+    `parameters` is optional.
 
     C{address1} The address to be matched, a C{address} object or address string.
 
     C{address2} The address to be matched, a C{address} object or address string.
 
     The C{address} object contains these optional fields:
       city, island, district, stateDistrict, state, countryRegion, country, worldRegion, postCode, poBox
+
+    `parameters` is a dictionary listing any parameter overrides to include.  For example, `postCodeAddressFieldWeight`.
+    Setting `parameters` is not cumulative.  Define all overrides at once.  If defined multiple times, only the
+    final declaration is used.
+
+    See `examples/address_similarity.py`
     """
 
     def __init__(self):
         self.use_multipart = False
-        _DocumentParamSetBase.__init__(self, ("address1", "address2"))
+        _DocumentParamSetBase.__init__(self, ("address1", "address2", "parameters"))
 
     def validate(self):
         """Internal. Do not use."""
-        for option in ("address1", "address2"):  # required
+        for option in "address1", "address2":  # required
             if self[option] is None:
                 raise RosetteException(
                     "missingParameter",
@@ -278,30 +285,39 @@ def validate(self):
 
 class NameSimilarityParameters(_DocumentParamSetBase):
     """Parameter object for C{name-similarity} endpoint.
-    All are required.
+
+    C{name1} and C{name2} are required.
+
+    `parameters` is optional.
 
     C{name1} The name to be matched, a C{name} object.
 
     C{name2} The name to be matched, a C{name} object.
 
     The C{name} object contains these fields:
 
-    C{text} Text of the name, required.
+        C{text} Text of the name, required.
+
+        C{language} Language of the name in ISO639 three-letter code, optional.
+
+        C{script} The ISO15924 code of the name, optional.
 
-    C{language} Language of the name in ISO639 three-letter code, optional.
+        C{entityType} The entity type, can be "PERSON", "LOCATION" or "ORGANIZATION", optional.
 
-    C{script} The ISO15924 code of the name, optional.
+    `parameters` is a dictionary listing any parameter overrides to include.  For example, `deletionScore`.
+    Setting `parameters` is not cumulative.  Define all overrides at once.  If defined multiple times, only the
+    final declaration is used.
 
-    C{entityType} The entity type, can be "PERSON", "LOCATION" or "ORGANIZATION", optional.
+    See `examples/name_similarity.py`
     """
 
     def __init__(self):
         self.use_multipart = False
-        _DocumentParamSetBase.__init__(self, ("name1", "name2"))
+        _DocumentParamSetBase.__init__(self, ("name1", "name2", "parameters"))
 
     def validate(self):
         """Internal. Do not use."""
-        for option in ("name1", "name2"):  # required
+        for option in "name1", "name2":  # required
             if self[option] is None:
                 raise RosetteException(
                     "missingParameter",
@@ -496,7 +512,7 @@ def call(self, parameters):
                 _my_loads(rdata, response_headers), status)
         else:
             if self.debug:
-                headers[_CUSTOM_HEADER_PREFIX + 'Devel'] = True
+                headers[_CUSTOM_HEADER_PREFIX + 'Devel'] = 'true'
             self.logger.info('operate: ' + url)
             headers['Accept'] = _APPLICATION_JSON
             headers['Accept-Encoding'] = "gzip"

rosette/api.py

@@ -49,13 +49,11 @@ def read(*filenames, **kwargs):
         'Natural Language :: English',
         'Operating System :: OS Independent',
         'Programming Language :: Python',
-        'Programming Language :: Python :: 2.7',
-        'Programming Language :: Python :: 3.5',
-        'Programming Language :: Python :: 3.6',
         'Programming Language :: Python :: 3.7',
         'Programming Language :: Python :: 3.8',
         'Programming Language :: Python :: 3.9',
         'Programming Language :: Python :: 3.10',
+        'Programming Language :: Python :: 3.11',
         'Topic :: Software Development :: Libraries :: Python Modules'
     ]
 )

setup.py

@@ -1,4 +1,5 @@
 sonar.projectKey=rosette-api-python-binding
 sonar.sources=rosette
+sonar.exclusions=**/tests/**,**/docs/**,**/examples/**
 sonar.python.coverage.reportPaths=coverage.xml
 #sonar.branch.name=RCB-596-pool-size