Add changes for ArangoDB 3.7

Author: joowani

.gitignore

@@ -108,3 +108,9 @@ venv.bak/
 
 # PyCharm
 .idea/
+
+# ArangoDB Starter
+localdata/
+
+# Node Modules
+node_modules/

.travis.yml

@@ -1,23 +1,21 @@
 sudo: false
 language: python
-matrix:
-  include:
-    - python: 2.7
-    - python: 3.5
-    - python: 3.6
-    - python: 3.7
-      dist: xenial
-      sudo: true
+python:
+  - "2.7"
+  - "3.5"
+  - "3.6"
+  - "3.7"
+  - "3.8"
 services:
     - docker
 before_install:
-    - docker run --name arango -d -p 8529:8529 -e ARANGO_ROOT_PASSWORD=passwd arangodb/arangodb:3.6.1
+    - docker create --name arango -p 8529:8529 -e ARANGO_ROOT_PASSWORD=passwd arangodb/arangodb-preview:3.7-alpha.3 --server.jwt-secret-keyfile=/tmp/keyfile
     - docker cp tests/static/service.zip arango:/tmp/service.zip
+    - docker cp tests/static/keyfile arango:/tmp/keyfile
+    - docker start arango
 install:
     - pip install flake8 mock
-    - pip install pytest==3.5.1
-    - pip install pytest-cov==2.5.1
-    - pip install python-coveralls==2.9.1
+    - pip install pytest pytest-cov coveralls
     - pip install sphinx sphinx_rtd_theme
     - pip install .
 script:

README.rst

@@ -34,28 +34,15 @@
 
 Welcome to the GitHub page for **python-arango**, a Python driver for ArangoDB_.
 
-Announcements
-=============
-
-- Python-arango version `5.0.0`_ is finally up! This release supports ArangoDB
-  version 3.5+ only. It also breaks backward-compatibility and you must make
-  changes in your application code. Please see the releases_ page for details.
-
-Features
-========
-
-- Pythonic interface
-- Lightweight
-- High API coverage
-
 Compatibility
 =============
 
-- Python versions 2.7, 3.5, 3.6 and 3.7 are supported
-- Python-arango 5.x supports ArangoDB 3.5+
-- Python-arango 4.x supports ArangoDB 3.3 ~ 3.4 only
-- Python-arango 3.x supports ArangoDB 3.0 ~ 3.2 only
-- Python-arango 2.x supports ArangoDB 1.x ~ 2.x only
+- Python versions 2.7+ and 3.5+ are supported
+- Python-arango 6.x supports ArangoDB 3.7+
+- Python-arango 5.x supports ArangoDB 3.5 ~ 3.6
+- Python-arango 4.x supports ArangoDB 3.3 ~ 3.4
+- Python-arango 3.x supports ArangoDB 3.0 ~ 3.2
+- Python-arango 2.x supports ArangoDB 1.x ~ 2.x
 
 Installation
 ============

arango/client.py

@@ -6,7 +6,11 @@
 
 __all__ = ['ArangoClient']
 
-from arango.connection import Connection
+from arango.connection import (
+    BasicConnection,
+    JWTConnection,
+    JWTSuperuserConnection
+)
 from arango.database import StandardDatabase
 from arango.exceptions import ServerConnectionError
 from arango.http import DefaultHTTPClient
@@ -85,7 +89,13 @@ def version(self):
         """
         return __version__
 
-    def db(self, name='_system', username='root', password='', verify=False):
+    def db(self,
+           name='_system',
+           username='root',
+           password='',
+           verify=False,
+           auth_method='basic',
+           superuser_token=None):
         """Connect to an ArangoDB database and return the database API wrapper.
 
         :param name: Database name.
@@ -96,22 +106,58 @@ def db(self, name='_system', username='root', password='', verify=False):
         :type password: str | unicode
         :param verify: Verify the connection by sending a test request.
         :type verify: bool
