getrak-python-sdk 1.0.0__py3-none-any.whl → 1.2.0__py3-none-any.whl

getrak/api.py

@@ -1,46 +1,151 @@
-import logging, os, jsonpickle
+import json
+import logging
+import os
+import threading
+import time
 from http import HTTPMethod
-from fmconsult.http.api import ApiBase
+
+from fmconsult.exceptions.bad_request_exception import BadRequestException
+from fmconsult.exceptions.forbidden_exception import ForbiddenException
+from fmconsult.exceptions.unauthorized_exception import UnauthorizedException
+from fmconsult.http.api import ApiBase, ContentType
 from fmconsult.utils.url import UrlUtil
 
+from getrak.errors import AuthenticationFailed, GetrakError
+
+log = logging.getLogger(__name__)
+
+AUTH_REJECTED = (BadRequestException, UnauthorizedException, ForbiddenException)
+
+
 class GetrakApi(ApiBase):
+    """Cliente da API Getrak.
+
+    Sem argumentos, lê `getrak.api.auth_code`, `getrak.api.login`, `getrak.api.password`
+    e `getrak.api.grant_type` e autentica na construção, como antes. Usuário e senha vão
+    no corpo do POST. Os demais argumentos são opcionais e servem para reutilizar um
+    token, limitar a taxa e tentar de novo em falha passageira.
+    """
+
+    def __init__(
+        self,
+        *,
+        auth_code=None,
+        login=None,
+        password=None,
+        grant_type=None,
+        base_url=None,
+        rate_limiter=None,
+        retry_transient=False,
+        authenticate_on_init=True,
+        verbose=True,
+        sleep=None,
+        clock=None,
+        max_attempts=5,
+        on_rate_limited=None,
+        on_token=None,
+        log_requests=True,
+        timeout=60,
+    ):
+        self.api_auth_code = auth_code if auth_code is not None else os.environ["getrak.api.auth_code"]
+        self.api_login = login if login is not None else os.environ["getrak.api.login"]
+        self.api_password = password if password is not None else os.environ["getrak.api.password"]
+        self.api_grant_type = grant_type if grant_type is not None else os.environ["getrak.api.grant_type"]
+        self.base_url = (base_url or "https://api.getrak.com").rstrip("/")
+        self.verbose = verbose
+        self._rate_limiter = rate_limiter
+        self._retry_transient = retry_transient
+        self._max_attempts = max_attempts
+        self._sleep = sleep or time.sleep
+        self._clock = clock or time.monotonic
+        self._on_rate_limited = on_rate_limited
+        self._on_token = on_token
+        self._log_requests = log_requests
+        self._timeout = timeout
+        self._auth_failed = False
+        self._token = None
+        self._token_type = "Bearer"
+        self._token_lock = threading.Lock()
+        self.requests = 0
+        self.rate_limited = 0
+        self.last_http_attempts = 0
+        self.current_operation = None
+        self.headers = {"Authorization": f"Basic {self.api_auth_code}"}
+        if authenticate_on_init:
+            self._ensure_token()
+
+    def _raise_if_auth_failed(self):
+        if self._auth_failed:
+            raise AuthenticationFailed("autenticação na Getrak já foi recusada nesta execução")
+
+    def _ensure_token(self):
+        with self._token_lock:
+            self._raise_if_auth_failed()
+            if self._token is None:
+                self._token = self._authenticate()
+            return self._token
+
+    def _renew_token(self, stale):
+        with self._token_lock:
+            self._raise_if_auth_failed()
+            if self._token is None or self._token == stale:
+                self._token = self._authenticate()
+            return self._token
+
+    def _authenticate(self):
+        if self.verbose:
+            log.info("api authentication...")
+        self.current_operation = "autenticação"
+        self.headers = {"Authorization": f"Basic {self.api_auth_code}"}
+        url = UrlUtil().make_url(self.base_url, ["newkoauth", "oauth", "token"])
+        try:
+            raw = self.call_request(
+                HTTPMethod.POST,
+                url,
+                payload={
+                    "username": self.api_login,
+                    "password": self.api_password,
+                    "grant_type": self.api_grant_type,
+                },
+                content_type=ContentType.FORM_URLENCODED,
+                request_timeout=self._timeout,
+            )
+        except AUTH_REJECTED:
+            self._auth_failed = True
+            raise AuthenticationFailed(
+                "Getrak recusou a autenticação; verifique usuário, senha e a credencial do cliente"
+            ) from None
+        try:
+            data = json.loads(raw)
+            token = data["access_token"]
+        except (ValueError, KeyError, TypeError):
+            raise GetrakError("resposta de autenticação da Getrak sem access_token") from None
+        if not isinstance(token, str) or not token:
+            raise GetrakError("resposta de autenticação da Getrak sem access_token")
+        if isinstance(data, dict) and data.get("error"):
+            raise AuthenticationFailed("Getrak recusou a autenticação")
+        token_type = str(data.get("token_type") or "Bearer")
+        self._token_type = "Bearer" if token_type.lower() == "bearer" else token_type
+        self.headers = {"Authorization": f"{self._token_type} {token}"}
+        if self._on_token is not None:
+            self._on_token(token)
+        return token
+
+    def _get(self, url, token, operation):
+        self.current_operation = operation
+        self.headers = {"Authorization": f"{self._token_type} {token}"}
+        return self.call_request(HTTPMethod.GET, url, request_timeout=self._timeout)
 
