paas-accounts

README

paas-accounts

API for storing information about PaaS users.

Build

go build -o paas-accounts .

Test

make start_postgres_docker
make test
make stop_postgres_docker

Run

BASIC_AUTH_USERNAME="some-user" \
BASIC_AUTH_PASSWORD="some-pass" \
DATABASE_URL="postgres://..." \
PORT=8080 \
	./paas-accounts

Deploy

A manifest.yml exists for deploying to cloudfoundry. You should ensure the required environment variables are in place and that a suitable postgres database service is bound.

API

PUT /documents/:name

Create or update a document:

curl -u <USER>:<PASS> -H "Content-Type: application/json" -X PUT -d '{"content": "my content"}' https://<HOSTNAME>/documents/my_document

GET /documents/:name

Retrieve an existing document:

curl -u <USER>:<PASS> https://<HOSTNAME>/documents/my_document

Agreements

POST /agreements

Record a user's agreement to a document:

curl -u <USER>:<PASS> -H "Content-Type: application/json" -X POST -d '{"user_uuid": "00000000-0000-0000-0000-000000000001", "document_name": "my_document"}' https://<HOSTNAME>/agreements

GET /users/:uuid/documents

Get all documents for a user:

curl -u <USER>:<PASS> https://<HOSTNAME>/users/00000000-0000-0000-0000-000000000001/documents

Get all documents for a user that need agreement:

curl -u <USER>:<PASS> -G -d agreed=false https://<HOSTNAME>/users/00000000-0000-0000-0000-000000000001/documents

GET /users/:uuid

Get a user:

curl -u <USER>:<PASS> https://<HOSTNAME>/users/00000000-0000-0000-0000-000000000001

GET /users

Get users by guids (accepts multiple guids):

curl -u <USER>:<PASS> -G https://<HOSTNAME>/users?uuids=00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002

Get users by email (accepts a single email address):

curl -u <USER>:<PASS> -G https://<HOSTNAME>/users?email=example%40example.com

POST /users/:uuid

POST a user:

curl -u <USER>:<PASS> -H "Content-Type: application/json" -X POST -d '{"user_email": "example@example.com", "username": "example@example.com", "user_uuid": "00000000-0000-0000-0000-000000000001"}' https://<HOSTNAME>/users/00000000-0000-0000-0000-000000000001

PATCH /users/:uuid

PATCH a user:

curl -u <USER>:<PASS> -H "Content-Type: application/json" -X PATCH -d '{"user_email": "newexample@example.com"}' https://<HOSTNAME>/users/00000000-0000-0000-0000-000000000001

Error handling

To handle an error in a handler function, such as an entity not being found or an internal server error, return one of the error types from api/errors.go

func HttpHandler(db *database.DB) echo.HandlerFunc {
	return func(c echo.Context) error {
		thing, err := db.GetAThing(c.Param("id"))
		
		if err != nil {
			if err == database.ErrNotFound {
				return NotFoundError{"thing not found"}
			}
			
			return InternalServerError{err}
		}
		
		return c.JSON(http.StatusOK, thing)
	}
	
}