Refactor getting service document and add Connection tests

Author: rliebz

dataverse/connection.py

@@ -12,23 +12,27 @@ def __init__(self, host, token):
         self.token = token
         self.host = host
         self.sd_uri = 'https://{host}/dvn/api/data-deposit/v1.1/swordv2/service-document'.format(host=self.host)
-        self.service_document = None
+        self._service_document = None
 
-        self.connect()
+        self.get_service_document()
 
     @property
     def auth(self):
         return self.token, None
 
-    def connect(self):
+    def get_service_document(self, refresh=False):
+        if not refresh and self._service_document:
+            return self._service_document
+
         resp = requests.get(self.sd_uri, auth=self.auth)
 
         if resp.status_code == 403:
             raise exceptions.UnauthorizedError('The credentials provided are invalid.')
         elif resp.status_code != 200:
             raise exceptions.ConnectionError('Could not connect to the Dataverse')
 
-        self.service_document = etree.XML(resp.content)
+        self._service_document = etree.XML(resp.content)
+        return self._service_document
 
     def create_dataverse(self, alias, name, email, parent=':root'):
         resp = requests.post(
@@ -46,6 +50,8 @@ def create_dataverse(self, alias, name, email, parent=':root'):
         elif resp.status_code != 201:
             raise exceptions.OperationFailedError('{0} Dataverse could not be created.'.format(name))
 
+        self.get_service_document(refresh=True)
+
     def delete_dataverse(self, alias):
         resp = requests.delete(
             'https://{0}/api/dataverses/{1}'.format(self.host, alias),
@@ -59,12 +65,11 @@ def delete_dataverse(self, alias):
         elif resp.status_code != 200:
             raise exceptions.OperationFailedError('Dataverse {0} could not be deleted.'.format(alias))
 
-    def get_dataverses(self, refresh=False):
-        if refresh:
-            self.connect()
+        self.get_service_document(refresh=True)
 
+    def get_dataverses(self, refresh=False):
         collections = get_elements(
-            self.service_document[0],
+            self.get_service_document(refresh)[0],
             tag='collection',
         )
 

dataverse/test/test_dataverse.py

@@ -69,7 +69,7 @@ def test_connect(self):
 
         assert connection.host == TEST_HOST
         assert connection.token == TEST_TOKEN
-        assert connection.service_document
+        assert connection._service_document
 
     def test_connect_unauthorized(self):
         with pytest.raises(exceptions.UnauthorizedError):
@@ -116,6 +116,47 @@ def test_delete_dataverse(self):
 
         assert dataverse is None
 
+    def test_get_dataverses(self):
+        connection = Connection(TEST_HOST, TEST_TOKEN)
+        original_dataverses = connection.get_dataverses()
+        assert isinstance(original_dataverses, list)
+
+        alias = str(uuid.uuid1())   # must be unique
+
+        connection.create_dataverse(
+            alias,
+            'Test Name',
+            'dataverse@example.com',
+        )
+
+        current_dataverses = connection.get_dataverses()
+        try:
+            assert len(current_dataverses) == len(original_dataverses) + 1
+            assert alias in [dataverse.alias for dataverse in current_dataverses]
+        finally:
+            connection.delete_dataverse(alias)
+
+        current_dataverses = connection.get_dataverses()
+        assert [dataverse.alias for dataverse in current_dataverses] == [dataverse.alias for dataverse in original_dataverses]
+
+    def test_get_dataverse(self):
+        connection = Connection(TEST_HOST, TEST_TOKEN)
+        alias = str(uuid.uuid1())   # must be unique
+        assert connection.get_dataverse(alias) is None
+
+        connection.create_dataverse(
+            alias,
+            'Test Name',
+            'dataverse@example.com',
+        )
+
+        dataverse = connection.get_dataverse(alias)
+        try:
+            assert dataverse is not None
+            assert dataverse.alias == alias
+        finally:
+            connection.delete_dataverse(alias)
+
 
 class TestDataset(object):