permission_model

.github/workflows/CD_production.yml

@@ -40,11 +40,6 @@ jobs:
             echo "runtime: python313" >> app.yaml
             echo "entrypoint: gunicorn -w 4 -k uvicorn.workers.UvicornWorker main:app" >> app.yaml
             echo "instance_class: F4" >> app.yaml
-            echo "inbound_services:" >> app.yaml
-            echo "  - warmup" >> app.yaml
-            echo "automatic_scaling:" >> app.yaml
-            echo "  min_instances: 0" >> app.yaml
-            echo "  max_instances: 10" >> app.yaml
             echo "" >> app.yaml
             echo "env_variables:" >> app.yaml
             echo "  MODE: \"production\"" >> app.yaml

.github/workflows/CD_staging.yml

@@ -40,11 +40,6 @@ jobs:
             echo "runtime: python313" >> app.yaml
             echo "entrypoint: gunicorn -w 4 -k uvicorn.workers.UvicornWorker main:app" >> app.yaml
             echo "instance_class: F4" >> app.yaml
-            echo "inbound_services:" >> app.yaml
-            echo "  - warmup" >> app.yaml
-            echo "automatic_scaling:" >> app.yaml
-            echo "  min_instances: 0" >> app.yaml
-            echo "  max_instances: 10" >> app.yaml
             echo "" >> app.yaml
             echo "env_variables:" >> app.yaml
             echo "  MODE: \"production\"" >> app.yaml

.github/workflows/tests.yml

@@ -5,7 +5,7 @@ name: Tests
 
 on:
   pull_request:
-    branches: [ "main",'pre-production', 'transfer']
+    branches: ['production', 'staging', 'transfer']
 
 permissions:
   contents: read

api/geospatial.py

@@ -14,7 +14,7 @@
 # limitations under the License.
 # ===============================================================================
 import json
-from typing import Annotated, List, Union
+from typing import Annotated, List
 
 from fastapi import APIRouter, Query, HTTPException
 from fastapi.responses import FileResponse
