Merit Server

A simple Web-Service to track your Merits!

Synopsis

MeritServer is a service to help track your Merits.

Motivation

We recently started with Merit Money in our Team and were looking for an easy piece of software to help us track our transactions. As there were no suitable projects around I decided to start my own to do this job. Beside that I could learn Akka-HTTP.

Installation

Download sources an use sbt run to compile an run the project. By default the webserver starts listening on port 9000.

Configuration

• merit.startAmount: The amount of merits each user can give each round.
• merit.payoutThreshold: The threshold on which random number from 0.0 to it a payout happens.
• merit.userFile: File path where the user data is save.
• merit.transactionFile: File path where the transaction data is saved.

API Reference

GET http://<server>:9000/v1/users

Returns all users.

curl --request GET \
  --url http://localhost:9000/v1/users

[
	{
		"id": "8a7dedd2-a946-4dff-b8c7-fb392a7627ee",
		"familyName": "Duck",
		"firstName": "Donald",
		"balance": 0
	},
	{
		"id": "51492b93-af20-4130-a37b-7b4c97fb9894",
		"familyName": "Duck",
		"firstName": "Daisy",
		"balance": 0
	}
]

PUT http://<server>:9000/v1/users

Accepts an array of users. Current users are deleted and replaced by the new ones.

curl --request PUT \
     --url http://localhost:9000/v1/users \
     --header 'content-type: application/json' \
     --data '[{
     "familyName": "Duck",
     "firstName": "Donald"
   }, {
     "familyName": "Duck",
     "firstName": "Daisy"
   }]'

[
	{
		"id": "8a7dedd2-a946-4dff-b8c7-fb392a7627ee",
		"familyName": "Duck",
		"firstName": "Donald",
		"balance": 0
	},
	{
		"id": "51492b93-af20-4130-a37b-7b4c97fb9894",
		"familyName": "Duck",
		"firstName": "Daisy",
		"balance": 0
	}
]

POST http://<server>:9000/v1/users

Creates a new user. This user is added to the current users.

curl --request POST \
  --url http://localhost:9000/v1/users \
  --header 'content-type: application/json' \
  --data '{
	"firstName": "Gustav",
	"familyName": "Duck"
}'

{
	"id": "3b25c2e4-00cc-4524-aa71-f400c306c0b0",
	"familyName": "Duck",
	"firstName": "Gustav",
	"balance": 0
}

GET http://<server>:9000/v1/users/{id}

Returns a specific user identified by {id}.

curl --request GET \
  --url http://localhost:9000/v1/users/51492b93-af20-4130-a37b-7b4c97fb9894

{
	"id": "51492b93-af20-4130-a37b-7b4c97fb9894",
	"familyName": "Duck",
	"firstName": "Daisy",
	"balance": 0
}

GET http://<server>:9000/v1/transactions

Returns all transactions.

curl --request GET \
  --url http://localhost:9000/v1/transactions

[
	{
		"booked": false,
		"reason": "You are a beauty!",
		"amount": 1,
		"to": "51492b93-af20-4130-a37b-7b4c97fb9894",
		"id": "3eb595f4-40a1-42bd-bceb-9a39164e0161",
		"date": "2017-01-16",
		"from": "8a7dedd2-a946-4dff-b8c7-fb392a7627ee"
	}
]

POST http://<server>:9000/v1/transactions

Creates a new transaction.

curl --request POST \
  --url http://localhost:9000/v1/transactions \
  --header 'content-type: application/json' \
  --data '{
	"from": "8a7dedd2-a946-4dff-b8c7-fb392a7627ee",
	"to": "51492b93-af20-4130-a37b-7b4c97fb9894",
	"amount": 1,
	"reason": "You are a beauty!"
}'

{
	"booked": false,
	"reason": "You are a beauty!",
	"amount": 1,
	"to": "51492b93-af20-4130-a37b-7b4c97fb9894",
	"id": "3eb595f4-40a1-42bd-bceb-9a39164e0161",
	"date": "2017-01-16",
	"from": "8a7dedd2-a946-4dff-b8c7-fb392a7627ee"
}

GET http://<server>:9000/v1/transactions/{id}

Returns a specific transaction identified by {id}.

curl --request GET \
  --url http://localhost:9000/v1/transactions/3eb595f4-40a1-42bd-bceb-9a39164e0161

{
	"booked": false,
	"reason": "You are a beauty!",
	"amount": 1,
	"to": "51492b93-af20-4130-a37b-7b4c97fb9894",
	"id": "3eb595f4-40a1-42bd-bceb-9a39164e0161",
	"date": "2017-01-16",
	"from": "8a7dedd2-a946-4dff-b8c7-fb392a7627ee"
}

DELETE http://<server>:9000/v1/transactions/{id}

Deletes a transaction specified by {id}.

curl --request DELETE \
  --url http://localhost:9000/v1/transactions/3eb595f4-40a1-42bd-bceb-9a39164e0161

GET http://<server>:9000/v1/merits

Returns for all users a list of all received merits since last payout.

curl --request GET \
  --url http://localhost:9000/v1/merits

[
	{
		"userId": "8a7dedd2-a946-4dff-b8c7-fb392a7627ee",
		"name": "Donald Duck",
		"amount": 0
	},
	{
		"userId": "51492b93-af20-4130-a37b-7b4c97fb9894",
		"name": "Daisy Duck",
		"amount": 42
	}
]

POST http://<server>:9000/v1/merits/payday

Based on a random number a payout is decided. The payout-list for all user is returned.

curl --request POST \
  --url http://localhost:9000/v1/merits/payday

Payday:

[
	{
		"userId": "8a7dedd2-a946-4dff-b8c7-fb392a7627ee",
		"name": "Donald Duck",
		"amount": 0
	},
	{
		"userId": "51492b93-af20-4130-a37b-7b4c97fb9894",
		"name": "Daisy Duck",
		"amount": 42
	}
]

Nothing yet:

[]

In any case all transactions are booked.
If no payout happened a users balance is increased according its merits to be paid out later.
In case of a payout, a users balance is set to 0.

Tests

To run the test simple use sbt test. And yes the coverage is not (yet) that high.

License

MIT