1. module chai-http
   1. function chai-http (chai, _)
   2. function chai-http.request (app)
   3. object chai-http.net
2. module chai-http.net
   1. function chai-http.net.isIP (str)
   2. function chai-http.net.isIPv4 (str)
   3. function chai-http.net.isIPv6 (str)
3. module chai-http.request
   1. function chai-http.request (app)
   2. function chai-http.request.Request (app, method, path)
   3. function chai-http.request.Test (app, method, path)
   4. function chai-http.request.agent (app)

module chai-http

function chai-http (chai, _)

• description and source-code

  chai-http = function (chai, _) {
  
    /*!
     * Module dependencies.
     */
  
    var net = require('net');
    var qs = require('qs');
    var url = require('url');
    var Cookie = require('cookiejar');
  
    /*!
     * Aliases.
     */
  
    var Assertion = chai.Assertion
      , i = _.inspect;
  
    /*!
     * Expose request builder
     */
  
    chai.request = require('./request');
  
    /*!
     * Content types hash. Used to
     * define `Assertion` properties.
     *
     * @type {Object}
     */
  
    var contentTypes = {
        json: 'application/json'
      , text: 'text/plain'
      , html: 'text/html'
    };
  
    /*!
     * Return a header from `Request` or `Response` object.
     *
     * @param {Request|Response} object
     * @param {String} Header
     * @returns {String|Undefined}
     */
  
    function getHeader(obj, key) {
      if (key) key = key.toLowerCase();
      if (obj.getHeader) return obj.getHeader(key);
      if (obj.headers) return obj.headers[key];
    };
  
    /**
     * ### .status (code)
     *
     * Assert that a response has a supplied status.
     *
     * ```js
     * expect(res).to.have.status(200);
     * ```
     *
     * @param {Number} status number
     * @name status
     * @api public
     */
  
    Assertion.addMethod('status', function (code) {
      new Assertion(this._obj).to.have.property('status');
      var status = this._obj.status;
  
      this.assert(
          status == code
        , 'expected #{this} to have status code #{exp} but got #{act}'
        , 'expected #{this} to not have status code #{act}'
        , code
        , status
      );
    });
  
    /**
     * ### .header (key[, value])
     *
     * Assert that a `Response` or `Request` object has a header.
     * If a value is provided, equality to value will be asserted.
     * You may also pass a regular expression to check.
     *
     * __Note:__ When running in a web browser, the
     * [same-origin policy](https://tools.ietf.org/html/rfc6454#section-3)
     * only allows Chai HTTP to read
     * [certain headers](https://www.w3.org/TR/cors/#simple-response-header),
     * which can cause assertions to fail.
     *
     * ```js
     * expect(req).to.have.header('x-api-key');
     * expect(req).to.have.header('content-type', 'text/plain');
     * expect(req).to.have.header('content-type', /^text/);
     * ```
     *
     * @param {String} header key (case insensitive)
     * @param {String|RegExp} header value (optional)
     * @name header
     * @api public
     */
  
    Assertion.addMethod('header', function (key, value) {
      var header = getHeader(this._obj, key);
  
      if (arguments.length < 2) {
        this.assert(
            'undefined' !== typeof header || null === header
          , 'expected header \'' + key + '\' to exist'
          , 'expected header \'' + key + '\' to not exist'
        );
      } else if (arguments[1] instanceof RegExp) {
        this.assert(
            value.test(header)
          , 'expected header \'' + key + '\' to match ' + value + ' but got ' + i(header)
          , 'expected header \'' + key + '\' not to match ' + value + ' but got ' + i(header)
          , value
          , header
        );
      } else {
        this.assert(
            header == value
          , 'expected header \'' + key + '\' to have value ' + value + ' but got ' + i(header)
          , 'expected header \'' + key + '\' to not have value ' + value
          , value
          , header
        );
      }
    });
  
    /**
     * ### .headers
     *
     * Assert that a `Response` or `Request` object has headers.
     *
     * __Note:__ When running in a web browser, the
     * [same-origin policy](https://tools.ietf.org/html/rfc6454#section-3)
     * only allows Chai HTTP to read
     * [certain headers](https://www.w3.org/TR/cors/#simple-response-header),
     * which can cause assertions to fail.
     *
     * ```js
     * expect(req).to.have.headers;
     * ```
     *
     * @name headers
     * @api public
     */
  
    Assertion.addProperty('headers', function () {
      this.assert(
          this._obj.headers || this._obj.getHeader
        , 'expected #{this} to have headers or getHeader method'
        , 'expected #{this} to not have headers or getHeader method'
      );
    });
  
    /**
     * ### .ip
     *
     * Assert that a string represents valid ip address.
     *
     * ```j ...

• example usage

  n/a

function chai-http.request (app)

• description and source-code

  request = function (app) {
  
    /*!
     * @param {Mixed} function or server
     * @returns {Object} API
     */
  
    var server = ('function' === typeof app)
        ? http.createServer(app)
        : app
      , obj = {};
  
    methods.forEach(function (method) {
      obj[method] = function (path) {
        return new Test(server, method, path);
      };
    });
    obj.del = obj.delete;
  
    return obj;
  }

