The last PR before tag v0.1 (#3)

There are still a lot of work to do in this features I started
start tests, I don't have much experience with pytest, so many things are far from being the best way to do them;

start plugins, you still need to create a factory/builder to build the list of plugin tasks.
I added a plugin (cep_aberto) for testing;

docstrings everywhere
see CHANGELOG.md for more info

Reviewed-on: https://codeberg.org/Krisque/jacobson/pulls/3
Co-authored-by: Christian G. Semke <[email protected]>
Co-committed-by: Christian G. Semke <[email protected]>

Author: chrisemke

.pre-commit-config.yaml

@@ -44,15 +44,15 @@ repos:
                     --no-space,
                 ]
     - repo: https://github.com/astral-sh/ruff-pre-commit
-      rev: v0.3.7
+      rev: v0.4.3
       hooks:
           - id: ruff
             name: Run Ruff Linter & Formater
             args: [--fix, --exit-non-zero-on-fix]
           - id: ruff-format
             name: Run Ruff Formater
     - repo: https://github.com/pre-commit/mirrors-mypy
-      rev: v1.9.0
+      rev: v1.10.0
       hooks:
           - id: mypy
             name: Run Mypy (Static type checker)
@@ -66,7 +66,7 @@ repos:
           - id: poetry-export
             args: [-f, requirements.txt, -o, requirements.txt]
     - repo: https://github.com/commitizen-tools/commitizen
-      rev: v3.22.0
+      rev: v3.25.0
       hooks:
           - id: commitizen
           - id: commitizen-branch

CHANGELOG.md

@@ -38,6 +38,9 @@ along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 ### Refactor
 
+- **api**: add docstrings and drop coordinates for now
+- **plugins**: start base for plugins and cep_aberto service
+- **settings**: move all .env settings to utils directory
 - **pydantic**: move pydantic models to sqlmodel models
 - **edgedb-jacobson**: remove edgedb and legacy jacobson
 - **graphql-query**: add pydantic and strawberry types to query

README.md

