bisslog-flask 0.0.1__tar.gz → 0.0.2__tar.gz

{bisslog_flask-0.0.1 → bisslog_flask-0.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bisslog_flask
-Version: 0.0.1
+Version: 0.0.2
 Summary: It is an extension of the bisslog library to support processes with flask
 Author-email: Darwin Stiven Herrera Cartagena <darwinsherrerac@gmail.com>
 Project-URL: Homepage, https://github.com/darwinhc/bisslog-flask
@@ -11,7 +11,7 @@ Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: bisslog>=0.0.7
-Requires-Dist: bisslog-schema>=0.0.3
+Requires-Dist: bisslog-schema>=0.0.6
 Requires-Dist: flask
 Provides-Extra: websocket
 Requires-Dist: flask-socketio; extra == "websocket"
@@ -19,45 +19,43 @@ Provides-Extra: cors
 Requires-Dist: flask-cors>=6.0.0; extra == "cors"
 Dynamic: license-file
 
-
 # bisslog-flask
 
 [![PyPI](https://img.shields.io/pypi/v/bisslog-flask)](https://pypi.org/project/bisslog-flask/)
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
 
-**bisslog-flask** is an extension of the bisslog library to support processes with Flask. It enables dynamic HTTP and WebSocket route registration from use case metadata, allowing developers to build clean, modular, and metadata-driven APIs with minimal boilerplate.
+**bisslog-flask** is an extension of the Bisslog library to support processes with Flask.  
+It enables dynamic HTTP and WebSocket route registration from use case metadata, allowing developers to build clean, modular, and metadata-driven APIs with minimal boilerplate.
 
-Part of the bisslog ecosystem, it is designed to work seamlessly with domain-centric architectures like Hexagonal or Clean Architecture.
+Part of the Bisslog ecosystem, it is designed to work seamlessly with domain-centric architectures like Hexagonal or Clean Architecture.
 
-## Features
+---
 
-- 🔁 Dynamic route registration for HTTP and WebSocket triggers
+## ✨ Features
 
+- 🔁 Dynamic route registration for HTTP and WebSocket triggers
 - 🧠 Metadata-driven setup – use YAML or JSON to declare your use cases
-
-- 🔒 Automatic CORS per endpoint using flask-cors
-
+- 🔒 Automatic CORS per endpoint using `flask-cors`
 - 🔌 Extensible resolver pattern – plug in your own processor
-
 - ⚙️ Mapper integration – maps HTTP request parts to domain function arguments
 
-
+---
 
 ## 📦 Installation
 
-~~~shell
+```bash
 pip install bisslog-flask
-~~~
-
-
+```
 
+---
 
 ## 🚀 Quickstart
 
 ### Programmatically
 
-if you want to configure the app before bisslog touches it
-~~~python
+Use this approach if you want to configure the app before Bisslog touches it:
+
+```python
 from flask import Flask
 from bisslog_flask import BisslogFlask
 
@@ -70,11 +68,11 @@ BisslogFlask(
 
 if __name__ == "__main__":
     app.run(debug=True)
-~~~
+```
 
-or
+Or use the factory version:
 
-~~~python
+```python
 from bisslog_flask import BisslogFlask
 
 app = BisslogFlask(
@@ -84,58 +82,73 @@ app = BisslogFlask(
 
 if __name__ == "__main__":
     app.run(debug=True)
-~~~
-
+```
 
+---
 
-## 🔧 How It Works
+## 🖥️ CLI Usage
 
-1. Loads metadata and discovers use case functions (or callables), then uses resolvers to register routes dynamically into a Flask app.
+You can also use the `bisslog_flask` CLI to run or generate a Flask app.
 
+```bash
+bisslog_flask run [--metadata-file FILE] [--use-cases-folder-path DIR]
+                  [--infra-folder-path DIR] [--encoding ENC]
+                  [--secret-key KEY] [--jwt-secret-key KEY]
 
-## 🔐 CORS Handling
+bisslog_flask build [--metadata-file FILE] [--use-cases-folder-path DIR]
+                    [--infra-folder-path DIR] [--encoding ENC]
+                    [--target-filename FILE]
+```
 
-CORS is applied only when allow_cors: true is specified in the trigger
+- `run`: Launches the Flask application from metadata.
+- `build`: Generates a boilerplate Flask file (`flask_app.py` by default).
 
-Fully dynamic: works even with dynamic Flask routes like /users/<id>
+All options are optional. You can override defaults via CLI flags.
 
-Powered by `@cross_origin` from `flask-cors`
+---
 
+## 🔐 CORS Handling
 
-## ✅ Requirements
+CORS is applied only when `allow_cors: true` is specified in the trigger.
 
-Python ≥ 3.7
+Fully dynamic: works even with Flask dynamic routes like `/users/<id>`.
 
-Flask ≥ 2.0
+Powered by `@cross_origin` from `flask-cors`.
 
-bisslog-schema ≥ 0.0.3
+---
 
-flask-cors
+## ✅ Requirements
 
-(Optional) flask-socketio if using WebSocket triggers
+- Python ≥ 3.7
+- Flask ≥ 2.0
+- bisslog-schema ≥ 0.0.3
+- flask-cors
+- (Optional) flask-sock if using WebSocket triggers
 
+---
 
 ## 🧪 Testing Tip
 
-You can test the generated Flask app directly with `app.test_client()` if you take the programmatic way:
+You can test the generated Flask app directly with `app.test_client()` if using the programmatic interface:
 
 ```python
 from bisslog_flask import BisslogFlask
 
 def test_user_create():
-    app = BisslogFlask(metadata_file="metadata.yml", use_cases_folder_path="src/use_cases")
+    app = BisslogFlask(
+        metadata_file="metadata.yml",
+        use_cases_folder_path="src/use_cases"
+    )
     client = app.test_client()
     response = client.post("/user", json={"name": "Ana", "email": "ana@example.com"})
     assert response.status_code == 200
 ```
 
-Not generating code or using the programmatic way you just need to test your use cases.
-
+If you're generating the code (boilerplate), you just need to test your use cases.
 
+---
 
 ## 📜 License
 
-This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
-
-
-
+This project is licensed under the MIT License.  
+See the [LICENSE](LICENSE) file for details.

bisslog_flask-0.0.2/README.md

@@ -0,0 +1,133 @@
+# bisslog-flask
+
+[![PyPI](https://img.shields.io/pypi/v/bisslog-flask)](https://pypi.org/project/bisslog-flask/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+
+**bisslog-flask** is an extension of the Bisslog library to support processes with Flask.  
+It enables dynamic HTTP and WebSocket route registration from use case metadata, allowing developers to build clean, modular, and metadata-driven APIs with minimal boilerplate.
+
+Part of the Bisslog ecosystem, it is designed to work seamlessly with domain-centric architectures like Hexagonal or Clean Architecture.
+
+---
+
+## ✨ Features
+
+- 🔁 Dynamic route registration for HTTP and WebSocket triggers
+- 🧠 Metadata-driven setup – use YAML or JSON to declare your use cases
+- 🔒 Automatic CORS per endpoint using `flask-cors`
+- 🔌 Extensible resolver pattern – plug in your own processor
+- ⚙️ Mapper integration – maps HTTP request parts to domain function arguments
+
+---
+
+## 📦 Installation
+
+```bash
+pip install bisslog-flask
+```
+
+---
+
+## 🚀 Quickstart
+
+### Programmatically
+
+Use this approach if you want to configure the app before Bisslog touches it:
+
+```python
+from flask import Flask
+from bisslog_flask import BisslogFlask
+
+app = Flask(__name__)
+BisslogFlask(
+    metadata_file="metadata.yml",
+    use_cases_folder_path="src/domain/use_cases",
+    app=app
+)
+
+if __name__ == "__main__":
+    app.run(debug=True)
+```
+
+Or use the factory version:
+
+```python
+from bisslog_flask import BisslogFlask
+
+app = BisslogFlask(
+    metadata_file="metadata.yml",
+    use_cases_folder_path="src/domain/use_cases"
+)
+
+if __name__ == "__main__":
+    app.run(debug=True)
+```
+
+---
+
+## 🖥️ CLI Usage
+
+You can also use the `bisslog_flask` CLI to run or generate a Flask app.
+
+```bash
+bisslog_flask run [--metadata-file FILE] [--use-cases-folder-path DIR]
+                  [--infra-folder-path DIR] [--encoding ENC]
+                  [--secret-key KEY] [--jwt-secret-key KEY]
+
+bisslog_flask build [--metadata-file FILE] [--use-cases-folder-path DIR]
+                    [--infra-folder-path DIR] [--encoding ENC]
+                    [--target-filename FILE]
+```
+
+- `run`: Launches the Flask application from metadata.
+- `build`: Generates a boilerplate Flask file (`flask_app.py` by default).
+
+All options are optional. You can override defaults via CLI flags.
+
+---
+
+## 🔐 CORS Handling
+
+CORS is applied only when `allow_cors: true` is specified in the trigger.
+
+Fully dynamic: works even with Flask dynamic routes like `/users/<id>`.
+
+Powered by `@cross_origin` from `flask-cors`.
+
+---
+
+## ✅ Requirements
+
+- Python ≥ 3.7
+- Flask ≥ 2.0
+- bisslog-schema ≥ 0.0.3
+- flask-cors
+- (Optional) flask-sock if using WebSocket triggers
+
+---
+
+## 🧪 Testing Tip
+
+You can test the generated Flask app directly with `app.test_client()` if using the programmatic interface:
+
+```python
+from bisslog_flask import BisslogFlask
+
+def test_user_create():
+    app = BisslogFlask(
+        metadata_file="metadata.yml",
+        use_cases_folder_path="src/use_cases"
+    )
+    client = app.test_client()
+    response = client.post("/user", json={"name": "Ana", "email": "ana@example.com"})
+    assert response.status_code == 200
+```
+
+If you're generating the code (boilerplate), you just need to test your use cases.
+
+---
+
+## 📜 License
+
+This project is licensed under the MIT License.  
+See the [LICENSE](LICENSE) file for details.

bisslog_flask-0.0.2/bisslog_flask/builder/builder_flask_app_manager.py

@@ -0,0 +1,353 @@
+"""
+Module for generating a Flask application boilerplate from Bisslog metadata and use case code.
+
+This builder analyzes declared metadata (e.g., triggers) and discovered use case implementations,
+and generates the corresponding Flask code—including HTTP routes, WebSocket endpoints, security
+configuration, and runtime setup.
+
+The generated code is returned as a full Python script and can be written to a file (e.g.,
+`flask_app.py`).
+"""
+from typing import Optional, Callable
+import json
+
+from bisslog_schema import read_full_service_metadata
+from bisslog_schema.eager_import_module_or_package import EagerImportModulePackage
+from bisslog_schema.schema import UseCaseInfo, TriggerHttp, TriggerWebsocket
+from bisslog_schema.setup import get_setup_metadata
+from bisslog_schema.use_case_code_inspector.use_case_code_metadata import UseCaseCodeInfo, \
+    UseCaseCodeInfoClass, UseCaseCodeInfoObject
+from .static_python_construct_data import StaticPythonConstructData
+
+
+class BuilderFlaskAppManager:
+    """
+    Flask application builder for Bisslog-based services.
+
+    This class dynamically generates Flask code based on user-declared metadata and
+    the implementation of use cases discovered in the source tree. It supports HTTP
+    and WebSocket triggers, integrates runtime setup from decorators, and configures
+    environment-based security.
+
+    The result is a complete Flask application scaffold that can be directly executed
+    or used as a starting point for further customization.
+    """
+
+    def __init__(self, eager_importer: Callable[[str], None]):
+        self._eager_importer = eager_importer
+
+
+    def _get_bisslog_setup(self, infra_path: Optional[str]) -> Optional[StaticPythonConstructData]:
+        """
+        Retrieves the Bisslog setup call for the 'flask' runtime, if defined.
+
+        This inspects the global Bisslog configuration and returns the corresponding
+        setup function call code for Flask.
+
+        Returns
+        -------
+        Optional[StaticPythonConstructData]
+            The setup code and imports, or None if no setup was declared.
+        """
+        self._eager_importer(infra_path)
+        setup_metadata = get_setup_metadata()
+        if setup_metadata is None:
+            return None
+
+        if setup_metadata.setup_function is not None:
+            n_params = setup_metadata.setup_function.n_params
+            if n_params == 0:
+                build = f"{setup_metadata.setup_function.function_name}()"
+            elif n_params == 1:
+                build = f"{setup_metadata.setup_function.function_name}(\"flask\")"
+            else:
+                build = (f"{setup_metadata.setup_function.function_name}(\"flask\")"
+                         "  # TODO: change this")
+            return StaticPythonConstructData(
+                importing={setup_metadata.setup_function.module:
+                               {setup_metadata.setup_function.function_name}},
+                build=build,
+            )
+        custom_runtime_setup = setup_metadata.runtime.get("flask", None)
+        if custom_runtime_setup is not None:
+            return StaticPythonConstructData(
+                importing={custom_runtime_setup.module:
+                               {custom_runtime_setup.function_name}},
+                build=f"{custom_runtime_setup.function_name}()"
+            )
+        return None
+
+    @staticmethod
+    def _generate_security_code() -> StaticPythonConstructData:
+        """
+        Generates Flask configuration code for secret keys using environment variables.
+
+        Returns
+        -------
+        StaticPythonConstructData
+            Code that assigns `SECRET_KEY` and `JWT_SECRET_KEY` to the Flask app.
+        """
+        build = """
+if "SECRET_KEY" in os.environ:
+    app.config["SECRET_KEY"] = os.environ["SECRET_KEY"]
+if "JWT_SECRET_KEY" in os.environ:
+    app.config["JWT_SECRET_KEY"] = os.environ["JWT_SECRET_KEY"]
+"""
+        return StaticPythonConstructData(build=build)
+
+    @staticmethod
+    def _generate_use_case_code_build(use_case_code_info: UseCaseCodeInfo):
+        """
+        Prepares the use case callable to be used in HTTP or WebSocket routes.
+
+        If the use case is a class, an instance is created. If it's an object, it's referenced.
+
+        Parameters
+        ----------
+        use_case_code_info : UseCaseCodeInfo
+            Static metadata about the use case implementation.
+
+        Returns
+        -------
+        Tuple[str, StaticPythonConstructData]
+            - Name of the callable reference (e.g., variable or instance).
+            - Generated setup code and required imports.
+        """
+        importing = {"flask": {"request"}, "bisslog.utils.mapping": {"Mapper"}}
+        starting_build = ""
+        if isinstance(use_case_code_info, UseCaseCodeInfoClass):
+            importing[use_case_code_info.module] = {use_case_code_info.class_name}
+            uc_callable = f"{use_case_code_info.name}_uc"
+            starting_build += f"{uc_callable} = {use_case_code_info.class_name}()"
+        elif isinstance(use_case_code_info, UseCaseCodeInfoObject):
+            importing[use_case_code_info.module] = {use_case_code_info.var_name}
+            uc_callable = use_case_code_info.var_name
+        else:
+            raise ValueError("Unsupported UseCaseCodeInfo type")
+        return uc_callable, StaticPythonConstructData(build=starting_build, importing=importing)
+
+    @staticmethod
+    def _generate_use_case_code_http_trigger(
+            use_case_key: str, uc_callable: str, use_case_code_info: UseCaseCodeInfo,
+            trigger_info: TriggerHttp, identifier: int) -> StaticPythonConstructData:
+        """
+        Generates the code for a use case with an HTTP trigger.
+
+        Parameters
+        ----------
+        use_case_key : str
+            Name used to identify the use case route.
+        use_case_code_info : UseCaseCodeInfo
+            Static code metadata for the specific use case.
+        trigger_info : TriggerHttp
+            Metadata of the HTTP trigger.
+
+        Returns
+        -------
+        StaticPythonConstructData
+            The generated code for the HTTP trigger.
+        """
+        starting_build = ""
+        mapper_code_lines = []
+        if trigger_info.mapper is not None:
+            mapper_name = f"{use_case_code_info.name}_mapper_{identifier}"
+            starting_build += (f"\n{mapper_name} = Mapper(name=\"{use_case_key}_mapper\", "
+                               f"base={json.dumps(trigger_info.mapper)})")
+            mapper_code_lines.append(f"""
+    res_map = {mapper_name}.map({{
+        "path_query": request.view_args or {{}},
+        "body": request.get_json(silent=True) or {{}},
+        "params": request.args.to_dict(),
+        "headers": request.headers,
+    }})""")
+        method = trigger_info.method.upper()
+        flask_path = (trigger_info.path or f"/{use_case_key}").replace("{", "<").replace("}", ">")
+        handler_name = f"{use_case_key}_handler_{identifier}"
+
+        lines = [
+            f'@app.route("{flask_path}", methods=["{method}"])',
+            f'def {handler_name}():',
+        ]
+        if not mapper_code_lines:
+            lines.append("    kwargs = {}")
+            lines.append("    kwargs.update(request.view_args or {})")
+            lines.append("    kwargs.update(request.get_json(silent=True) or {})")
+            lines.append("    kwargs.update(request.args.to_dict())")
+            lines.append("    kwargs.update(dict(request.headers))")
+            lines.append(f"    return {uc_callable}(**kwargs)\n")
+        else:
+            lines.extend(mapper_code_lines)
+            lines.append(f'    return {uc_callable}(**res_map)\n')
+
+        return StaticPythonConstructData(build=starting_build, body="\n".join(lines))
+
+    @staticmethod
+    def _generate_use_case_code_websocket_trigger(
+            use_case_key: str,
+            uc_callable: str,
+            use_case_code_info: UseCaseCodeInfo,
+            trigger_info: TriggerWebsocket,
+            identifier: int
+    ) -> StaticPythonConstructData:
+        """
+        Generates the code for a use case with a WebSocket trigger using flask-sock.
+
+        Parameters
+        ----------
+        use_case_key : str
+            The identifier of the use case.
+        uc_callable : str
+            The callable name to invoke.
+        use_case_code_info : UseCaseCodeInfo
+            Info about where the use case is defined.
+        trigger_info : TriggerWebsocket
+            Metadata describing the trigger.
+        identifier : int
+            An integer used to ensure uniqueness of function names.
+
+        Returns
+        -------
+        StaticPythonConstructData
+            Code and imports needed for WebSocket registration.
+        """
+        route_key = trigger_info.route_key or f"{use_case_key}.default"
+        handler_name = f"{use_case_key}_ws_handler_{identifier}"
+        mapper_decl = ""
+
+        imports = {
+            use_case_code_info.module: {use_case_code_info.name},
+            "flask_sock": {"Sock"},
+            "flask": {"request"},
+            "bisslog.utils.mapping": {"Mapper"},
+            "json": None
+        }
+
+        if trigger_info.mapper:
+            mapper_var = f"{use_case_key}_ws_mapper_{identifier}"
+            mapper_json = json.dumps(trigger_info.mapper)
+            mapper_decl = (f'\n{mapper_var} = Mapper(name="{use_case_key}_ws_mapper",'
+                           f' base={mapper_json})')
+
+            mapper_code = f"""
+            try:
+                body = json.loads(data)
+            except Exception:
+                body = {{}}
+            res_map = {mapper_var}.map({{
+                "route_key": "{route_key}",
+                "connection_id": request.headers.get("Sec-WebSocket-Key"),
+                "headers": request.headers,
+                "body": body
+            }})
+            response = {uc_callable}(**res_map)
+    """
+
+        else:
+            # fallback: pass entire raw message
+            mapper_code = f"""
+            try:
+                payload = json.loads(data)
+            except Exception:
+                payload = {{}}
+            response = {uc_callable}(**payload)
+    """
+
+        build = f"""
+    @sock.route("/ws/{route_key}")
+    def {handler_name}(ws):
+        while True:
+            data = ws.receive()
+            if data is None:
+                break;  # Client disconnected
+    {mapper_code}
+            if response is not None:
+                ws.send(response)
+    """
+
+        return StaticPythonConstructData(
+            importing=imports,
+            build=(mapper_decl + build)
+        )
+
+    def __call__(self,
+                 metadata_file: Optional[str] = None,
+                 use_cases_folder_path: Optional[str] = None,
+                 infra_path: Optional[str] = None,
+                 *,
+                 encoding: str = "utf-8",
+                 secret_key: Optional[str] = None,
+                 jwt_secret_key: Optional[str] = None,
+                 **kwargs) -> str:
+        """
+        Main entry point for generating the full Flask application code.
+
+        This method orchestrates metadata loading, trigger processing, and Flask code generation
+        (HTTP routes, WebSocket handlers, runtime setup, security config). The resulting app code
+        is returned as a ready-to-write Python string.
+
+        Parameters
+        ----------
+        metadata_file : str, optional
+            Path to the YAML or JSON metadata file.
+        use_cases_folder_path : str, optional
+            Path to the folder where use case implementations are located.
+        infra_path : str, optional
+            Path to additional infrastructure or adapter code.
+        encoding : str, default="utf-8"
+            Encoding used to read the metadata file.
+        secret_key : str, optional
+            secret key for Flask configuration.
+        jwt_secret_key : str, optional
+            JWT secret key for Flask configuration.
+        **kwargs
+            Additional keyword arguments (currently unused).
+
+        Returns
+        -------
+        str
+            The complete Flask application source code as a string.
+        """
+        full_service_metadata = read_full_service_metadata(
+            metadata_file=metadata_file,
+            use_cases_folder_path=use_cases_folder_path,
+            encoding=encoding
+        )
+        service_info = full_service_metadata.declared_metadata
+        use_cases = full_service_metadata.discovered_use_cases
+
+        res = StaticPythonConstructData(
+            importing={"flask": {"Flask"}, "os": None},
+            build="app = Flask(__name__)"
+        )
+        res += self._get_bisslog_setup(infra_path)
+
+        res += self._generate_security_code()
+
+        # Use cases
+        for use_case_key in service_info.use_cases:
+            use_case_info: UseCaseInfo = service_info.use_cases[use_case_key]
+            use_case_code_info: UseCaseCodeInfo = use_cases[use_case_key]
+            triggers_http = [t for t in use_case_info.triggers
+                             if isinstance(t.options, TriggerHttp)]
+            triggers_ws = [t for t in use_case_info.triggers
+                           if isinstance(t.options, TriggerWebsocket)]
+            triggers_flask = triggers_http + triggers_ws
+            if len(triggers_flask) == 0:
+                continue
+            uc_callable, res_uc = self._generate_use_case_code_build(use_case_code_info)
+            res += res_uc
+            for i, trigger in enumerate(triggers_flask):
+                if isinstance(trigger.options, TriggerHttp):
+                    res += self._generate_use_case_code_http_trigger(
+                        use_case_key, uc_callable, use_case_code_info, trigger.options, i
+                    )
+                elif isinstance(trigger.options, TriggerWebsocket):
+                    res += self._generate_use_case_code_websocket_trigger(
+                        use_case_key, uc_callable, use_case_code_info, trigger.options, i
+                    )
+        res += StaticPythonConstructData(body='\nif __name__ == "__main__":\n'
+                                              '    app.run(debug=True, host="0.0.0.0")')
+        return res.generate_boiler_plate_flask()
+
+
+bisslog_flask_builder = BuilderFlaskAppManager(EagerImportModulePackage(("src.infra", "infra")))