add some models, tests retrieving raw systems, and slight reorganize

Author: tipatterson-dev

external_models/__init__.py

@@ -0,0 +1,101 @@
+#   ==============================================================================
+#   Copyright (c) 2024 Botts Innovative Research, Inc.
+#   Date:  2024/5/31
+#   Author:  Ian Patterson
+#   Contact Email:  ian@botts-inc.com
+#   ==============================================================================
+
+from pydantic import BaseModel, ConfigDict, Field, field_validator, model_validator
+from shapely import Point
+from typing_extensions import Self
+
+
+class BoundingBox(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+
+    lower_left_corner: Point = Field(..., description="The lower left corner of the bounding box.")
+    upper_right_corner: Point = Field(..., description="The upper right corner of the bounding box.")
+    min_value: float = Field(None, description="The minimum value of the bounding box.")
+    max_value: float = Field(None, description="The maximum value of the bounding box.")
+
+    # @model_validator(mode='before')
+    # def validate_minmax(self) -> Self:
+    #     if self.min_value > self.max_value:
+    #         raise ValueError("min_value must be less than max_value")
+    #     return self
+
+
+class DateTime(BaseModel):
+    is_instant: bool = Field(True, description="Whether the date time is an instant or a period.")
+    iso_date: str = Field(None, description="The ISO formatted date time.")
+    time_period: tuple = Field(None, description="The time period of the date time.")
+
+    @model_validator(mode='before')
+    def valid_datetime_type(self) -> Self:
+        if self.is_instant:
+            if self.iso_date is None:
+                raise ValueError("Instant date time must have a valid ISO8601 date.")
+        return self
+
+    @field_validator('iso_date')
+    @classmethod
+    def check_iso_date(cls, v) -> str:
+        if not v:
+            raise ValueError("Instant date time must have a valid ISO8601 date.")
+        return v
+
+
+class SecurityConstraints:
+    constraints: list
+
+
+class LegalConstraints:
+    constraints: list
+
+
+class Characteristics:
+    characteristics: list
+
+
+class Capabilities:
+    capabilities: list
+
+
+class Contact:
+    contact: list
+
+
+class Documentation:
+    documentation: list
+
+
+class HistoryEvent:
+    history_event: list
+
+
+class ConfigurationSettings:
+    settings: list
+
+
+class FeatureOfInterest:
+    feature: list
+
+
+class Input:
+    input: list
+
+
+class Output:
+    output: list
+
+
+class Parameter:
+    parameter: list
+
+
+class Mode:
+    mode: list
+
+
+class ProcessMethod:
+    method: list

external_models/object_models.py

@@ -0,0 +1,82 @@
+#   ==============================================================================
+#   Copyright (c) 2024 Botts Innovative Research, Inc.
+#   Date:  2024/5/31
+#   Author:  Ian Patterson
+#   Contact Email:  ian@botts-inc.com
+#   ==============================================================================
+import uuid
+from typing import List
+
+from conSys4Py import DatastreamSchema
+from conSys4Py.datamodels.api_utils import Link
+from pydantic import BaseModel, ConfigDict, Field
+from shapely import Geometry
+
+from external_models import BoundingBox, Capabilities, Characteristics, ConfigurationSettings, Contact, DateTime, \
+    Documentation, \
+    FeatureOfInterest, HistoryEvent, Input, LegalConstraints, \
+    Mode, Output, Parameter, ProcessMethod, SecurityConstraints
+
+
+class System(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+
+    feature_type: str = Field(None, serialization_alias="type")
+    system_id: str = Field(None, serialization_alias="id")
+    properties: dict = Field(None)
+    geometry: Geometry | None = Field(None)
+    bbox: BoundingBox = Field(None)
+    links: List[Link] = Field(None)
+    description: str = Field(None)
+    uid: uuid.UUID = Field(None)
+    label: str = Field(None)
+    lang: str = Field(None)
+    keywords: List[str] = Field(None)
+    identifiers: List[str] = Field(None)
+    classifiers: List[str] = Field(None)
+    valid_time: DateTime = Field(None, serialization_alias="validTime")
+    security_constraints: List[SecurityConstraints] = Field(None, serialization_alias="securityConstraints")
+    legal_constraints: List[LegalConstraints] = Field(None, serialization_alias="legalConstraints")
+    characteristics: List[Characteristics] = Field(None)
+    capabilities: List[Capabilities] = Field(None)
+    contacts: List[Contact] = Field(None)
+    documentation: List[Documentation] = Field(None)
+    history: List[HistoryEvent] = Field(None)
+    definition: str = Field(None)
+    type_of: str = Field(None, serialization_alias="typeOf")
+    configuration: ConfigurationSettings = Field(None)
+    features_of_interest: List[FeatureOfInterest] = Field(None, alias="featuresOfInterest")
+    inputs: List[Input] = Field(None)
+    outputs: List[Output] = Field(None)
+    parameters: List[Parameter] = Field(None)
+    modes: List[Mode] = Field(None)
+    method: ProcessMethod = Field(None)
+
+
+class Datastream(BaseModel):
+    ds_id: str = Field(..., serialization_alias="id")
+    name: str = Field(...)
+    description: str
+    valid_time: DateTime = Field(..., serialization_alias="validTime")
+    output_name: str = Field(None, serialization_alias="outputName")
+    procedure_link: Link = Field(None, serialization_alias="procedureLink@link")
+    deployment_link: Link = Field(None, serialization_alias="deploymentLink@link")
+    ultimate_feature_of_interest_link: Link = Field(None, serialization_alias="ultimateFeatureOfInterest@link")
+    sampling_feature_link: Link = Field(None, serialization_alias="samplingFeature@link")
+    parameters: dict = Field(None)
+    phenomenon_time: DateTime = Field(None, serialization_alias="phenomenonTimeInterval")
+    result_time: DateTime = Field(None, serialization_alias="resultTimeInterval")
+    ds_type: str = Field(None, serialization_alias="type")
+    result_type: str = Field(None, serialization_alias="resultType")
+    links: List[Link] = Field(None)
+    schema: DatastreamSchema = Field(None)
+
+
+class Observation(BaseModel):
+    sampling_feature_id: str = Field(None, serialization_alias="samplingFeature@Id")
+    procedure_link: Link = Field(None, serialization_alias="procedure@link")
+    phenomenon_time: DateTime = Field(None, serialization_alias="phenomenonTime")
+    result_time: DateTime = Field(..., serialization_alias="resultTime")
+    parameters: dict = Field(None)
+    result: dict = Field(...)
+    result_link: Link = Field(None, serialization_alias="result@link")

oshconnect/__init__.py

@@ -1,4 +1,3 @@
-
 #   ==============================================================================
 #   Copyright (c) 2024 Botts Innovative Research, Inc.
 #   Date:  2024/5/28
@@ -11,31 +10,40 @@
 from abc import ABC
 from dataclasses import dataclass
 from enum import Enum
-import oshdatacore as swe_common
+import swecommondm as swe_common
+from conSys4Py import APIResourceTypes
+from conSys4Py.core.default_api_helpers import APIHelper
 
 
 @dataclass(kw_only=True)
 class Endpoints:
-    root: str = "/sensorhub"
+    root: str = "sensorhub"
     sos: str = f"{root}/sos"
     connected_systems: str = f"{root}/api"
 
 
 @dataclass(kw_only=True)
-class Node(ABC):
+class Node:
     _id: str
     address: str
     port: int
     endpoints: Endpoints
     is_secure: bool
-    _basic_auth: bytes
+    _basic_auth: bytes = None
+    _api_helper: APIHelper
 
-    def __init__(self, address: str, port: int, is_secure: bool):
+    def __init__(self, address: str, port: int, username: str = None, password: str = None, **kwargs: dict):
         self._id = f'node-{uuid.uuid4()}'
         self.address = address
         self.port = port
-        self.is_secure = is_secure
+        self.is_secure = username is not None and password is not None
+        if self.is_secure:
+            self.add_basicauth(username, password)
         self.endpoints = Endpoints()
+        self._api_helper = APIHelper(server_url=f'{self.address}:{self.port}',
+                                     api_root=self.endpoints.connected_systems, username=username, password=password)
+        if self.is_secure:
+            self._api_helper.user_auth = True
 
     def get_id(self):
         return self._id
@@ -50,17 +58,24 @@ def get_api_endpoint(self):
         return f"http{'s' if self.is_secure else ''}://{self.address}:{self.port}/{self.endpoints.connected_systems}"
 
     def add_basicauth(self, username: str, password: str):
+        if not self.is_secure:
+            self.is_secure = True
         self._basic_auth = base64.b64encode(f"{username}:{password}".encode('utf-8'))
 
     def get_decoded_auth(self):
         return self._basic_auth.decode('utf-8')
 
+    def discover_systems(self):
+        res = self._api_helper.retrieve_resource(APIResourceTypes.SYSTEM, req_headers={})
+        if res.ok:
+            return res.json()
+        else:
+            return None
+
 
 class TemporalModes(Enum):
     REAL_TIME = 0
     ARCHIVE = 1
     BATCH = 2
     RT_SYNC = 3
     ARCHIVE_SYNC = 4
-
-

oshconnect/datamodels/__init__.py

@@ -0,0 +1,6 @@
+#   ==============================================================================
+#   Copyright (c) 2024 Botts Innovative Research, Inc.
+#   Date:  2024/5/31
+#   Author:  Ian Patterson
+#   Contact Email:  ian@botts-inc.com
+#   ==============================================================================

oshconnect/datamodels/datamodels.py

@@ -0,0 +1,49 @@
+#   ==============================================================================
+#   Copyright (c) 2024 Botts Innovative Research, Inc.
+#   Date:  2024/6/13
+#   Author:  Ian Patterson
+#   Contact Email:  ian@botts-inc.com
+#   ==============================================================================
+from __future__ import annotations
+
+import uuid
+
+from oshconnect import Node
+from external_models.object_models import System as SystemResource
+
+
+class System:
+    uid: uuid.UUID
+    name: str
+    label: str
+    datastreams: list[Datastream]
+    control_channels: list[ControlChannel]
+    description: str
+    _parent_node: Node
+
+    def __init__(self, name: str, label: str, **kwargs):
+        self.uid = uuid.uuid4()
+        self.name = name
+        self.label = label
+        self.datastreams = []
+        self.control_channels = []
+
+    def update_parent_node(self, node: Node):
+        self._parent_node = node
+
+    @staticmethod
+    def from_system_resource(system_resource: SystemResource):
+        other_props = SystemResource.__dict__
+        return System(name=system_resource.name, label=system_resource.label)
+
+
+class Datastream:
+
+    def __init__(self):
+        pass
+
+
+class ControlChannel:
+
+    def __init__(self):
+        pass

oshconnect/datasource/__init__.py

@@ -17,6 +17,3 @@ class Mode(Enum):
     REPLAY = "replay"
     BATCH = "batch"
     REAL_TIME = "realTime"
-
-class DataSourceHandler:
-    datasources

oshconnect/datastore/datastore.py

@@ -7,4 +7,4 @@
 
 class DataStore:
     def __init__(self):
-        pass
+        pass