platzky 0.3.6__py3-none-any.whl → 0.4.3__py3-none-any.whl

platzky/db/db.py

@@ -4,7 +4,7 @@ from typing import Any, Callable
 
 from pydantic import BaseModel, Field
 
-from platzky.models import Color, MenuItem, Page, Post
+from platzky.models import MenuItem, Page, Post
 
 
 class DB(ABC):
@@ -81,11 +81,11 @@ class DB(ABC):
         pass
 
     @abstractmethod
-    def get_primary_color(self) -> Color:
+    def get_primary_color(self) -> str:
         pass
 
     @abstractmethod
-    def get_secondary_color(self) -> Color:
+    def get_secondary_color(self) -> str:
         pass
 
     @abstractmethod
@@ -96,6 +96,15 @@ class DB(ABC):
     def get_font(self) -> str:
         pass
 
+    @abstractmethod
+    def health_check(self) -> None:
+        """Perform a health check on the database.
+
+        Should raise an exception if the database is not healthy.
+        This should be a lightweight operation suitable for health checks.
+        """
+        pass
+
 
 class DBConfig(BaseModel):
     type: str = Field(alias="TYPE")

platzky/db/graph_ql_db.py

@@ -7,7 +7,7 @@ from gql.transport.exceptions import TransportQueryError
 from pydantic import Field
 
 from platzky.db.db import DB, DBConfig
-from platzky.models import Color, Post
+from platzky.models import Post
 
 
 def db_config_type():
@@ -289,11 +289,11 @@ class GraphQL(DB):
 
         return self.client.execute(favicon)["favicons"][0]["favicon"]["url"]
 
-    def get_primary_color(self) -> Color:
-        return Color()
+    def get_primary_color(self) -> str:
+        return "white"  # Default color as string
 
