Add diff_version and diff_object as well

Makes the functions more self-contained and responsible
for a single thing.

Author: rrooij

terminusdb_client/client/Client.py

@@ -2012,6 +2012,52 @@ def _convert_diff_document(self, document):
             new_doc = self._conv_to_dict(document)
         return new_doc
 
+    def diff_object(self, before_object, after_object):
+        """Diff two different objects.
+
+        Parameters
+        ----------
+        before_object : string
+            Before object to compare
+        after_object : string
+            After object to compare
+        """
+        self._check_connection(check_db=False)
+        return json.loads(
+            _finish_response(
+                requests.post(
+                    self._diff_url(),
+                    headers=self._default_headers,
+                    json={'before': before_object,
+                          'after': after_object},
+                    auth=self._auth(),
+                )
+            )
+        )
+
+    def diff_version(self, before_version, after_version):
+        """Diff two different versions. Can either be a branch or a commit
+
+        Parameters
+        ----------
+        before_version : string
+            Commit or branch of the before version to compare
+        after_version : string
+            Commit or branch of the after version to compare
+        """
+        self._check_connection(check_db=False)
+        return json.loads(
+            _finish_response(
+                requests.post(
+                    self._diff_url(),
+                    headers=self._default_headers,
+                    json={'before_data_version': before_version,
+                          'after_data_version': after_version},
+                    auth=self._auth(),
+                )
+            )
+        )
+
     def diff(
         self,
         before: Union[
@@ -2032,7 +2078,9 @@ def diff(
         ],
         document_id: Union[str, None] = None,
     ):
-        """Perform diff on 2 set of document(s), result in a Patch object.
+        """DEPRECATED
+
+        Perform diff on 2 set of document(s), result in a Patch object.
 
         Do not connect when using public API.
 

terminusdb_client/tests/integration_tests/test_client.py

@@ -110,6 +110,44 @@ def test_add_get_remove_org(docker_url):
         client.get_organization("testOrg")
 
 
+def test_diff_object(docker_url):
+    # create client
+    client = Client(docker_url, user_agent=test_user_agent)
+    # test create db
+    client.connect()
+    diff = client.diff_object({'test': 'wew'}, {'test': 'wow'})
+    assert diff == {'test': {'@before': 'wew', '@after': 'wow', '@op': 'SwapValue'}}
+
+
+def test_diff_version(docker_url):
+    client = Client(docker_url, user_agent=test_user_agent)
+    client.connect()
+    db_name = "philosophers" + str(random())
+    client.create_database(db_name)
+    client.connect(db=db_name)
+    # Add a philosopher schema
+    schema = {"@type": "Class",
+              "@id": "Philosopher",
+              "name": "xsd:string"
+              }
+    # Add schema and Socrates
+    client.insert_document(schema, graph_type="schema")
+    client.insert_document({"name": "Socrates"})
+
+    # Create new branch and switch to it
+    client.create_branch("changes")
+    client.branch = "changes"
+
+    # Add more philosophers
+    client.insert_document({"name": "Plato"})
+    client.insert_document({"name": "Aristotle"})
+
+    diff = client.diff_version("main", "changes")
+    assert len(diff) == 2
+    assert diff[0]['@insert']['name'] == 'Plato'
+    assert diff[1]['@insert']['name'] == 'Aristotle'
+
+
 def test_log(docker_url):
     # create client
     client = Client(docker_url, user_agent=test_user_agent)