quillsql 1.6__tar.gz → 1.8__tar.gz

{quillsql-1.6 → quillsql-1.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: quillsql
-Version: 1.6
+Version: 1.8
 Summary: Quill SDK for Python.
 Home-page: https://github.com/quill-sql/quill-python
 Author: Quill

{quillsql-1.6 → quillsql-1.8}/quillsql/core.py

@@ -17,8 +17,11 @@ DEFAULT_CACHE_TTL = 24 * 60 * 60
 
 # A connection pool with a cache in front.
 class CachedPool:
-    def __init__(self, config, cache_config):
-        self.pool = psycopg2.connect(config)
+    def __init__(self, config, cache_config, psycopg2_connection=None):
+        if psycopg2_connection:
+            self.pool = psycopg2_connection
+        else:
+            self.pool = psycopg2.connect(config)
         self.cache = self.get_cache(cache_config)
         self.ttl = cache_config and cache_config.get("ttl") or DEFAULT_CACHE_TTL
         self.cur = self.pool.cursor(cursor_factory=psycopg2.extras.RealDictCursor)
@@ -337,12 +340,20 @@ def handleDeleteTask(org_id, metadata, private_key, target_pool):
 
 ## Quill - Fullstack API Platform for Dashboards and Reporting.
 class Quill:
-    def __init__(self, private_key, database_connection_string, cache=None):
+    def __init__(
+        self,
+        private_key,
+        database_connection_string="",
+        psycopg2_connection=None,
+        cache=None,
+    ):
         # Handles both dsn-style connection strings (eg. "dbname=test password=secret" )
         # as well as url-style connection strings (eg. "postgres://foo@db.com")
         to_dsn = lambda conn: make_dsn(conn) if "://" in conn else conn
         self.database_connection_string = to_dsn(database_connection_string)
-        self.main_pool = CachedPool(database_connection_string, cache)
+        self.main_pool = CachedPool(
+            database_connection_string, cache, psycopg2_connection
+        )
         self.private_key = private_key
 
     def query(self, org_id, data):

{quillsql-1.6 → quillsql-1.8}/quillsql.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: quillsql
-Version: 1.6
+Version: 1.8
 Summary: Quill SDK for Python.
 Home-page: https://github.com/quill-sql/quill-python
 Author: Quill

{quillsql-1.6 → quillsql-1.8}/quillsql.egg-info/SOURCES.txt

@@ -10,4 +10,5 @@ quillsql.egg-info/requires.txt
 quillsql.egg-info/top_level.txt
 tests/__init__.py
 tests/cache_test.py
+tests/external_test.py
 tests/simple_test.py

{quillsql-1.6 → quillsql-1.8}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 setup(
     name="quillsql",
-    version="1.6",
+    version="1.8",  # v0.3.0 for parity
     packages=find_packages(),
     install_requires=[
         "psycopg2-binary",

quillsql-1.6/tests/simple_test.py → quillsql-1.8/tests/external_test.py

@@ -1,3 +1,4 @@
+import psycopg2
 import pytest
 from quillsql import Quill
 import os
@@ -5,10 +6,11 @@ from dotenv import load_dotenv
 
 load_dotenv()
 
-
+# Tests using an external db connection
+db = psycopg2.connect(os.environ.get("POSTGRES_STAGING_READ"))
 quill = Quill(
     private_key=os.environ.get("QUILL_PRIVATE_KEY"),
-    database_connection_string=os.environ.get("POSTGRES_STAGING_READ"),
+    psycopg2_connection=db
 )
 
 
@@ -61,25 +63,6 @@ def test_config_gets_admin_metadata():
         assert "customer_id" not in row
 
 
-def test_config_gets_admin_metadata_2():
-    res = quill.query(
-        org_id="2",
-        data={
-            "metadata": {
-                "id": "65895d225cd2e8cb2bd8542d",
-                "orgId": "2",
-                "clientId": "6579031b3e41c378aa8180ec",
-                "task": "item",
-                "filters": [],
-            }
-        },
-    )
-
-    print(res)
-    assert res is not None
-    assert "rows" in res
-
-
 def test_handles_empty_client_id():
     res = quill.query(
         org_id="2",
@@ -239,6 +222,22 @@ def test_orgs_works_correctly_with_client_id():
     assert "orgs" in res
 
 
+def test_orgs_works_without_id():
+    res = quill.query(
+        org_id="2",
+        data={
+            "metadata": {
+                "task": "orgs",
+                "clientId": "62cda15d7c9fcca7bc0a3689",
+            }
+        },
+    )
+
+    assert res is not None
+    assert "errorMessage" not in res
+    assert "orgs" in res
+
+
 def test_view_fails_with_no_clientId():
     res = quill.query(
         org_id="2",
@@ -278,6 +277,7 @@ def test_view_works_correctly_with_clientId():
     assert res["message"] == "OK"
 
 
+#  TODO: flaky vvvv
 # def test_delete_works_correctly_with_clientId():
 #     res = quill.query(
 #         org_id="2",

quillsql-1.8/tests/simple_test.py

@@ -0,0 +1,294 @@
+import pytest
+from quillsql import Quill
+import os
+from dotenv import load_dotenv
+
+load_dotenv()
+
+
+quill = Quill(
+    private_key=os.environ.get("QUILL_PRIVATE_KEY"),
+    database_connection_string=os.environ.get("POSTGRES_STAGING_READ"),
+)
+
+
+def test_config_gets_metadata():
+    res = quill.query(
+        org_id="2", data={"metadata": {"task": "config", "name": "spend"}}
+    )
+
+    assert res is not None
+    assert "sections" in res
+    assert "newQueries" in res
+    assert "filters" in res
+    assert res["filters"] == []
+    assert "fieldToRemove" in res
+    assert res["fieldToRemove"] == "customer_id"
+
+    for query in res["newQueries"]:
+        assert "columns" in query
+        assert any(
+            column["field"] == "spend"
+            and column["label"] == "spend"
+            and column["format"] == "dollar_amount"
+            for column in query["columns"]
+        )
+        assert any(
+            column["field"] == "month"
+            and column["label"] == "month"
+            and column["format"] == "MMM_yyyy"
+            for column in query["columns"]
+        )
+
+
+def test_config_gets_admin_metadata():
+    res = quill.query(
+        org_id="2",
+        data={
+            "metadata": {
+                "id": "65962cf6cfce31000b53c51c",
+                "orgId": "2",
+                "clientId": "62cda15d7c9fcca7bc0a3689",
+                "task": "item",
+                "filters": [],
+            }
+        },
+    )
+
+    assert res is not None
+    for row in res["rows"]:
+        assert row["id"] is not "id"
+        assert "customer_id" not in row
+
+
+# def test_config_gets_admin_metadata_2():
+#     res = quill.query(
+#         org_id="2",
+#         data={
+#             "metadata": {
+#                 "id": "65895d225cd2e8cb2bd8542d",
+#                 "orgId": "2",
+#                 "clientId": "6579031b3e41c378aa8180ec",
+#                 "task": "item",
+#                 "filters": [],
+#             }
+#         },
+#     )
+
+#     print(res)
+#     assert res is not None
+#     assert "rows" in res
+
+
+def test_handles_empty_client_id():
+    res = quill.query(
+        org_id="2",
+        data={
+            "metadata": {
+                "task": "item",
+                "id": "6580d3aea2caa9000b1c1b06",
+                "client_id": None,
+                "filters": [],
+                "query": "select * from transactions",
+            }
+        },
+    )
+
+    assert res["chartType"] == "line"
+    assert res["clientId"] == "62cda15d7c9fcca7bc0a3689"
+    assert res["name"] == "Total Spend Test"
+    assert res["dashboardName"] == "spend"
+
+
+def test_gets_item():
+    res = quill.query(
+        org_id="2",
+        data={
+            "metadata": {
+                "task": "item",
+                "id": "6580d3aea2caa9000b1c1b06",
+                "client_id": "62cda15d7c9fcca7bc0a3689",
+                "filters": [],
+                "query": "select * from transactions",
+            }
+        },
+    )
+
+    assert res["chartType"] == "line"
+    assert res["clientId"] == "62cda15d7c9fcca7bc0a3689"
+    assert res["name"] == "Total Spend Test"
+    assert res["dashboardName"] == "spend"
+
+
+def test_query_for_data():
+    res = quill.query(
+        org_id="2",
+        data={
+            "metadata": {
+                "task": "query",
+                "id": "6580d48f457d7b000b7bee2c",
+                "query": "select sum(amount) as spend, date_trunc('month', created_at) as month from transactions group by month order by max(created_at);",
+            }
+        },
+    )
+
+    assert "rows" in res
+    assert "fields" in res
+
+
+def test_creates_a_chart():
+    res = quill.query(
+        org_id="2",
+        data={
+            "metadata": {
+                "task": "create",
+                "dateField": {"table": "transactions", "field": "created_at"},
+                "query": "select sum(amount) as spend, date_trunc('month', created_at) as month from transactions group by month order by max(created_at);",
+                "name": "Total Spend Test",
+                "clientId": "62cda15d7c9fcca7bc0a3689",
+                "customerId": "2",
+                "xAxisField": "month",
+                "xAxisLabel": "month",
+                "yAxisFields": [
+                    {"field": "spend", "label": "spend", "format": "dollar_amount"}
+                ],
+                "yAxisLabel": "spend",
+                "chartType": "line",
+                "dashboardName": "spend",
+                "xAxisFormat": "MMM_yyyy",
+                "columns": [
+                    {"field": "spend", "label": "spend", "format": "dollar_amount"},
+                    {"field": "month", "label": "month", "format": "MMM_yyyy"},
+                ],
+            }
+        },
+    )
+
+    assert res is not None
+
+
+def test_returns_different_configs_for_different_org_ids():
+    data = {
+        "metadata": {
+            "task": "config",
+            "name": "spend",
+        }
+    }
+    res1 = quill.query(org_id="1", data=data)
+    res2 = quill.query(org_id="2", data=data)
+    assert res1 != res2
+
+
+def test_returns_different_items_for_different_org_ids():
+    data = {
+        "metadata": {
+            "task": "item",
+            "id": "6580d3aea2caa9000b1c1b06",
+            "filters": [],
+            "client_id": "62cda15d7c9fcca7bc0a3689",
+            "query": "select * from transactions",
+        }
+    }
+    res1 = quill.query(org_id="1", data=data)
+    res2 = quill.query(org_id="2", data=data)
+    assert res1 != res2
+
+
+def test_returns_different_query_data_for_different_org_ids():
+    data = {
+        "metadata": {
+            "task": "query",
+            "id": "6580d48f457d7b000b7bee2c",
+            "query": "select sum(amount) as spend, date_trunc('month', created_at) as month from transactions group by month order by max(created_at);",
+        }
+    }
+    res1 = quill.query(org_id="1", data=data)
+    res2 = quill.query(org_id="2", data=data)
+    assert res1 != res2
+
+
+def test_orgs_fails_with_no_client_id():
+    res = quill.query(
+        org_id="2",
+        data={
+            "metadata": {
+                "task": "orgs",
+                "id": "6580d3aea2caa9000b1c1b06",
+            }
+        },
+    )
+
+    assert res is not None
+    assert "errorMessage" in res
+
+
+def test_orgs_works_correctly_with_client_id():
+    res = quill.query(
+        org_id="2",
+        data={
+            "metadata": {
+                "task": "orgs",
+                "id": "6580d3aea2caa9000b1c1b06",
+                "clientId": "62cda15d7c9fcca7bc0a3689",
+            },
+        },
+    )
+
+    assert res is not None
+    assert "errorMessage" not in res
+    assert "orgs" in res
+
+
+def test_orgs_works_without_id():
+    res = quill.query(
+        org_id="2",
+        data={
+            "metadata": {
+                "task": "orgs",
+                "clientId": "62cda15d7c9fcca7bc0a3689",
+            }
+        },
+    )
+
+    assert res is not None
+    assert "errorMessage" not in res
+    assert "orgs" in res
+
+
+def test_view_fails_with_no_clientId():
+    res = quill.query(
+        org_id="2",
+        data={
+            "metadata": {
+                "task": "view",
+                "id": "6580d3aea2caa9000b1c1b06",
+            },
+        },
+    )
+
+    assert res is not None
+    assert "errorMessage" in res
+
+
+def test_view_works_correctly_with_clientId():
+    res = quill.query(
+        org_id="2",
+        data={
+            "metadata": {
+                "task": "view",
+                "id": "6580d3aea2caa9000b1c1b06",
+                "clientId": "62cda15d7c9fcca7bc0a3689",
+                "query": "select sum(amount) as spend, date_trunc('month', created_at) as month from transactions group by month order by max(created_at);",
+                "name": "Total Spend Test",
+                "deleted": False,
+            },
+        },
+    )
+
+    print(res)
+    assert res is not None
+    assert "errorMessage" not in res
+    assert "code" in res
+    assert "message" in res
+    assert res["code"] == 201
+    assert res["message"] == "OK"