scrumy-api

0.0.1 • Public • Published

scrumy-api

Simple wrapper for scrumy api. For the moment work only with get/list methods

Instalation

npm install scrumy-api

Usage

var Scrumy = require('scrumy-api')
var scrumy = new Scrumy('board', 'secret')
 
scrumy.listSprints('board', function(err, res, sprints){
  scrumy.listStories(sprints[0].id, function (err, res, stories) {
    stories.forEach(function(story){
      console.log(story.id);
    })
  })
})
 
scrumy.listCurrentSprint(function(err, res, current){
  console.log(current.sprint.stories[0].tittle)
})

Methods

var Scrumy = require('scrumy-api')
var scrumy = new Scrumy('board', 'secret')

Scrumies - API

  • scrumy.getScrumies(board, callback)

Sprints - API

  • scrumy.listSprints(board, callback)
  • scrumy.getSprints(sprintID, callback)
  • scrumy.getCurrentSprint(callback)

Stories - API

  • scrumy.listStories(sprintID, callback)
  • scrumy.getStories(storyID, callback)

Tasks - API

  • scrumy.listTasks(storyID, callback)
  • scrumy.getTasks(taskID, callback)

Scrumers - API

  • scrumy.listScrumers(board, callback)
  • scrumy.getScrumers(scrumerID, callback)

Snapshots - API

  • scrumy.listSnapshots(sprintID, callback)
  • scrumy.getSnapshots(snapshotID, callback)

Test

  • npm test

Coverage

  • npm run-script jscov
  • npm run-script cov-report
  • chromium-browser test/coverage.html

License

MIT

Readme

Keywords

none

Package Sidebar

Install

npm i scrumy-api

Weekly Downloads

0

Version

0.0.1

License

MIT

Last publish

Collaborators

  • ferlores