ls-api-clients 0.3.0__tar.gz

ls_api_clients-0.3.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 LightSolver Internal
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ls_api_clients-0.3.0/PKG-INFO

@@ -0,0 +1,21 @@
+Metadata-Version: 2.1
+Name: ls-api-clients
+Version: 0.3.0
+Summary: A package for laser-mind clients
+Author-email: Assaf Kalinski <assaf@lightsolver.com>
+Project-URL: Homepage, https://lightsolver.com
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: urllib3==1.26.13
+Requires-Dist: requests>=2.23
+Requires-Dist: msgpack>=1.0.0
+Requires-Dist: ls-cred-storage>=0.1.9
+Requires-Dist: laser-mind-client-meta>=0.0.9
+
+Lightsolver internal package.
+API clients for logging into LightSolver's API servers
+and for requesting tokens.

ls_api_clients-0.3.0/README.md

@@ -0,0 +1,3 @@
+Lightsolver internal package.
+API clients for logging into LightSolver's API servers
+and for requesting tokens.

ls_api_clients-0.3.0/ls_api_clients/__init__.py

@@ -0,0 +1 @@
+from ls_api_clients.ls_api_client import LSAPIClient

ls_api_clients-0.3.0/ls_api_clients/ls_api_client.py

@@ -0,0 +1,248 @@
+import os
+import logging
+import requests
+import json
+import time
+import msgpack
+from ls_cred_storage import LSCredStorage
+from laser_mind_client_meta import MessageKeys
+
+
+class LSAPIClient:
+
+    USER_KEY = 'user'
+    USER_ID_KEY = 'userId'
+    TIMESTAMP_KEY = 'timestamp'
+    SESSION_TOKEN_KEY = 'sessionToken'
+    ACCESS_TOKEN_KEY = 'accessToken'
+    MAX_TOKEN_RETENTION_TIME_SECS = 3500
+
+    SOLVER_REQUEST_HEADERS = {'accept' : 'application/octet-stream',
+                              'content-type' : 'application/octet-stream',
+                              'accept-encoding' : 'gzip, deflate, br'}
+
+    SOLUTION_REQUEST_HEADERS = {
+        'accept' : 'application/msgpack',
+        'content-type' : 'application/msgpack',
+        'accept-encoding' : 'gzip, deflate, br'
+    }
+
+    URL_REQUEST_HEADERS = {
+        'accept' : 'application/msgpack',
+        'content-type' : 'application/msgpack',
+        'accept-encoding' : 'gzip, deflate, br'
+    }
+
+    def __init__(self, username = None, password = None, printTiming = False, logLevel = logging.INFO, authEnabled = True):
+        self.LS_API_RUN_URL = os.environ['LS_API_RUN_URL'] if 'LS_API_RUN_URL' in os.environ else 'http://solve.lightsolver.com/api/v1/commands/run'
+        self.LS_API_RUN_SECURED_URL = os.environ['LS_API_RUN_SECURED_URL'] if 'LS_API_RUN_SECURED_URL' in os.environ else 'https://solve.lightsolver.com/api/v1/commands/run'
+        self.LS_API_GET_PRESIGNED_URL = os.environ['LS_API_GET_PRESIGNED_URL'] if 'LS_API_GET_PRESIGNED_URL' in os.environ else 'https://solve.lightsolver.com/api/v1/getposturl'
+        self.LS_AUTH_URL = os.environ['LS_AUTH_URL'] if 'LS_AUTH_URL' in os.environ else 'https://auth.devfront.lightsolver.com/authorize-solver-usage'
+        self.LS_REQUEST_URL = os.environ['LS_REQUEST_URL'] if 'LS_REQUEST_URL' in os.environ else 'https://solve.lightsolver.com/api/v1/getsolution'
+
+        logging.basicConfig(
+            filename="laser-mind.log",
+            level=logLevel,
+            format='%(asctime)s %(message)s', datefmt='%m/%d/%Y %H:%M:%S')
+        self.printTiming = printTiming
+        self.authEnabled = authEnabled
+        if authEnabled:
+            if username == None or password == None:
+                raise ValueError("You must input a username and password when authREnabled = True")
+            self.username = username
+            self.password = password
+            self.credStorage = LSCredStorage()
+            token_dic = self.check_and_get_persisted_tokens() #TODO @markin is this duplication with check_is_token_valid() in refresh_tokens_if_needed?
+
+            if token_dic == None:
+                self.refresh_tokens_if_needed()
+                logging.info('Got new session/access tokens')
+            logging.info('LSAPIClient created,connection is authenticated and authorized')
+        else:
+            logging.info('LSAPIClient created, authentication disabled')
+
+    def msgpack_encode(self, x):
+        v = msgpack.packb(x)
+        return v
+
+    def msgpack_decode(self, x):
+        try:
+            v = msgpack.unpackb(x)
+        except Exception as e:
+            return None
+        return v
+
+    def refresh_tokens_if_needed(self):
+        if self.authEnabled and not self.check_is_token_valid():
+            newTokenDic = self.GetTokensFromServer()
+            logging.info(f'got tokens for user {self.username}')
+            self.credStorage.update_current_token(newTokenDic)
+            self.credStorage.store_token(self.username, newTokenDic)
+
+    def GetTokensFromServer(self):
+        data = {
+            'user' : f'{self.username}',
+            'password' : f'{self.password}'
+        }
+
+        headers = {
+            'accept' : 'application/json',
+            'content-type' : 'application/json',
+            }
+        req = requests.post(self.LS_AUTH_URL, headers=headers, data=json.dumps(data))
+        req.raise_for_status()
+        token = req.json()
+        token_dic  = self.create_token_data_for_user(token)
+        return token_dic
+
+    def create_token_data_for_user(self, token):
+        dic = {
+            self.TIMESTAMP_KEY : time.time(),
+            self.USER_KEY : self.username,
+            self.SESSION_TOKEN_KEY : token[self.SESSION_TOKEN_KEY],
+            self.ACCESS_TOKEN_KEY : token[self.ACCESS_TOKEN_KEY],
+            self.USER_ID_KEY : token[self.USER_ID_KEY]
+        }
+        return dic
+
+    def check_and_get_persisted_tokens(self):
+        storedToken = self.credStorage.get_stored_token(self.username)
+        if storedToken != None:
+            if self.check_is_token_valid():
+                return storedToken
+        return None
+
+    def check_is_token_valid(self):
+        if self.credStorage.currentTokenDic != None:
+            return time.time() - self.credStorage.currentTokenDic[self.TIMESTAMP_KEY] < self.MAX_TOKEN_RETENTION_TIME_SECS
+        return False
+
+    def MakeDataForSolveRequest(self, commandName, param):
+        data = {
+            'name' : commandName,
+            'param' : param,
+            'creationTime' : time.time()
+        }
+        if self.authEnabled:
+            data['username'] = self.credStorage.currentTokenDic[self.USER_KEY]
+            data['userId'] = self.credStorage.currentTokenDic[self.USER_ID_KEY]
+            data['sessionToken'] = self.credStorage.currentTokenDic[self.SESSION_TOKEN_KEY]
+            data['accessToken'] = self.credStorage.currentTokenDic[self.ACCESS_TOKEN_KEY]
+        return self.msgpack_encode(data)
+
+    def MakeDataForUploadRequest(self, toUpload):
+        data = {
+            'param' : toUpload,
+            'creationTime' : time.time()
+        }
+        if self.authEnabled:
+            data['username'] = self.credStorage.currentTokenDic[self.USER_KEY]
+            data['userId'] = self.credStorage.currentTokenDic[self.USER_ID_KEY]
+            data['sessionToken'] = self.credStorage.currentTokenDic[self.SESSION_TOKEN_KEY]
+            data['accessToken'] = self.credStorage.currentTokenDic[self.ACCESS_TOKEN_KEY]
+        return self.msgpack_encode(data)
+
+    def MakeDataForResultRequest(self, solutionId):
+        data = {
+            'solId' : solutionId,
+            'creationTime' : time.time(),
+            'userId' : 0
+        }
+        if self.authEnabled:
+            data['username'] = self.credStorage.currentTokenDic[self.USER_KEY]
+            data['userId'] = self.credStorage.currentTokenDic[self.USER_ID_KEY]
+            data['sessionToken'] = self.credStorage.currentTokenDic[self.SESSION_TOKEN_KEY]
+            data['accessToken'] = self.credStorage.currentTokenDic[self.ACCESS_TOKEN_KEY]
+        return self.msgpack_encode(data)
+
+    def MakeDataForGetURLRequest(self, inputPath = None):
+        data = {
+            'creationTime' : time.time()
+        }
+
+        if self.authEnabled:
+            data['userId'] = self.credStorage.currentTokenDic[self.USER_ID_KEY]
+            data['sessionToken'] = self.credStorage.currentTokenDic[self.SESSION_TOKEN_KEY]
+            data['accessToken'] = self.credStorage.currentTokenDic[self.ACCESS_TOKEN_KEY]
+
+        if inputPath != None:
+            data[MessageKeys.QUBO_INPUT_PATH] = inputPath
+
+        return self.msgpack_encode(data)
+
+    def ValidateResponse(self, response):
+        if MessageKeys.ERROR_KEY in response:
+            raise Exception(response[MessageKeys.ERROR_KEY])
+        return True
+
+    def SendCommandRequest(self, commandName, input, secured = True):
+        if self.authEnabled:
+            if not self.credStorage.is_cached_user(self.username):
+                raise SystemError("username doesn't match stored token, please reconnect LightSolver service")
+            self.refresh_tokens_if_needed()
+        if self.printTiming:
+            startTime = time.time()
+        data = self.MakeDataForSolveRequest(commandName, input)
+        headers = self.SOLVER_REQUEST_HEADERS
+        req_url = self.LS_API_RUN_SECURED_URL if secured else self.LS_API_RUN_URL
+        response = requests.post(url = req_url, headers = headers, data = data)
+        response.raise_for_status()
+        dicResponse = self.msgpack_decode(response._content)
+        self.ValidateResponse(dicResponse)
+        if self.printTiming:
+            totalTime = time.time() - startTime
+        return dicResponse
+
+    def SendResultRequest(self, solutionId, timestamp):
+        self.refresh_tokens_if_needed()
+        id_str = f'{solutionId}_{timestamp}'
+        logging.info(f"getting {id_str}")
+        if self.printTiming:
+            startTime = time.time()
+        data = self.MakeDataForResultRequest(id_str)
+        headers = self.SOLUTION_REQUEST_HEADERS
+        req_url = self.LS_REQUEST_URL
+        response = requests.post(url = req_url, headers = headers, data = data)
+        if self.printTiming:
+            totalTime = time.time() - startTime
+        if response.status_code == 404:
+            return None
+
+        response.raise_for_status()
+        dicResponse = self.msgpack_decode(response._content)
+
+        if not isinstance(dicResponse, dict):
+            raise Exception("response is not a dictionary!")
+        if MessageKeys.ERROR_KEY in dicResponse:
+            raise Exception(dicResponse[MessageKeys.ERROR_KEY])
+        if MessageKeys.WARNING_KEY in dicResponse:
+            logging.warning(f"Warning: solver encountered \"{dicResponse[MessageKeys.WARNING_KEY]}\"")
+        return dicResponse
+
+    def SendGetURLRequest(self, urlPath = None):
+        self.refresh_tokens_if_needed()
+        logging.info(f"getting url")
+        if self.printTiming:
+            startTime = time.time()
+        data = self.MakeDataForGetURLRequest(urlPath)
+        headers = self.URL_REQUEST_HEADERS
+        req_url = self.LS_API_GET_PRESIGNED_URL
+        response = requests.post(url = req_url, headers = headers, data = data)
+        if self.printTiming:
+            totalTime = time.time() - startTime
+            print(f"{totalTime=}")
+        if response.status_code == 404:
+            return None
+        response.raise_for_status()
+
+        return self.msgpack_decode(response._content)
+
+    def SendUploadRequest(self, toUpload, url):
+        payload = self.MakeDataForUploadRequest(toUpload)
+        response = requests.put(url, data=payload)
+        response.raise_for_status()
+
+    def upload_command_input(self, data, inputPath = None):
+        urlResponse = self.SendGetURLRequest(inputPath)
+        self.SendUploadRequest(data, urlResponse['url'])
+        return urlResponse['reqId']

