WS-3314: update url, key header and documentation comments

Author: Adam Soos

rosette/__init__.py

@@ -1,5 +1,5 @@
 """
-Python client for the Rosette API.
+Python client for the Babel Street Analytics API.
 Copyright (c) 2014-2022 Basis Technology Corporation.
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

rosette/api.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 
 """
-Python client for the Rosette API.
+Python client for the Babel Street Analytics API.
 
 Copyright (c) 2014-2024 Basis Technology Corporation.
 
@@ -68,7 +68,7 @@ def _my_loads(obj, response_headers):
 
 
 class RosetteException(Exception):
-    """Exception thrown by all Rosette API operations for errors local and remote.
+    """Exception thrown by all Analytics API operations for errors local and remote.
 
     TBD. Right now, the only valid operation is conversion to __str__.
     """
@@ -96,13 +96,13 @@ def __init__(self, repertoire):
     def __setitem__(self, key, val):
         if key not in self.__params:
             raise RosetteException(
-                "badKey", "Unknown Rosette parameter key", repr(key))
+                "badKey", "Unknown Analytics parameter key", repr(key))
         self.__params[key] = val
 
     def __getitem__(self, key):
         if key not in self.__params:
             raise RosetteException(
-                "badKey", "Unknown Rosette parameter key", repr(key))
+                "badKey", "Unknown Analytics parameter key", repr(key))
         return self.__params[key]
 
     def validate(self):
@@ -370,9 +370,9 @@ def validate(self):
 
 class EndpointCaller(object):
     """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
+    from the Analytics server described by the L{API} object from which they
     are created.  Each L{EndpointCaller} object communicates with a specific endpoint
-    of the Rosette server, specified at its creation.  Use the specific
+    of the Analytics server, specified at its creation.  Use the specific
     instance methods of the L{API} object to create L{EndpointCaller} objects bound to
     corresponding endpoints.
 
@@ -382,7 +382,7 @@ class EndpointCaller(object):
 
     The results of all operations are returned as python dictionaries, whose
     keys and values correspond exactly to those of the corresponding
-    JSON return value described in the Rosette web service documentation.
+    JSON return value described in the Analytics web service documentation.
     """
 
     def __init__(self, api, suburl):
@@ -413,7 +413,7 @@ def __finish_result(self, response, ename):
                 complaint_url = ename + " " + self.suburl
 
             raise RosetteException(code, complaint_url +
-                                   " : failed to communicate with Rosette", msg)
+                                   " : failed to communicate with Analytics", msg)
 
     def __set_headers(self):
         headers = {'Accept': _APPLICATION_JSON,
@@ -435,7 +435,7 @@ def __set_headers(self):
             headers[_CUSTOM_HEADER_PREFIX + 'Devel'] = 'true'
 
         if self.user_key is not None:
-            headers[_CUSTOM_HEADER_PREFIX + "Key"] = self.user_key
+            headers["X-BabelStreetAPI-Key"] = self.user_key
 
         return headers
 
@@ -473,7 +473,7 @@ def call(self, parameters, paramtype=None):
 
         In all cases, the result is returned as a python dictionary
         conforming to the JSON object described in the endpoint's entry
-        in the Rosette web service documentation.
+        in the Analytics web service documentation.
 
         @param parameters: An object specifying the data,
         and possible metadata, to be processed by the endpoint.  See the
@@ -548,22 +548,22 @@ def call(self, parameters, paramtype=None):
 
 class API(object):
     """
-    Rosette Python Client Binding API; representation of a Rosette server.
+    Analytics Python Client Binding API; representation of an Analytics server.
     Call instance methods upon this object to obtain L{EndpointCaller} objects
-    which can communicate with particular Rosette server endpoints.
+    which can communicate with particular Analytics server endpoints.
     """
 
     def __init__(
             self,
             user_key=None,
-            service_url='https://api.rosette.com/rest/v1/',
+            service_url='https://analytics.babelstreet.com/rest/v1/',
             retries=5,
             refresh_duration=0.5,
             debug=False):
         """ Create an L{API} object.
         @param user_key: (Optional; required for servers requiring authentication.)
         An authentication string to be sent as user_key with all requests.  The
-        default Rosette server requires authentication to the server.
+        default Analytics server requires authentication to the server.
         """
         # logging.basicConfig(filename="binding.log", filemode="w", level=logging.DEBUG)
         self.user_key = user_key
@@ -703,7 +703,7 @@ def _make_request(self, operation, url, data, headers):
         except requests.exceptions.RequestException as exception:
             raise RosetteException(
                 exception,
-                "Unable to establish connection to the Rosette API server",
+                "Unable to establish connection to the Analytics API server",
                 url)
 
         raise RosetteException(code, message, url)