-	def __init__(self):
-		try:
-			self.api_auth_code 	= os.environ['getrak.api.auth_code']
-			self.api_login 		= os.environ['getrak.api.login']
-			self.api_password 	= os.environ['getrak.api.password']
-			self.api_grant_type = os.environ['getrak.api.grant_type']
-
-			self.base_url = 'https://api.getrak.com'
-			self.headers = {
-				'Authorization': f'Basic {self.api_auth_code}'
-			}
-
-			self.__login()
-		except:
-			raise
-	
-	def __login(self):
-		try:
-			logging.info('api authentication...')
-			res = self.call_request(
-				http_method=HTTPMethod.POST, 
-				request_url=UrlUtil().make_url(self.base_url, ['newkoauth','oauth','token']), 
-				params={
-					'username': self.api_login, 
-					'password': self.api_password,
-					'grant_type': self.api_grant_type
-				}
-			)
-			res = jsonpickle.decode(res)
-			if not('error' in res):
-				self.token_type = res['token_type']
-				self.access_token = res['access_token']
-				self.headers = {
-					'Authorization': f'{self.token_type} {self.access_token}'
-				}
-			else:
-				raise Exception(res['error_description'])
-		except:
-			raise
+    def _authorized(self, url, operation):
+        attempts = 0
+        token = self._ensure_token()
+        try:
+            raw = self._get(url, token, operation)
+        except UnauthorizedException:
+            attempts += self.last_http_attempts
+            token = self._renew_token(token)
+            raw = self._get(url, token, operation)
+            attempts += self.last_http_attempts
+            return raw, attempts
+        attempts += self.last_http_attempts
+        return raw, attempts

getrak/apis/recebidos.py

@@ -1,7 +1,15 @@
-import logging, jsonpickle
+import json
+import logging
+import re
+
+import jsonpickle
 from http import HTTPMethod
 from fmconsult.utils.url import UrlUtil
 from getrak.api import GetrakApi
+from getrak.errors import GetrakError, InvalidVehicleId, VehicleNotFound
+
+VEHICLE_ID_RE = re.compile(r"^[A-Za-z0-9_-]+$")
+
 
 class Recebidos(GetrakApi):
 
@@ -11,4 +19,27 @@ class Recebidos(GetrakApi):
       http_method=HTTPMethod.GET, 
       request_url=UrlUtil().make_url(self.base_url, ['v0.1','recebidos', id_veiculo, data_inicio, data_fim])
     )    
-    return jsonpickle.decode(res)
+    return jsonpickle.decode(res)
+
+  def fetch(self, vehicle_id, start, end):
+    """Busca as posições já autenticando sob demanda. Devolve `(lista, tentativas HTTP)`.
+
+    Valida o ID aqui. `get` continua aceitando o valor que o chamador passar.
+    """
+    if not isinstance(vehicle_id, str) or VEHICLE_ID_RE.fullmatch(vehicle_id) is None:
+      raise InvalidVehicleId("ID de veículo Getrak inválido")
+    url = UrlUtil().make_url(self.base_url, ["v0.1", "recebidos", vehicle_id, start, end])
+    raw, attempts = self._authorized(url, "recebidos")
+    try:
+      body = json.loads(raw)
+    except ValueError:
+      raise GetrakError("resposta de recebidos não é JSON") from None
+    if isinstance(body, dict):
+      message = body.get("error") if isinstance(body.get("error"), str) else ""
+      if "não encontrado" in message.casefold():
+        raise VehicleNotFound(message)
+    if not isinstance(body, list):
+      raise GetrakError("resposta de recebidos não é uma lista")
+    if not all(isinstance(item, dict) for item in body):
+      raise GetrakError("resposta de recebidos contém itens que não são objetos")
+    return body, attempts

