Example ResourceService #131

DiegoPino · 2015-12-16T14:58:41Z

see #129

Update

https://github.com/DiegoPino/islandora/tree/example-service
Get resource is working fine.

Depends on some minor fixes on Chullo at
https://github.com/DiegoPino/chullo/tree/api

or

Islandora/chullo#30

Basic (Manual testing)

Download/clone
Modify composer.json to match your local location of the previously referred Chullo
Modify config/settings.dev.yml to match your triplestore and fedora4 URLs
run $ composer update
run $ php -S localhost:8282 -t src src/index.php this will use the php embed web server to test
Assuming you already have some containers in fedora (with uuid) you can test the working route
with a call like this
$ curl http://localhost:8282/islandora/resource/7ef68f6f-72ab-4708-b0f4-8ec1f07cd580 -v
in case you have a child resource (lets say an image binary at /OBJ) you can issue this call
$ curl http://localhost:8282/islandora/resource/7ef68f6f-72ab-4708-b0f4-8ec1f07cd580/OBJ -v

Also accepts this query arguments: tx=transactionid and metadata=true
Will fail if tx given and not a valid transactionid (404)
Will get fcr:metadata for any resource (e.g binary) if metadata=true

Note: if you don't have a CLAW vagrant environment working you can use(only testing)

https://wiki.duraspace.org/display/FEDORA40/Quick+Start (download and run fcrepo-webapp-4.4.0-jetty-console.jar)
Download standalone blazegraph https://www.blazegraph.com/download/ and run it using the described method (please lower the java memory!)
Create a new resource in Fedora4 using the rest api (or page),
Since you won't have an indexer running, issue an insert data command to blaze graph to be able to test (you can use the same rdf response from fedora4 for a resource + nfo:uuid property to match using the web admin at http://localhost:9999/bigdata/#update)

TODO

*Rest of the resource routes (POST/PATCH/etc). Basically i have to resolve an issue with Fedora rewriting the triples based on the host header, which in our case, since we are a middle service, depends on where we are running our silex service. This means that, e.g, our returned location in case of a POST (creating a resource) will have the host and port of silex in the resource path which is bad. Same for any other operation. We are fetching the resource path from the triple store matching nfo:uuid. That one will always be a static one(inserted on resource creation) so trouble can occur when matching that returned resource path with fedora's rest point for that resource.

