Improve organization of package.

Author: rliebz

dataverse/example/__init__.py

@@ -0,0 +1,6 @@
+from .defaults import *
+
+try:
+    from .local import *
+except ImportError as error:
+    pass

dataverse/example/dvn_example.py

@@ -1,7 +1,5 @@
-DEFAULT_USERNAME = "changeme"
-DEFAULT_PASSWORD = "changeme"
 DEFAULT_HOST = "dataverse-demo.iq.harvard.edu"
-DEFAULT_CERT = "dataverseclient/resources/dvn-4.hmdc.harvard.edu"
+DEFAULT_TOKEN = "changeme"
 
 EXAMPLE_DICT = {
     "title": "ExampleTitle",
@@ -20,8 +18,23 @@
     "publication": "ExamplePublication",
 }
 
+SWORD_BOOTSTRAP = """<?xml version="1.0"?>
+<entry xmlns="http://www.w3.org/2005/Atom"
+        xmlns:dcterms="http://purl.org/dc/terms/">
+</entry>"""
 
-try:
-    from local import *
-except ImportError:
-    pass
+SWORD_NAMESPACE = {
+    "dcterms": "http://purl.org/dc/terms/",
+    "atom": "http://www.w3.org/2005/Atom",
+}
+
+UNIQUE_FIELDS = ['title', 'id', 'updated', 'summary']
+
+REPLACEMENT_DICT = {
+    'id': 'identifier',
+    'author': 'creator',
+    'producer': 'publisher',
+    'restriction': 'rights',
+    'keyword': 'subject',
+    'publication': 'isReferencedBy'
+}

dataverse/resources/dvn-4.hmdc.harvard.edu

@@ -6,9 +6,11 @@
 import requests
 
 from file import DataverseFile
-from sword import SWORD_BOOTSTRAP
-from utils import get_element, get_elements, DataverseException, \
-    get_files_in_path, add_field
+from settings import SWORD_BOOTSTRAP
+from utils import (
+    get_element, get_elements, DataverseException, get_files_in_path,
+    add_field,
+)
 
 
 class Study(object):

dataverse/settings/__init__.py

@@ -1,11 +1,9 @@
 PICS_OF_CATS_STUDY = {
-    "id" : "1",
-    "title" : "This Study is about Pictures of Cats",
-    "author" : "Peter Bull",
-    "abstract" : "In this study we prove that there can be pictures of cats passed through the intertubes.",
+    "id": "1",
+    "title": "This Study is about Pictures of Cats",
+    "author": "Peter Bull",
+    "description": "In this study we prove there can be pictures of cats.",
 }
 
-INGEST_FILES = "../resources/sword_ingest.zip"
-
 ATOM_STUDY = "../resources/atom-entry-study.xml"
 

dataverse/example/config.py dataverse/settings/defaults.pydataverse/example/config.py renamed to dataverse/settings/defaults.py

@@ -1,5 +1,4 @@
 import sys
-from time import sleep
 import unittest
 
 import logging
@@ -8,7 +7,7 @@
 # local modules
 from dataverse.study import Study
 from dataverse.connection import Connection
-from dataverse.example.config import DEFAULT_USERNAME, DEFAULT_HOST, DEFAULT_PASSWORD
+from dataverse.settings import DEFAULT_TOKEN, DEFAULT_HOST
 from dataverse.test.config import PICS_OF_CATS_STUDY, ATOM_STUDY
 from dataverse import utils
 
@@ -46,15 +45,13 @@ def test_get_elements(self):
 
     def test_format_term(self):
         # A term not in the replacement dict
-        term = 'title'
-        formatted_term = utils.format_term(term)
-        self.assertEqual(formatted_term, 'dcterms_title')
+        formatted_term = utils.format_term('title', namespace='dcterms')
+        self.assertEqual(formatted_term, '{http://purl.org/dc/terms/}title')
 
     def test_format_term_replace(self):
         # A term in the replacement dict
