Fix #60 issue, rename ObjectEntity class to UcoObject class

Author: fabrizio-turchi

case_mapping/base.py

@@ -192,7 +192,7 @@ class FacetEntity(UcoInherentCharacterizationThing):
     pass
 
 
-class ObjectEntity(UcoThing):
+class UcoObject(UcoThing):
     def __init__(
         self,
         *args: Any,
@@ -201,7 +201,7 @@ def __init__(
         facets: Union[None, FacetEntity, Sequence[FacetEntity]] = None,
         modified_time: Union[None, datetime, Sequence[datetime]] = None,
         object_created_time: Optional[datetime] = None,
-        object_marking: Union[None, "ObjectEntity", Sequence["ObjectEntity"]] = None,
+        object_marking: Union[None, "UcoObject", Sequence["UcoObject"]] = None,
         name: Optional[str] = None,
         spec_version: Optional[str] = None,
         tag: Union[None, str, Sequence[str]] = None,
@@ -287,7 +287,7 @@ def append_indexed_items(self, *args):
             self["olo:length"] = str(current_index)
 
 
-class IdentityAbstraction(ObjectEntity):
+class IdentityAbstraction(UcoObject):
     """
     An identity abstraction is a grouping of identifying characteristics unique to an individual or organization. This class is an ontological structural abstraction for this concept. Implementations of this concept should utilize the identity:Identity class.
     """

case_mapping/case/investigation.py

@@ -3,7 +3,7 @@
 
 from pytz import timezone
 
-from ..base import FacetEntity, ObjectEntity
+from ..base import FacetEntity, UcoObject
 from ..uco.action import Action
 from ..uco.location import Location
 
@@ -15,13 +15,13 @@ def __init__(
         description: Optional[str] = None,
         facets: Optional[List[FacetEntity]] = None,
         end_time: Optional[datetime] = None,
-        environment: Optional[ObjectEntity] = None,
-        instrument: Union[None, ObjectEntity, List[ObjectEntity]] = None,
+        environment: Optional[UcoObject] = None,
+        instrument: Union[None, UcoObject, List[UcoObject]] = None,
         location: Union[None, Location, List[Location]] = None,
         name: Optional[str] = None,
-        objects: Union[None, ObjectEntity, List[ObjectEntity]] = None,
-        performer: Optional[ObjectEntity] = None,
-        results: Union[None, ObjectEntity, List[ObjectEntity]] = None,
+        objects: Union[None, UcoObject, List[UcoObject]] = None,
+        performer: Optional[UcoObject] = None,
+        results: Union[None, UcoObject, List[UcoObject]] = None,
         start_time: Optional[datetime] = None,
         **kwargs: Any,
     ) -> None:
@@ -46,7 +46,7 @@ def __init__(
         self["@type"] = "case-investigation:InvestigativeAction"
 
 
-class CaseInvestigation(ObjectEntity):
+class CaseInvestigation(UcoObject):
     def __init__(self, name=None, focus=None, description=None, core_objects=None):
         """
         An investigative action is a CASE object that represents the who, where, when of investigation
@@ -69,11 +69,11 @@ def __init__(self, name=None, focus=None, description=None, core_objects=None):
         self.append_core_objects(core_objects)
 
 
-class ProvenanceRecord(ObjectEntity):
+class ProvenanceRecord(UcoObject):
     def __init__(
         self,
         exhibit_number: Optional[str] = None,
-        uco_core_objects: Union[None, ObjectEntity, List[ObjectEntity]] = None,
+        uco_core_objects: Union[None, UcoObject, List[UcoObject]] = None,
     ):
         super().__init__()
         self["@type"] = "case-investigation:ProvenanceRecord"

case_mapping/drafting/entities.py

@@ -1,4 +1,4 @@
-from ..base import FacetEntity, ObjectEntity, unpack_args_array
+from ..base import FacetEntity, UcoObject, unpack_args_array
 
 
 class FacetPassiveDNS(FacetEntity):
@@ -109,7 +109,7 @@ def __init__(self, isp_name=None):
         self._str_vars(**{"drafting:ispName": isp_name})
 
 
-class ObservablePort(ObjectEntity):
+class ObservablePort(UcoObject):
     def __init__(self, port, has_changed=None, state=None):
         """
         Used to represent a network port
@@ -475,7 +475,7 @@ def __init__(self, start_index, end_index, ml_job=None):
         self._node_reference_vars(**{"drafting:machineLearningJob": ml_job})
 
 
-class TextIntervals(ObjectEntity):
+class TextIntervals(UcoObject):
     def __init__(self, indexed_items=None):
         super().__init__()
         self["@type"] = "drafting:TextIntervals"

case_mapping/uco/action.py

@@ -3,27 +3,27 @@
 
 from pytz import timezone
 
-from ..base import FacetEntity, ObjectEntity, unpack_args_array
+from ..base import FacetEntity, UcoObject, unpack_args_array
 from .location import Location
 
 
-class Action(ObjectEntity):
+class Action(UcoObject):
     def __init__(
         self,
         *args: Any,
         action_count: Optional[int] = None,
         action_status: Optional[str] = None,
         end_time: Optional[datetime] = None,
-        environment: Optional[ObjectEntity] = None,
-        error: Optional[ObjectEntity] = None,
-        instrument: Union[None, ObjectEntity, Sequence[ObjectEntity]] = None,
+        environment: Optional[UcoObject] = None,
+        error: Optional[UcoObject] = None,
+        instrument: Union[None, UcoObject, Sequence[UcoObject]] = None,
         location: Union[None, Location, Sequence[Location]] = None,
-        objects: Union[None, ObjectEntity, Sequence[ObjectEntity]] = None,
-        participant: Union[None, Sequence[ObjectEntity]] = None,
-        performer: Optional[ObjectEntity] = None,
-        results: Union[None, ObjectEntity, Sequence[ObjectEntity]] = None,
+        objects: Union[None, UcoObject, Sequence[UcoObject]] = None,
+        participant: Union[None, Sequence[UcoObject]] = None,
+        performer: Optional[UcoObject] = None,
+        results: Union[None, UcoObject, Sequence[UcoObject]] = None,
         start_time: Optional[datetime] = None,
-        subaction: Optional[ObjectEntity] = None,
+        subaction: Optional[UcoObject] = None,
         **kwargs: Any,
     ) -> None:
         """

case_mapping/uco/core.py

@@ -3,10 +3,10 @@
 
 from pytz import timezone
 
-from ..base import ObjectEntity, unpack_args_array
+from ..base import UcoObject, unpack_args_array
 
 
-class Bundle(ObjectEntity):
+class Bundle(UcoObject):
     def __init__(
         self,
         *args: Any,
@@ -68,12 +68,12 @@ def append_to_uco_core_description(self, *args):
         self._append_strings("uco-core:description", *args)
 
 
-class Relationship(ObjectEntity):
+class Relationship(UcoObject):
     def __init__(
         self,
         *args: Any,
-        source: ObjectEntity,
-        target: ObjectEntity,
+        source: UcoObject,
+        target: UcoObject,
         start_time: Optional[datetime] = None,
         end_time: Optional[datetime] = None,
         kind_of_relationship: str,

case_mapping/uco/identity.py

@@ -1,6 +1,6 @@
 from typing import Dict, Optional
 
-from ..base import FacetEntity, IdentityAbstraction, ObjectEntity
+from ..base import FacetEntity, IdentityAbstraction, UcoObject
 
 
 class FacetBirthInformation(FacetEntity):

case_mapping/uco/location.py

@@ -1,9 +1,9 @@
 from typing import Optional
 
-from ..base import FacetEntity, ObjectEntity
+from ..base import FacetEntity, UcoObject
 
 
-class Location(ObjectEntity):
+class Location(UcoObject):
     def __init__(self, facets=None):
         super().__init__()
         self["@type"] = "uco-location:Location"

case_mapping/uco/observable.py

@@ -3,15 +3,15 @@
 
 from cdo_local_uuid import local_uuid
 
-from ..base import FacetEntity, ObjectEntity, UcoInherentCharacterizationThing
+from ..base import FacetEntity, UcoInherentCharacterizationThing, UcoObject
 from .action import Action
 from .core import Relationship
 from .identity import Identity
 from .location import Location
 from .types import Dictionary
 
 
-class ObservableDomainName(ObjectEntity):
+class ObservableDomainName(UcoObject):
     def __init__(self, has_changed=None, state=None, facets=None):
         """
         Used to represent domain name objects
@@ -39,7 +39,7 @@ def __init__(self, domain, isTLD=False):
         self._bool_vars(**{"uco-observable:isTLD": isTLD})
 
 
-class ObservableHostName(ObjectEntity):
+class ObservableHostName(UcoObject):
     def __init__(self, hostname, has_changed=None, state=None):
         """
         Used to represent host names of devices on a network
@@ -55,7 +55,7 @@ def __init__(self, hostname, has_changed=None, state=None):
         self._bool_vars(**{"uco-observable:hasChanged": has_changed})
 
 
-class ObservableIPv4Address(ObjectEntity):
+class ObservableIPv4Address(UcoObject):
     def __init__(self, has_changed=None, state=None, facets=None):
         """
         Used to represent an IPv4 address object
@@ -80,7 +80,7 @@ def __init__(self, ip=None):
         self._str_vars(**{"uco-observable:addressValue": ip})
 
 
-class ObservableAutonomousSystem(ObjectEntity):
+class ObservableAutonomousSystem(UcoObject):
     def __init__(self, has_changed=None, state=None, facets=None):
         """
         An autonomous system is a collection of connected Internet Protocol (IP) routing prefixes under the control of one or more network operators on behalf of a single administrative entity or domain that presents a common, clearly defined routing policy to the Internet.
@@ -110,7 +110,7 @@ def __init__(self, as_number, as_handle=None):
         self._str_vars(**{"uco-observable:asHandle": as_handle})
 
 
-class X509Certificate(ObjectEntity):
+class X509Certificate(UcoObject):
     def __init__(
         self,
         has_changed=False,
@@ -435,7 +435,7 @@ def __init__(self, name=None, address=None):
         )
 
 
-class Observable(ObjectEntity):
+class Observable(UcoObject):
     def __init__(
         self,
         *args: Any,
@@ -586,22 +586,20 @@ def __init__(self, browser=None, history_entries=None):
                         self.__handle_var_type_errors(key, var, "int")
                 elif key in keys_ref:
                     if isinstance(var, list) or isinstance(var, tuple):
-                        is_object_entity = [
-                            isinstance(item, ObjectEntity) for item in var
-                        ]
+                        is_object_entity = [isinstance(item, UcoObject) for item in var]
                         if all(is_object_entity):
                             history_entry[key] = [
                                 {"@id": item.get_id()} for item in var
                             ]
                         else:
                             self.__handle_list_type_errors(
-                                key, var, "ObjectEntity (no @id key)"
+                                key, var, "UcoObject (no @id key)"
                             )
-                    elif isinstance(var, ObjectEntity):
+                    elif isinstance(var, UcoObject):
                         history_entry[key] = {"@id": var.get_id()}
                     else:
                         self.__handle_var_type_errors(
-                            key, var, "ObjectEntity (no @id key)"
+                            key, var, "UcoObject (no @id key)"
                         )
                 elif key == "uco-observable:manuallyEnteredCount":
                     history_entry[key] = {
@@ -1062,17 +1060,17 @@ def __init__(
 class FacetCalendarEntry(FacetEntity):
     def __init__(
         self,
-        application: Union[None, ObjectEntity] = None,
+        application: Union[None, UcoObject] = None,
         attendant: Union[None, Identity, List[Identity]] = None,
         duration: Optional[int] = None,
         end_time=None,
         event_status: Optional[str] = None,
         event_type: Optional[str] = None,
         is_private: Optional[bool] = None,
-        location: Union[None, ObjectEntity] = None,
+        location: Union[None, UcoObject] = None,
         modified_time=None,
         observable_created_time=None,
-        owner: Union[None, ObjectEntity] = None,
+        owner: Union[None, UcoObject] = None,
         recurrence: Optional[str] = None,
         remind_time=None,
         start_time=None,
@@ -1385,11 +1383,11 @@ def __init__(self, path: str) -> None:
 class EventRecordFacet(FacetEntity):
     def __init__(
         self,
-        account: Union[None, ObjectEntity] = None,
-        application: Union[None, ObjectEntity] = None,
-        cyber_action: Union[None, ObjectEntity] = None,
+        account: Union[None, UcoObject] = None,
+        application: Union[None, UcoObject] = None,
+        cyber_action: Union[None, UcoObject] = None,
         end_time: Optional[datetime] = None,
-        event_record_device: Union[None, ObjectEntity] = None,
+        event_record_device: Union[None, UcoObject] = None,
         event_record_id: Optional[str] = None,
         event_record_raw: Optional[str] = None,
         event_record_service_name: Optional[str] = None,
@@ -1447,8 +1445,8 @@ class ObservableRelationship(Observable, Relationship):
     def __init__(
         self,
         *args: Any,
-        source: ObjectEntity,
-        target: ObjectEntity,
+        source: UcoObject,
+        target: UcoObject,
         start_time: Optional[datetime] = None,
         end_time: Optional[datetime] = None,
         kind_of_relationship: str,
@@ -1668,15 +1666,15 @@ def append_participants(self, *args):
         self._append_refs("uco-observable:participant", *args)
 
 
-class MessageThread(ObjectEntity):
+class MessageThread(UcoObject):
     def __init__(self, name=None, facets=None):
         super().__init__()
         self["@type"] = "uco-observable:MessageThread"
         self._str_vars(**{"uco-core:name": name})
         self.append_facets(facets)
 
 
-class Message(ObjectEntity):
+class Message(UcoObject):
     def __init__(self, has_changed=None, state=None, indexed_items=None):
         """
         A message is a discrete unit of electronic communication intended by the source for consumption by some

case_mapping/uco/tool.py

@@ -1,10 +1,10 @@
 from typing import Any, Optional
 
-from ..base import ObjectEntity
+from ..base import UcoObject
 from .identity import Identity
 
 
-class Tool(ObjectEntity):
+class Tool(UcoObject):
     def __init__(
         self,
         *args: Any,

example.py

@@ -49,7 +49,7 @@ def _next_timestamp() -> datetime:
 )
 bundle.append_to_uco_object(bundle_identity)
 
-investigation_items: list[base.ObjectEntity] = []
+investigation_items: list[base.UcoObject] = []
 
 ############################################
 # A DeviceFacet and a OperatingSystemFacet #