Post
Post data to a Travis CI API endpoint.
Installation
$ npm install travis-ci-post
Usage
var request = ;
request( [data,] options, clbk )
Sends a POST
request to a Travis CI API endpoint.
var opts ='pathname': '/builds/114143550/restart''token': 'tkjorjk34ek3nj4!';;{if errorthrow errormessage ;consoledir 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;;
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) or80
(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!';;
To specify a particular endpoint, set the pathname
option.
var opts ='pathname': '/jobs/114143551/cancel''token': 'tkjorjk34ek3nj4!';;
request.factory( options, clbk )
Creates a reusable function
.
var opts ='pathname': '/settings/env_vars''query': 'repository_id=42''token': 'tkjorjk34ek3nj4!';var update = request;optspathname = '/jobs/114143551/restart';delete optsquery;var restart = request;// Repeatedly update an environment variable and restart a job...var data ='env_var':'name': 'BEEP''value': 0'public': false;;dataenv_varvalue += 1;;;dataenv_varvalue += 1;;;// ...
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), thaterror
is returned immediately to the providedcallback
.
Examples
var request = ;var opts ='hostname': 'api.travis-ci.org''pathname': '/builds/114143550/restart''token': 'tkjorjk34ek3nj4!';;{if errorthrow errormessage ;console;}
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 aTRAVISCI_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
Copyright
Copyright © 2016. Athan Reines.