StacheR(ead)

A simple NodeJS lib to query items stored in Stache

Requirements

User of StacheRead assumes a working NodeJS and NPM environment. StacheRead has been tested successfully with NodeJS versions 6.9+ and 8.9+

Installation

Installation as an NPM Dependency

$ cd <my_node_project>
$ npm install --save git+https://bitbucket.org/uazgraduatecollege/stacheread-js.git

Usage

Initialization

const StacheR = require('stashr')

let myStache = new StacheR({
  domain: 'stache-server.my.edu',
  path: '/api/path/to/item/read/'
},
{
  userAgent: 'My StacheReader'
})

StacheR.read()

let item = process.env.myItem //12345
let key = process.env.itemKey //'a028e12b0dc38e62f169bc11229794eb57c95c6567c634958f9498ff70d97d70'

myStache.read(item, key, (error, response) => {
  if (error) {
    console.error("Error:\n" + error.message)
  }
  if (response) {
    console.log(response)
  }
})

StacheR.fetch()

The fetch() method wraps StacheR.get() in a Promise:

let item = process.env.myItem //12345
let key = process.env.itemKey //'a028e12b0dc38e62f169bc11229794eb57c95c6567c634958f9498ff70d97d70'

myStache.fetch(item, key)
.then((response) => {
  response.secrets = JSON.parse(response.secret)
  console.log(response)
})
.catch((error) => {
  console.error("Error:\n" + error.message)
})

A Note on the Use of JSON within Stache(d) items

While the response body served by a successful stache request will be JSON, it may also be useful to define one or more elements of the stached item as JSON values. In such cases, given the return format from Stache and the way Node's JSON.parse() work together, it's recommended to enclose both the object keys and their values in double-quotes.

Eg: Given a Stached item with the following values:

• nickname: Brian
• purpose: Romanes eunt domus,
• secret: { "romansgaveus": ["aqueducts", "sanitation", "roads", "education"] },
• memo: { "advice": "Always look on the bright side of life" }

Where secret holds a string that can be parsed into JSON, it's best to enclose both keys and string values in quotes.

Then, given a successful request

response.parsedSecrets = JSON.parse(response.secret)
response.parsedMemo = JSON.parse(response.memo)
console.log(response)

will output

{ nickname: 'Brian',
  purpose: 'Romanes eunt domus',
  secret: '{ "romansgaveus": ["aqueducts", "sanitation", "roads", "education"] }',
  memo: '{ "advice": "Always look on the bright side of life" }',
  parsedSecrets:
   { romansgaveus: ['aqueducts', 'sanitation', 'roads', 'education'] },
  parsedMemo:
   { advice: 'Always look on the bright side of life' } }

Status

A work in-progress, may be unstable. Contributors welcome if you bring us a shrubbery.