Merge pull request #1 from hypervectorio/definition-history

Definition history

Author: Jason Costello

hypervector/resources/auxilliary/__init__.py

@@ -0,0 +1,25 @@
+from hypervector.resources.abstract.api_resource import APIResource
+
+
+class Revision(APIResource):
+    resource_name = 'revision'
+
+    def __init__(self, revision_uuid, added, features):
+        self.revision_uuid = revision_uuid
+        self.added = added
+        self.features = features
+
+    @classmethod
+    def from_response(cls, dictionary):
+        return cls(
+            revision_uuid=dictionary['revision_uuid'],
+            added=dictionary['added'],
+            features=dictionary['features']
+        )
+
+    def to_response(self):
+        return {
+            "revision_uuid": self.revision_uuid,
+            "added": self.added,
+            "features": self.features
+        }

hypervector/resources/auxilliary/revision.py

@@ -3,6 +3,7 @@
 import requests
 
 import hypervector
+from hypervector.resources.auxilliary.revision import Revision
 from hypervector.resources.core.ensemble import Ensemble
 from hypervector.resources.abstract.api_resource import APIResource
 
@@ -57,6 +58,12 @@ def new(cls, definition_file, project_uuid=None):
         response = requests.post(endpoint, json=data, headers=cls.get_headers()).json()
         return cls.from_response(response)
 
+    def history(self):
+        endpoint = f"{hypervector.API_BASE}/definition/{self.definition_uuid}/history"
+        response = requests.get(endpoint, headers=self.get_headers()).json()
+        history = [Revision.from_response(response_item) for response_item in response]
+        return history
+
 
 def _parse_definition_from_json_file(definition_json_file):
     return json.load(open(definition_json_file, 'rb'))

hypervector/resources/core/definition.py

@@ -5,7 +5,7 @@
 
 setup(
     name='hypervector-wrapper',
-    version='0.0.7',
+    version='0.0.8',
     description='Python wrapper to use the Hypervector API',
     long_description=long_description,
     long_description_content_type="text/markdown",

setup.py

@@ -1,5 +1,8 @@
+import uuid
+
 import responses
 import hypervector
+from hypervector.resources.auxilliary.revision import Revision
 from tests.util import get_resource_path
 
 
@@ -33,3 +36,24 @@ def test_definition_new(mocked_resources):
 
     assert isinstance(definition, hypervector.Definition)
 
+
+def test_definition_history(mocked_resources, mocked_responses):
+    _, definition, _, _ = mocked_resources
+
+    mocked_revision = Revision(
+        revision_uuid=str(uuid.uuid4()),
+        added="01/01/1970 00:00:01",
+        features=[]
+    )
+
+    mocked_responses.add(
+        responses.GET,
+        f'{hypervector.API_BASE}/definition/{definition.definition_uuid}/history',
+        json=[mocked_revision.to_response()]
+    )
+
+    history = definition.history()
+
+    for revision in history:
+        assert isinstance(revision, Revision)
+