rococo 0.1.44__tar.gz → 0.1.45__tar.gz

{rococo-0.1.44 → rococo-0.1.45}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: rococo
-Version: 0.1.44
+Version: 0.1.45
 Summary: A Python library to help build things the way we want them built
 Home-page: https://github.com/EcorRouge/rococo
 Author: Jay Grieves

rococo-0.1.45/rococo/models/organization.py

@@ -0,0 +1,22 @@
+"""
+Organization model
+"""
+
+from dataclasses import dataclass
+
+from . import VersionedModel
+
+
+@dataclass
+class Organization(VersionedModel):
+    """An organization model."""
+
+    name: str = None
+    code: str = None
+    description: str = None
+    # members (with accompanied roles, including `owner`) are maintained through `PersonOrganizationRole`
+
+    # TODO: to see do we want redundancy, to have a relationship from an `Organization` to its `owner`
+    # despite that `roles` in Organization (including the `owner`) are defined through `PersonOrganizationRole`
+
+    # we could support relationships and hierarchy among organizations

rococo-0.1.45/rococo/models/person_organization_role.py

@@ -0,0 +1,31 @@
+"""
+PersonOrganizationRole model
+"""
+
+from dataclasses import dataclass, field
+
+from . import VersionedModel
+
+# from enum import Enum
+
+# class PersonOrganizationRoleEnum(Enum):
+#     OWNER = "OWNER"
+#     MANAGER = "MANAGER"
+#     MEMBER = "MEMBER"
+
+@dataclass
+class PersonOrganizationRole(VersionedModel):
+    """A person organization role model."""
+
+    person: str = field(metadata={
+        'relationship': {'model': 'Person', 'type': 'direct'},
+        'field_type': 'record_id'
+    })
+    organization: str = field(metadata={
+        'relationship': {'model': 'Organization', 'type': 'direct'},
+        'field_type': 'record_id'
+    })
+    
+    # TODO: We would benefit from strictly typed Enum for role, but flexibility would lower
+    # role: PersonOrganizationRoleEnum = PersonOrganizationRoleEnum.MEMBER
+    role: str

rococo-0.1.45/rococo/repositories/__init__.py

@@ -0,0 +1,7 @@
+"""
+base repository for rococo
+"""
+from .base_repository import BaseRepository
+from .surreal_db_repository import SurrealDbRepository
+from .organization_repository import OrganizationRepository
+from .person_organization_role_repository import PersonOrganizationRoleRepository

rococo-0.1.45/rococo/repositories/organization_repository.py

@@ -0,0 +1,18 @@
+from rococo.models import Organization
+from rococo.repositories import SurrealDbRepository
+
+
+class OrganizationRepository(SurrealDbRepository):
+    def __init__(self, adapter, message_adapter, message_queue_name):
+        super().__init__(adapter, Organization, message_adapter, message_queue_name)
+
+    def find_by_name(self, name: str):
+        conditions = {"name": name}
+        return self.get_one(conditions)
+
+    def update_organization_name(self, organization_id: str, new_name: str):
+        instance = self.get_one({"entity_id": organization_id})
+        if instance:
+            instance.name = new_name
+            return self.save(instance)
+        return None

rococo-0.1.45/rococo/repositories/person_organization_role_repository.py

@@ -0,0 +1,35 @@
+import copy
+from typing import List, Union
+from .surreal_db_repository import SurrealDbRepository
+from rococo.models import PersonOrganizationRole
+
+
+class PersonOrganizationRoleRepository(SurrealDbRepository):
+    def __init__(self, adapter, message_adapter, message_queue_name):
+        super().__init__(adapter, PersonOrganizationRole, message_adapter, message_queue_name)
+
+    def find_organizations_by_member(self, member_id: str, get_member: bool = False) -> List[PersonOrganizationRole]:
+        """finds all the organizations that a Person identified by member_id is a member of 
+
+        Args:
+            member_id (str): `person.entity_id`
+            get_member (bool, optional): should a member (Person) be fetched too?. Defaults to False.
+
+        Returns:
+            List[PersonOrganizationRole]: found PersonOrganizationRole
+        """
+        conditions = {"person.entity_id": member_id}
+        fetch_related: List[str] = ["organization", "person"] if get_member else ["organization"]
+        return self.get_many(conditions, fetch_related=fetch_related)
+    
+    def find_by_owner(self, owner_id: str, get_owner: bool = False) -> List[PersonOrganizationRole]:
+        # TODO
+        conditions = {"person.entity_id": owner_id}
+        fetch_related: List[str] = ["organization", "person"] if get_owner else ["organization"]
+        return self.get_many(conditions, fetch_related=fetch_related)
+
+    # in the case we chose to have `role` as a `PersonOrganizationRoleEnum` instead of `str`
+    #  def save(self, instance: PersonOrganizationRole, send_message: bool = False) -> PersonOrganizationRole:
+    #     instance_copy = copy.copy(instance)
+    #     instance_copy.role = instance.role.value
+    #     super().save(instance=instance_copy, send_message=send_message)

{rococo-0.1.44 → rococo-0.1.45}/rococo.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: rococo
-Version: 0.1.44
+Version: 0.1.45
 Summary: A Python library to help build things the way we want them built
 Home-page: https://github.com/EcorRouge/rococo
 Author: Jay Grieves

{rococo-0.1.44 → rococo-0.1.45}/rococo.egg-info/SOURCES.txt

@@ -33,6 +33,8 @@ rococo/models/person_organization_role.py
 rococo/models/versioned_model.py
 rococo/repositories/__init__.py
 rococo/repositories/base_repository.py
+rococo/repositories/organization_repository.py
+rococo/repositories/person_organization_role_repository.py
 rococo/repositories/surreal_db_repository.py
 tests/__init__.py
 tests/base_repository_test.py

{rococo-0.1.44 → rococo-0.1.45}/setup.py

@@ -2,7 +2,7 @@ from setuptools import find_packages, setup
 
 setup(
     name='rococo',
-    version='0.1.44',
+    version='0.1.45',
     packages=find_packages(),
     url='https://github.com/EcorRouge/rococo',
     license='MIT',

rococo-0.1.44/rococo/models/organization.py

@@ -1,14 +0,0 @@
-"""
-Organization model
-"""
-
-from dataclasses import dataclass
-
-from . import VersionedModel
-
-
-@dataclass
-class Organization(VersionedModel):
-    """An organization model."""
-
-    name: str = None

rococo-0.1.44/rococo/models/person_organization_role.py

@@ -1,18 +0,0 @@
-"""
-PersonOrganizationRole model
-"""
-
-from dataclasses import dataclass, field
-
-from . import VersionedModel
-
-@dataclass
-class PersonOrganizationRole(VersionedModel):
-    """A person organization role model."""
-
-    person: str = field(metadata={
-        'relationship': {'model': 'Person', 'type': 'direct'},
-        'field_type': 'record_id'
-    })
-    organization_id: str
-    role: str

rococo-0.1.44/rococo/repositories/__init__.py

@@ -1,5 +0,0 @@
-"""
-base repository for rococo
-"""
-from .base_repository import BaseRepository
-from .surreal_db_repository import SurrealDbRepository