~~Options are to match the host header to where fedora is running, this way, at least we would get a constant base uri, others are more complex (like living with this)~~
- Clean UP, bring to coding standards
- ~~Make URL configurations external (not sure, do we wan't to keep service as slim as possible?)~~
- Write Unit Tests

…edoraApi class from Chullo.

Depends on Chullo fixes at https://github.com/DiegoPino/chullo/tree/api

for get route: assuming it's running in 8181 (example php -S localhost:8181 -t src src/index.php ) then http://localhost:8181/islandora/resource/7ef68f6f-72ab-4708-b0f4-8ec1f07 cd580 will get the resource for a resource that has nfo:uuid -> 7ef68f6f-72ab-4708-b0f4-8ec1f07cd580 in the triple store and http://localhost:8181/islandora/resource/7ef68f6f-72ab-4708-b0f4-8ec1f07 cd580/OBJ will get the child resource for that one (in this case binary) Accepts also a ?tx=transactionid * if the transactionid does not exist if fails with 404 * if uuid is not uuid then it fails with 404 * if resource path is not in triple store if fails with 404

Main route for getting a resource accepts also a metadata argument localhost:8181/islandora/resource/7ef68f6f-72ab-4708-b0f4-8ec1f07cd580/O BJ/?metadata=true In case of binary it will return triples instead of the binary resource In case of an container i will get you the RDF (basically ignoring this option)

DiegoPino · 2015-12-17T16:40:48Z

@Islandora-CLAW/7-x-2-x-sprinters, updated, includes resource creation via POST

Also moved some route parameters to query arguments (checksum) in all routes: tx ,checksum and metadata (depending on what is used in each route)

Did also a lot of coding cleanup. Not sure if the Symphony coding standard as base is good enough? Moved the ->abort for non existing resource path in triple store into the middleware.

daniel-dgi · 2015-12-18T15:43:39Z

services/ResourceService/src/index.php

+  return $twig;
+}));
+
+$app['fedora'] =  $app->share(function() {


No need to call share() here. Just passing in the closure is enough. In earlier versions you had to do that because default was to create a new service every time it was pulled from the DI container. Now the default is to share a single instance.

Dani, did not find this in the documentation or release logs. Do you have the link for my own further learning?

http://pimple.sensiolabs.org/

Check out the usage section. If you want a new one per request from the container, you have to use $app->factory().

But now I'm wondering what version of pimple silex uses.

Nope, pimple 1.x in silex. We have to stick with ->share

I need to update the transaction service then!

nigelgbanks · 2015-12-18T16:32:41Z

Should we remove the following files from the Pull?

services/ResourceService/composer.lock

Also should we change the URL property of the VCS of the composer.json files?

daniel-dgi · 2015-12-18T18:06:59Z

Keep the composer.json files. Ditch the lock file.

We'll update where chullo gets pulled from in the composer.json files when the chullo PR gets merged. In general, it should always point to a version on packagist before getting merged.

DiegoPino · 2015-12-18T19:39:56Z

services/TransactionService/src/index.php

+
+require_once __DIR__.'/../vendor/autoload.php';
+
+use GuzzleHttp\Exception\ClientException;


We can remove Guzzle here right?

Using app->share in TransactionService.

* Added simplistic yaml config reader * Added middleware to handle empty $id in case of referencing root resource * Added error handler/catcher for unavailable Fedora and tripplestore services * Moved regex for uuid to config variable, not allows UUID V4 or empty * added Delete resource with ?force=true option in route to also remove tombstone in one step, can be used also on an existing tombstone Todo: * make a UUID/rdf generating service to generate intermediate resources in case of PUT and POST(if needed, still not convinced if really needed at this side) * check for mime types in case of updating existing resources, abort before hitting fedora if trying to "convert" and rdf->to binary or the other way resource. * Make messages more human friendly * Documentation

DiegoPino · 2016-01-04T20:46:49Z

@Islandora-CLAW/7-x-2-x-committers, some updates on this if you mind looking/commenting/discussing. If followed @daniel-dgi advice on most of the new stuff 😁 , except for removing the $child parameter because it's pretty handy like when requesting fcr:metadata, tombstones, or fixity for existing resources + our own OBJ/TN/etc naming convention. Mostly some cleanup, added delete method, made the uuid check regex a variable in yaml, intercepting some exceptions, different settings for debug and production. Still lots todo!

whikloj · 2016-01-06T18:15:04Z

services/TransactionService/composer.json

+    "repositories": [
+        {
+            "type": "vcs",
+            "url": "/Users/dpino/Desktop/Development/ISLANDORAWORK/CLAW_MICRO/chullo"


Should this be the main github repo and just make this PR rely on the Chullo PR?

daniel-dgi · 2016-01-06T18:43:22Z

services/ResourceService/src/index.php

+  else {
+    $configFile = __DIR__.'/../config/settings.yml';
+  }
+  $settings = Yaml::parse(file_get_contents($configFile));


So simple. Love it.

$checksum is optional, passed as get variable to the route ?checksum="urn:sha:somekey"

Moved all common middleware to global controllers def. Cleaner code and easier to maintain.

whikloj · 2016-01-14T20:56:57Z

services/ResourceService/src/index.php

+ * takes 'rx' and/or 'checksum' as optional query arguments
+ * @see https://wiki.duraspace.org/display/FEDORA40/RESTful+HTTP+API#RESTfulHTTPAPI-YellowPUTCreatearesourcewithaspecifiedpath,orreplacethetriplesassociatedwitharesourcewiththetriplesprovidedintherequestbody.
+ */
+$app->put("/islandora/resource/{id}/{child}",function (Application $app, Request $request, $id, $child) {


Should there also be a PUT route for when you only have an $id? Same for PATCH below and DELETE

Hi, child is optional, set to "" by default at https://github.com/Islandora-CLAW/CLAW/pull/131/files#diff-079c3800368dc100b90e9a9254e6fcc6R176 , so if not passed/used in the call it's all good, the route will match. Only post is {$id} only, and i would love to add $child there too

Ok, error was due to me sending my own Content-type header with curl. Future work might be to just strip the duplicate headers for PATCH as it has to be application/sparql-update.

whikloj · 2016-01-15T17:36:58Z

Future work has been completed, just that composer hates me. 👍 merging.

Example ResourceService

DiegoPino · 2016-01-15T18:28:55Z

😄

daniel-dgi and others added 8 commits December 8, 2015 00:32

Example transaction service.

015dd6c

Merge remote-tracking branch 'labs/sprint-002' into example-service

9638bca

Updating PR to use static factory function for Chullo.

00c2cf3

Using view handler to convert PSR-7 to Symfony responses. Using the F…

d3d34c8

…edoraApi class from Chullo.

Work in progress for Resource Services

b7a5146

Depends on Chullo fixes at https://github.com/DiegoPino/chullo/tree/api

POST resource creation working

86bd39b

DiegoPino added 2 commits December 17, 2015 18:31

PUT resource route working

89a09cc

Also moved some route parameters to query arguments (checksum) in all routes: tx ,checksum and metadata (depending on what is used in each route)

PATCH route added

2a0efc3

Did also a lot of coding cleanup. Not sure if the Symphony coding standard as base is good enough? Moved the ->abort for non existing resource path in triple store into the middleware.

daniel-dgi reviewed Dec 18, 2015
View reviewed changes

DiegoPino reviewed Dec 18, 2015
View reviewed changes

daniel-dgi and others added 3 commits December 18, 2015 15:54

Using app->share in TransactionService.

4b84572

Merge pull request #1 from daniel-dgi/example-service

d733150

Using app->share in TransactionService.

whikloj reviewed Jan 6, 2016
View reviewed changes

ruebot mentioned this pull request Jan 6, 2016

Example service #126

Closed

daniel-dgi reviewed Jan 6, 2016
View reviewed changes

whikloj self-assigned this Jan 13, 2016

legacy var removed

0654a2b

$checksum is optional, passed as get variable to the route ?checksum="urn:sha:somekey"

Unified middleware under global controllers

2428860

Moved all common middleware to global controllers def. Cleaner code and easier to maintain.

whikloj reviewed Jan 14, 2016
View reviewed changes

whikloj added a commit that referenced this pull request Jan 15, 2016

Merge pull request #131 from DiegoPino/example-service

1742149

Example ResourceService

whikloj merged commit 1742149 into Islandora:sprint-002 Jan 15, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Example ResourceService #131

Example ResourceService #131

DiegoPino commented Dec 16, 2015

DiegoPino commented Dec 17, 2015

daniel-dgi Dec 18, 2015

DiegoPino Dec 18, 2015

daniel-dgi Dec 18, 2015

DiegoPino Dec 18, 2015

daniel-dgi Dec 18, 2015

nigelgbanks commented Dec 18, 2015

daniel-dgi commented Dec 18, 2015

DiegoPino Dec 18, 2015

DiegoPino commented Jan 4, 2016

whikloj Jan 6, 2016

daniel-dgi Jan 6, 2016

DiegoPino Jan 6, 2016

whikloj Jan 14, 2016

DiegoPino Jan 14, 2016

whikloj Jan 14, 2016

whikloj commented Jan 15, 2016

DiegoPino commented Jan 15, 2016


		require_once __DIR__.'/../vendor/autoload.php';

		use GuzzleHttp\Exception\ClientException;

Example ResourceService #131

Example ResourceService #131

Conversation

DiegoPino commented Dec 16, 2015

Update

TODO

DiegoPino commented Dec 17, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nigelgbanks commented Dec 18, 2015

daniel-dgi commented Dec 18, 2015

Choose a reason for hiding this comment

DiegoPino commented Jan 4, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

whikloj commented Jan 15, 2016

DiegoPino commented Jan 15, 2016