• example usage

  ...
  * or a node.js http(s) server as the foundation for your request.
  * If the server is not running, chai-http will find a suitable
  * port to listen on for a given test.
  *
  * __Note:__ This feature is only supported on Node.js, not in web browsers.
  *
  * ```js
  * chai.request(app)
  *   .get('/')
  * ```
  *
  * #### URL
  *
  * You may also use a base url as the foundation of your request.
  *
  ...

module chai-http.net

function chai-http.net.isIP (str)

• description and source-code

  isIP = function (str) {
  	return ipRegex({exact: true}).test(str);
  }

• example usage

  ...
   *
   * @name ip
   * @api public
   */
  
  Assertion.addProperty('ip', function () {
    this.assert(
        net.isIP(this._obj)
      , 'expected #{this} to be an ip'
      , 'expected #{this} to not be an ip'
    );
  });
  
  /**
   * ### .json / .text / .html
  ...

function chai-http.net.isIPv4 (str)

• description and source-code

  isIPv4 = function (str) {
  	return ipRegex.v4({exact: true}).test(str);
  }

• example usage

  n/a

function chai-http.net.isIPv6 (str)

• description and source-code

  isIPv6 = function (str) {
  	return ipRegex.v6({exact: true}).test(str);
  }

• example usage

  n/a

module chai-http.request

function chai-http.request (app)

• description and source-code

  request = function (app) {
  
    /*!
     * @param {Mixed} function or server
     * @returns {Object} API
     */
  
    var server = ('function' === typeof app)
        ? http.createServer(app)
        : app
      , obj = {};
  
    methods.forEach(function (method) {
      obj[method] = function (path) {
        return new Test(server, method, path);
      };
    });
    obj.del = obj.delete;
  
    return obj;
  }

• example usage

  ...
  * or a node.js http(s) server as the foundation for your request.
  * If the server is not running, chai-http will find a suitable
  * port to listen on for a given test.
  *
  * __Note:__ This feature is only supported on Node.js, not in web browsers.
  *
  * ```js
  * chai.request(app)
  *   .get('/')
  * ```
  *
  * #### URL
  *
  * You may also use a base url as the foundation of your request.
  *
  ...

function chai-http.request.Request (app, method, path)

• description and source-code

  function Test(app, method, path) {
    Request.call(this, method, path);
    this.app = app;
    this.url = typeof app === 'string' ? app + path : serverAddress(app, path);
  }

• example usage

  n/a

function chai-http.request.Test (app, method, path)

• description and source-code

  function Test(app, method, path) {
    Request.call(this, method, path);
    this.app = app;
    this.url = typeof app === 'string' ? app + path : serverAddress(app, path);
  }

• example usage

  n/a

function chai-http.request.agent (app)

• description and source-code

  function TestAgent(app) {
    if (!(this instanceof TestAgent)) return new TestAgent(app);
    if (typeof app === 'function') app = http.createServer(app);
    (Agent || Request).call(this);
    this.app = app;
  }

• example usage

  ...
  *   chai.request.addPromises(q.Promise);
  * }
  * ```
  *
  * #### Retaining cookies with each request
  *
  * Sometimes you need to keep cookies from one request, and send them with the
  * next. For this, `.request.agent()` is available:
  *
  * ```js
  * // Log in
  * var agent = chai.request.agent(app)
  * agent
  *   .post('/session')
  *   .send({ username: 'me', password: '123' })
  ...