Open Source GeoSocial Intelligence Framework
DOI for current stable release v2.0.0:
Cognicity-reports-powertrack is the NodeJS reports module for collecting relevant tweets via Gnip PowerTrack as part of the Cognicity Framework, and sending users verification messages via Twitter. 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.
http://cognicity.info/cognicity/api-docs/cognicity-reports-powertrack/index.html
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 install
To 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 PowertrackDataSource.js. See sample-powertrack-config.js for an example configuration.
Set the app authentication parameters as provided by Twitter. See the ntwitter-module documentation for more details.
The messages are stored in objects, where the object name is the name of the message. Within the object, the property name (key) is the language, and the value is the message text. There is also a top-level 'defaultLanguage' property which is used if the language code from the tweet cannot be resolved.
twitter.defaultLanguage Sets the default language code used in responses if one can't be determined in the tweet.
Messages can be at most 109 characters long if addTimestamp is enabled, or 123 characters long if addTimestamp is disabled. Note that this length includes one shortened URL at current lengths - see https://dev.twitter.com/overview/t.co for details.
To run the full set of tests, run:
npm test
This will run the following tests:
JSHint will run on all JavaScript files in the root folder and test folders.
Running the script:
npm run jshint
This 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 mocha
The 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-docs
This 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 coverage
This 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:
This software is released under the GPLv3 License. See License.txt for details.