npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

travis-ci-post

v1.0.3

Published

Post data to a Travis CI API endpoint.

Downloads

19

Readme

Post

NPM version Build Status Coverage Status Dependencies

Post data to a Travis CI API endpoint.

Installation

$ npm install travis-ci-post

Usage

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

request( [data,] options, clbk )

Sends a POST request to a Travis CI API endpoint.

var opts = {
	'pathname': '/builds/114143550/restart',
	'token': 'tkjorjk34ek3nj4!'
};

request( opts, onResponse );

function onResponse( error, results ) {
	if ( error ) {
		throw new Error( error.message );
	}
	console.dir( results );
	/* returns 
		{
			"result": true,
			"flash": [{"notice": "The build was successfully restarted."}]
		}
	*/
}

Request data may be provided as either a JSON object or a string.

var opts = {
	'pathname': '/settings/env_vars',
	'query': 'repository_id=42',
	'token': 'tkjorjk34ek3nj4!'
};

var data = {
	'env_var': {
		'name': 'BEEP',
		'value': 'boop',
		'public': false
	}
};

request( data, opts, onResponse );

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'.
  • query: params portion of a query string; e.g., beep=boop&a=b. Default: ''.

To authenticate with an endpoint, set the token option.

var opts = {
	'pathname': '/builds/114143550/restart',
	'token': 'tkjorjk34ek3nj4!'
};

request( opts, onResponse );

To specify a particular endpoint, set the pathname option.

var opts = {
	'pathname': '/jobs/114143551/cancel',
	'token': 'tkjorjk34ek3nj4!'
};

request( opts, onResponse );

request.factory( options, clbk )

Creates a reusable function.

var opts = {
	'pathname': '/settings/env_vars',
	'query': 'repository_id=42',
	'token': 'tkjorjk34ek3nj4!'
};

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

opts.pathname = '/jobs/114143551/restart';
delete opts.query;

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

// Repeatedly update an environment variable and restart a job...
var data = {
	'env_var': {
		'name': 'BEEP',
		'value': 0,
		'public': false
	}
}
update( data );
restart();

data.env_var.value += 1;
update( data );
restart();

data.env_var.value += 1;
update( data );
restart();
// ...

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-post' );

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

request( 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-post

Usage

Usage: travispost [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.
  -qs, --query querystring  Params portion of a query string.

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=* travispost --token <token> --pathname '/builds/114143550/restart'

Setting the access token using an environment variable:

$ DEBUG=* TRAVISCI_TOKEN=<token> travispost --pathname '/builds/114143550/restart'

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

$ DEBUG=* ./node_modules/.bin/travispost --token <token> --pathname '/builds/114143550/restart'

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 '/builds/114143550/restart'

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.