Skip to content
This repository has been archived by the owner on Apr 4, 2018. It is now read-only.

Stores narrative messages for display on the datainsight dashboard

Notifications You must be signed in to change notification settings

alphagov/datainsight-narrative-recorder

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

42 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

THIS PROJECT IS NO LONGER UNDER ACTIVE DEVELOPMENT

About

This recorder forms part of the Data Insight Platform. It listens for the latest content for the narrative and exposes that information via an HTTP api for use by the dashboards.

Queue and Key name

The recorder listens to messages on the following topic:

*.narrative

The queue name defaults to narrative but can be overridden using the QUEUE environment variable.

Format

The expected format from the collector is:

{
  "envelope":{
    "collected_at":"2012-07-31T10:46:25+01:00",
    "collector":"narrative"
   },
   "payload":{
      "content":"Some content of interest went up 20%",
      "author":"Gareth Rushgrove"
   }
}

Dependencies

Bundler manages the ruby dependencies so you'll want a quick:

bundle install

If you're using the run command you'll need a message queue listening. This defaults to listening on localhost on 5672 but can be overridden with the AMQP environment variable.

Listening for changes

The recorder provides a command which will listen for messages on the topic store the latest message locally for use by the API.

bundle exec bin/narrative-recorder run

Full help details can be found with:

bundle exec bin/narrative-recorder help

Running the API

Once you have recorded the latest narrative the web application which exposes that information can be started.

bundle exec rackup

This starts a web application which exposes one URL at /narrative which returns a JSON document of the following format:

{"content":"Content goes here"}

About

Stores narrative messages for display on the datainsight dashboard

Resources

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published