nsj-rest-lib2 0.0.35__py3-none-any.whl → 0.0.37__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,203 @@
1
+ Metadata-Version: 2.4
2
+ Name: nsj_rest_lib2
3
+ Version: 0.0.37
4
+ Summary: Biblioteca para permitir a distribuição de rotas dinâmicas numa API, configuradas por meio de EDLs declarativos (em formato JSON).
5
+ Home-page: https://github.com/Nasajon/nsj_rest_lib2
6
+ Author: Nasajon Sistemas
7
+ Author-email: contact.dev@nasajon.com.br
8
+ Project-URL: Source, https://github.com/Nasajon/nsj_rest_lib2
9
+ Classifier: Development Status :: 3 - Alpha
10
+ Classifier: Intended Audience :: Developers
11
+ Classifier: Topic :: Software Development :: Libraries
12
+ Classifier: Programming Language :: Python :: 3
13
+ Requires-Python: >=3.4
14
+ Description-Content-Type: text/markdown
15
+ Requires-Dist: nsj-rest-lib<7.0.0,>=5.1.3
16
+ Requires-Dist: redis<7.0.0,>=6.4.0
17
+ Requires-Dist: nsj-multi-database-lib<3.0.0,>=2.0.1
18
+ Requires-Dist: pydantic<3.0.0,>=2.11.9
19
+ Requires-Dist: black<26.0.0,>=25.1.0
20
+ Requires-Dist: pyyaml<7.0.0,>=6.0.3
21
+
22
+ # RestLib2
23
+
24
+ O RestLib2 é uma plataforma que tem por objetivo o fornecimento de APIs para os clientes, a partir da descrição da entidades envolvidas, e sem a necessidade de programação imperativa tradicional.
25
+
26
+ Em resumo, a partir da declaração em JSON das entidades que compõe um negócio, bem como dos relacionamentos entre estas, as APIs já estarão disponíveis em produção.
27
+
28
+ O objetivo final é permitir que o desenvolvimento de APIs se torne rápido e simples, acessível àqueles que tratam diretamente com o negócio (incluindo implantadores, e, no limite, o próprio cliente).
29
+
30
+ ## Links
31
+
32
+ [Guia do EDL](docs/README.md)
33
+ [ESPECIFICAÇÃO DO MODELO DE ENTIDADES](docs/especificacao.md)
34
+
35
+ ## Rota das APIs geradas
36
+
37
+ A rota para acesso a uma API gerada por variar de acordo com o modo de configuração escolhido pela aplicação que usar o RestLib2. Mas, via de regra, sugere-se o padrão aplicado na API de DadosMestre:
38
+
39
+ ```http
40
+ #############################
41
+ # List Prod
42
+ #############################
43
+ GET https://api.nasajon.app/dados-mestre/edl1/clientes?tenant=47&grupo_empresarial=NASAJON HTTP/1.1
44
+ Authorization: Bearer *****
45
+ Accept: application/json
46
+ ```
47
+
48
+ * Note que, na API de Dados Mestre, todas as APIs do RestLib2 ficarão debaixo da rota: ```https://api.nasajon.app/dados-mestre/edl1/```
49
+ * O endpoint em si, varia a cada JSON, e fica configurado no nó ```api.resource``` do JSON de EDL em questão.
50
+
51
+ ## Fluxo básico de uso
52
+
53
+ Há dois modos básicos de publicar novas APIs a partir de um JSON gerado, para uma aplicação previamente configurada para uso da plataforma:
54
+
55
+ ### Fluxo por meio de código versionado
56
+ 1. Criar o JSON de descrição da entidade desejada, gravando-o no diretório "@schemas/entities" da aplicação em questão (tome [como exemplo o "dados-mestre"](https://github.com/Nasajon/dados-mestre-api/tree/production/%40schemas)).
57
+ 2. Fazer push das alterações.
58
+ 3. Aguardar o build da aplicação (pode ser útil conferir os logs do job de atualização dos JSON, na aplicação em questão, e também os logs do [worker de compilação](https://ci.nasajon.in/applications/restlib2?view=pods&conditions=false), no Argo).
59
+ 4. Testar as APIs compiladas.
60
+
61
+ ### Fluxo de deploy direto pela API
62
+ 1. Criar o JSON de descrição da entidade desejada.
63
+ 2. Registrá-lo diretamente, por meio da API de controle do RestLib2. segue exemplo de chamada abaixo:
64
+
65
+ ```http
66
+ ###############################
67
+ # Post dinâmico
68
+ ###############################
69
+ POST https://api.nasajon.app/restlib2/entities HTTP/1.1
70
+ Authorization: Bearer ******
71
+ Content-Type: application/json
72
+
73
+ {
74
+ "id": "{UUID}",
75
+ "escopo": "{escopo}",
76
+ "tenant": 0,
77
+ "grupo_empresarial": "00000000-0000-0000-0000-000000000000",
78
+ "codigo": "{codigo da entidade}",
79
+ "descricao": "{descrição da entidade}",
80
+ "json_schema": {
81
+ "edl_version": "1.0",
82
+ "escopo": "{escopo}",
83
+ "description": "{descrição da entidade}",
84
+ "id": "cliente",
85
+ "version": "0.0.1",
86
+ ...
87
+ }
88
+ }
89
+ ```
90
+
91
+ Observações:
92
+ * Note que, acima há placeholders a alterar.
93
+ * Note também que o JSON não está completo, e, o correto é deguir a documentação do EDL.
94
+ * Os valores tenant=0 e grupo_empresarial=00000000-0000-0000-0000-000000000000, indicam que a entidade é padrão, e serve para todos os tenants e grupos.
95
+
96
+ 3. Essa rota irá retornar algo semelhante a:
97
+
98
+ ```http
99
+ HTTP/1.1 202 ACCEPTED
100
+ Location: https://api.nasajon.app/restlib2/entity-compilations/status/{UUID do processo de compilação}
101
+ ```
102
+
103
+ E, se você fizer uma chamada à rota retornada, poderá acompanhar o status da compilação, incluindo eventuais erros que venham a ocorrer.
104
+
105
+ 4. Testar a API compilada.
106
+
107
+ ## Como rodar a compilação de EDLs localmente?
108
+
109
+ Você pode testar a compilação de seus EDLs localmente, incluindo a execução de diversas validações sobre os mesmos, desde que todos estejam dispostos num mesmo diertório.
110
+
111
+ Para isso, considere os passos a seguir:
112
+
113
+ 1. Crie um diretório, e coloque todos os seus EDLs lá (garantindo que EDLs relacionados estejam no mesmo).
114
+ 2. Instale, no seu ambiente pyhton de teste, a biblioteca `nsj-rest-lib2`:
115
+
116
+ ```sh
117
+ pip install nsj-rest-lib2
118
+ ```
119
+
120
+ 3. Rode o comando abaixo (adaptado para seu diretório):
121
+ ```sh
122
+ python3 -m nsj_rest_lib2.compiler.compiler -d $(shell pwd)/{diretorio_com_os_edls_json}
123
+ ```
124
+
125
+ O resultado da compilação será impresso no console (erros, ou código total gerado).
126
+
127
+ ## Como configurar uma aplicação para expôr rotas de acordo com o padrão do RestLib2?
128
+
129
+ Para que uma aplicação exponha as rotas no padrão do RestLib2, não são necessários muitos passos. Antes basta:
130
+
131
+ 1. Instalar, em sua aplicação, a dependência para o projeto nsj-rest-lib2
132
+
133
+ ```sh
134
+ pip install nsj-rest-lib2
135
+ ```
136
+
137
+ Não esqueça de fixar a versão usada (como sendo a última), no arquivo requirements.txt.
138
+
139
+ 2. Adicione a variável de ambiente abaixo em sua aplciação
140
+
141
+ ```env
142
+ ESCOPO_RESTLIB2: "{COLOQUE O IDENTIFICADOR DE ESCOPO QUE DESEJAR PARA SUA APLICAÇÃO (UMA SIMPLES STRING SEM ESPAÇO)}"
143
+ ```
144
+
145
+ * Esse identificador de escopo deve se único para sua aplicação.
146
+ * É importante nota que sua aplicação só irá expôr JSONs de EDL configurados para o mesmo escopo definido aqui.
147
+
148
+ 3. Instale, como dependência a biblioteca, nsj-rest-lib2:
149
+
150
+ ```sh
151
+ pip install nsj-rest-lib2
152
+ ```
153
+
154
+ Não esqueça de fixar a versão usada (como sendo a última), no arquivo requirements.txt.
155
+
156
+ 4. Adicione a linha abaixo no arquivo wsgi.py (de inicilização de sua aplicação):
157
+
158
+ ```python
159
+ from nsj_rest_lib2.controller.dynamic_controller import setup_dynamic_routes
160
+ from nasajon.injector_factory_multibanco import InjectorFactoryMultibanco
161
+
162
+ setup_dynamic_routes(application, injector_factory=InjectorFactoryMultibanco)
163
+ ```
164
+
165
+ * No exemplo acima, a rota é multibanco, mas, não é obrigatório.
166
+ * Os parâmetros de setup são:
167
+ * flask_app: Variável obrigatório, que aponte para sua aplicação Flask.
168
+ * multidb: Flag (padrão True)
169
+ * dynamic_root_path: URL padrão base de todos os endpoints do RestLib2 (padrão: "edl1")
170
+ * injector_factory: Classe de injeção de depndência usada (normalmente necessária para aplicações multibanco; o principal uso é justamente manipular a criação da conexão com o BD).
171
+
172
+ ## Carregando EDLs direto do disco
173
+
174
+ Também é possível carregar EDLs diretamente do disco, sem depender exclusivamente do Redis. Para isso, use o parâmetro opcional `edls_path` em `setup_dynamic_routes`, apontando para um caminho relativo ao workdir da aplicação (ou absoluto), contendo arquivos `.json`, `.yml` ou `.yaml` com os EDLs.
175
+
176
+ Exemplo:
177
+
178
+ ```python
179
+ from nsj_rest_lib2.controller.dynamic_controller import setup_dynamic_routes
180
+
181
+ setup_dynamic_routes(
182
+ application,
183
+ injector_factory=InjectorFactoryMultibanco,
184
+ edls_path="@schemas/entities",
185
+ )
186
+ ```
187
+
188
+ Observações:
189
+ * Os EDLs são carregados e compilados uma vez, ficando em cache em memória. Chamadas seguintes reutilizam o cache.
190
+ * A resolução das entidades ocorre primeiro pelo cache local; se não encontrar, o Redis é consultado (quando habilitado).
191
+
192
+ Para desabilitar o Redis e usar somente EDLs do disco, defina a variável de ambiente abaixo:
193
+
194
+ ```env
195
+ EDLS_FROM_REDIS=false
196
+ ```
197
+
198
+ O valor padrão de `EDLS_FROM_REDIS` é `true`.
199
+
200
+
201
+ **Pronto, isso deve bastar para expôr os EDLs configurados para o mesmo escopo da aplicação.**
202
+
203
+ **OBSERVAÇÃO GERAL: Isso só funciona para aplicações Flask.**
@@ -1,11 +1,11 @@
1
1
  nsj_rest_lib2/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
2
2
  nsj_rest_lib2/exception.py,sha256=E9uMUdoCCQOVQfc8f6gD9b5Pxurf3Q4SytDCcqSlkZ8,56
3
3
  nsj_rest_lib2/redis_config.py,sha256=4KLcvYS3nJO7PMQgF6F9_j6r-TyqcS7TBbd3LEQuKDU,629
4
- nsj_rest_lib2/settings.py,sha256=Hn_o1HZmievnYb8D1kNT2Nq-OEjxbyNjOiOpbnFsMwE,367
4
+ nsj_rest_lib2/settings.py,sha256=eK2aIFVhZK8kxEDHCW5agba5XP2aFPoh_PFnNLwCMH8,627
5
5
  nsj_rest_lib2/compiler/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
6
- nsj_rest_lib2/compiler/compiler.py,sha256=a-lfAEgj2O6mmYKoA3q2x_tVhjBD-y7C6LHixStgqaU,35263
6
+ nsj_rest_lib2/compiler/compiler.py,sha256=z-u9UeOhNKxH6bwaPWTxkN_SJjgZ6tGJD_iXc2D2Hr4,39433
7
7
  nsj_rest_lib2/compiler/compiler_structures.py,sha256=stspjqJGXU7Vz3BqQ-ZF5ZmumFm3R4jpkWgVVsXW5d0,1488
8
- nsj_rest_lib2/compiler/dto_compiler.py,sha256=Fs6VysuAjBgct7_Wc0sugvx7z9tfnlZcSrBu0l0Pyp0,7019
8
+ nsj_rest_lib2/compiler/dto_compiler.py,sha256=kT9v8z0MMHYGkVudkJA0VUY1tNCM7QzV6_RV-aWjSoE,7143
9
9
  nsj_rest_lib2/compiler/entity_compiler.py,sha256=LeGEBxsjAmZZog2gh4vjUX1aFp9JSVgHHOdTkY0aH-s,6733
10
10
  nsj_rest_lib2/compiler/function_get_delete_compiler.py,sha256=bfzpsKEb_qeGBlaMVJ22P0Ju0YJGrXiMSsBnSl2mqJA,8234
11
11
  nsj_rest_lib2/compiler/function_insert_update_compiler.py,sha256=a4KfituXIF1jxsI7Nox0TqxGZAxsO9kuOo7RwoGgbSE,18004
@@ -14,11 +14,12 @@ nsj_rest_lib2/compiler/migration_compiler.py,sha256=vlG54XmYRqzIo0Iey-4HbSRzPg3Y
14
14
  nsj_rest_lib2/compiler/migration_compiler_alter_table.py,sha256=awtqVrKox86rmlQV7K17JzZJZqz9cF7McshLBlLx65s,7969
15
15
  nsj_rest_lib2/compiler/migration_compiler_create_table.py,sha256=h22cU53EFnuB5t28fMZ_r7MM-14Vqqu3emebBUJN2LY,2606
16
16
  nsj_rest_lib2/compiler/migration_compiler_util.py,sha256=WB_GRX78nTRKlZkgL-4yowwlQoAe81llZ-E2AYfIbh4,5168
17
- nsj_rest_lib2/compiler/model.py,sha256=ow9dQve7npl4OZU2GyS0HMZ2OXvBSebWTQCXFm6iMxM,2358
17
+ nsj_rest_lib2/compiler/model.py,sha256=k3xxgJlogCbdT0cHoksPI-EnyRJJzn2sylpYhzWz4CI,3069
18
18
  nsj_rest_lib2/compiler/property_compiler.py,sha256=hMQX5vrLqjOEM_wdzuerxuARMq5JhZQ_R8cUVoLHNNM,47631
19
+ nsj_rest_lib2/compiler/response_dto_compiler.py,sha256=9859w1LSgb-9TcLTUx1bhqLVgJ4ulTwbDufonVJLCow,3614
19
20
  nsj_rest_lib2/compiler/edl_model/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
20
21
  nsj_rest_lib2/compiler/edl_model/ai_entity_edl.py,sha256=664QBDcOgVnyfwtUOXO1W7AKaZhueBG335x5DuogruY,7644
21
- nsj_rest_lib2/compiler/edl_model/api_model.py,sha256=7RpZkUGROZmTBh2psgTG_b3e4xxjc3uBr1EYb-wiAkc,3810
22
+ nsj_rest_lib2/compiler/edl_model/api_model.py,sha256=rDHQpxwVRYSYbu5E9sjhENXAC5Aid6D0cFXvhLMwriw,4376
22
23
  nsj_rest_lib2/compiler/edl_model/column_meta_model.py,sha256=s0sEVkoW1hV2_hto1mws4XhzKGH_b4NzhaOiwFH25Ks,694
23
24
  nsj_rest_lib2/compiler/edl_model/entity_model.py,sha256=Yc6wvjsiwacmz796mZIU-i9hxzNV9yuLPdULGKYHNbM,854
24
25
  nsj_rest_lib2/compiler/edl_model/entity_model_base.py,sha256=eRn0pirIPHvniqGpT0xE-mmgqz5RIVtqghxcnfxKNdQ,4345
@@ -31,18 +32,18 @@ nsj_rest_lib2/compiler/edl_model/trait_property_meta_model.py,sha256=NtMVZeOPu3L
31
32
  nsj_rest_lib2/compiler/util/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
32
33
  nsj_rest_lib2/compiler/util/relation_ref.py,sha256=1M_e-NyeqozlIYLl1rB76KqkmtMvgtqH_nJS-NK0Pck,3695
33
34
  nsj_rest_lib2/compiler/util/str_util.py,sha256=0ReIQ2Vy4zAmVMvGv0FcUehRQw15hlz0e7yDsF89ghk,1178
34
- nsj_rest_lib2/compiler/util/type_naming_util.py,sha256=jYUnr3eC6ewwhIAFHF89OOLoSH9aO_syHMF66AsWX3s,2355
35
+ nsj_rest_lib2/compiler/util/type_naming_util.py,sha256=WKBqGZ0a-JO1IO5Q_rHVpLBESUmbc5D_lgF9DWBwkpk,5065
35
36
  nsj_rest_lib2/compiler/util/type_util.py,sha256=HTKOH4uRTOY0YgoM8oUv_6cEcReE_bgKYXFBsQCb-3A,357
36
37
  nsj_rest_lib2/controller/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
37
- nsj_rest_lib2/controller/dynamic_controller.py,sha256=8kvN75-E4mA1nApNJMMQstKv036z8tDPV5YtLCokNQU,14132
38
+ nsj_rest_lib2/controller/dynamic_controller.py,sha256=g7ThrpLvzdhQYxzqcW5WJgCaDcgKzvqoWBEC4c4Tmpk,17474
38
39
  nsj_rest_lib2/dto/__init__.py,sha256=MsSFjiLMLJZ7QhUPpVBWKiyDnCzryquRyr329NoCACI,2
39
40
  nsj_rest_lib2/dto/escopo_dto.py,sha256=R9gxRwYxOVYhGjR3q03_iXvHm14N905zbRKLsS3jI-A,1393
40
41
  nsj_rest_lib2/entity/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
41
42
  nsj_rest_lib2/entity/escopo_entity.py,sha256=T4bxFDzHJvIj-nZ_6d0Xh2oQg21HgoRjp19nt6clY18,338
42
43
  nsj_rest_lib2/service/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
43
- nsj_rest_lib2/service/entity_config_writer.py,sha256=bLXWrncm_OOjkvF_wcEAJ1NVjhcrV-zt41gDNtPDh68,6100
44
- nsj_rest_lib2/service/entity_loader.py,sha256=FPHdJs6qA_-bjtHMsJ7OAe0RxVv0vfOMX5lN51ZB_JA,25355
45
- nsj_rest_lib2-0.0.35.dist-info/METADATA,sha256=dwRpdr9scMDq5gcRqj57_Zai44EHM-GkuZmy5vMG_8w,1094
46
- nsj_rest_lib2-0.0.35.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
47
- nsj_rest_lib2-0.0.35.dist-info/top_level.txt,sha256=L6zh0EfH8_rur7OJ8_V-El-XEMf4qg3bkF8ADgqLVIA,14
48
- nsj_rest_lib2-0.0.35.dist-info/RECORD,,
44
+ nsj_rest_lib2/service/entity_config_writer.py,sha256=QVgEO3Tv5g3dK8MQgCrWD9BZyCKV-BxBLfYNFi53PX8,5806
45
+ nsj_rest_lib2/service/entity_loader.py,sha256=kCAt0uKgnrw4gr48_xjspLDQzl_5PxyUYnM8W1YzIxs,39775
46
+ nsj_rest_lib2-0.0.37.dist-info/METADATA,sha256=5kHSDiNwLEvHSF8VNFBsR5jtnJHMIInItAAcrenG2Dk,8260
47
+ nsj_rest_lib2-0.0.37.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
48
+ nsj_rest_lib2-0.0.37.dist-info/top_level.txt,sha256=L6zh0EfH8_rur7OJ8_V-El-XEMf4qg3bkF8ADgqLVIA,14
49
+ nsj_rest_lib2-0.0.37.dist-info/RECORD,,
@@ -1,27 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: nsj_rest_lib2
3
- Version: 0.0.35
4
- Summary: Biblioteca para permitir a distribuição de rotas dinâmicas numa API, configuradas por meio de EDLs declarativos (em formato JSON).
5
- Home-page: https://github.com/Nasajon/nsj_rest_lib2
6
- Author: Nasajon Sistemas
7
- Author-email: contact.dev@nasajon.com.br
8
- Project-URL: Source, https://github.com/Nasajon/nsj_rest_lib2
9
- Classifier: Development Status :: 3 - Alpha
10
- Classifier: Intended Audience :: Developers
11
- Classifier: Topic :: Software Development :: Libraries
12
- Classifier: Programming Language :: Python :: 3
13
- Requires-Python: >=3.4
14
- Description-Content-Type: text/markdown
15
- Requires-Dist: nsj-rest-lib<7.0.0,>=5.1.3
16
- Requires-Dist: redis<7.0.0,>=6.4.0
17
- Requires-Dist: nsj-multi-database-lib<3.0.0,>=2.0.1
18
- Requires-Dist: pydantic<3.0.0,>=2.11.9
19
- Requires-Dist: black<26.0.0,>=25.1.0
20
- Requires-Dist: pyyaml<7.0.0,>=6.0.3
21
-
22
- # nsj_rest_lib2
23
-
24
- Biblioteca para permitir a distribuição de rotas dinâmicas numa API, configuradas por meio de EDLs declarativos (em formato JSON).
25
-
26
- [ESPECIFICAÇÃO DO MODELO DE ENTIDADES](docs/especificacao.md)
27
-