Merge remote-tracking branch 'upstream/master'

Author: alexdutton

.gitignore

@@ -0,0 +1,7 @@
+.cache/
+build/
+dist/
+sword2.egg-info/
+*.pyc
+*.py~
+

sword2/connection.py

@@ -1644,8 +1644,6 @@ def get_deposit_receipt(self, edit_iri):
 defget_ore_sword_statement(self, sword_statement_iri):
 """
 Getting the Sword Statement.
-
-IN PROGRESS - USE AT OWN RISK.... see `sword2.Sword_Statement`.
  """
 # get the statement first
 conn_l.debug("Trying to GET the ORE Sword Statement at %s."%sword_statement_iri)
@@ -1664,8 +1662,6 @@ def get_ore_sword_statement(self, sword_statement_iri):
 defget_atom_sword_statement(self, sword_statement_iri):
 """
 Getting the Sword Statement.
-
-IN PROGRESS - USE AT OWN RISK.... see `sword2.Sword_Statement`.
  """
 # get the statement first
 conn_l.debug("Trying to GET the ATOM Sword Statement at %s."%sword_statement_iri)
@@ -1781,7 +1777,23 @@ def __init__(self, resp, content):
 # return self._return_error_or_exception(PackagingFormatNotAvailable, resp, content)
 else:
 returnself._handle_error_response(resp, content)
-
+
+defreplace_file(self, file_edit_media, payload, mimetype, packaging=None, on_behalf_of=None, metadata_relevant=False):
+"""
+ API Sugar for replacing any given file (such as that retrieved from a feed of the media resource)
+ This supports all the headers required by 6.11 of the spec
+ """
+returnself._make_request(file_edit_media, payload=payload, mimetype=mimetype, filename="unnamed",
+packaging=packaging, on_behalf_of=on_behalf_of, metadata_relevant=metadata_relevant,
+method="PUT")
+
+defdelete_file(self, file_edit_media, on_behalf_of=None):
+"""
+ API sugar for deleting a given file (such as that retrieved from a feed of the media resource).
+ This supports all the headers required by 6.11 of the spec
+ """
+returnself._make_request(file_edit_media, on_behalf_of=on_behalf_of, method="DELETE")
+
 def_normalise_mime(self, mime):
 ifmimeisNone:
 returnNone

sword2/error_document.py

@@ -7,6 +7,9 @@
 fromdeposit_receiptimportDeposit_Receipt
 fromserver_errorsimportSWORD2ERRORSBYIRI, get_error
 
+fromsword2_loggingimportlogging
+ed_l=logging.getLogger(__name__)
+
 classError_Document(Deposit_Receipt):
 """
 Example Error document:
@@ -47,22 +50,26 @@ class Error_Document(Deposit_Receipt):
 The server SHOULD specify that the Content-Type of the is text/xml or application/xml.
  """
 def__init__(self, xml_deposit_receipt=None, code=None, resp=None):
+ed_l.debug("Constructing Error Document Representation")
 ifxml_deposit_receipt:
-super(Error_Document, self).__init__(xml_deposit_receipt)
+super(Error_Document, self).__init__(xml_deposit_receipt=xml_deposit_receipt, code=code)
 else:
-super(Error_Document, self).__init__("""<?xml version="1.0" encoding="utf-8"?>
-<sword:error xmlns:sword="http://purl.org/net/sword/"/>""")
+super(Error_Document, self).__init__(code=code)
 self.error_href=None
 self.error_info=None
-self.verboseDescription=None
+self.verbose_description=None
 self.content=None# for parity with the ContentWrapper
-self.code=code
 self.response_headers=resp
 self._characterise_error()
 
 def_characterise_error(self):
 if"sword_verboseDescription"inself.metadata.keys():
-self.verboseDescription=self.metadata['sword_verboseDescription']
-if"href"inself.dom.attrib.keys():
-self.error_href=self.dom.attrib['href']
-self.error_info=get_error(self.error_href, self.code)
+self.verbose_description=self.metadata['sword_verboseDescription']
+
+ifself.dom!=None:
+ed_l.debug("Error response contains document content")
+if"href"inself.dom.attrib.keys():
+self.error_href=self.dom.attrib['href']
+self.error_info=get_error(self.error_href, self.code)
+else:
+ed_l.debug("Error response does NOT contain document content")

sword2_logging.conf

@@ -0,0 +1,21 @@
+[loggers]
+keys=root
+
+[handlers]
+keys=consoleHandler
+
+[formatters]
+keys=basicFormatting
+
+[logger_root]
+level=DEBUG
+handlers=consoleHandler
+
+[handler_consoleHandler]
+class=StreamHandler
+level=DEBUG
+formatter=basicFormatting
+args=(sys.stdout,)
+
+[formatter_basicFormatting]
+format=%(asctime)s - %(name)s - %(levelname)s - %(message)s

tests/spec/test_spec.py

@@ -554,7 +554,8 @@ def test_25_basic_add_content_to_resource_package(self):
 payload=pkg, 
 mimetype=PACKAGE_MIME, 
 filename="example.zip",
-packaging='http://purl.org/net/sword/package/SimpleZip')
+packaging='http://purl.org/net/sword/package/SimpleZip',
+in_progress=True)
 receipt=conn.get_deposit_receipt(receipt.location)
 
 withopen(PACKAGE) aspkg:
