urbanriskmap / cognicity-grasp Goto Github PK

View Code? Open in Web Editor NEW

1.0 7.0 1.0 3.52 MB

Geosocial Rapid Assessment Platform for CogniCity

License: GNU General Public License v3.0

JavaScript 91.45% PLpgSQL 8.55%

cognicity-grasp's Introduction

DEPRECATED

CogniCity GRASP

Geosocial Rapid Assessment Platform

Introduction

cognicity-grasp is an extension to the CogniCity platform that adds support to collect disaster reports from residents using web-technologies. Users request a report card which is delivered in the form of a unique one time link pointing to a cognicity-server instance. The report card link is delivered by a simple conversational 'bot'. The bot can be included in cognicity-reports so that report cards can be delivered to users via social messaging or third-party application.

Key Files

Bot.js - GRASP module for user communication
ReportCard.js - GRASP module to create unique card link
App.js - Reference implementation
- sample-grasp-config.js - Sample config for reference implementation
public/ - Folder containing web elements for card design

GRASP Process

User input (e.g. via social messaging)
Bot.js scans User input for keyword "report"
Bot.js requests a report card from ReportCard.js
ReportCard.js creates unique card link, writes this to CogniCity database, and passess to Bot.js
Bot.js replies to User with unique card link
User opens link, requesting card resources from an instance of CogniCity server
Server uses local instance of ReportCard.js to validate unique card link against database

check card exists
check card not completed already

Server responds to User with card resources
User completes card, and sends response to server
Server adds report card to map and responds to User with unique report link
On update to reports table in CogniCity database, Bot.js responds to User thanking them, including unique report link for map

App.js

App.js is the reference implementation of CogniCity Grasp. It emulates user input from a reports module to generate a report card using Bot.js and ReportCard.js, and emulates server response for submission of the card by the user.

Dependencies

Stored in package.json, use:

npm install

Run App.js

$ node app.js
info: Application starting...
info: Bot requesting issue of card
info: Express listening
info: Issued card B1eYYW-R
Hi User, here is the link to your report card: http://localhost:3000/report/B1eYYW-R

$ curl http://localhost:3000/report/B1eYYW-R
Success - proceed with report

$ curl http://localhost:3000/report/ZZZ
Error - report card id invalid

ReportCard.js & Bot.js

ReportCard.js provides simple module for the creation, storage and validation of unique report card links.

Bot.js provides human-API endpoint to CogniCity Reports via keywords. Current keywords:

"reports" (case insensitive).

Bot.js requires an instance of ReportCard.js to issue report cards.

var ReportCard = require('ReportCard');
var Bot = require('Bot');

var report_card = new ReportCard(massive_database_object, winston_logger_object);
var bot = new Bot(config, report_card, winston_logger_object);

bot.parse(user_input, callback(err, response));

Bot.js Configuration

See sample-grasp-config.js

Schema

TO DO -> Move schema to /db?

Development

Unit tests

npm install --dev
npm test

Cards

Report card web elements are in the public/ folder. In the future, we'll use handlebars templates for multi-language support (see cards/).

cognicity-grasp's People

Contributors

Stargazers

Watchers

Forkers

ziyuanshen

cognicity-grasp's Issues

Picture upload links might be issued from the server but not used by the client

Right now, the client asks the server for a signed url, the server (which has credentials)
asks s3 for a signed url where the client can PUT an image. There's a corner case where the
server asks for a signed url, but the client doesn't actually PUT the image (connection drops, user backs out, so on.)

Here's a fix: use the lambda code to touch our database after it does the compression so that it tells us that an image url is present.

13 Hazards Parameter

BNPB released regulation (no 2 year 2012) to standardise Indonesian hazards parameter. Please look into this link to see the original document.

*start from page 15 - table 1 on the document

Finding:

Basically, the alert levels for all hazards described as:

low (green)
medium (yellow)
tinggi (red)

The thresholds for each level in each hazards are referring to the national standards that are released by related agency (i.e extreme weather by BMKG, etc).
We will follow up to BNPB next week if there is any update on this regulation while we have a discussion with PDC as well.

