hippie


!hippie

Synopsis

Thin request wrapper that enables powerful and intuitive API testing.

Features

* Intuitive and consistent API
* Built-in and custom expectations
* Support for custom parsers and serializers
* Easy to extend
* Middlewares
* Works great with any test runner

Examples

``
var api = require('hippie');
`

$3

`js
hippie()
.header("User-Agent", "hippie")
.json()
.get('https://api.github.com/users/vesln')
.expectStatus(200)
.end(function(err, res, body) {
if (err) throw err;
});
`

$3

`js
hippie()
.json()
.base('http://localhost:1234')
.get('/users/vesln')
.expectStatus(200)
.expectHeader('Content-Type', 'application/json; charset=utf-8')
.expectKey('username')
.expectValue('username', 'vesln')
.expectValue('repos[0].name', 'jsmd')
.expectBody({
username: 'vesln',
repos: [
{ name: 'jsmd' },
{ name: 'hippie' },
]
})
.expectBody(/vesln/g)
.end(function(err, res, body) {
if (err) throw err;
process.exit(0);
});
`

$3

`js
hippie()
.json()
.use(function(options, next) {
// modify the options for request here
next(options);
})
.get('https://api.github.com/users/vesln')
.end(function(err, res, body) {
if (err) throw err;
});
`
With middlewares you can modify the options passed to request. Here is an
example how you could persist the cookies across multiple requests:

`js
hippie(app)
.get('/')
.use(persistCookies)
.end(function() {});

function persistCookies(opts, next) {
opts.jar = true;
next(opts);
}
`

$3

`js
var xml = require('my-xml-library');

hippie()
.serializer(function(params, fn) {
var err = new Error('Things went wrong');
var res = xml.objectToXml(params);
fn(err, res);
})
.parser(function(body, fn) {
var err = new Error('Things went wrong');
var res = xml.xmlToObject(body);
fn(err, res);
})
.get('https://api.github.com/users/vesln.xml')
.expectStatus(200)
.end(function(err, res, body) {
if (err) throw err;
});
`

$3

Similar to Chai.js and other frameworks, you can enable showDiff.

`js
var hippie = require('hippie');
hippie.assert.showDiff = true;
`

!showDiff

$3

Since most of the time your test setup is going to be the same, you can simply
create a helper function for your tests that will take care of the repetitive
setup:

`js
var hippie = require('hippie');

