Final alpha release

Complete all abstract class for each package.
Complete all tests.

Author: MatteoGuadrini

README.md

@@ -138,6 +138,12 @@ Exception
 
 `Connection` objects should respond to the following methods.
 
+#### Connection attributes
+
+`.connected`
+
+This read-only attribute contains a boolean value.
+
 #### Connection methods
 
 `.close()`
@@ -164,6 +170,10 @@ Deleting of a single database with position and keyword arguments.
 
 List all databases.
 
+`.show_database(parameters...)`
+
+Show an information of a specific database
+
 ### Session Objects
 
 `Session` objects should respond to the following methods.

__info__.py

@@ -22,7 +22,7 @@
 
 """Information variable used by modules on this package."""
 
-__version__ = '0.0.6'
+__version__ = '0.0.7'
 __author__ = 'Matteo Guadrini'
 __email__ = '[email protected]'
 __homepage__ = 'https://github.com/MatteoGuadrini/nosqlapi'

nosqlapi/__init__.py

@@ -23,6 +23,7 @@
 """Python NOSQL Database library."""
 
 from nosqlapi.common.exception import *
+from nosqlapi.common.core import Connection, Session, Selector, Response, Batch
 from nosqlapi.kvdb import KVConnection, KVSelector, KVSession, KVResponse, KVBatch
 from nosqlapi.columndb import ColumnConnection, ColumnSelector, ColumnSession, ColumnResponse, ColumnBatch
 from nosqlapi.docdb import DocConnection, DocSelector, DocSession, DocResponse, DocBatch

nosqlapi/common/core.py

@@ -24,23 +24,35 @@
 from abc import ABC, abstractmethod
 from .exception import *
 
+# endregion
+
+# region global variables
+API_NAME = 'nosqlapi'
+
 
 # endregion
 
 # region classes
 class Connection(ABC):
     """Server connection abstract class"""
 
+    def __init__(self):
+        self._connected = False
+
+    @property
+    def connected(self):
+        return bool(self._connected)
+
     @abstractmethod
-    def close(self):
+    def close(self, *args, **kwargs):
         """Delete this object
 
         :return: None
         """
         pass
 
     @abstractmethod
-    def connect(self):
+    def connect(self, *args, **kwargs):
         """Connect database server
 
         :return: Session object
@@ -72,13 +84,37 @@ def delete_database(self, *args, **kwargs):
         pass
 
     @abstractmethod
-    def databases(self):
+    def databases(self, *args, **kwargs):
         """Get all databases
 
         :return: Response
         """
         pass
 
+    @abstractmethod
+    def show_database(self, *args, **kwargs):
+        """Show a database information
+
+        :return : Response object
+        """
+        pass
+
+    def __repr__(self):
+        return f"<{API_NAME} {self.__class__.__name__} object>"
+
+    def __str__(self):
+        return f"{repr(self)}, connected={self.connected}"
+
+    def __bool__(self):
+        if self.connected:
+            return True
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        self.close()
+
 
 class Selector(ABC):
     """Selector abstract class"""
@@ -140,13 +176,23 @@ def limit(self, value):
         self._limit = value
 
     @abstractmethod
-    def build(self):
+    def build(self, *args, **kwargs):
         """Build string query selector
 
         :return: string
         """
         pass
 
+    def __repr__(self):
+        return f"<{API_NAME} {self.__class__.__name__} object>"
+
+    def __str__(self):
+        return self.build()
+
+    def __bool__(self):
+        if self.selector:
+            return True
+
 
 class Session(ABC):
     """Server session abstract class"""
@@ -222,7 +268,7 @@ def delete(self, *args, **kwargs):
         pass
 
     @abstractmethod
-    def close(self):
+    def close(self, *args, **kwargs):
         """Delete session
 
         :return: None
