readme.md

# Waystone

> But mostly because it felt like the right thing to do, and that is reason enough.

# Installation

	./install

This will set up your system and also run Pulse for the first time. Continue to the Configuration section to complete your setup.

(Note: on Linux systems, make sure g++ is installed. All other dependencies will be installed by the script.)

# Configuration

The installation script will create an empty config.json file in the root of the project folder.

	{
		"PulseAPIKey": "",
		"DeviceID": ""
	}

To configure your Waystone installation, go to the Pulse Web UI at `http://localhost:8080`. The installation script should have run Pulse for you. If it's not running, you can find it in the `node_modules/indie-pulse-process/` folder (make sure you run the correct binary for your platform).

Once you're in the Web UI, go into the gear menu and select Show ID. This is the Device ID you need to copy as the value for the "DeviceID" key in the configuration file.

Next, select the Settings option from the gear menu and, in the resulting dialog box, click the button that reads "Generate" under the API Key section. This will generate your API key. Copy that key as the value for the "PulseAPIKey" key in the configuration file. 

# Running (and for testing during development)

	./dev

This will run the server.

# REST API

Traditional REST API. Messages received are not trusted and replies should not be trusted either. For trusted messages, we use [Pulse](https://ind.ie/pulse) and the [Teleportation API](#teleportation-api).

All methods receive and return serialised JSON.

### GET

#### isHandleAvailable

*Checks if the passed handle is available for use.*

Expects a handle to check:
 
	/handle

Returns:

	{
		"handleIsAvailable": Boolean
	}

#### getDeviceId

*Returns the device ID of the Waystone instance.*

Expects: 

	/

Returns:

	{
		"deviceId": "String"
	}

### POST 

#### addPerson

*Adds the passed person to Waystone* 

Expects a person:

	{
		"handle": "String",
		"name": "String",
		"bio": "String",
		"photo": "Base64EncodedString",
		"deviceId": "String",
		"email": "(optional) String"
	}

Returns:
	
	{
		"success": Boolean,
		"error (optional)": 
		{
			"code": Number,
			"message": "String"
		}		
	}

#### confirmNewDeviceForPerson

*Registers a request to confirm that a new device should be added to the person’s account.* 

Expects a device to add to a person:

	{	
		device:
		{
			"id": "String",
			"name": "String",

		},
		person:
		{
			"handle": "String"
		}
	}

Returns:

	{
		"success": Boolean,
		"error (optional)": 
		{
			"code": Number,
			"message": "String"
		}		
	}

**Note:** *`success = true` means that the request to register the new device has been successfully stored and will be relayed to the user via the Teleportation API for confirmation. The person will have to approve the request either via a notification on the native client (by way of the Teleportation API) or via email if they have that option enabled as a backup.*

# <a name='teleportation-api'></a>Teleportation API 

Messages dropped in specific folders are teleported automatically by Pulse to the recipients. These are trusted messages between authenticated devices. The message are files. The message names are the file names and the message bodies are the file contents. All message bodies are in serialised JSON format.

Message names are automatically prefixed with a timestamp and the handle of the sender in the following format:

	<datetime>__<messageName>

Where:

	<datetime> = 	ISO 8601 combined date and time string with timezone 
					with colons escaped by underscores for better cross-platform
					file name compability.

Example:

	1980-10-14T00_59_59-04_00__confirm_new_device

## Message-Acknowledge-Delete (MAD) pattern

Messaging in the Teleportation API uses the MAD pattern:

1. First party writes a message
2. Second party writes an acknowledgement message
3. First party deletes the message (now that it has been acknowledged)

The second party should only acknowledge the message once it has safely received it and loaded it into memory to act on it.

Acknowledgement messages have the form:

	<datetime>__ack__<originalMessageDatetime>__<originalMessageName>

## From Waystone to a person

### Adding a new device.

#### verify_new_device

Asks person to verify that they asked for the device with the presented ID and name.

Message body:

	{
		"id": "String",
		"name": "String"
	}

Reply with (either):

 * [confirm_new_device](#confirm-new-device)
 * [deny_new_device](#deny-new-device)

*Notes:*

  1. Not replying will eventually result in the request being forgotten.
  2. If you confirm the new device, its device ID will be added to the list of approved devices for that person and the person will get a `new_device_verified` message.

#### new_device_verified

Confirms that the person’s new device has been verified.

Message body:

	{
		"id": "String",
		"name": "String"
	}

### Friendship

#### friendship_request

A notification that the sender is requesting friendship.

Message body:
	
	{
		"from": "handle"
	}

#### friendship_acceptance

A notification that your friendship request has been accepted by sender.

Message body:

	{
		"from": "handle"
	}

## From a person to Waystone

### Adding a new device

#### <a name='confirm-new-device'></a>confirm_new_device

Confirm that you want to add the device with the passed ID to your Ind.ie account. The device will gain full access to your Ind.ie account. This is a response to the `verify_new_device` message.

Message body:

	{
		"id": "String"
	}

#### <a name='deny-new-device'></a>deny_new_device

Deny access to the device with the passed ID to your Ind.ie account. This is a response to the `verify_new_device` message.

Message body:

	{
		"id": "String"
	}

### Friendship

#### friendship_request

A friendship request to be relayed to the specified person.

Message body:
	
	{
		"to": "handle"
	}

#### friendship_acceptance

A request to relay that you have accepted the specified person’s friendship request.

Message body:

	{
		"to": "handle"
	}