function api() {
return hippie()
.json()
.serializer(customSerializer)
.parser(customParser)
.use(somethingSpecial)
.base('http://localhost:3000/api/v1')
.auth('user', 'pass')
.expect(somethingRepeatable);
}
`
Later on:

`js
test('my awesome api', function(done) {
api()
.get('/users')
.expectStatus(200)
.end();
});
`

API

$3

Configure a timeout for the HTTP request.

`js
hippie()
.timeout(1000)
.end(fn);
`

$3

Configure response time logging for the HTTP request.

`js
hippie()
.time(true)
.end(function(err, res, body) {
console.log('Response elapsed time: ', res.elapsedTime);
});
`

$3

Convert an object to query string values:

`js
hippie()
.qs({ foo: 'bar' })
.end(fn);
`

$3

Configure a base URL, useful when testing the same API endpoint.

`js
hippie()
.base('https://api.github.com')
.get('/users/vesln')
.end(fn);
`

$3

Set the URL for the HTTP request. Used internally by get, put etc. and
it should be used in combination with method.

`js
hippie()
.url('https://api.github.com')
.method('GET')
.end(fn);
`

$3

Configure the HTTP method. Used internally by get, put etc.

`js
hippie()
.url('https://api.github.com')
.method('OPTIONS')
.end(fn);
`

$3

Set a request header.

`js
hippie()
.header('Content-Type', 'application/json')
.send({ some: 'data' })
.end(fn);
`

$3

Helper method for:

- Content-Type: application/json
- Accept: application/json
- Serializer: json
- Parser: json

`js
hippie()
.json()
.get('https://github.com/vesln.json', fn);
`

$3

Helper method for:

- Content-Type: application/x-www-form-urlencoded
- Serializer: urlencoded

`js
hippie()
.form()
.patch('https://api.mindbloom.com/users/vesln')
.send({ timezone: 'UTC' })
.end();
`

$3

Configure a request body serializer.

`js
hippie()
.serializer(function(params, fn) {
var err = new Error('Things went wrong');
var res = xml.objectToXml(params);
fn(err, res);
});
`

$3

Configure a response body parser.

`js
hippie()
.parser(function(body, fn) {
var err = new Error('Things went wrong');
var res = xml.xmlToObject(body);
fn(err, res);
});
`

$3

Set request body.

`js
hippie()
.json()
.patch('https://api.mindbloom.com/users/vesln')
.send({ timezone: 'UTC' })
.end();
`

$3

Set Basic Auth credentials.

`js
hippie()
.auth('user', 'password')
.patch('https://api.mindbloom.com/users/vesln')
.send({ timezone: 'UTC' })
.end();
`

$3

Register a middleware that will be executed before the HTTP request.

`js
hippie()
.json()
.use(function(options, next) {
// modify the options for request here
// do other suff
next(options);
})
.get('https://api.github.com/users/vesln')
.end(fn);
`

For example, you can provide a client certificate with your request like so:

`js
var fs = require('fs');
hippie()
.json()
.use(function(options, next) {
options.agentOptions = {
cert: fs.readFileSync('client.crt'),
key: fs.readFileSync('client.key')
};
// Assuming you self-signed the CA
options.strictSSL = false;
next(options);
})
.get('https://localhost:8080/api/some-api-url')
.end(fn);
`

$3

Helper method for:

- Method: method
- URL: url
- End: fn [optional]

`js
hippie()
.get('https://api.github.com/users/vesln')
.end(fn);
`

Or if you want to execute the test immediately:

`js
hippie()
.get('https://api.github.com/users/vesln', fn);
`

$3

Set a response status code expectation.

`js
hippie()
.json()
.get('https://api.github.com/users/vesln')
.expectStatus(200)
.end(fn);
`

$3

Set a response header expectation.

`js
hippie()
.json()
.get('https://api.github.com/users/vesln')
.expectHeader('Content-Type', 'application/json; charset=utf-8')
.expectHeader('X-API-LIMIT', 3)
.end(fn);
`

$3

Register a string path expectation.

`js
hippie()
.json()
.get('https://api.github.com/users/vesln')
.expectValue('details.company', 'Awesome.io')
.expectValue('repos[0].name', 'hippie')
.end(fn);
`

For more information about string paths visit
pathval.

$3

Register a string path expectation for a given key.

`js
hippie()
.json()
.get('https://api.github.com/users/vesln')
.expectKey('details.company')
.expectKey('repos[0].name')
.end(fn);
`

For more information about string paths visit
pathval.

$3

Strict expectations:

`js
hippie()
.get('https://api.github.com/users/vesln')
.expectBody('{ "username": "vesln" }')
.end(fn);
`

Regular expression expectations:

`js
hippie()
.get('https://api.github.com/users/vesln')
.expectBody(/vesln/)
.end(fn);
`

Object/array expectations:

`js
hippie()
.get('https://api.github.com/users/vesln')
.expectBody({ username: 'vesln' })
.end(fn);
`

$3

Register a custom expectation.

`js
hippie()
.get('https://api.github.com/users/vesln')
.expect(function(res, body, next) {
var err = assertSomething;
next(err);
})
.end(fn);
`

$3

Execute the HTTP request and the tests.

`js
hippie()
.json()
.get('https://api.github.com/users/vesln')
.expectValue('details.company', 'Awesome.io')
.expectValue('repos[0].name', 'hippie')
.end(fn);
`

When no callback is provided, `end()` returns a promise.

`js
hippie()
.json()
.get('https://api.github.com/users/vesln')
.expectValue('details.company', 'Awesome.io')
.expectValue('repos[0].name', 'hippie')
.end()
.then(function(res) {
console.log(res);
})
.catch(function(err) {
console.error(err);
});
`

$3

Fire up an HTTP app and set its address as a base URL.
Also works with HTTP handler functions function(req res){}.

`js
hippie(expressApp)
.get('/')
.end(fn);
`

`js
hippie()
.app(function(req, res) {
res.end('Bye');
})
.get('/')
.end(fn);
`

Installation

`bash
npm install hippie
`

Tests

$3

`bash
$ npm test
`

$3

`bash
$ npm run-script coverage
``

Alternative projects

- supertest
- APIeasy
- chai-http
- frisby

License

(The MIT License)

Copyright (c) 2013 Veselin Todorov

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.