@@ -253,6 +299,22 @@ def revoke(self, *args, **kwargs):
         """
         pass
 
+    def __repr__(self):
+        return f"<{API_NAME} {self.__class__.__name__} object>"
+
+    def __str__(self):
+        return f"database={self.database}, description={self.description}"
+
+    def __bool__(self):
+        if self.description:
+            return True
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        self.close()
+
 
 class Response(ABC):
     """Server response abstract class"""
@@ -291,7 +353,7 @@ def __str__(self):
         return str(self.data)
 
     def __repr__(self):
-        return f'<class {self.__class__.__name__}: data={type(self.data)}, code={self.code}, error={self.error}>'
+        return f"<{API_NAME} {self.__class__.__name__} object>"
 
     def __contains__(self, item):
         return True if item in self.data else False
@@ -330,4 +392,14 @@ def execute(self, *args, **kwargs):
         """
         pass
 
+    def __repr__(self):
+        return f"<{API_NAME} {self.__class__.__name__} object>"
+
+    def __str__(self):
+        return str(self.batch)
+
+    def __bool__(self):
+        if self.batch:
+            return True
+
 # endregion

nosqlapi/docdb/client.py

@@ -38,17 +38,9 @@
 class DocConnection(Connection, ABC):
     """Document NOSQL database Connection class"""
 
-    def __init__(self,
-                 host=None,
-                 port=None,
-                 username=None,
-                 password=None,
-                 ssl=None,
-                 tls=None,
-                 cert=None,
-                 ca_cert=None,
-                 ca_bundle=None
-                 ):
+    def __init__(self, host=None, port=None, username=None, password=None, ssl=None, tls=None, cert=None, ca_cert=None,
+                 ca_bundle=None):
+        super().__init__()
         self.host = host
         self.port = port
         self.username = username

nosqlapi/graphdb/client.py

@@ -38,18 +38,9 @@
 class GraphConnection(Connection, ABC):
     """Graph NOSQL database Connection class"""
 
-    def __init__(self,
-                 host=None,
-                 port=None,
-                 database=None,
-                 username=None,
-                 password=None,
-                 ssl=None,
-                 tls=None,
-                 cert=None,
-                 ca_cert=None,
-                 ca_bundle=None
-                 ):
+    def __init__(self, host=None, port=None, database=None, username=None, password=None, ssl=None, tls=None, cert=None,
+                 ca_cert=None, ca_bundle=None):
+        super().__init__()
         self.host = host
         self.port = port
         self.database = database

nosqlapi/kvdb/client.py

@@ -38,18 +38,9 @@
 class KVConnection(Connection, ABC):
     """Key-value NOSQL database Connection class"""
 
-    def __init__(self,
-                 host=None,
-                 port=None,
-                 database=None,
-                 username=None,
-                 password=None,
-                 ssl=None,
-                 tls=None,
-                 cert=None,
-                 ca_cert=None,
-                 ca_bundle=None
-                 ):
+    def __init__(self, host=None, port=None, database=None, username=None, password=None, ssl=None, tls=None, cert=None,
+                 ca_cert=None, ca_bundle=None):
+        super().__init__()
         self.host = host
         self.port = port
         self.database = database

setup.py

@@ -0,0 +1,27 @@
+from setuptools import setup
+import __info__
+
+with open("README.md") as fh:
+    long_description = fh.read()
+
+setup(
+    name='nosqlapi',
+    version=__info__.__version__,
+    packages=['nosqlapi', 'nosqlapi.kvdb', 'nosqlapi.docdb', 'nosqlapi.common', 'nosqlapi.graphdb',
+              'nosqlapi.columndb'],
+    url=__info__.__homepage__,
+    license='GNU General Public License v3.0',
+    author=__info__.__author__,
+    author_email=__info__.__email__,
+    maintainer=__info__.__author__,
+    maintainer_email=__info__.__email__,
+    description='nosqlapi is a library for building standard NOSQL python libraries.',
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    classifiers=[
+            "Programming Language :: Python :: 3",
+            "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+            "Operating System :: OS Independent",
+        ],
+    python_requires='>=3.6'
+)

tests/test_columndb.py

