Merge pull request #116 from specklesystems/izzy/commit-spec

feat(client): add `branchName` to commit model

.circleci/config.yml

@@ -4,7 +4,7 @@ orbs:
   python: circleci/python@1.3.2
 
 jobs:
-  build:
+  test:
     docker:
       - image: "cimg/python:<<parameters.tag>>"
       - image: "circleci/node:12"
@@ -14,7 +14,7 @@ jobs:
           POSTGRES_DB: speckle2_test
           POSTGRES_PASSWORD: speckle
           POSTGRES_USER: speckle
-      - image: "speckle/speckle-server:5f8cf11cba07ea6a54000243f9cb343b61cbba13"
+      - image: "speckle/speckle-server"
         command: ["bash", "-c", "/wait && node bin/www"]
         environment:
           POSTGRES_URL: "localhost"
@@ -38,27 +38,30 @@ jobs:
           name: upgrade pip
       - python/install-packages:
           pkg-manager: poetry
-      - run: poetry run pytest --version
+      - run: poetry run pytest
 
   deploy:
     docker:
       - image: "circleci/python:3.8"
     steps:
       - checkout
+      - run: python patch_version.py $CIRCLE_TAG
       - run: poetry build
       - run: poetry publish -u specklesystems -p $PYPI_PASSWORD
 
 workflows:
   main:
-    jobs:
-      - build:
+    jobs: 
+      - test:
           matrix:
             parameters:
               tag: ["3.6", "3.7", "3.8", "3.9"]
-
-  publish:
-    jobs: 
+          filters:
+            tags:
+              only: /.*/
       - deploy:
+          requires:
+            - test 
           filters:
             tags:
               only: /[0-9]+(\.[0-9]+)*/

patch_version.py

@@ -0,0 +1,31 @@
+import re
+import sys
+
+
+def patch(tag):
+    print(f"Patching version: {tag}")
+
+    with open("pyproject.toml", "r") as f:
+        lines = f.readlines()
+
+        if "version" not in lines[2]:
+            raise Exception(f"Invalid pyproject.toml. Could not patch version.")
+
+        lines[2] = f'version = "{tag}"\n'
+        with open("pyproject.toml", "w") as file:
+            file.writelines(lines)
+
+
+def main():
+    if len(sys.argv) < 2:
+        return
+
+    tag = sys.argv[1]
+    if not re.match(r"[0-9]+(\.[0-9]+)*$", tag):
+        raise ValueError(f"Invalid tag provided: {tag}")
+
+    patch(tag)
+
+
+if __name__ == "__main__":
+    main()

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "specklepy"
-version = "2.2.4"
+version = "2.1.0"
 description = "The Python SDK for Speckle 2.0"
 readme = "README.md"
 authors = ["Speckle Systems <devops@speckle.systems>"]

specklepy/api/client.py

@@ -82,6 +82,11 @@ class SpeckleClient:
         except Exception as ex:
             raise SpeckleException(f"{self.url} is not a compatible Speckle Server", ex)
 
