lbxtoolkit 2.2.8__tar.gz → 2.2.9__tar.gz

{lbxtoolkit-2.2.8 → lbxtoolkit-2.2.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: lbxtoolkit
-Version: 2.2.8
+Version: 2.2.9
 Summary: 
 Author: Cristiano P. Ferrari
 Author-email: cristiano.ferrari@lbx.com.br
@@ -60,7 +60,7 @@ Interage com o banco de dados PostgreSQL
 Interage com APIs RESTfull, especialmente providas para a plataforma Sienge
 - `auth_base` Autentica (HTTPBasicAuth) sessão na API
 - `auth_bearer` Autentica sessão na API pelos métodos: OAuth, JWT, Bearer 
-- `endpoint_json` Realizad chama ao endpoint. Payload em formato `json` opcional.
+- `endpoint_json` Realizad chama ao endpoint. Aceita opcionalmente Payload em formato `json` ou arquivo binário.
 - `trata_erro_sienge` Retorna a mensagem de erro do Sienge caso código de retorno seja diferente de 200.
 - `close` Encerra a sessão autenticada
 
@@ -145,7 +145,7 @@ São nessários 2 parâmetros posicionais obrigatórios, e 5 parametros nominais
 - `cadencia` Número máximo de chamadas *por segudo* à API 
 - `timeout` Tempo máximo (segundos) para aguardar retorno à chamada. Padrão 6s, se omisso.
 - `logger` O objeto _log handler_ para lidar com as informações de saída. Se não informado, todas as saídas serão direcionadas para a stdout.
-- `headers` Cabeçalhos _http_ para a requisição à API.
+- `headers` Cabeçalhos _http_ para a requisição à API. Se não fornecido, será incluida implicitamente a chave `Content-Type` com valor `application/json`.
 - `verify` Verifica a validade do certificado SSL do servidor de destino da requisição.
 
 Quanto às credenciais de autenticação, assim como a classe de interação com o PostgreSQL, elas precisam ser fornecidas na forma de um *dicionário*. 
@@ -162,12 +162,14 @@ Caso a autenticação seja pelo método `api_rest.aut_bearer()`, o dicionário d
 A classe possui 3 métodos: 
 - `api_rest.auth_basic()`: instanciamento da sessão autenticando pelo método HTTPBasicAuth
 - `api_rest.auth_bearer()`: instanciamento da sessão autenticando pelos métodos OAuth, JWT, Bearer    
-- `api_rest.endpoint_json([endereço], [método], payload=None)`: para a chamada ao endpoint
+- `api_rest.endpoint_json([endereço], [método], payload=None, files=None)`: para a chamada ao endpoint
 - `close()` para encerra a instância/sessão
 
-O consumo é feito pelo método `api_rest.endpoint_json` que suporta apenas APIs cujo payload (opcional) seja aceito no formato JSON. 
+O consumo é feito pelo método `api_rest.endpoint_json` que suporta APIs cujo payload (opcional) seja aceito no formato JSON ou binario (files). 
 
-Esse método espera 2 parametros posicionais obrigatórios: o endereço do endpoint e o verbo (get, post, patch ou put), tendo parametro opcional o objeto de 'payload' (json). 
+Esse método espera 2 parametros posicionais obrigatórios: o endereço do endpoint e o verbo (get, post, patch ou put), tendo parametro opcional o objeto de 'payload' (json) ou 'files' (binário). 
+O método define no `headers` a chavee `Content-Type` implicita e automaticamente com o valor `application/json`, independente de ser ou não fornecido payload.
+Se a carga for do tipo binário, é necessário informar o Content-Type correto (`multipart/form-data`) ou repassar um dicionario vazio (`{}`) para o parametro `headers` no instanciamento da classe `api_rest`
 Note que o endereço do endpoint deve ser informado completo. A URL informada no instanciamento da classe corresponde apenas ao endereço de autenticação. 
 
 O tempo, em segundos, transcorrido entre a chamada a atual e a chamada anterior ao endpoint pode ser consultado pelo argumento `.Intervalo` no objeto recebido do retorno à chamada ao método `.endpoint_json`. 

{lbxtoolkit-2.2.8 → lbxtoolkit-2.2.9}/README.md

@@ -38,7 +38,7 @@ Interage com o banco de dados PostgreSQL
 Interage com APIs RESTfull, especialmente providas para a plataforma Sienge
 - `auth_base` Autentica (HTTPBasicAuth) sessão na API
 - `auth_bearer` Autentica sessão na API pelos métodos: OAuth, JWT, Bearer 
-- `endpoint_json` Realizad chama ao endpoint. Payload em formato `json` opcional.
+- `endpoint_json` Realizad chama ao endpoint. Aceita opcionalmente Payload em formato `json` ou arquivo binário.
 - `trata_erro_sienge` Retorna a mensagem de erro do Sienge caso código de retorno seja diferente de 200.
 - `close` Encerra a sessão autenticada
 
@@ -123,7 +123,7 @@ São nessários 2 parâmetros posicionais obrigatórios, e 5 parametros nominais
 - `cadencia` Número máximo de chamadas *por segudo* à API 
 - `timeout` Tempo máximo (segundos) para aguardar retorno à chamada. Padrão 6s, se omisso.
 - `logger` O objeto _log handler_ para lidar com as informações de saída. Se não informado, todas as saídas serão direcionadas para a stdout.
-- `headers` Cabeçalhos _http_ para a requisição à API.
+- `headers` Cabeçalhos _http_ para a requisição à API. Se não fornecido, será incluida implicitamente a chave `Content-Type` com valor `application/json`.
 - `verify` Verifica a validade do certificado SSL do servidor de destino da requisição.
 
 Quanto às credenciais de autenticação, assim como a classe de interação com o PostgreSQL, elas precisam ser fornecidas na forma de um *dicionário*. 
@@ -140,12 +140,14 @@ Caso a autenticação seja pelo método `api_rest.aut_bearer()`, o dicionário d
 A classe possui 3 métodos: 
 - `api_rest.auth_basic()`: instanciamento da sessão autenticando pelo método HTTPBasicAuth
 - `api_rest.auth_bearer()`: instanciamento da sessão autenticando pelos métodos OAuth, JWT, Bearer    
-- `api_rest.endpoint_json([endereço], [método], payload=None)`: para a chamada ao endpoint
+- `api_rest.endpoint_json([endereço], [método], payload=None, files=None)`: para a chamada ao endpoint
 - `close()` para encerra a instância/sessão
 
-O consumo é feito pelo método `api_rest.endpoint_json` que suporta apenas APIs cujo payload (opcional) seja aceito no formato JSON. 
+O consumo é feito pelo método `api_rest.endpoint_json` que suporta APIs cujo payload (opcional) seja aceito no formato JSON ou binario (files). 
 
-Esse método espera 2 parametros posicionais obrigatórios: o endereço do endpoint e o verbo (get, post, patch ou put), tendo parametro opcional o objeto de 'payload' (json). 
+Esse método espera 2 parametros posicionais obrigatórios: o endereço do endpoint e o verbo (get, post, patch ou put), tendo parametro opcional o objeto de 'payload' (json) ou 'files' (binário). 
+O método define no `headers` a chavee `Content-Type` implicita e automaticamente com o valor `application/json`, independente de ser ou não fornecido payload.
+Se a carga for do tipo binário, é necessário informar o Content-Type correto (`multipart/form-data`) ou repassar um dicionario vazio (`{}`) para o parametro `headers` no instanciamento da classe `api_rest`
 Note que o endereço do endpoint deve ser informado completo. A URL informada no instanciamento da classe corresponde apenas ao endereço de autenticação. 
 
 O tempo, em segundos, transcorrido entre a chamada a atual e a chamada anterior ao endpoint pode ser consultado pelo argumento `.Intervalo` no objeto recebido do retorno à chamada ao método `.endpoint_json`. 

{lbxtoolkit-2.2.8 → lbxtoolkit-2.2.9}/lbxtoolkit/api_rest.py

@@ -216,17 +216,23 @@ Para uso em APIs com autenticação JWT (JSON Web Token), OAuth, Bearer Token Au
                 return self.RetEndPoint
         #
         #
-    def endpoint_json(self, endpoint, metodo, payload=None): # Interage com End Point
+    def endpoint_json(self, endpoint, metodo, payload=None, file=None): # Interage com End Point
         self.ult_tempo_req = time() 
         self.Metodo = metodo.lower()
         #self.EndPoint = self.Url + endpoint
         self.EndPoint = endpoint
         self.Payload = payload
+        self.File = file
+
         MetodosAceitos = ['post', 'get', 'patch', 'put']
         if not any(element in self.Metodo for element in MetodosAceitos):
             self.logger.critico(f'Método {self.Metodo} não previsto. Abortando chamada!', exit=1)
         else:
-            ChamadaApi = f'self.Sessao.{self.Metodo}(self.EndPoint, timeout=self.Timeout, headers=self.Headers, verify=self.Verify)' if self.Payload is None else f'self.Sessao.{self.Metodo}(self.EndPoint, timeout=self.Timeout, headers=self.Headers, verify=self.Verify, json=self.Payload)'
+            ChamadaApi = f'self.Sessao.{self.Metodo}(self.EndPoint, timeout=self.Timeout, headers=self.Headers, verify=self.Verify)' if self.Payload is None and self.File is None else \
+                         f'self.Sessao.{self.Metodo}(self.EndPoint, timeout=self.Timeout, headers=self.Headers, verify=self.Verify, json=self.Payload)' if self.Payload and self.File is None else \
+                         f'self.Sessao.{self.Metodo}(self.EndPoint, timeout=self.Timeout, headers=self.Headers, verify=self.Verify, files=self.File)' if self.Payload is None and self.File else \
+                         f'self.Sessao.{self.Metodo}(self.EndPoint, timeout=self.Timeout, headers=self.Headers, verify=self.Verify, json=self.Payload, files=self.File)' 
+                         
             self.controla_cadencia()
             self.TempoUltReq = time()   
             try: 

{lbxtoolkit-2.2.8 → lbxtoolkit-2.2.9}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "lbxtoolkit"
-version = "2.2.8"
+version = "2.2.9"
 description = ""
 authors = ["Cristiano P. Ferrari <cristiano.ferrari@lbx.com.br>"]
 readme = "README.md"