unicore.hub

Installation

$ virtualenv ve
$ source ve/bin/activate
(ve)$ pip install -e .

Running unicore.hub.service

Run the development server using:

(ve)$ alembic upgrade head
(ve)$ pserve development.ini --reload

Running tests

(ve)$ py.test unicore/hub/

Using the APIs

The App API

To query the App API, create an app with management permissions:

(ve)$ hubservice development.ini create_app "Foo App" --group "group:apps_manager"
App 'Foo App' has been created and assigned to ('group:apps_manager',)
App identifier is '8fb79adb1a9340c390f32bb6c27ebc39'
App key is '83d0edb884084a3e64dcad57be5bce52a1a42ffb'

Use the management app's credentials to create, view and edit apps:

(ve)$ curl --user 8fb79adb1a9340c390f32bb6c27ebc39:83d0edb884084a3e64dcad57be5bce52a1a42ffb -H "Content-Type: application/json" -d '{"title": "Foo"}' http://localhost:8000/apps
{"key": "6a70619d5a53c103fe643ff311a733e0bb89124c", "title": "Foo", "uuid": "ba0529456a9a4602a85ccca6c35f4f38", "groups": []}
(ve)$ curl --user 8fb79adb1a9340c390f32bb6c27ebc39:83d0edb884084a3e64dcad57be5bce52a1a42ffb http://localhost:8000/apps/ba0529456a9a4602a85ccca6c35f4f38
{"key": "6a70619d5a53c103fe643ff311a733e0bb89124c", "title": "Foo", "uuid": "ba0529456a9a4602a85ccca6c35f4f38", "groups": []}
(ve)$ curl --user 8fb79adb1a9340c390f32bb6c27ebc39:83d0edb884084a3e64dcad57be5bce52a1a42ffb -d '{"title": "New Foo"}' -XPUT http://localhost:8000/apps/ba0529456a9a4602a85ccca6c35f4f38
{"key": "6a70619d5a53c103fe643ff311a733e0bb89124c", "title": "New Foo", "uuid": "ba0529456a9a4602a85ccca6c35f4f38", "groups": []}

To reset the app key, use the /apps/{user_id}/reset_key endpoint:

(ve)$ curl --user 8fb79adb1a9340c390f32bb6c27ebc39:83d0edb884084a3e64dcad57be5bce52a1a42ffb -XPUT http://localhost:8000/apps/ba0529456a9a4602a85ccca6c35f4f38/reset_key
{"key": "759f4f28b531d5fed817a01ce6cce130dab68498", "title": "New Foo", "uuid": "ba0529456a9a4602a85ccca6c35f4f38", "groups": []}

Note: The app created above does not have management permissions. This means it can only view and edit its own data, and it cannot create apps.

The User API

The User API can be queried using an app's credentials. Every app can create, view and edit its own user data. Aside from management apps, an app cannot access the user data of another app.

Let's use the app created above to store and retrieve user data:

(ve)$ curl --user ba0529456a9a4602a85ccca6c35f4f38:759f4f28b531d5fed817a01ce6cce130dab68498 -d '{"display_name": "Foo Bar"}' http://localhost:8000/users/cfdfbfc6ca064a48b77f0dc615e0841d
{"success": true}
(ve)$ curl --user ba0529456a9a4602a85ccca6c35f4f38:759f4f28b531d5fed817a01ce6cce130dab68498 http://localhost:8000/users/cfdfbfc6ca064a48b77f0dc615e0841d
{"display_name": "Foo Bar"}