getrak/errors.py

@@ -0,0 +1,14 @@
+class GetrakError(Exception):
+    """Erro da integração com a Getrak."""
+
+
+class InvalidVehicleId(GetrakError):
+    pass
+
+
+class VehicleNotFound(GetrakError):
+    """A conta não tem esse veículo. Não há lista de posições para gravar."""
+
+
+class AuthenticationFailed(GetrakError):
+    """A Getrak recusou as credenciais. Vale para as chamadas seguintes desta instância."""

{getrak_python_sdk-1.0.0.dist-info → getrak_python_sdk-1.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: getrak-python-sdk
-Version: 1.0.0
+Version: 1.2.0
 Summary: Client de comunicaçao c/ API da Getrak
 Author-email: Filipe Coelho <filipe@fmconsult.com.br>
 License: MIT License
@@ -18,4 +18,6 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: fmconsult-utils-python-sdk>=2.2.0
+Requires-Dist: jsonpickle>=3.0
 Dynamic: license-file

{getrak_python_sdk-1.0.0.dist-info → getrak_python_sdk-1.2.0.dist-info}/RECORD

@@ -1,15 +1,15 @@
-__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 getrak/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-getrak/api.py,sha256=IlO0dlqdUjJ3ErfPJhiMmIU-GQs4CU2Tt8VA3nLrz_M,1239
+getrak/api.py,sha256=sRhJdXUknljeuvEsJPO1gTBscoUlm0KD_NwS-9BbhyA,5890
+getrak/errors.py,sha256=mobmS8zzjzL1giAlj8o6OTX21gkz1OVbmd2n3CMNZOc,381
 getrak/apis/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 getrak/apis/localizacoes.py,sha256=UuRqEHRMecUQRdSUVq7gRXLPeKe4IZ0byYFlGbDn-6U,654
-getrak/apis/recebidos.py,sha256=GDwLphfGcYSvFzmYS6oZ7aQVGDTPaSA3nduKOM6KFQw,516
+getrak/apis/recebidos.py,sha256=pUWFyXiu-JWy0fykEKBETA7DTGM5jYbpwuqXsAQoZz0,1792
 getrak/database/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 getrak/database/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 getrak/database/models/dataexplained.py,sha256=9qjXvccphYUVK0LTNvxjMXRzMOsynbMmcYDkaK41Tdo,212
 getrak/database/models/vehicle.py,sha256=04SVD0TVwnF-4bLbMmdN0dKd9KboMa1-KfxkJ8Fwpv8,2941
-getrak_python_sdk-1.0.0.dist-info/licenses/LICENSE,sha256=YZjQnFjzXGFa0D3iCQkNDwGBNuTGJREkRmItGX1B3YM,122
-getrak_python_sdk-1.0.0.dist-info/METADATA,sha256=Ggz2gFc6tasbfOVQMELK9JKlmnmVYhujVmSH8qBY2RY,769
-getrak_python_sdk-1.0.0.dist-info/WHEEL,sha256=Nw36Djuh_5VDukK0H78QzOX-_FQEo6V37m3nkm96gtU,91
-getrak_python_sdk-1.0.0.dist-info/top_level.txt,sha256=LvUv9DvjYEQ08xdxNLM8xrBtFwGphZIKlX1S0KE43oY,16
-getrak_python_sdk-1.0.0.dist-info/RECORD,,
+getrak_python_sdk-1.2.0.dist-info/licenses/LICENSE,sha256=YZjQnFjzXGFa0D3iCQkNDwGBNuTGJREkRmItGX1B3YM,122
+getrak_python_sdk-1.2.0.dist-info/METADATA,sha256=r_VOClVT49asa7dbWvWf0-6qDpwFfA4mT6D2PSR8Ku4,849
+getrak_python_sdk-1.2.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+getrak_python_sdk-1.2.0.dist-info/top_level.txt,sha256=FTZAzVY_kDvwVRXKSWipeV7H-1ztlyuOMVHhyCEkQO0,7
+getrak_python_sdk-1.2.0.dist-info/RECORD,,

{getrak_python_sdk-1.0.0.dist-info → getrak_python_sdk-1.2.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.7.1)
+Generator: setuptools (84.0.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

getrak_python_sdk-1.2.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+getrak

getrak_python_sdk-1.0.0.dist-info/top_level.txt

@@ -1,2 +0,0 @@
-__init__
-getrak