ls_api_clients-0.3.0/ls_api_clients.egg-info/PKG-INFO

@@ -0,0 +1,21 @@
+Metadata-Version: 2.1
+Name: ls-api-clients
+Version: 0.3.0
+Summary: A package for laser-mind clients
+Author-email: Assaf Kalinski <assaf@lightsolver.com>
+Project-URL: Homepage, https://lightsolver.com
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: urllib3==1.26.13
+Requires-Dist: requests>=2.23
+Requires-Dist: msgpack>=1.0.0
+Requires-Dist: ls-cred-storage>=0.1.9
+Requires-Dist: laser-mind-client-meta>=0.0.9
+
+Lightsolver internal package.
+API clients for logging into LightSolver's API servers
+and for requesting tokens.

ls_api_clients-0.3.0/ls_api_clients.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+LICENSE
+README.md
+pyproject.toml
+ls_api_clients/__init__.py
+ls_api_clients/ls_api_client.py
+ls_api_clients.egg-info/PKG-INFO
+ls_api_clients.egg-info/SOURCES.txt
+ls_api_clients.egg-info/dependency_links.txt
+ls_api_clients.egg-info/requires.txt
+ls_api_clients.egg-info/top_level.txt

ls_api_clients-0.3.0/ls_api_clients.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

ls_api_clients-0.3.0/ls_api_clients.egg-info/requires.txt

@@ -0,0 +1,5 @@
+urllib3==1.26.13
+requests>=2.23
+msgpack>=1.0.0
+ls-cred-storage>=0.1.9
+laser-mind-client-meta>=0.0.9

ls_api_clients-0.3.0/ls_api_clients.egg-info/top_level.txt

@@ -0,0 +1 @@
+ls_api_clients

ls_api_clients-0.3.0/pyproject.toml

@@ -0,0 +1,33 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ls-api-clients"
+version = "0.3.0"
+authors = [
+  { name="Assaf Kalinski", email="assaf@lightsolver.com" },
+]
+description = "A package for laser-mind clients"
+readme = "README.md"
+requires-python = ">=3.8"
+dependencies = [
+  'urllib3==1.26.13',
+  'requests>=2.23',
+  'msgpack>=1.0.0',
+  'ls-cred-storage>=0.1.9',
+  'laser-mind-client-meta>=0.0.9'
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+"Homepage" = "https://lightsolver.com"
+
+
+[tool.setuptools.packages.find]
+include = ["ls_api_clients"]
+

ls_api_clients-0.3.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+