+    def __repr__(self):
+        return (
+            f"SpeckleClient( server: {self.url}, authenticated: {self.me is not None} )"
+        )
+
     def authenticate(self, token: str) -> None:
         """Authenticate the client using a personal access token
         The token is saved in the client object and a synchronous GraphQL entrypoint is created

specklepy/api/credentials.py

@@ -1,9 +1,13 @@
 import os
-from typing import List, Optional
+from specklepy.transports.server.server import ServerTransport
+from warnings import warn
 from pydantic import BaseModel
+from typing import List, Optional
+from urllib.parse import urlparse, unquote
 from specklepy.api.models import ServerInfo
+from specklepy.api.client import SpeckleClient
 from specklepy.transports.sqlite import SQLiteTransport
-from specklepy.logging.exceptions import SpeckleException
+from specklepy.logging.exceptions import SpeckleException, SpeckleWarning
 
 
 class UserInfo(BaseModel):
@@ -79,3 +83,100 @@ def get_default_account(base_path: str = None) -> Account:
         default.isDefault = True
 
     return default
+
+
+class StreamWrapper:
+    stream_url: str = None
+    use_ssl: bool = True
+    host: str = None
+    stream_id: str = None
+    commit_id: str = None
+    object_id: str = None
+    branch_name: str = None
+    client: SpeckleClient = None
+    account: Account = None
+
+    def __repr__(self):
+        return f"StreamWrapper( server: {self.host}, stream_id: {self.stream_id}, type: {self.type} )"
+
+    def __str__(self) -> str:
+        return self.__repr__()
+
+    @property
+    def type(self) -> str:
+        if self.object_id:
+            return "object"
+        elif self.commit_id:
+            return "commit"
+        elif self.branch_name:
+            return "branch"
+        else:
+            return "stream" if self.stream_id else "invalid"
+
+    def __init__(self, url: str) -> None:
+        self.stream_url = url
+        parsed = urlparse(url)
+        self.host = parsed.netloc
+        self.use_ssl = parsed.scheme == "https"
+        segments = parsed.path.strip("/").split("/")
+
+        if not segments or len(segments) > 4 or len(segments) < 2:
+            raise SpeckleException(
+                f"Cannot parse {url} into a stream wrapper class - invalid URL provided."
+            )
+
+        while segments:
+            segment = segments.pop(0)
+            if segments and segment.lower() == "streams":
+                self.stream_id = segments.pop(0)
+            elif segments and segment.lower() == "commits":
+                self.commit_id = segments.pop(0)
+            elif segments and segment.lower() == "branches":
+                self.branch_name = unquote(segments.pop(0))
+            elif segments and segment.lower() == "objects":
+                self.object_id = segments.pop(0)
+            elif segment.lower() == "globals":
+                self.branch_name = "globals"
+                if segments:
+                    self.commit_id = segments.pop(0)
+            else:
+                raise SpeckleException(
+                    f"Cannot parse {url} into a stream wrapper class - invalid URL provided."
+                )
+
+        if not self.stream_id:
+            raise SpeckleException(
+                f"Cannot parse {url} into a stream wrapper class - no stream id found."
+            )
+
+    def get_account(self) -> Account:
+        if self.account:
+            return self.account
+
+        self.account = next(
+            (a for a in get_local_accounts() if self.host in a.serverInfo.url),
+            None,
+        )
+
+        return self.account
+
+    def get_client(self) -> SpeckleClient:
+        if self.client:
+            return self.client
+
+        if not self.account:
+            self.get_account()
+
+        self.client = SpeckleClient(host=self.host, use_ssl=self.use_ssl)
+
+        if self.account is None:
+            warn(f"No local account found for server {self.host}", SpeckleWarning)
+            return self.client
+
+        self.client.authenticate(acct.token)
+        return self.client
+
+    def get_transport(self) -> ServerTransport:
+        if not self.client:
+            self.get_client()
+        return ServerTransport(self.client, self.stream_id)

specklepy/api/models.py

@@ -22,6 +22,7 @@ class Commit(BaseModel):
     authorName: Optional[str]
     authorId: Optional[str]
     authorAvatar: Optional[str]
+    branchName: Optional[str]
     createdAt: Optional[str]
     sourceApplication: Optional[str]
     referencedObject: Optional[str]

specklepy/api/operations.py

@@ -52,7 +52,8 @@ def receive(
     Arguments:
         obj_id {str} -- the id of the object to receive
         remote_transport {Transport} -- the transport to receive from
-        local_transport {Transport} -- the transport to send from
+        local_transport {Transport} -- the local cache to check for existing objects
+                                       (defaults to `SQLiteTransport`)
 
     Returns:
         Base -- the base object
@@ -97,9 +98,7 @@ def serialize(base: Base, write_transports: List[AbstractTransport] = []) -> str
     return serializer.write_json(base)[1]
 
 
-def deserialize(
-    obj_string: str, read_transport: AbstractTransport = SQLiteTransport()
-) -> Base:
+def deserialize(obj_string: str, read_transport: AbstractTransport = None) -> Base:
     """
     Deserialize a string object into a Base object. If the object contains referenced child objects that are not stored in the local db, a read transport needs to be provided in order to recompose the base with the children objects.
 
