goodmap 1.1.0__tar.gz → 1.1.2__tar.gz

{goodmap-1.1.0 → goodmap-1.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: goodmap
-Version: 1.1.0
+Version: 1.1.2
 Summary: Map engine to serve all the people :)
 License-File: LICENSE.md
 Author: Krzysztof Kolodzinski
@@ -12,6 +12,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
+Provides-Extra: docs
 Requires-Dist: Babel (>=2.10.3,<3.0.0)
 Requires-Dist: Flask (==3.0.3)
 Requires-Dist: Flask-Babel (>=4.0.0,<5.0.0)
@@ -24,8 +25,12 @@ Requires-Dist: google-cloud-storage (>=2.7.0,<3.0.0)
 Requires-Dist: gql (>=3.4.0,<4.0.0)
 Requires-Dist: gunicorn (>=20.1.0,<21.0.0)
 Requires-Dist: humanize (>=4.6.0,<5.0.0)
+Requires-Dist: myst-parser (>=4.0.0,<5.0.0) ; extra == "docs"
 Requires-Dist: platzky (>=1.0.0,<2.0.0)
 Requires-Dist: pydantic (>=2.7.1,<3.0.0)
+Requires-Dist: sphinx (>=8.0.0,<9.0.0) ; extra == "docs"
+Requires-Dist: sphinx-rtd-theme (>=3.0.0,<4.0.0) ; extra == "docs"
+Requires-Dist: tomli (>=2.0.0,<3.0.0) ; extra == "docs"
 Description-Content-Type: text/markdown
 
 ![Github Actions](https://github.com/problematy/goodmap/actions/workflows/release.yml/badge.svg?event=push&branch=main)

{goodmap-1.1.0 → goodmap-1.1.2}/goodmap/core_api.py

@@ -117,13 +117,8 @@ def core_pages(
             Shows a single location with all data
             """
             location = database.get_location(location_id)
-
-            # TODO getting visible_data and meta_data should be taken from db methods
-            #    e.g. db.get_visible_data() and db.get_meta_data()
-            #    visible_data and meta_data should be models
-            all_data = database.get_data()
-            visible_data = all_data["visible_data"]
-            meta_data = all_data["meta_data"]
+            visible_data = database.get_visible_data()
+            meta_data = database.get_meta_data()
 
             formatted_data = prepare_pin(location.model_dump(), visible_data, meta_data)
             return jsonify(formatted_data)

{goodmap-1.1.0 → goodmap-1.1.2}/goodmap/db.py

@@ -2,6 +2,7 @@ import json
 import os
 import tempfile
 from functools import partial
+from typing import Any
 
 from goodmap.core import get_queried_data
 from goodmap.data_models.location import LocationBase
@@ -387,6 +388,142 @@ def get_data(db):
     return globals()[f"{db.module_name}_get_data"]
 
 
+# ------------------------------------------------
+# get_visible_data
+
+
+def google_json_db_get_visible_data(self) -> dict[str, Any]:
+    """
+    Retrieve visible data configuration from Google Cloud Storage JSON blob.
+
+    Returns:
+        dict: Dictionary containing field visibility configuration.
+              Returns empty dict if not found.
+    """
+    return self.data.get("map", {}).get("visible_data", {})
+
+
+def json_file_db_get_visible_data(self) -> dict[str, Any]:
+    """
+    Retrieve visible data configuration from JSON file database.
+
+    Returns:
+        dict: Dictionary containing field visibility configuration.
+              Returns empty dict if not found.
+    """
+    return self.data.get("map", {}).get("visible_data", {})
+
+
+def json_db_get_visible_data(self) -> dict[str, Any]:
+    """
+    Retrieve visible data configuration from in-memory JSON database.
+
+    Returns:
+        dict: Dictionary containing field visibility configuration.
+              Returns empty dict if not found.
+    """
+    return self.data.get("visible_data", {})
+
+
+def mongodb_db_get_visible_data(self) -> dict[str, Any]:
+    """
+    Retrieve visible data configuration from MongoDB.
+
+    Returns:
+        dict: Dictionary containing field visibility configuration.
+              Returns empty dict if config document not found or field missing.
+
+    Raises:
+        pymongo.errors.ConnectionFailure: If database connection fails.
+        pymongo.errors.OperationFailure: If database operation fails.
+    """
+    config_doc = self.db.config.find_one({"_id": "map_config"})
+    if config_doc:
+        return config_doc.get("visible_data", {})
+    return {}
+
+
+def get_visible_data(db):
+    """
+    Get the appropriate get_visible_data function for the given database backend.
+
+    Args:
+        db: Database instance (must have module_name attribute).
+
+    Returns:
+        callable: Backend-specific get_visible_data function.
+    """
+    return globals()[f"{db.module_name}_get_visible_data"]
+
+
+# ------------------------------------------------
+# get_meta_data
+
+
+def google_json_db_get_meta_data(self) -> dict[str, Any]:
+    """
+    Retrieve metadata configuration from Google Cloud Storage JSON blob.
+
+    Returns:
+        dict: Dictionary containing metadata configuration.
+              Returns empty dict if not found.
+    """
+    return self.data.get("map", {}).get("meta_data", {})
+
+
+def json_file_db_get_meta_data(self) -> dict[str, Any]:
+    """
+    Retrieve metadata configuration from JSON file database.
+
+    Returns:
+        dict: Dictionary containing metadata configuration.
+              Returns empty dict if not found.
+    """
+    return self.data.get("map", {}).get("meta_data", {})
+
+
+def json_db_get_meta_data(self) -> dict[str, Any]:
+    """
+    Retrieve metadata configuration from in-memory JSON database.
+
+    Returns:
+        dict: Dictionary containing metadata configuration.
+              Returns empty dict if not found.
+    """
+    return self.data.get("meta_data", {})
+
+
+def mongodb_db_get_meta_data(self) -> dict[str, Any]:
+    """
+    Retrieve metadata configuration from MongoDB.
+
+    Returns:
+        dict: Dictionary containing metadata configuration.
+              Returns empty dict if config document not found or field missing.
+
+    Raises:
+        pymongo.errors.ConnectionFailure: If database connection fails.
+        pymongo.errors.OperationFailure: If database operation fails.
+    """
+    config_doc = self.db.config.find_one({"_id": "map_config"})
+    if config_doc:
+        return config_doc.get("meta_data", {})
+    return {}
+
+
+def get_meta_data(db):
+    """
+    Get the appropriate get_meta_data function for the given database backend.
+
+    Args:
+        db: Database instance (must have module_name attribute).
+
+    Returns:
+        callable: Backend-specific get_meta_data function.
+    """
+    return globals()[f"{db.module_name}_get_meta_data"]
+
+
 # ------------------------------------------------
 # get_categories
 
@@ -786,6 +923,12 @@ def mongodb_db_add_suggestion(self, suggestion_data):
     CRUDHelper.add_item_to_mongodb(self.db.suggestions, suggestion_data, "Suggestion", "pending")
 
 
+def google_json_db_add_suggestion(self, suggestion_data):
+    # Temporary workaround: just use notifier without storing
+    # Full implementation would require writing back to Google Cloud Storage
+    pass
+
+
 def add_suggestion(db, suggestion_data):
     return globals()[f"{db.module_name}_add_suggestion"](db, suggestion_data)
 
@@ -876,6 +1019,16 @@ def mongodb_db_get_suggestions_paginated(self, query):
     return __build_pagination_response(items, total_count, page, per_page)
 
 
+def google_json_db_get_suggestions(self, query_params):
+    # GoogleJsonDb is read-only, suggestions not stored in blob
+    return []
+
+
+def google_json_db_get_suggestions_paginated(self, query):
+    """Google JSON suggestions with pagination (read-only)."""
+    return PaginationHelper.create_paginated_response([], query)
+
+
 def get_suggestions(db):
     return globals()[f"{db.module_name}_get_suggestions"]
 
@@ -906,6 +1059,11 @@ def mongodb_db_get_suggestion(self, suggestion_id):
     return self.db.suggestions.find_one({"uuid": suggestion_id}, {"_id": 0})
 
 
+def google_json_db_get_suggestion(self, suggestion_id):
+    # GoogleJsonDb is read-only, suggestions not stored in blob
+    return None
+
+
 def get_suggestion(db):
     return globals()[f"{db.module_name}_get_suggestion"]
 
@@ -946,6 +1104,11 @@ def mongodb_db_update_suggestion(self, suggestion_id, status):
         raise ValueError(f"Suggestion with uuid {suggestion_id} not found")
 
 
+def google_json_db_update_suggestion(self, suggestion_id, status):
+    # GoogleJsonDb is read-only, no-op
+    pass
+
+
 def update_suggestion(db, suggestion_id, status):
     return globals()[f"{db.module_name}_update_suggestion"](db, suggestion_id, status)
 
@@ -984,6 +1147,11 @@ def mongodb_db_delete_suggestion(self, suggestion_id):
         raise ValueError(f"Suggestion with uuid {suggestion_id} not found")
 
 
+def google_json_db_delete_suggestion(self, suggestion_id):
+    # GoogleJsonDb is read-only, no-op
+    pass
+
+
 def delete_suggestion(db, suggestion_id):
     return globals()[f"{db.module_name}_delete_suggestion"](db, suggestion_id)
 
@@ -1022,6 +1190,12 @@ def mongodb_db_add_report(self, report_data):
     self.db.reports.insert_one(report_data)
 
 
+def google_json_db_add_report(self, report_data):
+    # Temporary workaround: just use notifier without storing
+    # Full implementation would require writing back to Google Cloud Storage
+    pass
+
+
 def add_report(db, report_data):
     return globals()[f"{db.module_name}_add_report"](db, report_data)
 
@@ -1128,6 +1302,16 @@ def mongodb_db_get_reports_paginated(self, query):
     return __build_pagination_response(items, total_count, page, per_page)
 
 
+def google_json_db_get_reports(self, query_params):
+    # GoogleJsonDb is read-only, reports not stored in blob
+    return []
+
+
+def google_json_db_get_reports_paginated(self, query):
+    """Google JSON reports with pagination (read-only)."""
+    return PaginationHelper.create_paginated_response([], query)
+
+
 def get_reports(db):
     return globals()[f"{db.module_name}_get_reports"]
 
@@ -1157,6 +1341,11 @@ def mongodb_db_get_report(self, report_id):
     return self.db.reports.find_one({"uuid": report_id}, {"_id": 0})
 
 
+def google_json_db_get_report(self, report_id):
+    # GoogleJsonDb is read-only, reports not stored in blob
+    return None
+
+
 def get_report(db):
     return globals()[f"{db.module_name}_get_report"]
 
@@ -1210,6 +1399,11 @@ def mongodb_db_update_report(self, report_id, status=None, priority=None):
             raise ValueError(f"Report with uuid {report_id} not found")
 
 
+def google_json_db_update_report(self, report_id, status=None, priority=None):
+    # GoogleJsonDb is read-only, no-op
+    pass
+
+
 def update_report(db, report_id, status=None, priority=None):
     return globals()[f"{db.module_name}_update_report"](db, report_id, status, priority)
 
@@ -1247,6 +1441,11 @@ def mongodb_db_delete_report(self, report_id):
         raise ValueError(f"Report with uuid {report_id} not found")
 
 
+def google_json_db_delete_report(self, report_id):
+    # GoogleJsonDb is read-only, no-op
+    pass
+
+
 def delete_report(db, report_id):
     return globals()[f"{db.module_name}_delete_report"](db, report_id)
 
@@ -1258,6 +1457,8 @@ def delete_report(db, report_id):
 
 def extend_db_with_goodmap_queries(db, location_model):
     db.extend("get_data", get_data(db))
+    db.extend("get_visible_data", get_visible_data(db))
+    db.extend("get_meta_data", get_meta_data(db))
     db.extend("get_locations", get_locations(db, location_model))
     db.extend("get_locations_paginated", get_locations_paginated(db, location_model))
     db.extend("get_location", get_location(db, location_model))
@@ -1266,17 +1467,16 @@ def extend_db_with_goodmap_queries(db, location_model):
     db.extend("delete_location", delete_location)
     db.extend("get_categories", get_categories(db))
     db.extend("get_category_data", get_category_data(db))
-    if db.module_name in ("json_db", "json_file_db", "mongodb_db"):
-        db.extend("add_suggestion", add_suggestion)
-        db.extend("get_suggestions", get_suggestions(db))
-        db.extend("get_suggestions_paginated", get_suggestions_paginated(db))
-        db.extend("get_suggestion", get_suggestion(db))
-        db.extend("update_suggestion", update_suggestion)
-        db.extend("delete_suggestion", delete_suggestion)
-        db.extend("add_report", add_report)
-        db.extend("get_reports", get_reports(db))
-        db.extend("get_reports_paginated", get_reports_paginated(db))
-        db.extend("get_report", get_report(db))
-        db.extend("update_report", update_report)
-        db.extend("delete_report", delete_report)
+    db.extend("add_suggestion", add_suggestion)
+    db.extend("get_suggestions", get_suggestions(db))
+    db.extend("get_suggestions_paginated", get_suggestions_paginated(db))
+    db.extend("get_suggestion", get_suggestion(db))
+    db.extend("update_suggestion", update_suggestion)
+    db.extend("delete_suggestion", delete_suggestion)
+    db.extend("add_report", add_report)
+    db.extend("get_reports", get_reports(db))
+    db.extend("get_reports_paginated", get_reports_paginated(db))
+    db.extend("get_report", get_report(db))
+    db.extend("update_report", update_report)
+    db.extend("delete_report", delete_report)
     return db

{goodmap-1.1.0 → goodmap-1.1.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "goodmap"
-version = "1.1.0"
+version = "1.1.2"
 description = "Map engine to serve all the people :)"
 authors = ["Krzysztof Kolodzinski <krzysztof.kolodzinski@problematy.pl>"]
 readme = "README.md"
@@ -22,6 +22,18 @@ aiohttp = "^3.8.4"
 pydantic = "^2.7.1"
 platzky = "^1.0.0"
 deprecation = "^2.1.0"
+sphinx = {version = "^8.0.0", optional = true}
+sphinx-rtd-theme = {version = "^3.0.0", optional = true}
+tomli = {version = "^2.0.0", optional = true}
+myst-parser = {version = "^4.0.0", optional = true}
+
+[tool.poetry.extras]
+docs = [
+    "sphinx",
+    "sphinx-rtd-theme",
+    "myst-parser",
+    "tomli"
+]
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^7.1.2"
@@ -33,6 +45,7 @@ black = "^24.8.0"
 ruff = "^0.4.4"
 platzky-redirections = "^0.1.0"
 python-semantic-release = "^10.4.1"
+interrogate = "^1.7.0"
 
 [tool.poetry.group.local.dependencies]
 platzky = {path = "vendor/platzky", develop = true}
@@ -103,4 +116,13 @@ prerelease = false
 
 [tool.semantic_release.publish]
 dist_glob_patterns = ["dist/*"]
-upload_to_vcs_release = true
+upload_to_vcs_release = true
+
+[tool.interrogate]
+fail-under = 24
+ignore-init-method = true
+ignore-init-module = true
+ignore-magic = true
+ignore-private = true
+ignore-semiprivate = false
+exclude = ["tests", "docs"]