Merge pull request #5 from rliebz/test

merging changes that may put master in to an unstable state for the time being

Author: codersquid

.gitignore

@@ -1,3 +1,6 @@
 .vagrant
 .DS_Store
 *pyc
+.idea/
+.cache/
+*~

dvn_client/src/requirements.txt __init__.pydvn_client/src/requirements.txt renamed to __init__.py

@@ -0,0 +1 @@
+__author__ = 'RLiebowitz'

dvn_client/__init__.py

@@ -0,0 +1,49 @@
+<?xml version="1.0"?>
+<!--
+modified from http://swordapp.github.io/SWORDv2-Profile/SWORDProfile.html#protocoloperations_editingcontent_metadata
+-->
+<entry xmlns="http://www.w3.org/2005/Atom"
+       xmlns:dcterms="http://purl.org/dc/terms/">
+    <!-- some embedded metadata -->
+    <dcterms:title>Roasting at Home</dcterms:title>
+    <dcterms:creator>Peets, John</dcterms:creator>
+    <dcterms:creator>Stumptown, Jane</dcterms:creator>
+
+    <!-- Producer with financial or admin responsibility of the data -->
+    <dcterms:publisher>Coffee Bean State University</dcterms:publisher>
+
+    <!-- related publications -->
+    <dcterms:isReferencedBy holdingsURI="http://dx.doi.org/10.1038/dvn333" agency="DOI"
+        IDNo="10.1038/dvn333">Peets, J., &amp; Stumptown, J. (2013). Roasting at Home. New England Journal of Coffee, 3(1), 22-34.</dcterms:isReferencedBy>
+
+    <!-- production date -->
+    <dcterms:date>2013-07-11</dcterms:date>
+
+    <!-- Other Identifier for the data in this study (or potentially global id if unused) -->
+    <dcterms:identifier>doi:10.1000/182</dcterms:identifier>
+    <!-- <dcterms:identifier>hdl:1XXZY.1/XYXZ</dcterms:identifier> -->
+
+    <dcterms:description>Considerations before you start roasting your own coffee at home.</dcterms:description>
+
+    <!-- keywords -->
+    <dcterms:subject>coffee</dcterms:subject>
+    <dcterms:subject>beverage</dcterms:subject>
+    <dcterms:subject>caffeine</dcterms:subject>
+
+    <!-- geographic coverage -->
+    <dcterms:coverage>United States</dcterms:coverage>
+    <dcterms:coverage>Canada</dcterms:coverage>
+    <!-- kind of data -->
+    <dcterms:type>aggregate data</dcterms:type>
+    <!-- List of sources of the data collection-->
+    <dcterms:source>Stumptown, Jane. 2011. Home Roasting. Coffeemill Press.</dcterms:source>
+    <!-- restrictions -->
+    <dcterms:rights>Creative Commons CC-BY 3.0 (unported) http://creativecommons.org/licenses/by/3.0/</dcterms:rights>
+    <!-- related materials -->
+    <dcterms:relation>Peets, John. 2010. Roasting Coffee at the Coffee Shop. Coffeemill Press</dcterms:relation>
+
+
+    <!-- unsupported fields! -->
+    <dcterms:abstract>A real abstract!</dcterms:abstract>
+    <dcterms:bibliographicCitation>Insert Journal Article Citation from OJS</dcterms:bibliographicCitation>
+</entry>

dvn_client/resources/atom-example.xml

@@ -1,2 +1 @@
-# To change this template, choose Tools | Templates
-# and open the template in the editor.
+__author__ = 'RLiebowitz'

dvn_client/src/__init__.py

@@ -16,14 +16,16 @@
 #local modules
 from dataverse import Dataverse
 
+
 class DvnConnection(object):
     # todo add port number
     def __init__(self, username, password, host, cert=None, sdUriOverride=None):
         # Connection Properties
         self.username = username
         self.password = password
         self.host = host