@@ -111,6 +110,9 @@ def deserialize(
     Returns:
         Base -- the deserialized object
     """
+    if not read_transport:
+        read_transport = SQLiteTransport()
+
     serializer = BaseObjectSerializer(read_transport=read_transport)
 
     return serializer.read_json(obj_string=obj_string)

specklepy/api/resources/commit.py

@@ -40,6 +40,7 @@ class Resource(ResourceBase):
                         authorId
                         authorName
                         authorAvatar
+                        branchName
                         createdAt
                         sourceApplication
                         totalChildrenCount

specklepy/logging/exceptions.py

@@ -28,3 +28,8 @@ class GraphQLException(SpeckleException):
 
     def __str__(self) -> str:
         return f"GraphQLException: {self.message}"
+
+
+class SpeckleWarning(Warning):
+    def __init__(self, *args: object) -> None:
+        super().__init__(*args)

specklepy/transports/server/server.py

@@ -22,11 +22,15 @@ class ServerTransport(AbstractTransport):
     def __init__(self, client: SpeckleClient, stream_id: str, **data: Any) -> None:
         super().__init__(**data)
         # TODO: replace client with account or some other auth avenue
+        if not client.me:
+            raise SpeckleException("The provided SpeckleClient was not authenticated.")
         self.url = client.url
         self.stream_id = stream_id
 
         token = client.me["token"]
-        self._batch_sender = BatchSender(self.url, self.stream_id, token, max_batch_size_mb=1)
+        self._batch_sender = BatchSender(
+            self.url, self.stream_id, token, max_batch_size_mb=1
+        )
 
         self.session = requests.Session()
         self.session.headers.update(
@@ -73,19 +77,25 @@ class ServerTransport(AbstractTransport):
             r.encoding = "utf-8"
 
         if r.status_code != 200:
-            raise SpeckleException(f"Can't get object {self.stream_id}/{id}: HTTP error {r.status_code} ({r.text[:1000]})")
+            raise SpeckleException(
+                f"Can't get object {self.stream_id}/{id}: HTTP error {r.status_code} ({r.text[:1000]})"
+            )
         root_obj_serialized = r.text
         root_obj = json.loads(root_obj_serialized)
-        closures = root_obj.get('__closure', {})
+        closures = root_obj.get("__closure", {})
 
         # Check which children are not already in the target transport
         children_ids = list(closures.keys())
         children_found_map = target_transport.has_objects(children_ids)
-        new_children_ids = [id for id in children_found_map if not children_found_map[id]]
+        new_children_ids = [
+            id for id in children_found_map if not children_found_map[id]
+        ]
 
         # Get the new children
         endpoint = f"{self.url}/api/getobjects/{self.stream_id}"
-        r = self.session.post(endpoint, data={"objects": json.dumps(new_children_ids)}, stream=True)
+        r = self.session.post(
+            endpoint, data={"objects": json.dumps(new_children_ids)}, stream=True
+        )
         if r.encoding is None:
             r.encoding = "utf-8"
         lines = r.iter_lines(decode_unicode=True)

specklepy/transports/sqlite.py

@@ -34,12 +34,18 @@ class SQLiteTransport(AbstractTransport):
         self.scope = scope or "Objects"
         self._base_path = base_path or self.__get_base_path()
 
-        os.makedirs(self._base_path, exist_ok=True)
+        try:
+            os.makedirs(self._base_path, exist_ok=True)
 
-        self._root_path = os.path.join(
-            os.path.join(self._base_path, f"{self.scope}.db")
-        )
-        self.__initialise()
+            self._root_path = os.path.join(
+                os.path.join(self._base_path, f"{self.scope}.db")
+            )
+            self.__initialise()
+        except Exception as ex:
+            raise SpeckleException(
+                f"SQLiteTransport could not initialise {self.scope}.db at {self._base_path}. Either provide a different `base_path` or use an alternative transport.",
+                ex,
+            )
 
     def __repr__(self) -> str:
         return f"SQLiteTransport(app: '{self.app_name}', scope: '{self.scope}')"

tests/test_wrapper.py

@@ -0,0 +1,41 @@
+import pytest
+from specklepy.api.credentials import StreamWrapper
+
+
+class TestWrapper:
+    def test_parse_stream(self):
+        wrap = StreamWrapper("https://testing.speckle.dev/streams/a75ab4f10f")
+        assert wrap.type == "stream"
+
+    def test_parse_branch(self):
+        wacky_wrap = StreamWrapper(
+            "https://testing.speckle.dev/streams/4c3ce1459c/branches/%F0%9F%8D%95%E2%AC%85%F0%9F%8C%9F%20you%20wat%3F"
+        )
+        wrap = StreamWrapper(
+            "https://testing.speckle.dev/streams/4c3ce1459c/branches/next%20level"
+        )
+        assert wacky_wrap.type == "branch"
+        assert wacky_wrap.branch_name == "🍕⬅🌟 you wat?"
+        assert wrap.type == "branch"
+
+    def test_parse_commit(self):
+        wrap = StreamWrapper(
+            "https://testing.speckle.dev/streams/4c3ce1459c/commits/8b9b831792"
+        )
+        assert wrap.type == "commit"
+
+    def test_parse_object(self):
+        wrap = StreamWrapper(
+            "https://testing.speckle.dev/streams/a75ab4f10f/objects/5530363e6d51c904903dafc3ea1d2ec6"
+        )
+        assert wrap.type == "object"
+
+    def test_parse_globals_as_branch(self):
+        wrap = StreamWrapper("https://testing.speckle.dev/streams/0c6ad366c4/globals/")
+        assert wrap.type == "branch"
+
+    def test_parse_globals_as_commit(self):
+        wrap = StreamWrapper(
+            "https://testing.speckle.dev/streams/0c6ad366c4/globals/abd3787893"
+        )
+        assert wrap.type == "commit"