goodmap 1.1.1__py3-none-any.whl → 1.1.3__py3-none-any.whl

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/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
@@ -332,7 +333,7 @@ def json_file_db_get_location_obligatory_fields(db):
 
 
 def google_json_db_get_location_obligatory_fields(db):
-    return json.loads(db.blob.download_as_text(client=None))["map"]["location_obligatory_fields"]
+    return db.data.get("map", {}).get("location_obligatory_fields", [])
 
 
 def mongodb_db_get_location_obligatory_fields(db):
@@ -351,7 +352,7 @@ def get_location_obligatory_fields(db):
 
 
 def google_json_db_get_data(self):
-    return json.loads(self.blob.download_as_text(client=None))["map"]
+    return self.data.get("map", {})
 
 
 def json_file_db_get_data(self):
@@ -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
 
@@ -401,7 +538,7 @@ def json_file_db_get_categories(self):
 
 
 def google_json_db_get_categories(self):
-    return json.loads(self.blob.download_as_text(client=None))["map"]["categories"].keys()
+    return self.data.get("map", {}).get("categories", {}).keys()
 
 
 def mongodb_db_get_categories(self):
@@ -454,17 +591,17 @@ def json_file_db_get_category_data(self, category_type=None):
 
 
 def google_json_db_get_category_data(self, category_type=None):
-    data = json.loads(self.blob.download_as_text(client=None))["map"]
+    data = self.data.get("map", {})
     if category_type:
         return {
-            "categories": {category_type: data["categories"].get(category_type, [])},
+            "categories": {category_type: data.get("categories", {}).get(category_type, [])},
             "categories_help": data.get("categories_help", []),
             "categories_options_help": {
                 category_type: data.get("categories_options_help", {}).get(category_type, [])
             },
         }
     return {
-        "categories": data["categories"],
+        "categories": data.get("categories", {}),
         "categories_help": data.get("categories_help", []),
         "categories_options_help": data.get("categories_options_help", {}),
     }
@@ -507,9 +644,7 @@ def get_location_from_raw_data(raw_data, uuid, location_model):
 
 
 def google_json_db_get_location(self, uuid, location_model):
-    return get_location_from_raw_data(
-        json.loads(self.blob.download_as_text(client=None))["map"], uuid, location_model
-    )
+    return get_location_from_raw_data(self.data.get("map", {}), uuid, location_model)
 
 
 def json_file_db_get_location(self, uuid, location_model):
@@ -541,9 +676,7 @@ def get_locations_list_from_raw_data(map_data, query, location_model):
 
 
 def google_json_db_get_locations(self, query, location_model):
-    return get_locations_list_from_raw_data(
-        json.loads(self.blob.download_as_text(client=None))["map"], query, location_model
-    )
+    return get_locations_list_from_raw_data(self.data.get("map", {}), query, location_model)
 
 
 def json_file_db_get_locations(self, query, location_model):
@@ -573,7 +706,7 @@ def get_locations(db, location_model):
 def google_json_db_get_locations_paginated(self, query, location_model):
     """Google JSON locations with improved pagination."""
     # Get all locations from raw data
-    data = json.loads(self.blob.download_as_text(client=None))["map"]
+    data = self.data.get("map", {})
     all_locations = list(get_locations_list_from_raw_data(data, query, location_model))
     return PaginationHelper.create_paginated_response(all_locations, query)
 
@@ -1320,6 +1453,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))

{goodmap-1.1.1.dist-info → goodmap-1.1.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: goodmap
-Version: 1.1.1
+Version: 1.1.3
 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.1.dist-info → goodmap-1.1.3.dist-info}/RECORD

@@ -1,15 +1,15 @@
 goodmap/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
 goodmap/config.py,sha256=sseE4sceFB8OBuFsrRpQJvjv0Vg5KFdkzihBX_hbE2c,1313
 goodmap/core.py,sha256=rzMhOIYnR1jxTX6uHQJKIPLYxdUm4_v2d6LrtHtJpHU,1465
-goodmap/core_api.py,sha256=MxJ7SGOFBBnV_cBIiZoImHLaY8_FtEW-dl3od5-mIt8,13529
+goodmap/core_api.py,sha256=RVG4X64BSXTIzmj9mPK1DcT9p6xD00NnmX8FUaoj-uE,13277
 goodmap/data_models/location.py,sha256=H3EKozc-WZvrYm6cwajl8_gaw4rQhxdlvxR1mk4mpkA,1104
 goodmap/data_validator.py,sha256=lBmVAPxvSmEOdUGeVYSjUvVVmKfPyq4CWoHfczTtEMM,4090
-goodmap/db.py,sha256=UKWrd0b0zvz8T-bjnclXXLAtW-1fcxv8Rd6z_Dqmpvg,43695
+goodmap/db.py,sha256=2yZIQO6KbN6y21gxwO0xmxXIcXXrk7wqd7mgSOAefJw,47491
 goodmap/formatter.py,sha256=VlUHcK1HtM_IEU0VE3S5TOkZLVheMdakvUeW2tCKdq0,783
 goodmap/goodmap.py,sha256=q6okPopWBH6jDkKJcGDegebaapHLFUVilJ3p3aKi97k,2960
 goodmap/templates/goodmap-admin.html,sha256=39PJ1drk_xdkyzXgPZZNXYq9gA9oTVeR8hsgeae6E0g,35614
 goodmap/templates/map.html,sha256=N4N0ONzEFUS4bFtOA2jgXVbMQ7cKd1cRYIVnGLUzBIE,3995
-goodmap-1.1.1.dist-info/METADATA,sha256=GHTcCxF_L_qMoEoFI6Re3DAyriNrKA9Y6Hau-8vji7Y,5356
-goodmap-1.1.1.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
-goodmap-1.1.1.dist-info/licenses/LICENSE.md,sha256=nkCQOR7uheLRvHRfXmwx9LhBnMcPeBU9d4ebLojDiQU,1067
-goodmap-1.1.1.dist-info/RECORD,,
+goodmap-1.1.3.dist-info/METADATA,sha256=CstkaPb9MW6r9Pj03bVWuCfEmW-juFPr9UGe30l3Fyo,5619
+goodmap-1.1.3.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+goodmap-1.1.3.dist-info/licenses/LICENSE.md,sha256=nkCQOR7uheLRvHRfXmwx9LhBnMcPeBU9d4ebLojDiQU,1067
+goodmap-1.1.3.dist-info/RECORD,,