-        self.sdUri = "https://{host}/dvn/api/data-deposit/v1/swordv2/service-document".format(host=self.host) if not sdUriOverride else sdUriOverride.format(host=self.host)
+        self.sdUri = "https://{host}/dvn/api/data-deposit/v1/swordv2/service-document".format(host=self.host) \
+            if not sdUriOverride else sdUriOverride.format(host=self.host)
         self.cert = cert
 
         # Connection Status and SWORD Properties
@@ -39,10 +41,12 @@ def __init__(self, username, password, host, cert=None, sdUriOverride=None):
 
     # todo raise exception if connection fails?
     def _connect(self):
-        self.swordConnection = sword2.Connection(self.sdUri, 
-                      user_name = self.username,
-                      user_pass = self.password, 
-                      ca_certs = self.cert)
+        self.swordConnection = sword2.Connection(
+            service_document_iri=self.sdUri,
+            user_name=self.username,
+            user_pass=self.password,
+            ca_certs=self.cert,
+        )
 
         self.serviceDocument = self.swordConnection.get_service_document()
         self.connected = True

dvn_client/src/config.py

@@ -4,10 +4,10 @@
 # python base lib modules
 import pprint
 
-#downloaded modules
+# downloaded modules
 from lxml import etree
 
-#local modules
+# local modules
 from study import Study
 import utils
 
@@ -29,14 +29,15 @@ def is_released(self):
             collectionInfo,
             namespace="http://purl.org/net/sword/terms/state",
             tag="dataverseHasBeenReleased",
-            numberOfElements=1
+            numberOfElements=1,
         ).text
         return bool(status)
 
-    def add_study(self, study):        
+    def add_study(self, study):
+        # this creates the study AND generates a deposit receipt
         depositReceipt = self.connection.swordConnection.create(
+            col_iri=self.collection.href,
             metadata_entry=study.entry,
-            col_iri=self.collection.href
         )
 
         study.hostDataverse = self
@@ -45,6 +46,9 @@ def add_study(self, study):
 
     def delete_study(self, study):
         depositReceipt = self.connection.swordConnection.delete(study.editUri)
+        study.lastDepositReceipt = depositReceipt
+
+        # todo: Is this used? Should it be? Other ways to handle this?
         study.isDeleted = True
 
     # Note: Functionality removed
@@ -66,13 +70,13 @@ def get_studies(self):
         studiesResponse = self.connection.swordConnection.get_resource(self.collection.href)
 
         return [
-            Study.CreateStudyFromEntryElement(element, hostDataverse=self)
+            Study.from_entry_element(element, hostDataverse=self)
             for element in utils.get_elements(studiesResponse.content, tag='entry')
         ]
         # # get all the entry nodes and parse them into study objects
         # studies = []
         # for element in utils.get_elements(studiesResponse.content, tag="entry"):
-        #     s = Study.CreateStudyFromEntryElement(element, hostDataverse=self)
+        #     s = Study.from_entry_element(element, hostDataverse=self)
         #     studies.append(s)
         #
         # return studies

dvn_client/src/connection.py

@@ -0,0 +1 @@
+__author__ = 'RLiebowitz'

dvn_client/src/dataverse.py

@@ -0,0 +1,23 @@
+DEFAULT_USERNAME = "rliebz"
+DEFAULT_PASSWORD = "other"
+DEFAULT_HOST = "dvn-4.hmdc.harvard.edu"
+DEFAULT_CERT = "dvn_client/resources/dvn-4.hmdc.harvard.edu"
+
+EXAMPLE_DICT = {
+    "title" : "ExampleTitle",
+    "id" : "ExampleID",
+    "author" : ["ExampleAuthor1", "ExampleAuthor2"],
+    "producer" : "ExampleProducer",
+    "date" : "1992-10-04",
+    "description" : "ExampleDescription",
+    "abstract" : "ExampleAbstract",
+    "type" : "ExampleType",
+    "source" : "ExampleSource",
+    "restriction" : "ExampleRestriction",
+    "relation" : "ExampleRelation",
+    "keyword" : "ExampleKeyword",
+    "coverage" : "ExampleCoverage",
+    "publication" : "ExamplePublication",
+}
+
+EXAMPLE_FILE = "dvn_client/resources/atom-example.xml"