lusid-sdk 1.1.257__py3-none-any.whl → 2.0.430__py3-none-any.whl

lusid/{utilities → extensions}/proxy_config.py

@@ -1,3 +1,7 @@
+from urllib3 import make_headers
+from typing import Dict
+
+
 class ProxyConfig:
     """
     This class is used to hold the proxy configuration details
@@ -19,9 +23,10 @@ class ProxyConfig:
 
     @address.setter
     def address(self, address):
-
         if "http://" not in address and "https://" not in address:
-            raise ValueError(f"The provided proxy address of {address} does not contain a protocol, please specify in the full format e.g. http://myproxy.com:8080")
+            raise ValueError(
+                f"The provided proxy address of {address} does not contain a protocol, please specify in the full format e.g. http://myproxy.com:8080"
+            )
 
         self.__address = address
 
@@ -48,7 +53,20 @@ class ProxyConfig:
 
             proxy_url = f"{self.address[0:index + 3]}{self.username}:{self.password}@{self.address[index + 3:]}"
 
-        return {
-            "http": proxy_url,
-            "https": proxy_url
-        }
+        return {"http": proxy_url, "https": proxy_url}
+
+    @property
+    def headers(self) -> Dict[str, str]:
+        """Return Proxy auth headers
+
+        Returns
+        -------
+        Any
+            Proxy auth headers
+        """
+        if self.__username is not None and self.__password is not None:
+            return make_headers(
+                proxy_basic_auth=f"{self.__username}:{self.__password}"
+            )
+        else:
+            return {}

lusid/{utilities → extensions}/refreshing_token.py

@@ -7,11 +7,15 @@ from datetime import datetime
 from datetime import timedelta
 from collections import UserString
 from urllib.parse import quote
+import logging
 
+logger = logging.getLogger(__name__)
 
-class RefreshingToken(UserString):
 
-    def __init__(self, api_configuration, expiry_offset=60, id_provider_response_handler=None):
+class RefreshingToken(UserString):
+    def __init__(
+        self, api_configuration, expiry_offset=60, id_provider_response_handler=None
+    ):
         """
         Implementation of UserString that will automatically refresh the token value upon expiry
 
@@ -21,19 +25,37 @@ class RefreshingToken(UserString):
         before it is consumed by the RefreshingToken, mutation of the Response is possible with this handler
         """
 
-        self.token_data = {
-            "expires": None,
-            "access_token": None,
-            "refresh_token": None
-        }
+        self.token_data = {"expires": None, "access_token": None, "refresh_token": None}
         self.expiry_offset = expiry_offset
-        self.api_configuration = api_configuration
+        try:
+            self.password = api_configuration.password
+            self.client_id = api_configuration.client_id
+            self.client_secret = api_configuration.client_secret
+            self.username = api_configuration.username
+            self.token_url = api_configuration.token_url
+            self.proxy_config = api_configuration.proxy_config
+            self.certificate_filename = api_configuration.certificate_filename
+        except AttributeError:
+            logger.debug("Could not access ApiConfig attribute - ensure api_config is an ApiConfiguration object")
+        self._validate_oauth_params()
         self.id_provider_response_handler = id_provider_response_handler
         self.refresh_func = self.get_refresh_token
         self.lock = threading.Lock()
         self.retry_count = 0
         self.retry_limit = 5
         self.backoff_base = 2
+    
+    def _validate_oauth_params(self):
+        if self.password is None:
+            raise ValueError("Password is None. This value must be set for Oauth")
+        if self.client_id is None:
+            raise ValueError("Client Id is None. This value must be set for Oauth")
+        if self.client_secret is None:
+            raise ValueError("Client Secret is None. This value must be set for Oauth")
+        if self.username is None:
+            raise ValueError("Username is None. This value must be set for Oauth")
+        if self.token_url is None:
+            raise ValueError("Token Url is None. This value must be set for Oauth")
 
     def update_token_data(self, id_provider_json):
         """
