Alternative Islandora ResourceService using providers #135

DiegoPino · 2016-01-20T14:39:20Z

Sprint 003 Work

What does this Pull Request do?

Changed the one-file logic ResourceService silex app to a full ServiceProvider and ControllerProvider based app.
Allowed some external service injection/swapping possibilities for users, had to move the global middleware to specific middleware for each route to allow other silex apps to use and avoid
all the transforms we do here.
Twig was left as an independent registered Service to be swap-able.

Update:

Added a Collection Service skeleton. Does nothing, allows many cool stuff
Added UUID generator serviceProvider, works with UUIDV4 and UUIDV5
What's new?

Simpler index.php file, loads the ServiceProvider and ControllerProvider as a unified multi inherited class to make editing easier. Route Mounting is now relative. All the global middleware was moved to each individual route (not pretty) to allow other apps to use this provider (Not sure how yet!) and avoid all their local routes to be parsed by this one.

How should ResourceServiceProvider be tested?

Same as the previous ResourceService, all basic REST methods are enabled, which means
POST, GET, PUT, DELETE, PATCH

Basic (Manual testing, be sure to have a working composer environment)

Download/clone/diff
Modify config/settings.dev.yml to match your triplestore and fedora4 URLs, if running without any code change (this settings file depends on the enabled $app['debug'] = true definition in index.php
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 (replace the uuid for one of yours)

$ curl http://localhost:8282/islandora/resource/7ef68f6f-72ab-4708-b0f4-8ec1f07cd580 -v in case
you have a child resource without uuid that is child of one with (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 (the stuff after the ?)
- tx=transactionid
- 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

to can also get a resource that is direct child of root and has a simple path(no slashes) ( we double slash to avoid the uuid)

$ curl http://localhost:8282/islandora/resource///OBJ -v

Note: if you don't have a CLAW vagrant environment working you can use(only for 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)

How should CollectionService be tested (stub route, will be expanded)?

1 Modify composer.json to match the path to your ResourceServiceProvider local location
2 run $ composer update
3 run $ php -S localhost:8282 -t src src/index.php this will use the php embed web server to test
curl -i -X POST http://localhost:8282/islandora/collection
will return the root resource using the ResourceService GET route. Not super cool, but watch the console!

TODO CollectionService

Make the routes really work
Generate RDF using twig templates to create all the containers. Should be just a few lines of code!

Some extra examples:

curl -i -X POST -H "Content-Type: image/jpg" -H "Slug:IMAGEN" --data-binary "@76.jpg" "http://localhost:8282/islandora/resource/7ef68f6f-72ab-4708-b0f4-8ec1f07cd580" -v

Previous command creates a binary resource with slug/Path "IMAGEN" as child of UUID 7ef68f6f-72ab-4708-b0f4-8ec1f07cd580 identified fedora4 Resource

curl -i -X DELETE "http://localhost:8282/islandora/resource/7ef68f6f-72ab-4708-b0f4-8ec1f07cd580/IMAGEN?force=true" -v

Previous command deletes IMAGEN resource and ?force=true also gets rid of the tombstone. Without you keep the tombstone

curl -X PATCH -H "Content-type: application/sparql-update" --data-binary "@patch.rdf" http://localhost:8282/islandora/resource/7ef68f6f-72ab-4708-b0f4-8ec1f07cd580 -v -i

Previous command patches (updates) the UUID 7ef68f6f-72ab-4708-b0f4-8ec1f07cd580 identified fedora4 Resource using SPARQL query

Additional Notes:

This is a working but "test "Service that needs some cleanups, checks, (like the "use" statements) and can/will be moved in the future. It was done to be able to use this routes inside the PCDM Collection Service and/or Object Service during development.

Thanks a lot!

Diego Pino Navarro
A dog & human friendly developer

Changed the one-file logic to full ServiceProvider and ControllerProvider. Allowed some external service injection/swapping possibilities for users, had to move the global middleware to specific middleware for each route to allow other silex apps to use and avoid all the transforms we do here

Added git VCS for chullo. No need to have it locally Removed a debug statement

whikloj · 2016-01-20T17:32:28Z

services/ResourceServiceProvider/src/Provider/ResourceServiceProvider.php

+    $app['islandora.resourcecontroller'] = $app->share(function() use ($app) {
+      return new \Islandora\ResourceService\Controller\ResourceController($app);
+    });
+    if (!isset($app['twig'])) {


Is this necessary, I thought the $app->share() took care of this type of logic?

@whikloj, do you mean the "use" statements? I was unsure if putting there had any logic, but i thought it could be a good idea for code clarity/new users. I can remove it once all others had a look at the code

whikloj · 2016-01-20T17:40:02Z

This is awesome @DiegoPino, I feel better knowing that I was close on some of my work.

DiegoPino · 2016-01-20T17:47:00Z

@whikloj, thanks, i really appreciate this. I'm pretty sure you where more than close. I did this pull also to serve as a base example on how to move any service to a provider, but i'm not sure if my implementation is the best, so i would love we could compare ways and more if you could make some pulls against this one!

daniel-dgi · 2016-01-20T18:09:51Z

services/ResourceServiceProvider/src/index.php

+    return;
+  }
+  //Not sure what the best "verbose" message is
+  return new response(sprintf('Islandora Resource Service exception: %s / HTTP %d response', $e->getMessage(), $code), $code);


Right!! moving to uppercase… sorry. Thanks for catching this @daniel-dgi and thanks @whikloj for explaining me what dani catched!! I can't even see my own code sometimes.

lazy php, more lazy diego

We have a monolithic project, git gets crazy in composer. Lets use path for now. Must be tuned during testing to local path. Before final merging will add real git.

Collection Service does nothing. But it allows to do anything. Whole remote serviceprovider/controllerprovider logic is working perfect, also UUID4 (and swappable V5 also). Test route transforms a post to collection into an internal GET to resource. Some debug error_log in place to see what is happening. Pretty happy!

DiegoPino · 2016-01-22T21:42:59Z

Added new working code to help others to jump in. UUID generator (v4 and V5) service provider and a Collection Service Skeleton
Tested both and 👍

Thanks

whikloj · 2016-01-23T03:21:43Z

Awesome job @DiegoPino !!

ResourceServiceProvider works 👍
CollectionService test route works as expected 👍
I like how you can see it using the ResourceServiceProvider to fulfill the GET request.

Makes me wonder if these core services (Resource/Collection) should not be combined as one? Just combine the code so they share an index.php with the ResourceServiceProvider and CollectionService as sub-directories with the provider code.
Thoughts @ruebot, @daniel-dgi, @nigelgbanks ???

I'm good to merge this, but as it is Friday night I'll leave it for now incase there are any questions/concerns. I'll merge it tomorrow to give anyone a chance to test it themselves.

Also, key point I missed. When pointing the collection service composer.json to the ResourceServiceProvider I forgot I had pulled the branch with a different name (sprint-3). If you do this, remember to change the dev-sprint-002 to dev-<branch name>.

whikloj · 2016-01-24T00:22:56Z

Merging... we can move forward from here.

Alternative Islandora ResourceService using providers

DiegoPino · 2016-01-24T19:56:07Z

Thanks @whikloj for testing and merging!

DiegoPino added 2 commits January 20, 2016 10:58

Composer update + little cleanup

d28273a

Added git VCS for chullo. No need to have it locally Removed a debug statement

whikloj reviewed Jan 20, 2016
View reviewed changes

daniel-dgi reviewed Jan 20, 2016
View reviewed changes

DiegoPino added 5 commits January 20, 2016 16:08

new Response needs capital R

ce3699c

lazy php, more lazy diego

UUID provider for ResourceServiceProvier

8ec0bef

Collection Service WIP

dd65ddc

Changed to PATH type on repositories composer

ff2750c

We have a monolithic project, git gets crazy in composer. Lets use path for now. Must be tuned during testing to local path. Before final merging will add real git.

whikloj self-assigned this Jan 23, 2016

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

Merge pull request #135 from DiegoPino/sprint-002

162e1b9

Alternative Islandora ResourceService using providers

whikloj merged commit 162e1b9 into Islandora:sprint-002 Jan 24, 2016

ruebot mentioned this pull request Feb 10, 2016

Implement Collection PHP Service #132

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Alternative Islandora ResourceService using providers #135

Alternative Islandora ResourceService using providers #135

DiegoPino commented Jan 20, 2016

whikloj Jan 20, 2016

DiegoPino Jan 20, 2016

whikloj commented Jan 20, 2016

DiegoPino commented Jan 20, 2016

daniel-dgi Jan 20, 2016

DiegoPino Jan 20, 2016

DiegoPino commented Jan 22, 2016

whikloj commented Jan 23, 2016

whikloj commented Jan 24, 2016

DiegoPino commented Jan 24, 2016

Alternative Islandora ResourceService using providers #135

Alternative Islandora ResourceService using providers #135

Conversation

DiegoPino commented Jan 20, 2016

Sprint 003 Work

What does this Pull Request do?

What's new?

How should ResourceServiceProvider be tested?

How should CollectionService be tested (stub route, will be expanded)?

TODO CollectionService

Some extra examples:

Additional Notes:

whikloj Jan 20, 2016

Choose a reason for hiding this comment

DiegoPino Jan 20, 2016

Choose a reason for hiding this comment

whikloj commented Jan 20, 2016

DiegoPino commented Jan 20, 2016

daniel-dgi Jan 20, 2016

Choose a reason for hiding this comment

DiegoPino Jan 20, 2016

Choose a reason for hiding this comment

DiegoPino commented Jan 22, 2016

whikloj commented Jan 23, 2016

whikloj commented Jan 24, 2016

DiegoPino commented Jan 24, 2016