-    def get_secondary_color(self):
-        return Color()
+    def get_secondary_color(self) -> str:
+        return "navy"  # Default color as string
 
     def get_plugins_data(self):
         plugins_data = gql(
@@ -307,3 +307,18 @@ class GraphQL(DB):
             """
         )
         return self.client.execute(plugins_data)["pluginConfigs"]
+
+    def health_check(self) -> None:
+        """Perform a health check on the GraphQL database.
+
+        Raises an exception if the database is not accessible.
+        """
+        # Simple query to check connectivity
+        health_query = gql(
+            """
+            query {
+              __typename
+            }
+            """
+        )
+        self.client.execute(health_query)

platzky/db/json_db.py

@@ -116,3 +116,11 @@ class Json(DB):
 
     def get_plugins_data(self):
         return self.data.get("plugins", [])
+
+    def health_check(self) -> None:
+        """Perform a health check on the JSON database.
+
+        Raises an exception if the database is not accessible.
+        """
+        # Try to access site_content to ensure basic structure is valid
+        self._get_site_content()

platzky/db/mongodb_db.py

@@ -0,0 +1,143 @@
+import datetime
+from typing import Any
+
+from pydantic import Field
+from pymongo import MongoClient
+from pymongo.collection import Collection
+from pymongo.database import Database
+
+from platzky.db.db import DB, DBConfig
+from platzky.models import MenuItem, Page, Post
+
+
+def db_config_type():
+    return MongoDbConfig
+
+
+class MongoDbConfig(DBConfig):
+    connection_string: str = Field(alias="CONNECTION_STRING")
+    database_name: str = Field(alias="DATABASE_NAME")
+
+
+def get_db(config):
+    mongodb_config = MongoDbConfig.model_validate(config)
+    return MongoDB(mongodb_config.connection_string, mongodb_config.database_name)
+
+
+def db_from_config(config: MongoDbConfig):
+    return MongoDB(config.connection_string, config.database_name)
+
+
+class MongoDB(DB):
+    def __init__(self, connection_string: str, database_name: str):
+        super().__init__()
+        self.connection_string = connection_string
+        self.database_name = database_name
+        self.client: MongoClient[Any] = MongoClient(connection_string)
+        self.db: Database[Any] = self.client[database_name]
+        self.module_name = "mongodb_db"
+        self.db_name = "MongoDB"
+
+        # Collection references
+        self.site_content: Collection[Any] = self.db.site_content
+        self.posts: Collection[Any] = self.db.posts
+        self.pages: Collection[Any] = self.db.pages
+        self.menu_items: Collection[Any] = self.db.menu_items
+        self.plugins: Collection[Any] = self.db.plugins
+
+    def get_app_description(self, lang: str) -> str:
+        site_content = self.site_content.find_one({"_id": "config"})
+        if site_content and "app_description" in site_content:
+            return site_content["app_description"].get(lang, "")
+        return ""
+
+    def get_all_posts(self, lang: str) -> list[Post]:
+        posts_cursor = self.posts.find({"language": lang})
+        return [Post.model_validate(post) for post in posts_cursor]
+
+    def get_menu_items_in_lang(self, lang: str) -> list[MenuItem]:
+        menu_items_doc = self.menu_items.find_one({"_id": lang})
+        if menu_items_doc and "items" in menu_items_doc:
+            return [MenuItem.model_validate(item) for item in menu_items_doc["items"]]
+        return []
+
+    def get_post(self, slug: str) -> Post:
+        post_doc = self.posts.find_one({"slug": slug})
+        if post_doc is None:
+            raise ValueError(f"Post with slug {slug} not found")
+        return Post.model_validate(post_doc)
+
+    def get_page(self, slug: str) -> Page:
+        page_doc = self.pages.find_one({"slug": slug})
+        if page_doc is None:
+            raise ValueError(f"Page with slug {slug} not found")
+        return Page.model_validate(page_doc)
+
+    def get_posts_by_tag(self, tag: str, lang: str) -> Any:
+        posts_cursor = self.posts.find({"tags": tag, "language": lang})
+        return posts_cursor
+
+    def add_comment(self, author_name: str, comment: str, post_slug: str) -> None:
+        now_utc = datetime.datetime.now(datetime.timezone.utc).isoformat(timespec="seconds")
+        comment_doc = {
+            "author": str(author_name),
+            "comment": str(comment),
+            "date": now_utc,
+        }
+
+        result = self.posts.update_one({"slug": post_slug}, {"$push": {"comments": comment_doc}})
+        if result.matched_count == 0:
+            raise ValueError(f"Post with slug {post_slug} not found")
+
+    def get_logo_url(self) -> str:
+        site_content = self.site_content.find_one({"_id": "config"})
+        if site_content:
+            return site_content.get("logo_url", "")
+        return ""
+
+    def get_favicon_url(self) -> str:
+        site_content = self.site_content.find_one({"_id": "config"})
+        if site_content:
+            return site_content.get("favicon_url", "")
+        return ""
+
+    def get_primary_color(self) -> str:
+        site_content = self.site_content.find_one({"_id": "config"})
+        if site_content:
+            return site_content.get("primary_color", "white")
+        return "white"
+
+    def get_secondary_color(self) -> str:
+        site_content = self.site_content.find_one({"_id": "config"})
+        if site_content:
+            return site_content.get("secondary_color", "navy")
+        return "navy"
+
+    def get_plugins_data(self) -> list[Any]:
+        plugins_doc = self.plugins.find_one({"_id": "config"})
+        if plugins_doc and "data" in plugins_doc:
+            return plugins_doc["data"]
+        return []
+
+    def get_font(self) -> str:
+        site_content = self.site_content.find_one({"_id": "config"})
+        if site_content:
+            return site_content.get("font", "")
+        return ""
+
+    def health_check(self) -> None:
+        """Perform a health check on the MongoDB database.
+
+        Raises an exception if the database is not accessible.
+        """
+        # Simple ping to check if database is accessible
+        self.client.admin.command("ping")
+
+    def _close_connection(self) -> None:
+        """Close the MongoDB connection"""
+        if self.client:
+            self.client.close()
+
+    def __del__(self):
+        """Ensure connection is closed when object is destroyed"""
+        self._close_connection()

platzky/engine.py

@@ -1,7 +1,8 @@
 import os
-from typing import List
+from concurrent.futures import ThreadPoolExecutor, TimeoutError
+from typing import Any, Callable, Dict, List, Tuple
 
-from flask import Flask, request, session
+from flask import Blueprint, Flask, jsonify, make_response, request, session
 from flask_babel import Babel
 
 from platzky.config import Config
@@ -17,6 +18,7 @@ class Engine(Flask):
         self.login_methods = []
         self.dynamic_body = ""
         self.dynamic_head = ""
+        self.health_checks: List[Tuple[str, Callable[[], None]]] = []
         directory = os.path.dirname(os.path.realpath(__file__))
         locale_dir = os.path.join(directory, "locale")
         config.translation_directories.append(locale_dir)
@@ -26,6 +28,7 @@ class Engine(Flask):
             locale_selector=self.get_locale,
             default_translation_directories=babel_translation_directories,
         )
+        self._register_default_health_endpoints()
 
         self.cms_modules: List[CmsModule] = []
         # TODO add plugins as CMS Module - all plugins should be visible from
@@ -69,3 +72,69 @@ class Engine(Flask):
 
         session["language"] = lang
         return lang
+
+    def add_health_check(self, name: str, check_function: Callable[[], None]) -> None:
+        """Register a health check function"""
+        if not callable(check_function):
+            raise TypeError(f"check_function must be callable, got {type(check_function)}")
+        self.health_checks.append((name, check_function))
+
+    def _register_default_health_endpoints(self):
+        """Register default health endpoints"""
+
+        health_bp = Blueprint("health", __name__)
+        HEALTH_CHECK_TIMEOUT = 10  # seconds
+
+        @health_bp.route("/health/liveness")
+        def liveness():
+            """Simple liveness check - is the app running?"""
+            return jsonify({"status": "alive"}), 200
+
+        @health_bp.route("/health/readiness")
+        def readiness():
+            """Readiness check - can the app serve traffic?"""
+            health_status: Dict[str, Any] = {"status": "ready", "checks": {}}
+            status_code = 200
+
+            executor = ThreadPoolExecutor(max_workers=1)
+            try:
+                # Database health check with timeout
+                future = executor.submit(self.db.health_check)
+                try:
+                    future.result(timeout=HEALTH_CHECK_TIMEOUT)
+                    health_status["checks"]["database"] = "ok"
+                except TimeoutError:
+                    health_status["checks"]["database"] = "failed: timeout"
+                    health_status["status"] = "not_ready"
+                    status_code = 503
+                except Exception as e:
+                    health_status["checks"]["database"] = f"failed: {e!s}"
+                    health_status["status"] = "not_ready"
+                    status_code = 503
+
+                # Run application-registered health checks
+                for check_name, check_func in self.health_checks:
+                    future = executor.submit(check_func)
+                    try:
+                        future.result(timeout=HEALTH_CHECK_TIMEOUT)
+                        health_status["checks"][check_name] = "ok"
+                    except TimeoutError:
+                        health_status["checks"][check_name] = "failed: timeout"
+                        health_status["status"] = "not_ready"
+                        status_code = 503
+                    except Exception as e:
+                        health_status["checks"][check_name] = f"failed: {e!s}"
+                        health_status["status"] = "not_ready"
+                        status_code = 503
+            finally:
+                # Shutdown without waiting if any futures are still running
+                executor.shutdown(wait=False)
+
+            return make_response(jsonify(health_status), status_code)
+
+        # Simple /health alias for liveness
+        @health_bp.route("/health")
+        def health():
+            return liveness()
+
+        self.register_blueprint(health_bp)

{platzky-0.3.6.dist-info → platzky-0.4.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: platzky
-Version: 0.3.6
+Version: 0.4.3
 Summary: Not only blog engine
 License: MIT
 Requires-Python: >=3.10,<4.0
@@ -10,6 +10,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Requires-Dist: Flask (==3.0.3)
 Requires-Dist: Flask-Babel (>=4.0.0,<5.0.0)
 Requires-Dist: Flask-Minify (>=0.42,<0.43)
@@ -22,6 +23,7 @@ Requires-Dist: gql (>=3.4.0,<4.0.0)
 Requires-Dist: humanize (>=4.9.0,<5.0.0)
 Requires-Dist: pydantic (>=2.7.1,<3.0.0)
 Requires-Dist: pygithub (>=2.6.1,<3.0.0)
+Requires-Dist: pymongo (>=4.7.0,<5.0.0)
 Description-Content-Type: text/markdown
 
 ![Github Actions](https://github.com/platzky/platzky/actions/workflows/tests.yml/badge.svg?event=push&branch=main)

{platzky-0.3.6.dist-info → platzky-0.4.3.dist-info}/RECORD

@@ -10,14 +10,15 @@ platzky/blog/comment_form.py,sha256=4lkNJ_S_2DZmJBbz-NPDqahvy2Zz5AGNH2spFeGIop4,
 platzky/config.py,sha256=M3gmZI9yI-ThgmTA4RKsAPcnJwJjcWhXipYzq3hO-Hk,2346
 platzky/db/README.md,sha256=IO-LoDsd4dLBZenaz423EZjvEOQu_8m2OC0G7du170w,1753
 platzky/db/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-platzky/db/db.py,sha256=o3jXcA97MwOepJhxtmXpyfDATRcMcJmX6O1Bro5-Rkw,2796
+platzky/db/db.py,sha256=0h5rGCBO_N1wBqJRl5EoiW_bFDpNIvmNwuA0hJi89jw,3060
 platzky/db/db_loader.py,sha256=CuEiXxhIa4bFMm0vi7ugzm7j3WycilGRKCU6smgIImE,905
 platzky/db/github_json_db.py,sha256=G1GBIomeKOCeG05pA4qccaFntiGzkgyEMQJz_FQlvNY,2185
 platzky/db/google_json_db.py,sha256=rS__UEK7ed71htTg066_vzpg0etTlpke6YkcrAQ3Fgk,1325
-platzky/db/graph_ql_db.py,sha256=aGE1glBmLmx4mE1aysGe6sl0lP2uG89LUnu2hmkdvqk,8528
-platzky/db/json_db.py,sha256=-k6NcMBK99SwJObK7UA15hqVSvElrvYR1Vl7G9p0re4,3772
+platzky/db/graph_ql_db.py,sha256=af6yy1R27YO8N9zJWU7VgU7optRgpdk_1ZUtab_1eT4,8967
+platzky/db/json_db.py,sha256=NUBPy4jt-y37TYq4SCGaSgief3MbBWL_Efw8Bxp8Jo0,4046
 platzky/db/json_file_db.py,sha256=tPo92n5zG7vGpunn5vl66zISHBziQdxBttitvc5hPug,1030
-platzky/engine.py,sha256=BrZNm2ooO0e1hp41vaABbxLWPN_WfYglTYEM5v2NkTk,2272
+platzky/db/mongodb_db.py,sha256=28KO8XmTEiqE7FcNBzw_pfxOy6Vo-T7qsHdUlh59QX0,5174
+platzky/engine.py,sha256=Kv242PsB8lVz_FCYdGogd8o5zGmn5Msev3B3lfYRUXA,5411
 platzky/locale/en/LC_MESSAGES/messages.po,sha256=WaZGlFAegKRq7CSz69dWKic-mKvQFhVvssvExxNmGaU,1400
 platzky/locale/pl/LC_MESSAGES/messages.po,sha256=sUPxMKDeEOoZ5UIg94rGxZD06YVWiAMWIby2XE51Hrc,1624
 platzky/models.py,sha256=DZZgKW2Q3fY2GMdikFUmAgpsRqT5VKAOwP6RmEsmO2M,1871
@@ -39,6 +40,6 @@ platzky/templates/post.html,sha256=GSgjIZsOQKtNx3cEbquSjZ5L4whPnG6MzRyoq9k4B8Q,1
 platzky/templates/robots.txt,sha256=2_j2tiYtYJnzZUrANiX9pvBxyw5Dp27fR_co18BPEJ0,116
 platzky/templates/sitemap.xml,sha256=iIJZ91_B5ZuNLCHsRtsGKZlBAXojOTP8kffqKLacgvs,578
 platzky/www_handler.py,sha256=pF6Rmvem1sdVqHD7z3RLrDuG-CwAqfGCti50_NPsB2w,725
-platzky-0.3.6.dist-info/METADATA,sha256=pky9jOUlo1VBEYzyC1L4Fd6GZRsnKXUdb0d5mxlLwtM,1727
-platzky-0.3.6.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-platzky-0.3.6.dist-info/RECORD,,
+platzky-0.4.3.dist-info/METADATA,sha256=RMfCt6cM7vEEWaS_lmahJZ9kNyy53c41_gmu064X6tU,1818
+platzky-0.4.3.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+platzky-0.4.3.dist-info/RECORD,,

{platzky-0.3.6.dist-info → platzky-0.4.3.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 2.1.3
+Generator: poetry-core 2.2.1
 Root-Is-Purelib: true
 Tag: py3-none-any