@@ -100,7 +100,9 @@ def get_feature_collection(
 
     things = get_thing_features(session, thing_type, group)
 
-    def make_feature_dict(thing, geometry, *other):
+    def make_feature_dict(thing, geometry, elevation, *other):
+        geometry = json.loads(geometry)
+        geometry["coordinates"].append(elevation)
         return {
             "type": "Feature",
             "properties": {
@@ -109,7 +111,7 @@ def make_feature_dict(thing, geometry, *other):
                 "name": thing.name,
                 "group": group,
             },
-            "geometry": json.loads(geometry),
+            "geometry": geometry,
         }
 
     features = [make_feature_dict(*item) for item in things]

api/location.py

@@ -30,6 +30,7 @@
 from services.geospatial_helper import make_within_wkt
 from services.query_helper import make_query, order_sort_filter, simple_get_by_id
 from services.crud_helper import model_patcher, model_deleter, model_adder
+from services.location_helper import set_geographic_attributes
 
 from fastapi import APIRouter
 
@@ -48,7 +49,9 @@ async def create_location(
     """
     Create a new sample location in the database.
     """
-    return model_adder(session, Location, location_data, user=user)
+    location = model_adder(session, Location, location_data, user=user)
+    set_geographic_attributes(session, location_data, location)
+    return location
 
 
 @router.patch(
@@ -64,7 +67,9 @@ async def update_location(
     """
     Update a sample location in the database.
     """
-    return model_patcher(session, Location, location_id, location_data, user=user)
+    location = model_patcher(session, Location, location_id, location_data, user=user)
+    set_geographic_attributes(session, location_data, location)
+    return location
 
 
 # @router.get("/shapefile", summary="Get location as shapefile")

constants.py

@@ -15,4 +15,5 @@
 # ===============================================================================
 
 SRID_WGS84 = 4326
+SRID_UTM_ZONE_13N = 26913
 # ============= EOF =============================================

db/base.py

@@ -13,18 +13,45 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 # ===============================================================================
+"""
+db/base.py
+
+This file defines the foundational components for the SQLAlchemy models.
+It includes:
+1.  The declarative base class (`Base`) that all models will inherit from.
+2.  A helper function (`lexicon_term`) to create standardized foreign key columns
+    referencing the `lexicon_term` table.
+3. A helper function (`pascal_to_snake`) to convert class names from PascalCase to snake_case
+    for automatic table naming.
+4. Mixins for common functionality:
+    - `AutoBaseMixin`: Adds automatic table naming and an auto-incrementing primary key.
+    - `PropertiesMixin`: Adds a JSONB properties column for storing additional attributes.
+    - `ReleaseMixin`: Adds a release status column referencing the `lexicon_term` table.
+    - `AuditMixin`: Adds standard audit columns (created_at, created_by, updated_at, updated_by).
+5.  A simple `User` model for tracking user information in audit columns.
+6.  Polymorphic helper mixins (`StatusHistoryMixin`, `NotesMixin`, `AttributionMixin`, `PermissionMixin`.)
+    which provide a clean, reusable way to add relationships to the polymorphic
+    metadata tables. Any model that can have a status history (like Thing or Location)
+    can simply inherit from the `StatusHistoryMixin` mixin.
+7.  An `AuditMixin` to add standard audit columns to tables.
+"""
+
 from sqlalchemy import (
     Column,
     DateTime,
     func,
     Integer,
     JSON,
     String,
-    Boolean,
-    Text,
     ForeignKey,
 )
-from sqlalchemy.orm import DeclarativeBase, declared_attr, Mapped, mapped_column
+from sqlalchemy.orm import (
+    DeclarativeBase,
+    declared_attr,
+    Mapped,
+    mapped_column,
+    relationship,
+)
 from sqlalchemy_searchable import make_searchable
 from sqlalchemy_continuum import make_versioned
 import re
@@ -41,6 +68,12 @@ class Base(DeclarativeBase):
 
 
 def lexicon_term(foreignkeykw=None, **kw):
+    """Create a SQLAlchemy mapped column for a self-referencing lexicon term.
+
+    This helper function simplifies the creation of a string column that also
+    acts as a foreign key to the 'term' column of the 'lexicon_term' table.
+    It standardizes the column type to String(100) and sets the onupdate
+    behavior to "CASCADE"."""
 
     fkw = foreignkeykw if foreignkeykw else {}
 
@@ -55,13 +88,18 @@ def pascal_to_snake(name):
     return re.sub(r"(?<!^)(?=[A-Z])", "_", name).lower()
 
 
+# ============= Common Mixins =============================================
 class ReleaseMixin:
+    """Mixin to add release status to a model."""
+
     @declared_attr
     def release_status(self):
         return lexicon_term(default="draft")
 
 
 class AuditMixin:
+    """Mixin to add standard audit columns to a model."""
+
     @declared_attr
     def created_at(self):
         return Column(
@@ -109,6 +147,8 @@ def updated_by_id(self):
 
 
 class AutoBaseMixin(AuditMixin):
+    """Mixin to add automatic table naming and an auto-incrementing primary key."""
+
     @declared_attr
     def __tablename__(self):
         return pascal_to_snake(self.__name__)
@@ -119,6 +159,8 @@ def id(self):
 
 
 class PropertiesMixin:
+    """Mixin to add a JSONB properties column for storing additional attributes."""
+
     @declared_attr
     def properties(self):
         return Column(
@@ -129,7 +171,48 @@ def properties(self):
         )
 
 
+# ============= Polymorphic Helper Mixins =============================================
+class StatusHistoryMixin:
+    """
+    Mixin for models that can have a status history (e.g., Thing, Location).
+    It automatically creates a polymorphic One-to-Many relationship to the
+    StatusHistory table.
+    """
+
+    @declared_attr
+    def status_history(self):
+        # One-to-Many polymorphic relationship
+        return relationship(
+            "StatusHistory",
+            primaryjoin=f"and_({self.__name__}.{self.__name__.lower()}_id==StatusHistory.statusable_id, "
+            f"StatusHistory.statusable_type=='{self.__name__}')",
+            cascade="all, delete-orphan",
+            lazy="selectin",
+        )
+
+
+class PermissionMixin:
+    """
+    Mixin for models that can have permissions (e.g., Thing, Location).
+    It automatically creates a polymorphic One-to-Many relationship to the
+    Permission table.
+    """
+
+    @declared_attr
+    def permissions(self):
+        # One-to-Many polymorphic relationship
+        return relationship(
+            "Permission",
+            primaryjoin=f"and_({self.__name__}.{self.__name__.lower()}_id==Permission.permissible_id, "
+            f"Permission.permissible_type=='{self.__name__}')",
+            lazy="selectin",
+            viewonly=True,
+        )
+
+
 class User(Base):
+    """Represents a user in the system."""
+
     __tablename__ = "user"
 
     id: Mapped[int] = mapped_column(Integer, primary_key=True, nullable=False)

db/group.py

@@ -20,6 +20,7 @@
 from sqlalchemy.orm import relationship, Mapped
 from sqlalchemy.testing.schema import mapped_column
 
+from constants import SRID_WGS84
 from db.base import Base, AutoBaseMixin, ReleaseMixin
 
 
@@ -28,7 +29,7 @@ class Group(Base, AutoBaseMixin, ReleaseMixin):
     description: Mapped[str] = mapped_column(String(255), nullable=True)
     name: Mapped[str] = mapped_column(String(100), nullable=False, unique=True)
     project_area: Mapped[Optional[WKBElement]] = mapped_column(
-        Geometry(geometry_type="MULTIPOLYGON", srid=4326, spatial_index=True)
+        Geometry(geometry_type="MULTIPOLYGON", srid=SRID_WGS84, spatial_index=True)
     )
 
     # Foreign Keys

db/location.py

@@ -21,8 +21,6 @@
 from uuid import UUID
 
 from sqlalchemy import (
-    Column,
-    Integer,
     String,
     ForeignKey,
     DateTime,
@@ -32,6 +30,7 @@
 from sqlalchemy.orm import relationship, Mapped, mapped_column
 from sqlalchemy.ext.associationproxy import association_proxy, AssociationProxy
 
+from constants import SRID_WGS84
 from db.base import Base, AutoBaseMixin, ReleaseMixin
 from db.lexicon import lexicon_term
 
@@ -43,9 +42,12 @@ class Location(Base, AutoBaseMixin, ReleaseMixin):
         String(36), nullable=True, unique=True
     )
     description: Mapped[str] = mapped_column
-    name: Mapped[str] = mapped_column(String(255), nullable=True)
+    # name: Mapped[str] = mapped_column(String(255), nullable=True)
     point: Mapped[WKBElement] = mapped_column(
-        Geometry(geometry_type="POINTZ", srid=4326, spatial_index=True)
+        Geometry(geometry_type="POINT", srid=SRID_WGS84, spatial_index=True)
+    )
+    elevation: Mapped[float] = mapped_column(
+        nullable=False, comment="in meters with vertical datum of NAVD88"
     )
 
     state: Mapped[str] = lexicon_term(nullable=True, default="New Mexico")
@@ -65,7 +67,7 @@ class Location(Base, AutoBaseMixin, ReleaseMixin):
     )
 
     # --- Proxy Definitions ---
-    things: AssociationProxy[list["Thing"]] = association_proxy(
+    things: AssociationProxy[list["Thing"]] = association_proxy(  # noqa: F821
         "thing_associations", "thing"
     )
 
@@ -95,7 +97,9 @@ class LocationThingAssociation(Base, AutoBaseMixin):
 
     # --- Relationship Definitions ---
     location: Mapped["Location"] = relationship(back_populates="thing_associations")
-    thing: Mapped["Thing"] = relationship(back_populates="location_associations")
+    thing: Mapped["Thing"] = relationship(  # noqa: F821
+        back_populates="location_associations"
+    )
 
 
 # ============= EOF =============================================