.github/workflows/ci.yml

@@ -0,0 +1,48 @@
+name: Chai HTTP
+
+on:
+  pull_request:
+    branches:
+      - master
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    name: Test on node ${{ matrix.node_version }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node_version:
+          - 10 # to be removed 2021-05
+          - 12 # to be removed 2022-05
+          - 14 # to be removed 2023-05
+          - x.x.x # safety net; don't remove
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node_version }}
+      - run: npm ci
+      - run: npm test
+      - uses: coverallsapp/github-action@v1.0.1
+        with:
+          github-token: ${{ secrets.github_token }}
+
+
+  publish-npm:
+    if: ${{ github.event_name == 'push' }}
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 14
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm run release
+        env:
+          NPM_TOKEN: ${{secrets.NPM_TOKEN}} # ff9b......76c4
+          GITHUB_TOKEN: ${{secrets.GH_RELEASE_TOKEN}}

.releaserc.json

@@ -0,0 +1,14 @@
+{
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    "@semantic-release/changelog",
+    "@semantic-release/npm",
+    "@semantic-release/github",
+    ["@semantic-release/git", {
+      "assets": ["dist/*", "package.json", "CHANGELOG.md", "package-lock.json"],
+      "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+    }]
+  ],
+  "tagFormat": "${version}"
+}

README.md

@@ -1,4 +1,4 @@
-# Chai HTTP [![Build Status](https://travis-ci.org/chaijs/chai-http.svg?branch=master)](https://travis-ci.org/chaijs/chai-http)
+# Chai HTTP  [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) [![NPM version](https://img.shields.io/npm/v/chai-http.svg)](https://img.shields.io/npm/v/chai-http.svg) [![Dependency Status](https://img.shields.io/david/chaijs/chai-http.svg)](https://img.shields.io/david/chaijs/chai-http.svg) [![devDependencies](https://david-dm.org/chaijs/chai-http/dev-status.svg)](https://david-dm.org/chaijs/chai-http/dev-status.svg)
 
 > HTTP integration testing with Chai assertions.
 
@@ -11,7 +11,7 @@
 
 #### Installation
 
-This is a addon plugin for the [Chai Assertion Library](http://chaijs.com). Install via [npm](http://npmjs.org).
+This is an addon plugin for the [Chai Assertion Library](http://chaijs.com). Install via [npm](http://npmjs.org).
 
     npm install chai-http
 
@@ -20,8 +20,8 @@ This is a addon plugin for the [Chai Assertion Library](http://chaijs.com). Inst
 Use this plugin as you would all other Chai plugins.
 
 ```js
-var chai = require('chai')
-  , chaiHttp = require('chai-http');
+const chai = require('chai');
+const chaiHttp = require('chai-http');
 
 chai.use(chaiHttp);
 ```
@@ -68,13 +68,13 @@ keep the server open, perhaps if you're making multiple requests, you must call
 `.keepOpen()` after `.request()`, and manually close the server down:
 
 ```js
-var requester = chai.request(app).keepOpen()
+const requester = chai.request(app).keepOpen()
 
 Promise.all([
   requester.get('/a'),
   requester.get('/b'),
 ])
-.then(responses => ....)
+.then(responses => { /* ... */ })
 .then(() => requester.close())
 ```
 
@@ -90,17 +90,37 @@ chai.request('http://localhost:8080')
 
 #### Setting up requests
 
-Once a request is created with a given VERB, it can have headers, form data,
-json, or even file attachments added to it, all with a simple API:
+Once a request is created with a given VERB (get, post, etc), you chain on these additional methods to create your request:
 
+| Method  | Purpose  |
+|---|---|
+| `.set(key, value)` | Set request headers  |
+| `.send(data)` |  Set request data (default type is JSON) |
+| `.type(dataType)` | Change the type of the data sent from the `.send()` method (xml, form, etc) |
+| `.attach(field, file, attachment)` | Attach a file | 
+| `.auth(username, password)` | Add auth headers for Basic Authentication |
+| `.query(parmasObject)` |  Chain on some GET parameters |
+
+Examples:
+
+`.set()`
+```js
+// Set a request header
+chai.request(app)
+  .put('/user/me')
+  .set('Content-Type', 'application/json')
+  .send({ password: '123', confirmPassword: '123' })
+```
+
+`.send()`
 ```js
 // Send some JSON
 chai.request(app)
   .put('/user/me')
-  .set('X-API-Key', 'foobar')
   .send({ password: '123', confirmPassword: '123' })
 ```
 
+`.type()`
 ```js
 // Send some Form Data
 chai.request(app)
@@ -113,20 +133,29 @@ chai.request(app)
   })
 ```
 
+`.attach()`
 ```js
 // Attach a file
 chai.request(app)
   .post('/user/avatar')
   .attach('imageField', fs.readFileSync('avatar.png'), 'avatar.png')
 ```
 
+`.auth()`
 ```js
 // Authenticate with Basic authentication
 chai.request(app)
   .get('/protected')
   .auth('user', 'pass')
+
+// Authenticate with Bearer Token
+chai.request(app)
+  .get('/protected')
+  .auth(accessToken, { type: 'bearer' })  
+
 ```
 
+`.query()`
 ```js
 // Chain some GET query parameters
 chai.request(app)
@@ -139,7 +168,7 @@ chai.request(app)
 In the following examples we use Chai's Expect assertion library:
 
 ```js
-var expect = chai.expect;
+const { expect } = chai;
 ```
 
 To make the request and assert on its response, the `end` method can be used:
@@ -148,7 +177,7 @@ To make the request and assert on its response, the `end` method can be used:
 chai.request(app)
   .put('/user/me')
   .send({ password: '123', confirmPassword: '123' })
-  .end(function (err, res) {
+  .end((err, res) => {
      expect(err).to.be.null;
      expect(res).to.have.status(200);
   });
@@ -170,16 +199,16 @@ callback has completed, and the assertions can be verified:
 it('fails, as expected', function(done) { // <= Pass in done callback
   chai.request('http://localhost:8080')
   .get('/')
-  .end(function(err, res) {
+  .end((err, res) => {
     expect(res).to.have.status(123);
     done();                               // <= Call done to signal callback end
   });
 });
 
-it('succeeds silently!', function() {   // <= No done callback
+it('succeeds silently!', () => {   // <= No done callback
   chai.request('http://localhost:8080')
   .get('/')
-  .end(function(err, res) {
+  .end((err, res) => {
     expect(res).to.have.status(123);    // <= Test completes before this runs
   });
 });
@@ -198,16 +227,15 @@ and chaining of `then`s becomes possible:
 chai.request(app)
   .put('/user/me')
   .send({ password: '123', confirmPassword: '123' })
-  .then(function (res) {
+  .then((res) => {
      expect(res).to.have.status(200);
   })
-  .catch(function (err) {
+  .catch((err) => {
      throw err;
   });
 ```
 
-__Note:__ Node.js version 0.10.x and some older web browsers do not have
-native promise support. You can use any spec compliant library, such as:
+__Note:__ Some older web browsers do not have native promise support. You can use any spec compliant library, such as:
  - [kriskowal/q](https://github.com/kriskowal/q)
  - [stefanpenner/es6-promise](https://github.com/stefanpenner/es6-promise)
  - [petkaantonov/bluebird](https://github.com/petkaantonov/bluebird)
@@ -220,7 +248,7 @@ requiring in chai-http. For example:
 if (!global.Promise) {
   global.Promise = require('q');
 }
-var chai = require('chai');
+const chai = require('chai');
 chai.use(require('chai-http'));
 ```
 
@@ -231,16 +259,16 @@ next (for example, when you want to login with the first request, then access an
 
 ```js
 // Log in
-var agent = chai.request.agent(app)
+const agent = chai.request.agent(app)
 agent
   .post('/session')
   .send({ username: 'me', password: '123' })
-  .then(function (res) {
+  .then((res) => {
     expect(res).to.have.cookie('sessionid');
     // The `agent` now has the sessionid cookie saved, and will send it
     // back to the server in the next request:
     return agent.get('/user/me')
-      .then(function (res) {
+      .then((res) => {
          expect(res).to.have.status(200);
       });
   });
@@ -320,6 +348,16 @@ expect(req).to.be.html;
 expect(req).to.be.text;
 ```
 
+### .charset
+
+
+
+Assert that a `Response` or `Request` object has a given charset.
+
+```js
+expect(req).to.have.charset('utf-8');
+```
+
 ### .redirect
 
 
@@ -372,6 +410,16 @@ expect(res).to.have.cookie('session_id', '1234');
 expect(res).to.not.have.cookie('PHPSESSID');
 ```
 
+## Releasing
+
+`chai-http` is released with [`semantic-release`](https://github.com/semantic-release/semantic-release) using the plugins:
+- [`commit-analyzer`](https://github.com/semantic-release/commit-analyzer) to determine the next version from commit messages.
+- [`release-notes-generator`](https://github.com/semantic-release/release-notes-generator) to summarize release in
+- [`changelog`](https://github.com/semantic-release/changelog) to update the CHANGELOG.md file.
+- [`github`](https://github.com/semantic-release/github) to publish a [GitHub release](https://github.com/chaijs/chai-http/releases).
+- [`git`](https://github.com/semantic-release/git) to commit release assets.
+- [`npm`](https://github.com/semantic-release/npm) to publish to [npm](https://www.npmjs.com/package/chai-http).
+
 ## License
 
 (The MIT License)