Source for the Open Concept Lab APIs

Fork the repo on github and clone your fork:

git clone https://github.com/{youruser}/oclapi

Add a remote repo to upstream in order to be able to fetch updates:

git remote add upstream https://github.com/OpenConceptLab/oclapi

Go to:

cd oclapi/django-nonrel/ocl

Fire up containers:

docker-compose up

Open up http://0.0.0.0:8000/admin/authtoken/token/ in a browser and login with username 'root' and password 'Root123'. Note down the key, which you will need later to access REST resources.

Note that when using the docker quickstart on Windows, you need to check docker machine IP and replace 0.0.0.0 with the actual IP address. Run:

docker-machine ip

Follow this guide to install Python 2.7 and set up a virtual environment. You may wish to name your virtual environment something more descriptive, for example replace:

virtualenv venv

With:

virtualenv ocl

And then run:

source ocl/bin/activate

The OCL API uses MongoDB as its backend datastore. If you don't have it already, use Homebrew to install it:

brew install mongodb

Once installed, use the mongod command to start a local instance of the MongoDB server. Then, in a separate console window, run mongo to start the interactive command-line client. Using the Mongo command-line, create a database named ocl:

 > use ocl

Solr is used to support searching across OCL API entities. To download Solr 4.9.0, visit the Solr mirrors page and select a mirror. Then download solr-4.9.0.tgz (NOT solr-4.9.0-src.tgz).

Choose an install directory (e.g. ~/third-party, henceforth $INSTALL_DIR) and extract the tarball there. You will then need to set 2 environment variables:

   export SOLR_ROOT=$INSTALL_DIR/solr-4.9.0
   export SOLR_HOME=$OCLAPI_ROOT/solr

$OCLAPI_ROOT refers to your Git project root (i.e. the location of this Readme file).

This should enable you to run $OCLAPI_ROOT/run_solr.sh, which starts Solr in a Jetty instance listening on port 8983. Verify this by visiting:

 http://localhost:8983/solr

Clone this repository, and cd into the django/ocl directory. Before you can run the server, you will need to execute the following steps:

1. Install the project dependencies:

   pip install -r requirements.txt

2. Use syncdb to create your backing Mongo collections.

   ./manage.py syncdb

   If you are starting with a clean Mongo database, syncdb will prompt you to create a superuser. Follow that prompt.

   If you are not prompted to create a superuser, or wish to do so later, you can also use the command:

   ./manage.py createsuperuser

3. Verify your superuser and make note of your token.

   $ mongo
   > use ocl
   > db.auth_user.find({'is_superuser':true})

   This should revel the superuser you just created. Note the user's _id (e.g. ObjectId("528927fb2f3e986be1627d6d")), and use it to locate your token:

   > db.authtoken_token.find({'user_id': ObjectId("528927fb2f3e986be1627d6d")})[0]

   Make note of the token _id (e.g. "20e6ac8fe09129debac2929f4a20a56bea801165"). You will need this to access your endpoints once you start up your server.

4. Run the lightweight web server that ships with Django.

   ./manage.py runserver

   The OCL API should now be running at http://localhost:8000.

5. Test an endpoint.

   Remember, the API uses token-based authentication, so you can't just plug an endpoint into a browser and hit Return. You'll need to use a tool that allows you to specify a header with your request. One simple example is curl:

   curl -H "Authorization: Token c1328d443285f2c933775574e83fe3abfe6d7c0d" http://localhost:8000/users/

   I recommend using the Advanced REST Client app for Chrome. This provides you with a nice editor for passing parameters along with your POST and PUT requests.

6. Create an API user.

   Your superuser is not a valid API user, because it was not created via the POST /users/ operation. However, you can use your superuser to access that endpoint and create an API user:

   curl -H "Authorization: Token c1328d443285f2c933775574e83fe3abfe6d7c0d" -H "Content-Type: application/json" -d '{"username":"test","email":"test@test.com", "name":"TestyMcTest"}' http://localhost:8000/users/   

7. (Optional) Make your API user an admin (staff) user.

   Log into the Django admin console with the superuser credentials you established in step 4:

   http://localhost:8000/admin/

   Then navigate to the user list:

   http://localhost:8000/admin/auth/user/

   Select the user you just created, and check the box next to "staff status". Now your user is an admin within the context of the OCL API.