Visual Studio Online client for Node.js
Switch branches/tags
Nothing to show
Clone or download
Pull request Compare This branch is 3 commits behind LeanKit-Labs:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
public
spec
src
.esformatter
.gitignore
.jscsrc
LICENSE
README.md
coffeelint.json
gulpfile.js
package.json

README.md

Visual Studio Online Node.js Client

The VSO client module for Node.js is a wrapper for the latest Visual Studio Online REST API. It provides an easy-to-use set of functions designed to simplify the integration of external systems and utilities with your Visual Studio Online account.

Features:

  • Get a list of projects, collections, teams, and team members
  • Manage Team Rooms, membership and messages
  • Query for work items using saved queries or WIQL
  • Create and update work items, including attachments
  • Manage saved queries
  • TFS version control, branches, changesets, shelvesets, and labels
  • Git repositories, commits, diffs, pushes, stats and refs
  • Service hook publishers, consumers, and subscriptions

Requirements

Installing the client

npm install vso-client

Client usage

You can authenticate with Visual Studio Online using basic authentication or OAuth 2.0.

Basic Authentication

You must first enable alternate credentials on your profile.

var vso = require('vso-client');
var client = vso.createClient('url', 'collection', 'your-username', 'your-p@ssw0rd');

client.getProjects(function(err, projects) {
  if (err) {
    console.log(err);
  } else {
    console.log(projects);
  }
});

OAuth 2.0

Step 1: Authorize application

To use OAuth 2.0, you must follow the steps described in Authorize access with OAuth 2.0.

Step 2: Request access token

Use the vso-client to request or renew an access token.

var vso = require('vso-client');

vso.getToken ('clientAssertion', 'assertion', 'redirectUri', function(err, response) {
    if(err) {
        console.log(err);
    } else {
        if (typeof (response.Error) !== "undefined") {
           console.log("No token. Returned message was: " + response);
        } else {
           console.log("Received Token: " + response.access_token)
        }
    }
}

Note: Use refreshToken to renew an existing access token.

Step 3: Initialize client with access token

var client = vso.createOAuthClient('url', 'collection', 'access token');

client.getProjects(function(err, projects) {
  if (err) {
    console.log(err);
  } else {
    console.log(projects);
  }
});

Client Options

The VSO client supports a few optional settings, passed as an options object when you create the client (The last parameter of createClient and createOAuthClient)

var options = {
  apiVersion: "1.0",
  userAgent: "My App 1.0",
  clientOptions: {
    proxy: "http://localproxy.com"
  }
}
var vso = require('vso-client');
var client = vso.createClient('url', 'collection', 'your-username', 'your-p@ssw0rd', options);

API Versioning

Visual Studio Online API are versioned to ensure client applications keep working as expect when a new version of the API comes out.

When you create a client using createClient or createOAuthClient you can explicitly specify the API version you wish to use.

If you don't explicitly specify the version you want to use, the latest version will be used by default. Since it is up to the caller to pass the right parameters (and interpret the results) to the methods it calls, it is therefore recommended to explicitly pass a version when you create a client.

In can specify the version by passing the apiVersion member in the options parameter.

An example with the createClient (it works the same with createOAuthClient)

var vso = require('vso-client');
var client = vso.createClient('url', 'collection', 'your-username', 'your-p@ssw0rd', {apiVersion : "1.0-preview.1"});

Custom User Agent

By default, the user agent string used by the client when making requests is vso-client/{version} node/{version} {os}. You can specify a custom application name to append to the user-agent string.

var vso = require('vso-client');
var client = vso.createClient('url', 'collection', 'your-username', 'your-p@ssw0rd', {userAgent : "My-App/1.0"});

The application name shouldn't contain spaces and if you want to specify a version name, it shouldn't be part of the application name but separated with a slash.

Althoug VSO client doesn't enforce the product name for user agent you should follow the rules explained in RFC 7231

Other Request Options

You can pass other client options to be used by the internal request client by using the clientOptions property of the options object, such as a proxy server to use for requests.

var requestOptions = { proxy: 'http://localproxy.com' };
var vso = require('vso-client');
var client = vso.createClient('url', 'collection', 'your-username', 'your-p@ssw0rd', { clientOptions: requestOptions });

API Reference

Review the tests for a full list of client functions and their usuage. Also, refer to the Visual Studio Online REST API documentation.

Developing from Source

The VSO client is written in CoffeeScript. To modify and rebuild the client from source, you will need the CoffeeScript compiler. Gulp.js is used to automatically build the client and run all mocha tests.

  • Clone or download the vso-client Github repository.

  • Open a Terminal window, change to the repository folder, and install dependent packages.

      npm install -g coffee-script
      npm install -g gulp
      npm install -g mocha
      npm install -g should
      npm install
      npm install --package-dev
    
  • Add environment variables for integration tests

    OS X / Linux

    export VSO_URL=your-vso-account-URL
    export VSO_COLLECTION=your-project-collection
    export VSO_USER=your-username
    export VSO_PWD=your-password
    export VSO_SERVICE_ACCOUNT_USER=service-account-username
    export VSO_SERVICE_ACCOUNT_PWD=service-account-password
    

    Windows

    setx VSO_URL "your-vso-account-URL"
    setx VSO_COLLECTION "your-project-collection"
    setx VSO_USER "your-username"
    setx VSO_PWD "your-password"
    setx VSO_SERVICE_ACCOUNT_USER=service-account-username
    setx VSO_SERVICE_ACCOUNT_PWD=service-account-password
    

    Notes

    • On Windows, you will need to reopen your command prompt after setting environment variables.
    • To get a Visual Studio Online service account you can use the TFS Service Credential Viewer
  • Keep gulp running to compile the /src folder and run mocha tests in the /spec folder.

      gulp
    

Installing manually

  • Create a folder in your node application's node_modules folder named vso-client (e.g. `[project-name]/node_modules/vso-client).
  • Copy all the files and folders in the vso-client project folder to the vso-client folder created in the previous step.

License

The Visual Studio Online client module is licensed under MIT. Refer to license.txt for more information.