chore: Add JSONB support (#46)

* Add JSONB to tableschema type mapping.

* Add documentation for troubleshooting.

* Add test for JSONB.

Author: gregmundy

README.md

@@ -324,4 +324,11 @@ pipenv install --dev
 2. Run the tests with the following command,
 ```bash
 pipenv run pytest -c pytest.ini
-```
+```
+
+## Troubleshooting
+If you have trouble starting the application with `docker-compose up` the problem may lie in your postgres container.
+
+Try running `docker rm postgres-container-id` to remove any prevoiusly saved data in the postgres container. This will allow the application to rebuild the database from scratch and should start successfully.
+
+Or try running `docker system prune`.

data_resource_api/factories/table_schema_types.py

@@ -3,6 +3,7 @@
 """
 
 from sqlalchemy import Integer, String, Float, Boolean, Date, DateTime
+from sqlalchemy.dialects.postgresql import JSONB
 
 # Mapping of a Frictionless Table Schema to SQLAlchemy Data Type.
 #
@@ -15,7 +16,7 @@
     'number': Float,
     'integer': Integer,
     'boolean': Boolean,
-    'object': String,
+    'object': JSONB,
     'array': String,
     'date': Date,
     'time': DateTime,

tests/schemas.py

@@ -1,42 +1,3 @@
-custom_descriptor = [{
-    "api": {
-      "resource": "tests",
-      "methods": [
-        {
-          "get": {
-            "enabled": True,
-            "secured": False,
-            "grants": []
-          }
-        }
-      ]
-    },
-    "datastore": {
-      "tablename": "tests",
-      "restricted_fields": [],
-      "schema": {
-        "fields": [
-          {
-            "name": "id",
-            "title": "Test ID",
-            "description": "Test Desc",
-            "type": "integer",
-            "required": True
-          },
-          {
-            "name": "name",
-            "title": "namename",
-            "description": "test name",
-            "type": "string",
-            "required": True
-          }
-        ],
-        "primaryKey": "id"
-      }
-    }
-  }
-]
-
 frameworks_descriptor = {
     "api": {
       "resource": "frameworks",
@@ -102,6 +63,12 @@
             "description": "framework name",
             "type": "string",
             "required": True
+          },
+          {
+            "name": "jsonb",
+            "title": "jsonb",
+            "type": "object",
+            "required": False
           }
         ],
         "primaryKey": "id"

tests/test_custom_descriptor.py

@@ -30,6 +30,16 @@ def post_a_framework(c, skills: list):
 
         return body['id']
 
+    @staticmethod
+    def get_a_framework_by_id(c, id: int):
+        route = '/frameworks'
+        response = c.get(f'{route}/{id}')
+        body = json.loads(response.data)
+
+        expect(response.status_code).to(equal(200))
+
+        return body
+
     @staticmethod
     def post_a_framework_with_no_skills(c):
         route = '/frameworks'
@@ -43,6 +53,20 @@ def post_a_framework_with_no_skills(c):
 
         return body['id']
 
+    @staticmethod
+    def post_json(c, data: object):
+        route = '/frameworks'
+        post_body = {
+            "name": "test",
+            "jsonb": data
+        }
+        response = c.post(route, json=post_body)
+        body = json.loads(response.data)
+
+        expect(response.status_code).to(equal(201))
+
+        return body['id']
+
     @staticmethod
     def put_a_framework_skill(c, framework_id: int, skills: list):
         route = f'/frameworks/{framework_id}/skills'
@@ -205,3 +229,12 @@ def test_mn_reverse_relationship(self, frameworks_skills_client):
         resp = ApiHelper.get_frameworks_on_skill(c, skill_1)
 
         expect(resp['frameworks']).to(equal([framework_id]))
+
+    def test_json(self, frameworks_skills_client):
+        c = frameworks_skills_client
+
+        json_framework_id = ApiHelper.post_json(c, {"testkey": "testvalue"})
+
+        resp = ApiHelper.get_a_framework_by_id(c, json_framework_id)
+
+        expect(resp['jsonb']).to(equal("{'testkey': 'testvalue'}"))

tests/test_junc_holder.py

@@ -3,11 +3,6 @@
 import pytest
 
 
-class TestTable:
-    def __init__(self, table_name):
-        self.__tablename__ = table_name
-
-
 class TestJuncHolder(object):
     def test_use(self):
         JuncHolder.reset()