Open Source GeoSocial Intelligence Framework
Cognicity reports module for floodgauge readings
####cognicity-reports-floodgauge: Module for cognicity-reports module to collect BPBD floodgauge API (Siaga Levels).
Travis build status:
DOI for current stable release v2.0.0:
Cognicity-reports-floodgauge is the NodeJS reports module for collecting floodgauge levels from the BPBD floodgauge API. For detailed framework documentation see http://cognicity.info. This module is not designed to be run standalone but is designed to be run as a submodule of cognicity-reports, which can run just with this submodule alone.
- NodeJS version 4.2.1 or compatible
- Check package.json for details
If you're going to commit changes to the JavaScript, be sure to run 'npm test' first - and fix any issues that it complains about, otherwise the build will fail when you push the commit.
Please install this as a submodule of cognicity-reports. Please refer to the documentation of that project for further information.
Install the node dependencies for this submodule as listed in package.json using npm: npm install
To build on OS X we recommend using homebrew to install node, npm, and required node modules as follows:
brew install node
npm installTo build on Windows we recommend installing all dependencies and running npm install.
App configuration parameters are stored in a configuration file which is parsed by FloodgaugeDataSource.js. See sample-floodgauge-config.js for an example configuration.
config.floodgauge = {}; config.floodgauge.serviceURL = "http://example.com/cgi-bin/wlr"; // E.g. https://example.com/cgi-bin/wlr config.floodgauge.pollInterval = 1000 * 60 * 15; // E.g. 1000 * 60 * 15 = 15 minutes config.floodgauge.historicalLoadPeriod = 1000 * 60 * 120; // E.g. 1000 * 60 * 120 = 2 hours
// Floodgauge configuration for cognicity-schema config.floodgauge.pg = {}; config.floodgauge.pg.table_floodgauge = 'floodgauge_reports';
- serviceURL - The URL of the flood gauge API
- pollInterval - How often to poll the data source, in milliseconds
- historicalLoadPeriod - How far back to process reports, in milliseconds
- pg.table_floodgauge - Database table to store floodgauge data reports in
To run the full set of tests, run:
npm testThis will run the following tests:
JSHint will run on all JavaScript files in the root folder and test folders.
Running the script:
npm run jshintThis will print an error to the screen if any problems are found.
Mocha will run all unit tests in the test folder and can be run with the following script:
npm run mochaThe test output will tell you how many tests passed and failed.
There is a git pre-commit hook which will run the 'npm test' command before your commit and will fail the commit if testing fails.
To use this hook, copy the file from 'git-hooks/pre-commit' to '.git/hooks/pre-commit' in your project folder.
cp git-hooks/pre-commit .git/hooks/To build the JSDoc documentation run the following npm script:
npm run build-docsThis will generate the API documentation in HTML format in the docs folder, where you can open it with a web browser.
To build test code coverage documentation, run the following npm script:
npm run coverageThis will run istanbul code coverage over the full mocha test harness and produce HTML documentation in the directory coverage where you can open it with a web browser.
The release procedure is as follows:
- Update the CHANGELOG.md file with the newly released version, date, and a high-level overview of changes. Commit the change.
- Create a tag in git from the current head of master. The tag version should be the same as the version specified in the package.json file - this is the release version.
- Update the version in the package.json file and commit the change.
- Further development is now on the updated version number until the release process begins again.
This software is released under the GPLv3 License. See License.txt for details.