Add schema error codes, documentation and other misc things

Author: joowani

README.rst

@@ -60,12 +60,18 @@ To install a stable version from PyPi_:
     ~$ pip install python-arango
 
 
-To install the latest version directly from GitHub_:
+To install the latest version from GitHub_:
 
 .. code-block:: bash
 
     ~$ pip install -e [email protected]:joowani/python-arango.git@master#egg=python-arango
 
+To install experimental version from GitHub_:
+
+.. code-block:: bash
+
+    ~$ pip install -e [email protected]:joowani/python-arango.git@dev#egg=python-arango
+
 You may need to use ``sudo`` depending on your environment.
 
 Getting Started
@@ -172,4 +178,4 @@ Please take a look at this page_ before submitting a pull request. Thanks!
     http://python-driver-for-arangodb.readthedocs.io/en/master/index.html
 .. _page:
     http://python-driver-for-arangodb.readthedocs.io/en/master/contributing.html
-.. _aioarangodb: https://github.com/bloodbare/aioarangodb
+.. _aioarangodb: https://github.com/bloodbare/aioarangodb

arango/client.py

@@ -131,7 +131,7 @@ def db(self,
                 deserializer=self._deserializer,
                 superuser_token=superuser_token
             )
-        elif auth_method == 'basic':
+        elif auth_method.lower() == 'basic':
             connection = BasicConnection(
                 hosts=self._hosts,
                 host_resolver=self._host_resolver,
@@ -143,7 +143,7 @@ def db(self,
                 serializer=self._serializer,
                 deserializer=self._deserializer,
             )
-        elif auth_method == 'jwt':
+        elif auth_method.lower() == 'jwt':
             connection = JWTConnection(
                 hosts=self._hosts,
                 host_resolver=self._host_resolver,

arango/errno.py

@@ -682,6 +682,16 @@
 # Concurrent request still using the cursor.
 CURSOR_BUSY = 1601
 
+##############################
+# ArangoDB Validation Errors #
+##############################
+
+# Document does not pass schema validation.
+VALIDATION_FAILED = 1620
+
+# Schema description is invalid.
+VALIDATION_BAD_PARAMETER = 1621
+
 ###############################
 # ArangoDB Transaction Errors #
 ###############################

docs/admin.rst

@@ -61,14 +61,31 @@ database.
     sys_db.metrics()
 
 
-You can also access or hot-reload JWT secrets (enterprise edition only):
+Features available in enterprise edition only:
 
 .. code-block:: python
 
-    # Retrieve JWT secrets
+    from arango import ArangoClient
+
+    # Initialize the ArangoDB client.
+    client = ArangoClient()
+
+    # Connect to "_system" database as root user using JWT authentication.
+    sys_db = client.db(
+        '_system',
+        username='root',
+        password='passwd',
+        auth_method='jwt'
+    )
+
+    # Retrieve JWT secrets.
     sys_db.jwt_secrets()
 
-    # Hot-reload JWT secrets
+    # Hot-reload JWT secrets.
     sys_db.reload_jwt_secrets()
 
-See :ref:`StandardDatabase` for API specification.
+    # Rotate the user-supplied keys for encryption.
+    sys_db.encryption()
+
+
+See :ref:`StandardDatabase` for API specification.

docs/async.rst

@@ -5,8 +5,7 @@ In **asynchronous execution**, python-arango sends API requests to ArangoDB in
 fire-and-forget style. The server processes the requests in the background, and
 the results can be retrieved once available via :ref:`AsyncJob` objects.
 
-**Example
-:**
+**Example:**
 
 .. testcode::
 

docs/cluster.rst

@@ -80,7 +80,8 @@ Below is an example on how to manage clusters using python-arango.
     # Get the cluster health.
     cluster.health()
 
-    # Get details for a specific server in the cluster.
+    # Get cluster server details.
+    cluster.server_count()
     server_id = cluster.server_id()
     cluster.server_engine(server_id)
     cluster.server_version(server_id)

docs/index.rst

@@ -24,12 +24,18 @@ To install a stable version from PyPi_:
     ~$ pip install python-arango
 
 
-To install the latest version directly from GitHub_:
+To install the latest version from GitHub_:
 
 .. code-block:: bash
 
     ~$ pip install -e [email protected]:joowani/python-arango.git@master#egg=python-arango
 
+To install experimental version from GitHub_:
+
+.. code-block:: bash
+
+    ~$ pip install -e [email protected]:joowani/python-arango.git@dev#egg=python-arango
+
 
 You may need to use ``sudo`` depending on your environment.
 
@@ -48,6 +54,7 @@ Contents
     database
     collection
     document
+    schema
     indexes
     graph
     aql

docs/schema.rst

@@ -0,0 +1,38 @@
+Schema Validation
+-----------------
+
+ArangoDB supports document validation using JSON schemas. You can use this
+feature by providing a schema during collection creation using the ``schema``
+parameter.
+
+**Example:**
+
+.. testcode::
+
+    from arango import ArangoClient
+
+    # Initialize the ArangoDB client.
+    client = ArangoClient()
+
+    # Connect to "test" database as root user.
+    db = client.db('test', username='root', password='passwd')
+
+    # Create a new collection named "employees".
+    if db.has_collection('employees'):
+        db.delete_collection('employees')
+
+    employees = db.create_collection(
+        name='employees',
+        schema={
+            'rule': {
+                'type': 'object',
+                'properties': {
+                    'name': {'type': 'string'},
+                    'email': {'type': 'string'}
+                },
+                'required': ['name', 'email']
+            },
+            'level': 'moderate',
+            'message': 'Schema Validation Failed.'
+        }
+    )