@@ -43,7 +65,9 @@ class RefreshingToken(UserString):
         """
         self.token_data["access_token"] = id_provider_json["access_token"]
         # Set the expiry just before the actual expiry to ensure no failed requests
-        delta = timedelta(seconds=id_provider_json.get("expires_in", 3600) - self.expiry_offset)
+        delta = timedelta(
+            seconds=id_provider_json.get("expires_in", 3600) - self.expiry_offset
+        )
         self.token_data["expires"] = datetime.utcnow() + delta
         self.token_data["refresh_token"] = id_provider_json["refresh_token"]
 
@@ -54,29 +78,36 @@ class RefreshingToken(UserString):
         :return: The retrieved access token
         """
         # the safe parameter is to ensure that the / character is also encoded
-        encoded_password = quote(self.api_configuration.password, safe='')
-        encoded_client_id = quote(self.api_configuration.client_id, safe='')
-        encoded_client_secret = quote(self.api_configuration.client_secret, safe='')
+        encoded_password = quote(self.password, safe="")
+        encoded_client_id = quote(self.client_id, safe="")
+        encoded_client_secret = quote(self.client_secret, safe="")
 
         # Prepare our authentication request
-        token_request_body = f"grant_type=password&username={self.api_configuration.username}" \
-            f"&password={encoded_password}&scope=openid client groups offline_access" \
+        token_request_body = (
+            f"grant_type=password&username={self.username}"
+            f"&password={encoded_password}&scope=openid client groups offline_access"
             f"&client_id={encoded_client_id}&client_secret={encoded_client_secret}"
+        )
 
-        headers = {"Accept": "application/json", "Content-Type": "application/x-www-form-urlencoded"}
+        headers = {
+            "Accept": "application/json",
+            "Content-Type": "application/x-www-form-urlencoded",
+        }
 
         # extra request args
         kwargs = {"headers": headers}
 
-        if self.api_configuration.proxy_config is not None:
-            kwargs["proxies"] = self.api_configuration.proxy_config.format_proxy_schema()
+        if self.proxy_config is not None:
+            kwargs["proxies"] = self.proxy_config.format_proxy_schema()
 
         # use certificate if supplied
-        if self.api_configuration.certificate_filename is not None:
-            kwargs["verify"] = self.api_configuration.certificate_filename
+        if self.certificate_filename is not None:
+            kwargs["verify"] = self.certificate_filename
 
         # make request to Okta to get an authentication token
-        id_provider_response = requests.post(self.api_configuration.token_url, data=token_request_body, **kwargs)
+        id_provider_response = requests.post(
+            self.token_url, data=token_request_body, **kwargs
+        )
 
         if self.id_provider_response_handler is not None:
             self.id_provider_response_handler(id_provider_response)
