travis-ci-put v2.0.1

Put

Update a Travis CI API resource.

Installation

$ npm install travis-ci-put

Usage

var request = require( 'travis-ci-put' );

request( data, options, clbk )

Updates a Travis CI API resource. Request data may be provided as either a JSON object or a string.

var data = {
	'hook': {
		'id': 42,
		'active': true // enable
	}
};

var opts = {
	'pathname': '/hooks'
};

request( data, opts, onResponse );

function onResponse( error, results ) {
	if ( error ) {
		throw new Error( error.message );
	}
	console.dir( results );
	/* returns 
		{
			"result": true
		}
	*/
}

The function accepts the following options:

• protocol: request protocol. Default: 'https'.
• hostname: endpoint hostname. Default: 'api.travis-ci.org'.
• port: endpoint port. Default: 443 (https) or 80 (http).
• pathname: resource pathname; e.g., /repos. Default: '/'.
• token: Travis CI access token.
• accept: media type. Default: 'application/vnd.travis-ci.2+json'.

To authenticate with an endpoint, set the token option.

var opts = {
	'pathname': '/hooks',
	'token': 'tkjorjk34ek3nj4!'
};

request( data, opts, onResponse );

To specify a particular resource endpoint, set the pathname option.

var opts = {
	'pathname': '/hooks'
};

request( data, opts, onResponse );

request.factory( options, clbk )

Creates a reusable function.

var opts = {
	'pathname': '/hooks',
	'token': 'tkjorjk34ek3nj4!'
};

var update = request.factory( opts, onResponse );

// Enable Travis on multiple repositories...
var data = {
	'hook': {
		'id': 42,
		'active': true
	}
};
update( data );

data.hook.id = 43;
update( data );

data.hook.id = 44;
update( data );
// ...

The factory method accepts the same options as request().

Notes

• If the module encounters an application-level error while initially querying an endpoint (e.g., no network connection, malformed request, etc), that error is returned immediately to the provided callback.

Examples

var request = require( 'travis-ci-put' );

var data = {
	'hook': {
		'id': 42,
		'active': false // disable
	}
};

var opts = {
	'hostname': 'api.travis-ci.org',
	'pathname': '/hooks',
	'token': 'tkjorjk34ek3nj4!'
};

request( data, opts, onResponse );

function onResponse( error, results ) {
	if ( error ) {
		throw new Error( error.message );
	}
	console.log( results );
}

To run the example code from the top-level application directory,

$ node ./examples/index.js

Note: in order to run the example, you will need to obtain an access token and modify the token option accordingly.

CLI

Installation

To use the module as a general utility, install the module globally

$ npm install -g travis-ci-put

Usage

Usage: travisput [options]

Options:

  -h,  --help               Print this message.
  -V,  --version            Print the package version.
       --protocol protocol  Request protocol. Default: https.
       --hostname host      Hostname. Default: api.travis-ci.org.
  -p,  --port port          Port. Default: 443 (https) or 80 (http).
       --pathname pathname  Resource pathname. Default: '/'.
       --token token        Travis CI access token.
       --accept media_type  Media type. Default: application/vnd.travis-ci.2+json.
  -d,  --data data          Request data.

Notes

• In addition to the token option, the token may also be specified by a TRAVISCI_TOKEN environment variable. The command-line option always takes precedence.

Examples

Setting the access token using the command-line option:

$ DEBUG=* travisput --token <token> --pathname '/hooks' --data '{"hook":{"id":42,"active":true}}'

Setting the access token using an environment variable:

$ DEBUG=* TRAVISCI_TOKEN=<token> travisput --pathname '/hooks' --data '{"hook":{"id":42,"active":true}}'

For local installations, modify the command to point to the local installation directory; e.g.,

$ DEBUG=* ./node_modules/.bin/travisput --token <token> --pathname '/hooks' --data '{"hook":{"id":42,"active":true}}'

Or, if you have cloned this repository and run npm install, modify the command to point to the executable; e.g.,

$ DEBUG=* node ./bin/cli --token <token> --pathname '/hooks' --data '{"hook":{"id":42,"active":true}}'

Tests

Unit

This repository uses tape for unit tests. To run the tests, execute the following command in the top-level application directory:

$ make test

All new feature development should have corresponding unit tests to validate correct functionality.

Test Coverage

This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:

$ make test-cov

Istanbul creates a ./reports/coverage directory. To access an HTML version of the report,

$ make view-cov

Browser Support

This repository uses Testling for browser testing. To run the tests in a (headless) local web browser, execute the following command in the top-level application directory:

$ make test-browsers

To view the tests in a local web browser,

$ make view-browser-tests

License

MIT license.

Copyright

Copyright © 2016. Athan Reines.