+        :param auth_method: HTTP authentication method. Accepted values are
+            "basic" (default) and "jwt". If set to "jwt", the token is
+            refreshed automatically using ArangoDB username and password. This
+            assumes that the clocks of the server and client are synchronized.
+        :type auth_method: str | unicode
+        :param superuser_token: User generated token for superuser access.
+            If set, parameters **username**, **password** and **auth_method**
+            are ignored. This token is not refreshed automatically.
+        :type superuser_token: str | unicode
         :return: Standard database API wrapper.
         :rtype: arango.database.StandardDatabase
         :raise arango.exceptions.ServerConnectionError: If **verify** was set
             to True and the connection fails.
         """
-        connection = Connection(
-            hosts=self._hosts,
-            host_resolver=self._host_resolver,
-            sessions=self._sessions,
-            db_name=name,
-            username=username,
-            password=password,
-            http_client=self._http,
-            serializer=self._serializer,
-            deserializer=self._deserializer
-        )
+        if superuser_token is not None:
+            connection = JWTSuperuserConnection(
+                hosts=self._hosts,
+                host_resolver=self._host_resolver,
+                sessions=self._sessions,
+                db_name=name,
+                http_client=self._http,
+                serializer=self._serializer,
+                deserializer=self._deserializer,
+                superuser_token=superuser_token
+            )
+        elif auth_method == 'basic':
+            connection = BasicConnection(
+                hosts=self._hosts,
+                host_resolver=self._host_resolver,
+                sessions=self._sessions,
+                db_name=name,
+                username=username,
+                password=password,
+                http_client=self._http,
+                serializer=self._serializer,
+                deserializer=self._deserializer,
+            )
+        elif auth_method == 'jwt':
+            connection = JWTConnection(
+                hosts=self._hosts,
+                host_resolver=self._host_resolver,
+                sessions=self._sessions,
+                db_name=name,
+                username=username,
+                password=password,
+                http_client=self._http,
+                serializer=self._serializer,
+                deserializer=self._deserializer,
+            )
+        else:
+            raise ValueError('invalid auth_method: {}'.format(auth_method))
+
         if verify:
             try:
                 connection.ping()

arango/cluster.py

@@ -4,11 +4,14 @@
 
 from arango.api import APIWrapper
 from arango.exceptions import (
+    ClusterEndpointsError,
     ClusterHealthError,
     ClusterMaintenanceModeError,
+    ClusterServerEngineError,
     ClusterServerIDError,
     ClusterServerRoleError,
-    ClusterStatisticsError,
+    ClusterServerStatisticsError,
+    ClusterServerVersionError,
 )
 from arango.request import Request
 
@@ -42,7 +45,7 @@ def server_role(self):
 
         :return: Server role. Possible values are "SINGLE" (server which is
             not in a cluster), "COORDINATOR" (cluster coordinator), "PRIMARY",
-            "SECONDARY", "AGENT" (Agency node in a cluster) or "UNDEFINED".
+            "SECONDARY", "AGENT" (Agency server in a cluster) or "UNDEFINED".
         :rtype: str | unicode
         :raise arango.exceptions.ClusterServerRoleError: If retrieval fails.
         """
@@ -58,25 +61,70 @@ def response_handler(resp):
 
         return self._execute(request, response_handler)
 
-    def statistics(self, server_id):
-        """Return the cluster statistics for the given server.
+    def server_version(self, server_id):
+        """Return the version of the given server.
 
         :param server_id: Server ID.
         :type server_id: str | unicode
-        :return: Cluster statistics for the given server.
+        :return: Version of the given server.
         :rtype: dict
-        :raise arango.exceptions.ClusterStatisticsError: If retrieval fails.
+        :raise arango.exceptions.ClusterServerVersionError: If retrieval fails.
         """
         request = Request(
             method='get',
-            endpoint='/_admin/clusterStatistics',
-            params={'DBserver': server_id}
+            endpoint='/_admin/cluster/nodeVersion',
+            params={'ServerID': server_id}
         )
 
         def response_handler(resp):
             if resp.is_success:
                 return resp.body
-            raise ClusterStatisticsError(resp, request)
+            raise ClusterServerVersionError(resp, request)
+
+        return self._execute(request, response_handler)
+
+    def server_engine(self, server_id):
+        """Return the engine details for the given server.
+
+        :param server_id: Server ID.
+        :type server_id: str | unicode
+        :return: Engine details of the given server.
+        :rtype: dict
+        :raise arango.exceptions.ClusterServerEngineError: If retrieval fails.
+        """
+        request = Request(
+            method='get',
+            endpoint='/_admin/cluster/nodeEngine',
+            params={'ServerID': server_id}
+        )
+
+        def response_handler(resp):
+            if resp.is_success:
+                return resp.body
+            raise ClusterServerEngineError(resp, request)
+
+        return self._execute(request, response_handler)
+
+    def server_statistics(self, server_id):
+        """Return the statistics for the given server.
+
+        :param server_id: Server ID.
+        :type server_id: str | unicode
+        :return: Statistics for the given server.
+        :rtype: dict
+        :raise arango.exceptions.ClusterServerStatisticsError: If retrieval
+            fails.
+        """
+        request = Request(
+            method='get',
+            endpoint='/_admin/cluster/nodeStatistics',
+            params={'ServerID': server_id}
+        )
+
+        def response_handler(resp):
+            if resp.is_success:
+                return resp.body
+            raise ClusterServerStatisticsError(resp, request)
 
         return self._execute(request, response_handler)
 
@@ -122,3 +170,22 @@ def response_handler(resp):
             raise ClusterMaintenanceModeError(resp, request)
 
         return self._execute(request, response_handler)
+
+    def endpoints(self):
+        """Return coordinate endpoints. This method is for clusters only.
+
+        :return: List of endpoints.
+        :rtype: [str | unicode]
+        :raise arango.exceptions.ServerEndpointsError: If retrieval fails.
+        """
+        request = Request(
+            method='get',
+            endpoint='/_api/cluster/endpoints'
+        )
+
+        def response_handler(resp):
+            if not resp.is_success:
+                raise ClusterEndpointsError(resp, request)
+            return [item['endpoint'] for item in resp.body['endpoints']]
+
+        return self._execute(request, response_handler)