@@ -105,17 +136,22 @@ class RefreshingToken(UserString):
         """
 
         # If any data is missing to use a refresh token e.g. on first try, get an access token using credentials
-        if self.token_data["access_token"] is None or self.token_data["expires"] is None or self.token_data["refresh_token"] is None:
+        if (
+            self.token_data["access_token"] is None
+            or self.token_data["expires"] is None
+            or self.token_data["refresh_token"] is None
+        ):
             return self.get_access_token()
 
         # check if the token has expired and refresh if needed
         if self.token_data["expires"] <= datetime.utcnow():
-
-            encoded_client = base64.b64encode(bytes(f"{self.api_configuration.client_id}:{self.api_configuration.client_secret}", 'utf-8'))
+            encoded_client = base64.b64encode(
+                bytes(f"{self.client_id}:{self.client_secret}", "utf-8")
+            )
 
             headers = {
                 "Content-Type": "application/x-www-form-urlencoded",
-                "Authorization": f"Basic {encoded_client.decode('utf-8')}"
+                "Authorization": f"Basic {encoded_client.decode('utf-8')}",
             }
 
             request_body = f"grant_type=refresh_token&scope=openid client groups offline_access&refresh_token={self.token_data['refresh_token']}"
@@ -123,20 +159,25 @@ class RefreshingToken(UserString):
             # request parameters
             kwargs = {"headers": headers}
 
-            if self.api_configuration.proxy_config is not None:
-                kwargs["proxies"] = self.api_configuration.proxy_config.format_proxy_schema()
+            if self.proxy_config is not None:
+                kwargs["proxies"] = self.proxy_config.format_proxy_schema()
 
-            if self.api_configuration.certificate_filename is not None:
-                kwargs["verify"] = self.api_configuration.certificate_filename
+            if self.certificate_filename is not None:
+                kwargs["verify"] = self.certificate_filename
 
-            id_provider_response = requests.post(self.api_configuration.token_url, data=request_body, **kwargs)
+            id_provider_response = requests.post(
+                self.token_url, data=request_body, **kwargs
+            )
 
             if self.id_provider_response_handler is not None:
                 self.id_provider_response_handler(id_provider_response)
 
             # Refresh token may be expired, if so, get new request token
-            if id_provider_response.status_code == 400 and 'refresh token is invalid or expired' \
-                    in id_provider_response.json()['error_description']:
+            if (
+                id_provider_response.status_code == 400
+                and "refresh token is invalid or expired"
+                in id_provider_response.json()["error_description"]
+            ):
                 return self.get_access_token()
             elif id_provider_response.status_code == 429:
                 self._handle_retry(id_provider_response)
@@ -165,7 +206,9 @@ class RefreshingToken(UserString):
         :param requests.Response id_provider_response: The response from the identity provider
         """
         if self.retry_count >= self.retry_limit:
-            raise ValueError(f"Max retry limit of {self.retry_limit} reached with response of {id_provider_response.json()}")
+            raise ValueError(
+                f"Max retry limit of {self.retry_limit} reached with response of {id_provider_response.json()}"
+            )
 
         self.retry_count += 1
 
@@ -177,7 +220,12 @@ class RefreshingToken(UserString):
                 wait_time = int(retry_value)
             except ValueError:
                 # http date always in GMT
-                wait_time = int(datetime.strptime(retry_value, '%a, %d %b %Y %H:%M:%S GMT').timestamp() - datetime.utcnow().timestamp())
+                wait_time = int(
+                    datetime.strptime(
+                        retry_value, "%a, %d %b %Y %H:%M:%S GMT"
+                    ).timestamp()
+                    - datetime.utcnow().timestamp()
+                )
                 if wait_time <= 0:  # Won't wait for a negative period
                     return
 
