https://github.com/meltwater/mlabs-http
Node.js HTTP client wrapper around Got
https://github.com/meltwater/mlabs-http
Last synced: 2 months ago
JSON representation
Node.js HTTP client wrapper around Got
- Host: GitHub
- URL: https://github.com/meltwater/mlabs-http
- Owner: meltwater
- License: mit
- Created: 2018-10-05T16:07:32.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-07-20T06:16:43.000Z (about 2 years ago)
- Last Synced: 2025-07-18T20:23:54.084Z (3 months ago)
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/@meltwater/mlabs-http
- Size: 2.6 MB
- Stars: 1
- Watchers: 10
- Forks: 2
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# HTTP client
[](https://www.npmjs.com/package/@meltwater/mlabs-http)
[](https://github.com/meltwater/mlabs-http)
[](https://github.com/meltwater/mlabs-http/tree/master/docs)
[](https://codecov.io/gh/meltwater/mlabs-http)
[](https://circleci.com/gh/meltwater/mlabs-http)
HTTP client wrapper around [Got].
[Got]: https://github.com/sindresorhus/got
## Description
The client provides an almost identical API to Got.
All requests are wrapped with proper logging and error handling.
Logging can be customized per-client and per-request.
Supports Prometheus metric collection for all requests.
For a GraphQL client with a corresponding feature set,
see [@meltwater/mlabs-graphql].
[@meltwater/mlabs-graphql]: https://github.com/meltwater/mlabs-graphql
## Installation
Add this as a dependency to your project using [npm] with
```
$ npm install @meltwater/mlabs-http
```
or using [Yarn] with
```
$ yarn add @meltwater/mlabs-http
```
[npm]: https://www.npmjs.com/
[Yarn]: https://yarnpkg.com/
## Usage
**See the complete [API documentation](./docs) and [working examples](./examples).**
```js
import { createHttpClient } from '@meltwater/mlabs-http'
const logResponse = async () => {
const http = createHttpClient({origin: 'https://httpbin.org'})
const body = await http.get('/get')
console.log(body)
}
logResponse().catch(err => { console.error(err) })
```
### With Prometheus metrics
```js
import { Registry } from 'prom-client'
import { createHttpClient, collectMetrics } from '@meltwater/mlabs-http'
const register = new Registry()
collectMetrics({ register })
const logMetrics = async () => {
const http = createHttpClient({metricRegistry: register, origin: 'https://httpbin.org'})
await http.get('/get')
console.log(register.metrics())
}
logMetrics().catch(err => { console.error(err) })
```
## Development Quickstart
```
$ git clone https://github.com/meltwater/mlabs-http.git
$ cd mlabs-http
$ nvm install
$ yarn
```
Run each command below in a separate terminal window:
```
$ yarn run watch
$ yarn run test:watch
```
## Development and Testing
### Source code
The [mlabs-http source] is hosted on GitHub.
Clone the project with
```
$ git clone git@github.com:meltwater/mlabs-http.git
```
[mlabs-http source]: https://github.com/meltwater/mlabs-http
### Requirements
You will need [Node.js] with [npm], [Yarn],
and a [Node.js debugging] client.
Be sure that all commands run under the correct Node version, e.g.,
if using [nvm], install the correct version with
```
$ nvm install
```
Set the active version for each shell session with
```
$ nvm use
```
Install the development dependencies with
```
$ yarn
```
[Node.js]: https://nodejs.org/
[Node.js debugging]: https://nodejs.org/en/docs/guides/debugging-getting-started/
[npm]: https://www.npmjs.com/
[nvm]: https://github.com/creationix/nvm
#### CircleCI
_CircleCI should already be configured: this section is for reference only._
The following environment variables must be set on [CircleCI]:
- `NPM_TOKEN`: npm token for installing and publishing packages.
- `NPM_TEAM`: npm team to grant read-only package access
(format `org:team`, optional).
- `CODECOV_TOKEN`: Codecov token for uploading coverage reports (optional).
These may be set manually or by running the script `./.circleci/envvars.sh`.
[CircleCI]: https://circleci.com/
### Development tasks
Primary development tasks are defined under `scripts` in `package.json`
and available via `yarn run`.
View them with
```
$ yarn run
```
##### Publishing a new release
Release a new version using [`npm version`][npm version].
This will run all tests, update the version number,
create and push a tagged commit,
and trigger CircleCI to publish the new version to npm.
- **Update the CHANGELOG before each new release after version 1.**
- New versions are released when the commit message is a valid version number.
- Versions are only published on release branches:
`master` branch or any branch matching `ver/*`.
- If branch protection options are enabled,
you must first run `npm version` on a separate branch,
wait for the commit to pass any required checks,
then merge and push the changes to a release branch.
- **Do not use the GitHub pull request button to merge version commits**
as the commit tagged with the new version number will not match after merging.
[npm version]: https://docs.npmjs.com/cli/version
#### Examples
**See the [full documentation on using examples](./examples).**
View all examples with
```
$ yarn run example
```
#### Linting
Linting against the [JavaScript Standard Style] and [JSON Lint]
is handled by [gulp].
View available commands with
```
$ yarn run gulp --tasks
```
Run all linters with
```
$ yarn run lint
```
In a separate window, use gulp to watch for changes
and lint JavaScript and JSON files with
```
$ yarn run watch
```
Automatically fix most JavaScript formatting errors with
```
$ yarn run format
```
[gulp]: https://gulpjs.com/
[JavaScript Standard Style]: https://standardjs.com/
[JSON Lint]: https://github.com/zaach/jsonlint
#### Tests
Unit and integration testing is handled by [AVA]
and coverage is reported by [Istanbul] and uploaded to [Codecov].
- Test files end in `.spec.js`.
- Unit tests are placed under `lib` alongside the tested module.
- Integration tests are placed in `test`.
- Static files used in tests are placed in `fixtures`.
Watch and run tests on changes with
```
$ yarn run test:watch
```
If using [AVA snapshot testing], update snapshots with
```
$ yarn run test:update
```
Generate a coverage report with
```
$ yarn run report
```
An HTML version will be saved in `coverage`.
##### Debugging tests
Create a breakpoint by adding the statement `debugger` to the test
and start a debug session with, e.g.,
```
$ yarn run test:inspect lib/class.spec.js
```
Watch and restart the debugging session on changes with
```
$ yarn run test:inspect:watch lib/class.spec.js
```
[AVA]: https://github.com/avajs/ava
[AVA snapshot testing]: https://github.com/avajs/ava#snapshot-testing
[Codecov]: https://codecov.io/
[Istanbul]: https://istanbul.js.org/
## Contributing
The author and active contributors may be found in `package.json`,
```
$ jq .author < package.json
$ jq .contributors < package.json
```
To submit a patch:
1. Request repository access by submitting a new issue.
2. Create your feature branch (`git checkout -b my-new-feature`).
3. Make changes and write tests.
4. Commit your changes (`git commit -am 'Add some feature'`).
5. Push to the branch (`git push origin my-new-feature`).
6. Create a new Pull Request.
## License
This npm package is licensed under the MIT license.
## Warranty
This software is provided by the copyright holders and contributors "as is" and
any express or implied warranties, including, but not limited to, the implied
warranties of merchantability and fitness for a particular purpose are
disclaimed. In no event shall the copyright holder or contributors be liable for
any direct, indirect, incidental, special, exemplary, or consequential damages
(including, but not limited to, procurement of substitute goods or services;
loss of use, data, or profits; or business interruption) however caused and on
any theory of liability, whether in contract, strict liability, or tort
(including negligence or otherwise) arising in any way out of the use of this
software, even if advised of the possibility of such damage.