@@ -575,7 +576,8 @@ def test_26_advanced_add_content_to_resource_package(self):
 payload=pkg, 
 mimetype=PACKAGE_MIME, 
 filename="example.zip",
-packaging='http://purl.org/net/sword/package/SimpleZip')
+packaging='http://purl.org/net/sword/package/SimpleZip',
+in_progress=True)
 receipt=conn.get_deposit_receipt(receipt.location)
 
 withopen(PACKAGE) aspkg:
@@ -593,21 +595,22 @@ def test_27_basic_add_metadata(self):
 conn.get_service_document()
 col=conn.sd.workspaces[0][1][0]
 e=Entry(title="Multipart deposit", id="asidjasidj", dcterms_abstract="abstract", dcterms_identifier="http://whatever/")
-withopen(PACKAGE) aspkg:
-receipt=conn.create(col_iri=col.href,
-metadata_entry=e,
-payload=pkg, 
-mimetype=PACKAGE_MIME, 
-filename="example.zip",
-packaging='http://purl.org/net/sword/package/SimpleZip')
+#with open(PACKAGE) as pkg:
+receipt=conn.create(col_iri=col.href,
+metadata_entry=e,
+#payload=pkg, 
+#mimetype=PACKAGE_MIME, 
+#filename="example.zip",
+#packaging = 'http://purl.org/net/sword/package/SimpleZip',
+in_progress=True)
 
 # ensure that we have a receipt (the server may not give us one
 # by default)
 receipt=conn.get_deposit_receipt(receipt.location)
 
 ne=Entry(title="Multipart deposit", id="asidjasidj", dcterms_identifier="http://another/",
 dcterms_creator="Me!", dcterms_rights="CC0")
-new_receipt=conn.append(dr=receipt, metadata_entry=ne)
+new_receipt=conn.append(dr=receipt, metadata_entry=ne)
 
 assertnew_receipt.code==200
 
@@ -619,10 +622,11 @@ def test_28_advanced_add_metadata(self):
 withopen(PACKAGE) aspkg:
 receipt=conn.create(col_iri=col.href,
 metadata_entry=e,
-payload=pkg, 
-mimetype=PACKAGE_MIME, 
-filename="example.zip",
-packaging='http://purl.org/net/sword/package/SimpleZip')
+#payload=pkg, 
+#mimetype=PACKAGE_MIME, 
+#filename="example.zip",
+#packaging = 'http://purl.org/net/sword/package/SimpleZip',
+in_progress=True)
 
 # ensure that we have a receipt (the server may not give us one
 # by default)
@@ -707,13 +711,14 @@ def test_31_delete_container(self):
 conn.get_service_document()
 col=conn.sd.workspaces[0][1][0]
 e=Entry(title="Multipart deposit", id="asidjasidj", dcterms_abstract="abstract", dcterms_identifier="http://whatever/")
-withopen(PACKAGE) aspkg:
-receipt=conn.create(col_iri=col.href,
-metadata_entry=e,
-payload=pkg, 
-mimetype=PACKAGE_MIME, 
-filename="example.zip",
-packaging='http://purl.org/net/sword/package/SimpleZip')
+#with open(PACKAGE) as pkg:
+receipt=conn.create(col_iri=col.href,
+metadata_entry=e,
+#payload=pkg, 
+#mimetype=PACKAGE_MIME, 
+#filename="example.zip",
+#packaging = 'http://purl.org/net/sword/package/SimpleZip',
+in_progress=True)
 
 # ensure that we have a receipt (the server may not give us one
 # by default)
@@ -730,7 +735,7 @@ def test_31_delete_container(self):
 another_receipt=conn.get_deposit_receipt(edit_iri)
 
 # FIXME: this is the broken assert
-#assert another_receipt.code == 404
+assertanother_receipt.code==404
 
 deftest_32_get_atom_statement(self):
 conn=Connection(SSS_URL, user_name=SSS_UN, user_pass=SSS_PW, on_behalf_of=SSS_OBO)
@@ -739,7 +744,7 @@ def test_32_get_atom_statement(self):
 e=Entry(title="Multipart deposit", id="asidjasidj", dcterms_abstract="abstract", dcterms_identifier="http://whatever/")
 withopen(PACKAGE) aspkg:
 receipt=conn.create(col_iri=col.href,
-metadata_entry=e,
+# metadata_entry = e,
 payload=pkg, 
 mimetype=PACKAGE_MIME, 
 filename="example.zip",
@@ -764,7 +769,7 @@ def test_33_get_ore_statement(self):
 e=Entry(title="Multipart deposit", id="asidjasidj", dcterms_abstract="abstract", dcterms_identifier="http://whatever/")
 withopen(PACKAGE) aspkg:
 receipt=conn.create(col_iri=col.href,
-metadata_entry=e,
+# metadata_entry = e,
 payload=pkg, 
 mimetype=PACKAGE_MIME, 
 filename="example.zip",
@@ -789,7 +794,7 @@ def test_34_complete_deposit(self):
 e=Entry(title="Foo", id="asidjasidj", dcterms_abstract="abstract", dcterms_title="my title")
 withopen(PACKAGE) aspkg:
 receipt=conn.create(col_iri=col.href,
-metadata_entry=e,
+# metadata_entry = e,
 payload=pkg, 
 mimetype=PACKAGE_MIME, 
 filename="example.zip",