-        term = 'id'
-        formatted_term = utils.format_term(term)
-        self.assertEqual(formatted_term, 'dcterms_identifier')
+        formatted_term = utils.format_term('id', namespace='dcterms')
+        self.assertEqual(formatted_term, '{http://purl.org/dc/terms/}identifier')
 
 
 class TestStudy(unittest.TestCase):
@@ -72,6 +69,7 @@ def test_init(self):
             tag='publisher'
         ).text
         self.assertEqual(title, 'My Study')
+        self.assertEqual(title, study.title)
         self.assertEqual(publisher, 'Mr. Pub Lisher')
 
     def test_init_from_xml(self):
@@ -91,20 +89,24 @@ def test_init_from_xml(self):
 
 
 class TestStudyOperations(unittest.TestCase):
+
     @classmethod
     def setUpClass(self):
-
         print "Connecting to DVN."
-        self.dvc = Connection(
-            username=DEFAULT_USERNAME,
-            password=DEFAULT_PASSWORD,
-            host=DEFAULT_HOST,
-            disable_ssl=True
-        )
+        self.dvc = Connection(DEFAULT_HOST, DEFAULT_TOKEN)
 
         print "Getting Dataverse"
-        self.dv = self.dvc.get_dataverses()[0]
-        self.dv.is_released
+        dataverses = self.dvc.get_dataverses()
+        if not dataverses:
+            raise utils.DataverseException(
+                'You must have a published Dataverse to run these tests.'
+            )
+
+        self.dv = dataverses[0]
+        if not self.dv.is_released:
+            raise utils.DataverseException(
+                'You must publish "{0}" to run these tests.'.format(self.dv.title)
+            )
 
         print "Removing any existing studies."
         studies = self.dv.get_studies()
@@ -114,9 +116,9 @@ def setUpClass(self):
         print 'Dataverse emptied.'
 
     def setUp(self):
-        #runs before each test method
+        # runs before each test method
 
-        #create a study for each test
+        # create a study for each test
         s = Study(**PICS_OF_CATS_STUDY)
         self.dv.add_study(s)
         doi = s.doi
@@ -138,17 +140,15 @@ def test_create_study_from_xml(self):
         self.dv.delete_study(retrieved_study)
 
     def test_add_files(self):
-        self.s.add_files(['test_dvn.py', 'config.py'])
-        sleep(3) #wait for ingest
+        self.s.add_files(['test_dataverse.py', 'config.py'])
         actual_files = [f.name for f in self.s.get_files()]
 
-        self.assertIn('test_dvn.py', actual_files)
+        self.assertIn('test_dataverse.py', actual_files)
         self.assertIn('config.py', actual_files)
 
     def test_upload_file(self):
         self.s.upload_file('file.txt', 'This is a simple text file!')
         self.s.upload_file('file2.txt', 'This is the second simple text file!')
-        sleep(3) #wait for ingest
         actual_files = [f.name for f in self.s.get_files()]
 
         self.assertIn('file.txt', actual_files)
@@ -191,7 +191,8 @@ def test_delete_a_study(self):
         self.dv.delete_study(atomStudy)
         self.assertEqual(atomStudy.get_state(refresh=True), 'DEACCESSIONED')
         self.assertEqual(len(self.dv.get_studies()), startingNumberOfStudies - 1)
-        
+
+    @unittest.skip('Released studies can no longer be deaccessioned via API')
     def test_release_study(self):
         self.assertTrue(self.s.get_state() == "DRAFT")
         self.s.release()

dataverse/study.py

@@ -3,7 +3,7 @@
 from lxml import etree
 import bleach
 
-from sword import SWORD_NAMESPACE, REPLACEMENT_DICT, UNIQUE_FIELDS
+from settings import SWORD_NAMESPACE, REPLACEMENT_DICT, UNIQUE_FIELDS
 
 
 class DataverseException(Exception):