Skip to content
This repository has been archived by the owner on Jan 17, 2023. It is now read-only.

Latest commit

 

History

History
268 lines (212 loc) · 6.98 KB

README.md

File metadata and controls

268 lines (212 loc) · 6.98 KB
Raw

Choirless API

The Choirless API allows easy manipulation of data stored in the Choirless music collaboration platform.

This API can be deployed to IBM Cloud Functions (based on Apache OpenWhisk) or during development, run locally as a Node.js/Express app. Application data is stored in Cloudant/Apache CouchDB databases.

Configuration

The following environment variables configure how the API accesses the database:

  • COUCH_URL - the URL of the CouchDB/Cloudant service e.g. http://admin:admin@localhost:5984.
  • COUCH_USERS_DATABASE - the name of the users database, storing registered Choirless users.
  • COUCH_CHOIRLESS_DATABASE - the name of the main Choirless database (stores choirs/members/songs/parts).
  • COUCH_KEYS_DATABASE - the name of the database for storing API access keys.
  • COUCH_RENDER_DATABASE - the name of the database to store render status objects.
  • COUCH_INVITATION_DATABASE - the name of the invitations database.
  • LOCAL_MODE - if true runs without authentication middleware.
  • COS_REGION - the Cloud Object Storage region.
  • COS_ACCESS_KEY_ID - Cloud Object Storage credentials.
  • COS_ACCESS_KEY_SECRET - Cloud Object Storage credentials.
  • COS_DEFAULT_BUCKET - Cloud Object Storage raw upload bucket.
  • COS_ENDPOINT - Cloud Object Storage endpoint.

W3ID Environment Variables

The key management page (/keys) is protected by W3ID, and is further protected by a whitelist of users. The following are the steps you'll to need to follow and the environment variables you'll need to protect the /keys route.

Instructions for registering your app with W3ID can be found here. Required environment variables can be found here.

Setup

The databases and secondary indexes can be setup by running setup.sh on a shell with the appropriate environment variables set.

Testing

Run the automated test suite with:

npm run test

Tests are configured to run automatically in Travis.

Running the local dev server

The API can be run locally with:

# disable authentication and whitelist middleware with LOCAL_MODE=true
export LOCAL_MODE="true"
npm run server

Deploying serverlessly on IBM Cloud Functions

echo 'to do'

Using in your own project

To save having to spin up your own API server, you can embed the API functions into your own code. First add this repo to your package.json:

  ...
  dependencies: {
    "choirlessapi": "Choirless/choirlessapi"
  }
  ...

Then require the module in your own code and use it (they rely on the presence of the environment variables described in the Configuration section):

const choirlessAPI = require('choirlessapi')
const main = async () => {
  try {
    const user = await choirlessAPI.getUser({ userId: 'someid' })
    console.log(user)
  } catch (e) {
    console.log('error', e)
  }
}
main()

Every function expects an object with parameters listed in the API Reference and returns a Promise:

API Reference

Read the API Reference.

Objects

The following objects are stored:

                         +--------------+             +---------------+
                         |              |            /|               |
                         |    choir     +-------------+     song      |
                         |              |            \|               |
                         +------+-------+             +-------+-------+
                                |                             |
                                |                             |
+-------------+       +--------/-\-----------+         +-----/-\------+
|             |       |                      |         |              |
|    user     +-------+     choirmember      |         |  songpart    |
|             |       |                      |         |              |
+-------------+       +----------------------+         +--------------+

Users

{
  _id: "<userid>",
  type: "user",
  userId: "<userid>",
  userType: "regular",
  name: "Glynn Bird",
  email: "bob@aol.com",
  createdOn: "2018-01-26",
  verified: true,
  password: "<sha256(salt + password)>",
  salt: "<some random data>"
}
  • userType can be regular or admin.

Choirs

{
  _id: "<choirid>:0",
  type: "choir",
  choirId: "<choirid>",
  name: "IBM Bristol Choir",
  description: "IBM Bristol office choir.",
  createdByUserId: "<userid>",
  createdByName: "Bob",
  createdOn: "2020-05-01",
  choirType: "private"
}

choirType:

  • private - invite only
  • public - anyone can join

Choir Members

{
  _id: "<choirid>:member:<userId>",
  type: "choirmember",
  choirId: "<choirid>",
  userId: "<userid>",
  joined: "2020-05-02",
  name: "Glynn Bird",
  memberType: "leader"
}

memberType:

  • leader - can create songs, and reference parts
  • member - can create renditions of parts

Songs

{
  _id: "<choirid>:song:<soingid>"
  type: "song",
  name: "The Lorem Ipum Song",
  description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
  choirId: "<choirid>",
  songId: "<songid>",
  userId: "<userid>",
  createdOn: "2020-05-01",
  partNames: [
    {
      partNameId: "abc",
      name: "baritone",
    },
    {
      partNameId: "def",
      name: "tenor"
    }
  ]
}

Song parts

{
  _id: "<choirid>:song:<songid>:part:<partid>"
  type: "songpart",
  choirId: "<choirid>",
  songId: "<songid>",
  partId: "<partid>",
  partName: "alto",
  partType: "rendition",
  createdBy: "<userid>",
  name: "Glynn Bird",
  createdOn: "2020-05-01",
  offset: 200,
  frontendOffset: 150,
  aspectRatio: "4:3",
  hidden: false,
  audio: false,
  volume: 1.0
}

partType:

  • backing - backing track
  • reference - exemplar rendition of part
  • rendition - choir members rendition of a reference part

Invitation

This allows a user to extend an invitation to new user to join the choir:

{
  
  creator: '<id of user who created the invite>',
  invitee: '<email of invited user>',
  choirId: '<id of choir>',
  expires: <expiry timestamp of invite>
}

Render

This records progress of the rendering process:

{
  choirId: '<id of choir whose song is being rendererd>',
  songId: '<id of song being rendererd>',
  partId: "<id of the part that triggered the render>",
  status: "new", // one of new/converted/aligned/rendered/composited/done
  date: "2020-08-01T10:56:22.000Z"
}