raphyot/p2v_meeting_room

P2V Meeting room

This is a project for Cisco Live 2018 in Barcelona. The goal is to map physical people to virtual spark room and add a spark board automatically by scanning their badges.

This project exposes API the scanner can call and will call spark API accordingly.

Algorithm

Each time a badge is scanned, we will record the email address of the user in the DB.

As soon as the user is a member of the team, we will:

• Create a new room with a name composed of the current UTC time + the email address of the firts non team member scanned
• Add every user scanned to the room:
  • Users will be all the non team member scanned between the last team member and the penultimate
  • Users added to the spark room will only be ones scanned by the same sacnner
  • The team member added to the room will be admin
  • If additional team member need to join, they will have to do it manually in spark
  • The team member will have to manually link himself to the sparkboard

A typical URL that will be called by the scanner will be:

http://localhost:5000/api/badge/scans/?email=rawouter%40cisco.com&badgeId=1234567890&firstname=Raphael&lastname=Wouters&ScannerName=clinics001

API usage

The API is defined in swagger at http://localhost:5000/api

Configuration

The configuration is set using the env var APP_SETTINGS default to production Check the configuration details in instance/config.py

Database

By default the app will use sqlite DB in the /db directory, this can be changed in the configuration file. Swapping to posgres can simply be done by changing the SQLALCHEMY_DATABASE_URI, which can also be set through env var.

DB and tables are created at startup if they don't exists.

If you are using docker with the production configuration, mount the /db directory on the host disk for permanent storage.

Spark configuration

Set up the variables SPARK_BEARER with the bot bearer, and SPARK_TEAM_ID with your team ID where you will create the spaces. This can also be set through env var.

Docker

The make file allow you to build the project into docker: make image The whole project is also stored on containers.cisco.com.

Typical docker command, PAY ATTENTION TO THE CURRENT VERSION IN THE IMAGE NAME

docker run \
    --rm \
    -p 5000:5000 \
    -v "/tmp:/db" \
    -e "SPARK_BEARER=MDFlYjQ1NDgtMDE1Ny00YmQxLTk5MjMtZDU0OWI2ZTE4NGZkZjI0ODE0NTItZjc2" \
    -e "SPARK_TEAM_ID=Y2lzY29zcGFyazovL3VzL1RFQU0vYTg1YWQ0OTAtYzQ2Ny0xMWU3LWI3NDMtN2RmYTRiMTA3Nzc5" \
    raphyot/p2v_meeting_room:v1.0.0