@@ -197,10 +245,9 @@ class RefreshingToken(UserString):
 
         :return: int: The number of seconds to wait
         """
-        return backoff_base ** retries
+        return backoff_base**retries
 
     def __getattribute__(self, item):
-
         # return the value of the string
         if item == "data":
             self.lock.acquire()

lusid/extensions/rest.py

@@ -0,0 +1,300 @@
+# coding: utf-8
+
+"""
+    LUSID API
+
+    FINBOURNE Technology  # noqa: E501
+
+    Contact: info@finbourne.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""
+
+
+import io
+import json
+import logging
+import re
+import ssl
+
+from urllib.parse import urlencode, quote_plus
+import urllib3
+
+from lusid.exceptions import ApiException, UnauthorizedException, ForbiddenException, NotFoundException, ServiceException, ApiValueError
+
+
+logger = logging.getLogger(__name__)
+
+
+class RESTResponse(io.IOBase):
+
+    def __init__(self, resp):
+        self.urllib3_response = resp
+        self.status = resp.status
+        self.reason = resp.reason
+        self.data = resp.data
+
+    def getheaders(self):
+        """Returns a dictionary of the response headers."""
+        return self.urllib3_response.headers
+
+    def getheader(self, name, default=None):
+        """Returns a given response header."""
+        return self.urllib3_response.headers.get(name, default)
+
+
+class RESTClientObject(object):
+
+    def __init__(self, configuration, pools_size=4, maxsize=None):
+        # urllib3.PoolManager will pass all kw parameters to connectionpool
+        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/poolmanager.py#L75  # noqa: E501
+        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/connectionpool.py#L680  # noqa: E501
+        # maxsize is the number of requests to host that are allowed in parallel  # noqa: E501
+        # Custom SSL certificates and client certificates: http://urllib3.readthedocs.io/en/latest/advanced-usage.html  # noqa: E501
+
+        # cert_reqs
+        if configuration.verify_ssl:
+            cert_reqs = ssl.CERT_REQUIRED
+        else:
+            cert_reqs = ssl.CERT_NONE
+
+        addition_pool_args = {}
+        if configuration.assert_hostname is not None:
+            addition_pool_args['assert_hostname'] = configuration.assert_hostname  # noqa: E501
+
+        if configuration.retries is not None:
+            addition_pool_args['retries'] = configuration.retries
+
+        if configuration.tls_server_name:
+            addition_pool_args['server_hostname'] = configuration.tls_server_name
+
+
+        if configuration.socket_options is not None:
+            addition_pool_args['socket_options'] = configuration.socket_options
+
+        if maxsize is None:
+            if configuration.connection_pool_maxsize is not None:
+                maxsize = configuration.connection_pool_maxsize
+            else:
+                maxsize = 4
+
+        # https pool manager
+        if configuration.proxy:
+            self.pool_manager = urllib3.ProxyManager(
+                num_pools=pools_size,
+                maxsize=maxsize,
+                cert_reqs=cert_reqs,
+                ca_certs=configuration.ssl_ca_cert,
+                cert_file=configuration.cert_file,
+                key_file=configuration.key_file,
+                proxy_url=configuration.proxy,
+                proxy_headers=configuration.proxy_headers,
+                **addition_pool_args
+            )
+        else:
+            self.pool_manager = urllib3.PoolManager(
+                num_pools=pools_size,
+                maxsize=maxsize,
+                cert_reqs=cert_reqs,
+                ca_certs=configuration.ssl_ca_cert,
+                cert_file=configuration.cert_file,
+                key_file=configuration.key_file,
+                **addition_pool_args
+            )
+
+    def request(self, method, url, query_params=None, headers=None,
+                body=None, post_params=None, _preload_content=True,
+                _request_timeout=None):
+        """Perform requests.
+
+        :param method: http request method
+        :param url: http request url
+        :param query_params: query parameters in the url
+        :param headers: http request headers
+        :param body: request json body, for `application/json`
+        :param post_params: request post parameters,
+                            `application/x-www-form-urlencoded`
+                            and `multipart/form-data`
+        :param _preload_content: if False, the urllib3.HTTPResponse object will
+                                 be returned without reading/decoding response
+                                 data. Default is True.
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        """
+        method = method.upper()
+        assert method in ['GET', 'HEAD', 'DELETE', 'POST', 'PUT',
+                          'PATCH', 'OPTIONS']
+
+        if post_params and body:
+            raise ApiValueError(
+                "body parameter cannot be used with post_params parameter."
+            )
+
+        post_params = post_params or {}
+        headers = headers or {}
+        # url already contains the URL query string
+        # so reset query_params to empty dict
+        query_params = {}
+
+        timeout = None
+        if _request_timeout:
+            if isinstance(_request_timeout, (int,float)):  # noqa: E501,F821
+                timeout = urllib3.Timeout(total=_request_timeout)
+            elif (isinstance(_request_timeout, tuple) and
+                  len(_request_timeout) == 2):
+                timeout = urllib3.Timeout(
+                    connect=_request_timeout[0], read=_request_timeout[1])
+
+        try:
+            # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE`
+            if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']:
+
+                # no content type provided or payload is json
+                if not headers.get('Content-Type') or re.search('json', headers['Content-Type'], re.IGNORECASE):
+                    request_body = None
+                    if body is not None:
+                        request_body = json.dumps(body)
+                    r = self.pool_manager.request(
+                        method, url,
+                        body=request_body,
+                        preload_content=_preload_content,
+                        timeout=timeout,
+                        headers=headers)
+                elif headers['Content-Type'] == 'application/x-www-form-urlencoded':  # noqa: E501
+                    r = self.pool_manager.request(
+                        method, url,
+                        fields=post_params,
+                        encode_multipart=False,
+                        preload_content=_preload_content,
+                        timeout=timeout,
+                        headers=headers)
+                elif headers['Content-Type'] == 'multipart/form-data':
+                    # must del headers['Content-Type'], or the correct
+                    # Content-Type which generated by urllib3 will be
+                    # overwritten.
+                    del headers['Content-Type']
+                    r = self.pool_manager.request(
+                        method, url,
+                        fields=post_params,
+                        encode_multipart=True,
+                        preload_content=_preload_content,
+                        timeout=timeout,
+                        headers=headers)
+                # Pass a `string` parameter directly in the body to support
+                # other content types than Json when `body` argument is
+                # provided in serialized form
+                elif isinstance(body, str) or isinstance(body, bytes):
+                    request_body = body
+                    r = self.pool_manager.request(
+                        method, url,
+                        body=request_body,
+                        preload_content=_preload_content,
+                        timeout=timeout,
+                        headers=headers)
+                else:
+                    # Cannot generate the request from given parameters
+                    msg = """Cannot prepare a request message for provided
+                             arguments. Please check that your arguments match
+                             declared content type."""
+                    raise ApiException(status=0, reason=msg)
+            # For `GET`, `HEAD`
+            else:
+                r = self.pool_manager.request(method, url,
+                                              fields={},
+                                              preload_content=_preload_content,
+                                              timeout=timeout,
+                                              headers=headers)
+        except urllib3.exceptions.SSLError as e:
+            msg = "{0}\n{1}".format(type(e).__name__, str(e))
+            raise ApiException(status=0, reason=msg)
+
+        if _preload_content:
+            r = RESTResponse(r)
+
+            # log response body
+            logger.debug("response body: %s", r.data)
+
+        if not 200 <= r.status <= 299:
+            if r.status == 401:
+                raise UnauthorizedException(http_resp=r)
+
+            if r.status == 403:
+                raise ForbiddenException(http_resp=r)
+
+            if r.status == 404:
+                raise NotFoundException(http_resp=r)
+
+            if 500 <= r.status <= 599:
+                raise ServiceException(http_resp=r)
+
+            raise ApiException(http_resp=r)
+
+        return r
+
+    def get_request(self, url, headers=None, query_params=None, _preload_content=True,
+            _request_timeout=None):
+        return self.request("GET", url,
+                            headers=headers,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            query_params=query_params)
+
+    def head_request(self, url, headers=None, query_params=None, _preload_content=True,
+             _request_timeout=None):
+        return self.request("HEAD", url,
+                            headers=headers,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            query_params=query_params)
+
+    def options_request(self, url, headers=None, query_params=None, post_params=None,
+                body=None, _preload_content=True, _request_timeout=None):
+        return self.request("OPTIONS", url,
+                            headers=headers,
+                            query_params=query_params,
+                            post_params=post_params,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            body=body)
+
+    def delete_request(self, url, headers=None, query_params=None, body=None,
+               _preload_content=True, _request_timeout=None):
+        return self.request("DELETE", url,
+                            headers=headers,
+                            query_params=query_params,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            body=body)
+
+    def post_request(self, url, headers=None, query_params=None, post_params=None,
+             body=None, _preload_content=True, _request_timeout=None):
+        return self.request("POST", url,
+                            headers=headers,
+                            query_params=query_params,
+                            post_params=post_params,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            body=body)
+
+    def put_request(self, url, headers=None, query_params=None, post_params=None,
+            body=None, _preload_content=True, _request_timeout=None):
+        return self.request("PUT", url,
+                            headers=headers,
+                            query_params=query_params,
+                            post_params=post_params,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            body=body)
+
+    def patch_request(self, url, headers=None, query_params=None, post_params=None,
+              body=None, _preload_content=True, _request_timeout=None):
+        return self.request("PATCH", url,
+                            headers=headers,
+                            query_params=query_params,
+                            post_params=post_params,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            body=body)