Skip to content

Latest commit

 

History

History
60 lines (38 loc) · 1.64 KB

README.md

File metadata and controls

60 lines (38 loc) · 1.64 KB
Raw

Implementation ID

This application is used to generate an ImplementationId.

Description: https://wiki.openmrs.org/x/wREz

CI build: https://ci.openmrs.org/browse/II-II

Docker image: https://hub.docker.com/r/openmrs/implementation-id/tags/

Implementation details

It's an unauthenticated POST request. It does require implementationId, description and passphrase. implementationId shouldn't have ^ or | chars (no idea why).

  • If any of the fields is incorrect or missing, it will return code 400.
  • If implementationId doesn't exist on the database, it creates and returns code 200.
  • If implementationId already exists and passphrase matches, it returns code 200.
  • If implementationId already exists and passphrase doesn't match, it will return an 403 error.

A log is created for all cases. Passphrase is stored using bcrypt

Running locally

Make sure to install docker and docker-compose locally.

# Check compile errors
$ python -m py_compile implementationid.py

# Build new docker image
$ docker-compose build

# Starting database and application in docker containers
# ctrl+c to stop containers
$ docker-compose up

# to test application (from another terminal)
$ curl localhost:8000/ping

You can open test/implementationidtest.html in a browser to submit requests to your local server.

To test it from the command line:

# local server
$ ./test/post-request.sh <implementationId> <description> <passphrase>

# remote server
$ ./test/post-request.sh <implementationId> <description> <passphrase> https://implementation.openmrs.org

# to power off and delete data
$ docker-compose down -v