def test_01_create(self):
# Create instances of the ApiRequest object
# construct a blank one, just to make sure we can
req = ApiRequest()
assert req.raw is None
assert req.account is None
assert req.json() is None
# make one using valid source data
source = RequestFixtureFactory.record()
csource = deepcopy(source)
csource["@context"] = app.config.get("API_JSON_LD_CONTEXT")
acc = MonitorUKAccount()
acc.save()
req = ApiRequest(csource, account=acc)
assert req.raw == source
assert req.account.id == acc.id
assert isinstance(req.json(), basestring)
# make one with some invalid data
with self.assertRaises(dataobj.DataStructureException):
req = ApiRequest({"whatever" : "here"}, account=acc)
def test_02_update(self):
# Do updates on the ApiRequest object
source = RequestFixtureFactory.record()
csource = deepcopy(source)
csource["@context"] = app.config.get("API_JSON_LD_CONTEXT")
acc = MonitorUKAccount()
acc.save()
# do an update on blank one (unlikely use case)
req = ApiRequest()
req.update(csource)
assert req.raw == source
assert req.account is None
assert isinstance(req.json(), basestring)
# make one, and then update it
source2 = deepcopy(source)
source2["dc:title"] = "An update"
req = ApiRequest(source, account=acc)
req.update(source2)
assert req.raw == source2
assert req.account.id == acc.id
assert isinstance(req.json(), basestring)
# make a valid one, and then do something invalid to it
req = ApiRequest(source, account=acc)
with self.assertRaises(dataobj.DataStructureException):
req.update({"whatever" : "here"})
def test_08_append(self):
# Check that append works, which is the same as update
source = RequestFixtureFactory.record()
acc = MonitorUKAccount()
acc.save()
# do an update on blank one (unlikely use case)
req = ApiRequest()
req.append(source)
assert req.raw == source
assert req.account is None
assert isinstance(req.json(), basestring)
# make one, and then update it
source2 = deepcopy(source)
source2["dc:title"] = "An update"
req = ApiRequest(source, account=acc)
req.append(source2)
assert req.raw == source2
assert req.account.id == acc.id
assert isinstance(req.json(), basestring)
# make a valid one, and then do something invalid to it
req = ApiRequest(source, account=acc)
with self.assertRaises(dataobj.DataStructureException):
req.append({"whatever" : "here"})
def test_10_validate(self):
# Check the various validation routines
acc = MonitorUKAccount()
acc.save()
source = RequestFixtureFactory.record()
# first prove that our source record validates
csource = deepcopy(source)
csource["@context"] = app.config.get("API_JSON_LD_CONTEXT")
req = ApiRequest(csource, account=acc)
assert req.raw == csource
# 1 - a record with no identifiers
asource = deepcopy(source)
del asource["dc:identifier"]
asource["@context"] = app.config.get("API_JSON_LD_CONTEXT")
with self.assertRaises(dataobj.DataStructureException):
req = ApiRequest(asource, account=acc)
# 2 - a record with no apc
asource = deepcopy(source)
del asource["jm:apc"]
asource["@context"] = app.config.get("API_JSON_LD_CONTEXT")
with self.assertRaises(dataobj.DataStructureException):
req = ApiRequest(asource, account=acc)
# 3 - an apc with no inc vat amount
asource = deepcopy(source)
del asource["jm:apc"][0]["amount_inc_vat_gbp"]
asource["@context"] = app.config.get("API_JSON_LD_CONTEXT")
with self.assertRaises(dataobj.DataStructureException):
req = ApiRequest(asource, account=acc)
# 4 - a record with a date in the wrong format
asource = deepcopy(source)
asource["dcterms:dateAccepted"] = "sometime last week"
asource["@context"] = app.config.get("API_JSON_LD_CONTEXT")
with self.assertRaises(dataobj.DataStructureException):
req = ApiRequest(asource, account=acc)
# 5 - a record with an unparseable number
asource = deepcopy(source)
asource["jm:apc"][0]["amount_inc_vat_gbp"] = "three fifty"
asource["@context"] = app.config.get("API_JSON_LD_CONTEXT")
with self.assertRaises(dataobj.DataStructureException):
req = ApiRequest(asource, account=acc)
# 6 - a record with an invalid currency code
asource = deepcopy(source)
asource["jm:apc"][0]["currency"] = "XXX"
asource["@context"] = app.config.get("API_JSON_LD_CONTEXT")
with self.assertRaises(dataobj.DataStructureException):
req = ApiRequest(asource, account=acc)
def test_09_responses(self):
# Check that we get appropriate JSON responses
source = RequestFixtureFactory.record()
acc = MonitorUKAccount()
acc.save(blocking=True)
req = ApiRequest(source, account=acc)
req.save()
# have a look at what we'd expect the responses to be if this was a create
cr = req.created_response()
assert cr.get("status") == "created"
assert cr.get("request_id") is not None
assert cr.get("public_id") == "10.1234/me"
# now look at the responses if this was an update/append
ur = req.updated_response()
assert ur.get("status") == "updated"
assert ur.get("request_id") is not None
assert ur.get("public_id") == "10.1234/me"
# now look at a delete
dr = req.deleted_response()
assert dr.get("status") == "deleted"
assert dr.get("request_id") is not None
assert dr.get("public_id") == "10.1234/me"
# just make a quick check to be sure that if no DOI is present, we get the right kind of info in the public_id
source2 = RequestFixtureFactory.record()
source2["dc:identifier"] = [{"type" : "pmcid", "id" : "PMC1234"}]
req2 = ApiRequest(source2, account=acc)
req2.save()
cr = req.created_response()
assert cr.get("public_id") == req.id
ur = req.updated_response()
assert ur.get("public_id") == req.id
dr = req.deleted_response()
assert dr.get("public_id") == req.id
def test_07_save_delete(self):
# Work through acycle of saves and deletes to observe the outputs
source = RequestFixtureFactory.record()
acc = MonitorUKAccount()
acc.save(blocking=True)
req = ApiRequest(source, account=acc)
req.save()
dao = Request()
req2 = dao.pull(req.request.id)
assert req2 is not None
assert req2.owner == acc.id
assert req2.record == source
assert req2.action == "update"
# now publish the request
PublicApi.publish(req2)
time.sleep(2)
# now pull the object as identified by its API identifier (which should be the DOI)
source2 = deepcopy(source)
source2["dc:title"] = "An update"
next = ApiRequest.pull(req.id, account=acc)
next.update(source2)
next.save()
# now, at this point we should have 2 request objects in the index. One for the
# original save, and one for the new save
req3 = dao.pull(next.request.id)
assert req3 is not None
assert req3.owner == acc.id
assert req3.record == source2
assert req3.action == "update"
# now issue a delete on the same record
next.delete()
# by now we should have 3 request objects in the index, 2 for the above updates
# and one for the delete request
req4 = dao.pull(next.request.id)
assert req4 is not None
assert req4.owner == acc.id
assert req4.record == source2
assert req4.action == "delete"
def test_01_request_delete(self):
# Create a delete request
record = RequestFixtureFactory.record()
acc = BasicAccount()
acc.id = "test1"
r = RequestApi.delete(record, acc, "01010101")
# now check it was saved correctly
assert r is not None
r1 = r.pull(r.id)
assert r1 is not None
assert r1.owner == acc.id
assert r1.action == "delete"
assert r1.public_id == "01010101"
def test_06_get_id(self):
# Get the operative ID of a record
acc = MonitorUKAccount()
acc.id = "abcdefghij"
source = RequestFixtureFactory.record()
# first, provide a record which has a doi, and ensure that's the id we get back
req = ApiRequest(source, account=acc)
assert req.id == "10.1234/me"
# now make a public record, and check we get the right ids for it
pub_source = PublicAPCFixtureFactory.example()
del pub_source["id"]
del pub_source["record"]["dc:identifier"]
pub = PublicAPC(pub_source)
pub.save(blocking=True)
result = ApiRequest.pull(pub.id, account=acc)
assert result.id == pub.id
assert result.id == result.public_id
def test_01_request_update(self):
# Create an update Request
record = RequestFixtureFactory.record()
acc = BasicAccount()
acc.id = "test1"
# without a public id
r1 = RequestApi.update(record, acc)
# with a public id
r2 = RequestApi.update(record, acc, "01010101")
# now check they were saved correctly
assert r1 is not None
assert r2 is not None
r11 = r1.pull(r1.id)
assert r11 is not None
r21 = r2.pull(r2.id)
assert r21 is not None