@@ -32,18 +32,28 @@ else async call to all plugins that are configured, return and insert on databas
 call to tell the api to update some register from plugins that are configured
 ```
 
-# TODO
+# TODO (Needed for v0.1)
 - [x] git hooks (pre-commit)
 - [x] SqlModel
-- [ ] Api's support plugin-like (cepaberto, brazilapi...)
-- [ ] Tests (pytest)
+- [-] Api's support plugin-like (viacep, brazilapi...) cep aberto was added for test, need to think in a better structure for plugins and tasks
+- [-] Tests, need to fix a lot of tests, need to study other ways to test
+- [ ] Integration Tests
+- [ ] Custom exceptions
+- [ ] Add log support (see loguru)
 - [ ] Docs (mkdocs)
-- [ ] fix podman pod for all devs (see jacobson-dev.yaml)
 - [ ] Alembic migrations
 
+## TODO (nice to have)
+- [ ] move from docker-compose to a podman pod
+- [ ] study mypyc viability
 
 # DEV
 The idea is to just run this command and podman will run the entire dev environment
 ```bash
 podman compose up -d --build
 ```
+
+You can access the api at localhost port 8000 /graphql
+```
+http://127.0.0.1:8000/graphql
+```

api/address/inputs.py

@@ -16,7 +16,7 @@
 along with this program.  If not, see <https://www.gnu.org/licenses/>.
 """
 
-from strawberry import auto, input
+from strawberry import auto
 from strawberry.experimental.pydantic import input as pydantic_input
 
 from database.models.brazil import Address, AddressBase, City, State
@@ -27,23 +27,23 @@ class StateInput:
     acronym: auto
     # Needed until strawberry support auto | None type
     # https://github.com/strawberry-graphql/strawberry/issues/3435
-    name: str | None
+    name: str | None = None
 
 
 @pydantic_input(model=City)
 class CityInput:
     ibge: auto
     # Needed until strawberry support auto | None type
     # https://github.com/strawberry-graphql/strawberry/issues/3435
-    name: str | None
+    name: str | None = None
     ddd: auto
 
 
-@input
-class CoordinatesInput:
-    latitude: float
-    longitude: float
-    altitude: float | None = None
+# @input
+# class CoordinatesInput:
+#     latitude: float
+#     longitude: float
+#     altitude: float | None = None
 
 
 @pydantic_input(model=AddressBase)

api/address/types.py

@@ -16,7 +16,7 @@
 along with this program.  If not, see <https://www.gnu.org/licenses/>.
 """
 
-from strawberry import auto, type
+from strawberry import auto
 from strawberry.experimental.pydantic import type as pydantic_type
 
 from database.models.brazil import Address, City, State
@@ -35,11 +35,11 @@ class CityType:
     ddd: auto
 
 
-@type(name='Coordinates')
-class CoordinatesType:
-    latitude: float
-    longitude: float
-    altitude: float
+# @type(name='Coordinates')
+# class CoordinatesType:
+#     latitude: float
+#     longitude: float
+#     altitude: float
 
 
 @pydantic_type(name='Address', model=Address)
@@ -49,4 +49,4 @@ class AddressType:
     state: StateType
     neighborhood: auto
     complement: auto
-    coordinates: CoordinatesType | None = None
+    # coordinates: CoordinatesType | None = None

api/app.py

@@ -25,6 +25,15 @@
 app.include_router(graphql_app, prefix='/graphql')
 
 
-@app.on_event("startup")
+@app.on_event('startup')
 async def on_startup() -> None:
+    """
+    Create database.
+
+    Todo:
+    ----
+    - Move from events to lifespan
+    see https://fastapi.tiangolo.com/advanced/events/
+
+    """
     await init_db()

api/resolvers.py

@@ -21,26 +21,38 @@
 from api.address.inputs import AddressFilterInput, AddressInsertInput
 from database import functions
 from database.models.brazil import Address
+from plugins.plugins_controller import get_zipcode_from_plugins
 
 
 async def get_address(
     filter: AddressFilterInput,
     page_size: PositiveInt,
     page_number: PositiveInt,
-) -> list[Address | None]:
+) -> list[Address]:
+    """
+    Get all addresses from database or all plugins.
+
+    Parameters
+    ----------
+    filter : AddressFilterInput
+        Strawberry input dataclass, everything can be None
+        (based on sqlmodel model)
+    page_size : PositiveInt
+        How many elements in each page
+    page_number : PositiveInt
+        Number of the page
+
+    Returns
+    -------
+    list[Address]
+        All addresses (db model) based on filter or empty list
+
+    """
     result = await functions.get_address_by_dc_join_state_join_city(
         filter, page_size, page_number
     )
-    if not result:
-        try:
-            ...
-            # result = async get from plugins
-        except Exception:
-            ...
-            # there is no address found
-        else:
-            ...
-            # async insert on database
+    if not result and filter.zipcode:
+        result = await get_zipcode_from_plugins(filter.zipcode)
     return result
 
 

api/schema.py

@@ -33,7 +33,27 @@ async def all_address(
         filter: AddressFilterInput,
         page_size: PositiveInt = 10,
         page_number: PositiveInt = 1,
-    ) -> list[AddressType | None]:
+    ) -> list[AddressType]:
+        """
+        Query all addresses from database or all plugins.
+
+        Parameters
+        ----------
+        filter : AddressFilterInput
+            Strawberry input dataclass, everything can be None
+            (based on sqlmodel model)
+        page_size : PositiveInt, optional
+            How many elements in each page, by default 10
+        page_number : PositiveInt, optional
+            Number of the page, by default 1
+
+        Returns
+        -------
+        list[AddressType]
+            All addresses (db model converted to strawberry dataclass)
+            based on filter or empty list
+
+        """
         return list(
             map(
                 AddressType.from_pydantic,
@@ -49,6 +69,6 @@ async def create_address(self, address: AddressInsertInput) -> AddressType:
         return AddressType.from_pydantic(await insert_address(address))
 
 
-schema = Schema(query=Query, mutation=Mutation)  # , mutation=Mutation)
+schema = Schema(query=Query, mutation=Mutation)
 
 graphql_app = GraphQLRouter[object, object](schema)

database/__init__.py

@@ -0,0 +1,17 @@
+"""
+Jacobson is a self hosted zipcode API
+Copyright (C) 2023-2024  Christian G. Semke.
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.
+"""

database/engine.py

@@ -16,59 +16,21 @@
 along with this program.  If not, see <https://www.gnu.org/licenses/>.
 """
 
-from urllib.parse import quote_plus
-
-from pydantic import (
-    BaseModel,
-    MySQLDsn,
-    PositiveInt,
-    computed_field,
-)
-from pydantic_settings import BaseSettings
 from sqlalchemy.ext.asyncio import create_async_engine
 from sqlmodel import SQLModel
 
-
-class UrlValidate(BaseModel):
-    url: MySQLDsn
-
-
-class Database(BaseSettings):
-    DATABASE_USER: str
-    DATABASE_PASSWORD: str
-    DATABASE_HOST: str
-    DATABASE_PORT: PositiveInt
-    DATABASE_NAME: str
-
-    @computed_field  # type: ignore[misc]
-    @property
-    def DATABASE_URL(self) -> str:
-        url = (
-            'mysql+asyncmy://'
-            f'{self.DATABASE_USER}:{quote_plus(self.DATABASE_PASSWORD)}@'
-            f'{self.DATABASE_HOST}:{self.DATABASE_PORT}/{self.DATABASE_NAME}'
-        )
-
-        return str(UrlValidate(url=url).url)
-
-    class Config:
-        """A config class to make model immutable."""
-
-        env_file = '.env'
-        frozen = True
-
-
-database = Database()
+from utils.settings import settings
 
 engine = create_async_engine(
-    database.DATABASE_URL,
+    settings.DATABASE_URL,
     echo=True,
     future=True,
     pool_size=20,
     max_overflow=20,
     pool_recycle=3600,
 )
 
+
 async def init_db() -> None:
     async with engine.begin() as session:
         await session.run_sync(SQLModel.metadata.create_all)