fogbugz

FogBugz integration module

node-fogbugz

Talks to FogBugz' icky XML API for you.

$npm install fogbugz

Create a fogbugz.conf.json in your app's root directory. It should look like this:

{
  "host": "zzz.fogbugz.com",
  "username": "zzz@yyy.com",
  "password": "Password1"
}
var fogbugz = require('fogbugz');
fogbugz.logon()
 .then(function() {
   return fogbugz.getBug('12345');
 })
 .then(function(bug) {
    console.log(bug.title);
 });
var fogbugz = require('fogbugz');

Forgets the stored token.

Manually sets a login token if you have one by some other means.

token: string, FogBugz API logon token

Assuming you are logged in and have a cached token, this will log you out.

Function|promise|Q.promise, Promise

Logs you into FogBugz based on contents of fogbugz.conf.json.

Function|promise|Q.promise, Promise

Retrieves a list of Filters as an array. Each item in the array is of type Filter. Example:

[{"name": "My Cases", "type": "builtin", "id": "ez",
"url": "https://zzz.fogbugz.com/default.asp?pgx=LF&ixFilter=ez"}),
{"name": "Inbox", "type": "builtin", "id": "inbox",
 "url": "https://zzz.fogbugz.com/default.asp?pgx=LF&ixFilter=inbox"}]

Function|promise|Q.promise, Promise

Sets the current Filter. Allows to call fogbugz.search() with an empty string as the 'query' paramenter to list all cases in the current filter.

filter: Filter|string, Filter object or string ID

Performs a search against FogBugz's cases. Promise resolves to a Case object or an array of Case objects.

query: string, Query string

[cols]: array, Fields to pull

[max]: number, Number of cases to get at once

Function|promise|Q.promise, Promise

Gets a bug by ID

id: string|number, ID of bug

[cols]: number, Cols to pull; defaults to everything

Filter pseudoclass

obj: Object, Object representing Filter

Sets the current filter to be this Filter

Case pseudoclass. Stores original case data from server in its _raw property.

obj: Object, Object representing Case

Christopher Hiller

MIT