cc @talltom @anexact @prittandrani @nashinmahtani @clgeros

Follow up on image_id in grasp_reports

Do we really need image_id or can we make card_id part of primary key in grasp_report_images?

Prototype Card Interactivity (CogniCity)

Trigger request for card one-time-link via Twitter
CogniCity server to accept card input data
Create database table for card data?
Push out via report API

Bot Language

Hi! We were discussing about the bot language, which is may be the best for the users if we provide Indonesian & English.

We were talking deeper about how the bot will determine the language to be used for the rest of the report, and come up to this idea that the bot will send the first message to request the user to choose the language, like in the screenshot here:

Any comments? :) @talltom @fadmastuti @anexact @nashinmahtani @clgeros

translations check

urbanriskmap/riskmap#132 (comment)

adding realtime rainfall graph

Hi @talltom , after our discussion with BMKG (Meteorological, Climatological and Geophysical Agency), they are agree to feed our map with the realtime rainfall data in mm/h. Can we show it on the map like the waterlevel or sensor data in a realtime graph per hour?

I have made the wiki page and added this on our list. Please check on this link .

BMKG also will provides us the location data of the rainfall station for Jabodetabek, Bandung, Surabaya. Can we integrate their .csv/.kml data (with a column for coordinates)?

cc @anexact

Add testing for image upload

We should write tests around the image upload functionality.

User input validation - need to build

As we are collecting data directly from users we need to add validation processes for report cards:

Client side, how to inform user if input is incorrect (e.g. report length too long?)
Server side, how to catch malformed input data from report cards (e.g. null geolocation etc)

Agree Report Card Data Fields

Suggested fields:

card_id
created_at (ISO 8601 timestamp with timezone from user device)
text (UTF8 @ 140 chars)
water_depth
image (optional)
location (GeoJson (point))

When you click next, then go back and back, you get a blank screen on the landing page.

Cards should work both on desktop and on phones

Right now we are constrained to either testing on a phone or on Desktop. The touch and click apis are different. We should add code to make this more streamlined.

Create as stand-alone module, within cognicity-reports template

cognicity-grasp should follow the template of other cognicity-reports submodules:

independent configuration via local config.js
shared database parameters
shared log file
index.js exposing module API

Prototype Card Design (web content)

Requirements for prototype:

Get user location via web geolocation (ref: https://developer.mozilla.org/en-US/docs/Web/API/Geolocation/Using_geolocation)
User input: water level
User input: free text
Submit button

Photo uploads occur immediately, not after the user signs our terms and conditions

Right now photos are uploaded immediately when you click the upload button, but we should instead hold off until the user signs the terms and conditions.

Test values set in 'before' not always updated

Setting global values in the 'before' function, may return false positives where these are not updated in the test due to some other errors.

Need a more robust method of testing changes to logs.

Can't submit card without a location

ReportCard.js causes a crash if result object is undefined

Putting this here so I remember to fix it later.

I think we're not doing error checking correctly in ReportCard.js.

/Users/abrahamq/Documents/urop/cognicity-grasp/ReportCard.js:157
else if (result[0].received === false){
^

TypeError: Cannot read property 'received' of undefined
at /Users/abrahamq/Documents/urop/cognicity-grasp/ReportCard.js:157:29
at null. (/Users/abrahamq/Documents/urop/cognicity-grasp/ReportCard.js:85:6)
at Query.handleReadyForQuery (/Users/abrahamq/Documents/urop/cognicity-grasp/node_modules/pg/lib/query.js:114:10)
at null. (/Users/abrahamq/Documents/urop/cognicity-grasp/node_modules/pg/lib/client.js:172:19)
at emitOne (events.js:82:20)
at emit (events.js:169:7)
at Socket. (/Users/abrahamq/Documents/urop/cognicity-grasp/node_modules/pg/lib/connection.js:121:12)
at emitOne (events.js:77:13)
at Socket.emit (events.js:169:7)
at readableAddChunk (_stream_readable.js:146:16)