Merge pull request #146 from A-Baji/master

update api responses to valid json

Author: guzman-raphael

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 Observes [Semantic Versioning](https://semver.org/spec/v2.0.0.html) standard and [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) convention.
 
+## [0.6.2] - 2022-11-10
+
+### Fixed
+
+- Convert the return of the insert route and normal record routes to valid json [#146](https://github.com/datajoint/pharus/pull/146)
+
 ## [0.6.1] - 2022-11-04
 
 ### Added
@@ -214,6 +220,7 @@ Observes [Semantic Versioning](https://semver.org/spec/v2.0.0.html) standard and
 - Support for DataJoint attribute types: `varchar`, `int`, `float`, `datetime`, `date`, `time`, `decimal`, `uuid`.
 - Check dependency utility to determine child table references.
 
+[0.6.2]: https://github.com/datajoint/pharus/compare/0.6.1...0.6.2
 [0.6.1]: https://github.com/datajoint/pharus/compare/0.6.0...0.6.1
 [0.6.0]: https://github.com/datajoint/pharus/compare/0.5.6...0.6.0
 [0.5.6]: https://github.com/datajoint/pharus/compare/0.5.5...0.5.6

README.rst

@@ -29,13 +29,13 @@ To start the API server, use the command:
 
     .. code-block:: bash
 
-        PHARUS_VERSION=0.6.1 docker-compose -f docker-compose-deploy.yaml up -d
+        PHARUS_VERSION=0.6.2 docker-compose -f docker-compose-deploy.yaml up -d
 
 To stop the API server, use the command:
 
     .. code-block:: bash
 
-        PHARUS_VERSION=0.6.1 docker-compose -f docker-compose-deploy.yaml down
+        PHARUS_VERSION=0.6.2 docker-compose -f docker-compose-deploy.yaml down
 
 References
 ----------

docker-compose-deploy.yaml

@@ -1,5 +1,5 @@
-# PHARUS_VERSION=0.6.1 docker-compose -f docker-compose-deploy.yaml pull
-# PHARUS_VERSION=0.6.1 docker-compose -f docker-compose-deploy.yaml up -d
+# PHARUS_VERSION=0.6.2 docker-compose -f docker-compose-deploy.yaml pull
+# PHARUS_VERSION=0.6.2 docker-compose -f docker-compose-deploy.yaml up -d
 #
 # Intended for production deployment.
 # Note: You must run both commands above for minimal outage

pharus/component_interface.py

@@ -180,7 +180,7 @@ def dj_query_route(self):
                         for r in self.payload["submissions"]
                     ]
                 )
-        return "Insert successful"
+        return {"response": "Insert Successful"}
 
     def fields_route(self):
         parent_attributes = sorted(set(sum([p.primary_key for p in self.parents], [])))

pharus/server.py

@@ -126,7 +126,7 @@ def api_version() -> str:
             Content-Type: application/json
 
             {
-                "version": "0.6.1"
+                "version": "0.6.2"
             }
 
         :statuscode 200: No error.
@@ -573,7 +573,9 @@ def record(
                 Vary: Accept
                 Content-Type: text/plain
 
-                Insert Successful
+                {
+                    "response": "Insert Successful"
+                }
 
             **Example unexpected response**:
 
@@ -631,7 +633,9 @@ def record(
                 Vary: Accept
                 Content-Type: text/plain
 
-                Update Successful
+                {
+                    "response": "Update Successful"
+                }
 
             **Example unexpected response**:
 
@@ -673,7 +677,9 @@ def record(
                 Vary: Accept
                 Content-Type: text/plain
 
-                Delete Successful
+                {
+                    "response": "Delete Successful"
+                }
 
             **Example conflict response**:
 
@@ -751,15 +757,15 @@ def record(
             _DJConnector._insert_tuple(
                 connection, schema_name, table_name, request.json["records"]
             )
-            return "Insert Successful"
+            return {"response": "Insert Successful"}
         except Exception:
             return traceback.format_exc(), 500
     elif request.method == "PATCH":
         try:
             _DJConnector._update_tuple(
                 connection, schema_name, table_name, request.json["records"]
             )
-            return "Update Successful"
+            return {"response": "Update Successful"}
         except Exception:
             return traceback.format_exc(), 500
     elif request.method == "DELETE":
@@ -779,7 +785,7 @@ def record(
                     if k == "cascade"
                 },
             )
-            return "Delete Sucessful"
+            return {"response": "Delete Successful"}
         except IntegrityError as e:
             match = foreign_key_error_regexp.match(e.args[0])
             return (

pharus/version.py

@@ -1,2 +1,2 @@
 """Package metadata."""
-__version__ = "0.6.1"
+__version__ = "0.6.2"

tests/test_form.py

@@ -19,7 +19,7 @@ def test_insert_map(token, client, connection, schemas_simple):
         headers=dict(Authorization=f"Bearer {token}"),
     )
     assert REST_response.status_code == 200, REST_response.data
-    assert REST_response.data == b"Insert successful"
+    assert REST_response.get_json() == {"response": "Insert Successful"}
 
 
 def test_insert_no_map(token, client, connection, schemas_simple):
@@ -33,7 +33,7 @@ def test_insert_no_map(token, client, connection, schemas_simple):
         headers=dict(Authorization=f"Bearer {token}"),
     )
     assert REST_response.status_code == 200
-    assert REST_response.data == b"Insert successful"
+    assert REST_response.get_json() == {"response": "Insert Successful"}
 
 
 def test_insert_fail(token, client, connection, schemas_simple):