@@ -91,7 +91,7 @@ def delete_database(self, name, exists=False):
 
     def databases(self):
         if self.connection:
-            self.connection.send(f"DESCRIBE keyspaces;")
+            self.connection.send(f"DESCRIBE KEYSPACES;")
             # while len(self.t.recv(2048)) > 0:
             self.t.recv = mock.MagicMock(return_value='test_db db1 db2')
             self._return_data = self.t.recv(2048)
@@ -101,6 +101,18 @@ def databases(self):
         else:
             raise ConnectError(f"Server isn't connected")
 
+    def show_database(self, name):
+        if self.connection:
+            self.connection.send(f"DESCRIBE KEYSPACE {name};")
+            # while len(self.t.recv(2048)) > 0:
+            self.t.recv = mock.MagicMock(return_value='table1 table2 table3')
+            self._return_data = self.t.recv(2048)
+            if not self:
+                raise DatabaseError(f'Request error: {self.return_data}')
+            return MyDBResponse(self.return_data.split())
+        else:
+            raise ConnectError(f"Server isn't connected")
+
 
 class MyDBSession(nosqlapi.columndb.ColumnSession):
 
@@ -386,6 +398,17 @@ def test_columndb_get_all_database(self):
         self.assertEqual(myconn.return_data, 'CLOSED')
         self.assertRaises(ConnectError, myconn.databases)
 
+    def test_columndb_show_database(self):
+        myconn = MyDBConnection('mycolumndb.local', 12345, username='admin', password='pass', database='test_db')
+        myconn.connect()
+        self.assertEqual(myconn.return_data, 'OK_PACKET')
+        dbs = myconn.show_database('test_db')
+        self.assertIsInstance(dbs, MyDBResponse)
+        self.assertEqual(dbs.data, ['table1', 'table2', 'table3'])
+        myconn.close()
+        self.assertEqual(myconn.return_data, 'CLOSED')
+        self.assertRaises(ConnectError, myconn.databases)
+
 
 class ColumnSessionTest(unittest.TestCase):
     myconn = MyDBConnection('mycolumndb.local', 12345, username='admin', password='pass', database='test_db')

tests/test_docdb.py

@@ -88,6 +88,22 @@ def databases(self):
         else:
             raise ConnectError("server isn't connected")
 
+    def show_database(self, name):
+        self.req.get = mock.MagicMock(return_value={'body': '{"result": {"name": "test_db", "size": "0.4GB"}}',
+                                                    'status': 200,
+                                                    'header': '"Content-Type": [ "application/json" ]'})
+        if self.connection:
+            ret = self.req.get(f"{self.connection}/databases?name={name}")
+            dbs = json.loads(ret.get('body'))
+            if dbs['result']:
+                return MyDBResponse(dbs['result'],
+                                    ret['status'],
+                                    ret['header'])
+            else:
+                raise DatabaseError('no databases found on this server')
+        else:
+            raise ConnectError("server isn't connected")
+
 
 class MyDBSession(nosqlapi.docdb.DocSession):
     # Simulate http requests
@@ -337,6 +353,17 @@ def test_docdb_get_all_database(self):
         self.assertEqual(myconn.connection, None)
         self.assertRaises(ConnectError, myconn.databases)
 
+    def test_columndb_show_database(self):
+        myconn = MyDBConnection('mydocdb.local', 12345, username='admin', password='test')
+        myconn.connect()
+        self.assertEqual(myconn.connection, 'http://admin:[email protected]:12345')
+        dbs = myconn.show_database('test_db')
+        self.assertIsInstance(dbs, MyDBResponse)
+        self.assertEqual(dbs.data, {'name': 'test_db', 'size': '0.4GB'})
+        myconn.close()
+        self.assertEqual(myconn.connection, None)
+        self.assertRaises(ConnectError, myconn.databases)
+
 
 class DocSessionTest(unittest.TestCase):
     myconn = MyDBConnection('mydocdb.local', 12345, username='admin', password='test')