Giter Club home page Giter Club logo

node-backlog-api's Introduction

backlog-api

Backlog XML-RPC API wrapper for Node.js

NPM

Build Status Coverage Status

Installation

$ npm install backlog-api

Usage

var backlogApi = require('backlog-api');

var backlog = backlogApi('space', 'user', 'pass');

backlog.findIssue({
  projectId: 1,
  statusId: [1, 2, 3],
}, function(err, issues) {
  console.log(issues);
});

Example

// show 'BAPI' project, 'bouzuya' user, 'imcomplete' issues.
var backlogApi = require('backlog-api');

// set env
// process.env.BACKLOG_SPACE_ID
// process.env.BACKLOG_USERNAME
// process.env.BACKLOG_PASSWORD
var backlog = backlogApi();

// get project id 
backlog.getProjects(function(err, projects) {
  if (err) throw err;
  var projectId = projects.filter(function(p) {
    return p.key === 'BAPI';
  })[0].id;
  
  // get user id
  backlog.getUsers({
    projectId: projectId
  }, function(err, users) {
    if (err) throw err;
    var userId = users.filter(function(u) {
      return u.name === 'bouzuya'
    })[0].id;
    
    // get issues
    backlog.findIssue({
      projectId: projectId,
      assignerId: userId,
      statusId: [1, 2, 3]
    }, function(err, issues) {
      console.log(issues);
    });
  });
});

Supported Methods

  • backlog.getProjects
  • backlog.getProject (projectId)
  • backlog.getProject (projectKey)
  • backlog.getComponents
  • backlog.getVersions
  • backlog.getUsers
  • backlog.getIssue (issueId)
  • backlog.getIssue (issueKey)
  • backlog.getIssueTypes
  • backlog.getComments
  • backlog.countIssue
  • backlog.findIssue
  • backlog.createIssue
  • backlog.updateIssue
  • backlog.switchStatus
  • backlog.addComment
  • backlog.addIssueType
  • backlog.updateIssueType
  • backlog.deleteIssueType
  • backlog.addVersion
  • backlog.updateVersion
  • backlog.deleteVersion
  • backlog.addComponent
  • backlog.updateComponent
  • backlog.deleteComponent
  • backlog.getTimeline
  • backlog.getProjectSummary
  • backlog.getProjectSummaries
  • backlog.getUser
  • backlog.getUserIcon
  • backlog.getActivityTypes
  • backlog.getStatuses
  • backlog.getResolutions
  • backlog.getPriorities
  • backlog.getCustomFields
  • backlog.getChildIssues
  • backlog.admin.getUsers
  • backlog.admin.addUser
  • backlog.admin.updateUser
  • backlog.admin.deleteUser
  • backlog.admin.getProjects
  • backlog.admin.addProject
  • backlog.admin.updateProject
  • backlog.admin.deleteProject
  • backlog.admin.getProjectUsers
  • backlog.admin.addProjectUser
  • backlog.admin.updateProjectUsers
  • backlog.admin.deleteProjectUser
  • backlog.admin.addCustomField
  • backlog.admin.updateCustomField
  • backlog.admin.deleteCustomField

Todo

1.0.x

  • all method support

1.1.x

  • parameter type validation

2.x

  • new interface

node-backlog-api's People

Contributors

bouzuya avatar

Stargazers

Nao avatar Taichi Murai avatar Yusuke Hirao avatar Yusuke Sangenya avatar Hiroshi Yamamoto avatar Shiro Nohara avatar Aleksandar Vidakovic avatar Takumi Yamamoto avatar Kazuhiro Homma avatar Takeshi Tanabe avatar Takashi Someda avatar  avatar

Watchers

James Cloos avatar  avatar Ikuro Nishizuka avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.