arun-babu / mw

a middleware for smart cities

MW

A middleware for smart cities

Quickstart

1. Clone the repository:

   git clone https://github.com/arun-babu/mw
   cd corinthian
   git submodule init
   git submodule update
   

2. Install the required dependencies (Host OS must be Ubuntu):

   ./test-suite/require.sh
   

3. If the host OS is not Ubuntu then install the following dependencies manually

   • docker
   • docker-compose

   Also install the following dependencies if the tests need to be run

   • requests
   • urllib3
   • pika

4. Start the installation:

   ./docker/install
   

5. Test the middleware using:

   ./test-suite/test functional --random
   

Restricting admin APIs

By default the admin related APIs are allowed from any host. To restrict access of admin APIs through localhost only: unset the "ALLOW_ADMIN_APIS_FROM_OTHER_HOSTS" environment variable (in the docker/.env file).

Use-case diagrams

Sequence diagrams

• Registration

• Share/Follow

API

All APIs are based on the following format: /<caller of the API>/<action>

• /admin/register-owner

• /owner/register-entity

• /entity/publish

• /entity/subscribe

• /owner/follow

• /owner/follow-status