https://github.com/oleg-koval/trembita
Request wrapper for consuming third-party services
https://github.com/oleg-koval/trembita
api api-wrapper decorator expose hacktoberfest javascript request request-wrapper wrapper wrapper-api
Last synced: 6 months ago
JSON representation
Request wrapper for consuming third-party services
- Host: GitHub
- URL: https://github.com/oleg-koval/trembita
- Owner: oleg-koval
- License: mit
- Created: 2018-01-10T13:37:28.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T04:28:40.000Z (over 2 years ago)
- Last Synced: 2025-04-12T02:46:15.192Z (6 months ago)
- Topics: api, api-wrapper, decorator, expose, hacktoberfest, javascript, request, request-wrapper, wrapper, wrapper-api
- Language: JavaScript
- Homepage:
- Size: 1.89 MB
- Stars: 10
- Watchers: 2
- Forks: 0
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# trembita-js
[](https://github.com/oleg-koval/trembita/actions)
[](https://coveralls.io/github/oleg-koval/trembita?branch=master)
[](https://github.com/dwyl/goodparts 'JavaScript The Good Parts')
[](https://www.npmjs.com/package/trembita)
> Request wrapper core for consuming third party services.
Whenever you need to communicate with third party API to get or save data from
own codebase, you would have to perform a set of common steps such as login,
query, etc. Trembita.js is doing the same by abstracting the innards of the
actual REST calls to third-party API and exposing only the developer relevant
details. Trembita.js supports plugins which are API connectors that are exposing
methods for API communication. Each plugin is describing another third-party
service. It performs these commonly used functions - creates requests, parses
responses, handles errors etc.
The goal of this module is not only to provide you with a simple interface but
the implementation of commonly used tools out of the box. This is a core module
to reuse with plugins each for a different third-party service.
Trembita API wrapper plugin lets you call itself instead of the API directly.
Well what happens if you want to change from one API to another? Now you have
to rewrite ALL of your code. If you used a wrapper then all you have to do is
change the wrapper and you are done.
## Table of Contents
- [Install](#install)
- [Usage](#usage)
- [Contribute](#contribute)
- [License](#license)
## Install
Using npm:
```shell
npm install trembita
```
Using yarn:
```shell
yarn add trembita
```
## Usage
Trembita is not supposed to be used directly, rather than to develop plugins/clients.
In order you can use a third party service by implementing your plugin, make
sure you fill the next requirements:
- Extend Trembita module.
- Construct the plugin by implementing the properties inherited from Trembita
module.
- Define the methods that contains the logic that expose third party library
logic you want to use.
One example of usage would be:
```js
const clientOptions = {
headers: {
header1: 'xxx',
header2: 'yyy'
},
endpoint: 'http://serviceapi.com'
};
const MyAPIClient = class MyAPIClient extends Trembita {
constructor(options) {
super(...arguments);
this.getData = paramsQueryString => {
const params = {
url: `api/path/`,
qs: paramsQueryString,
expectedCodes: [200, 401, 403, 404],
headers: {
header1: this.header1,
header2: this.header2
}
};
return this.request(params);
};
}
};
const client = new MyAPIClient(clientOptions);
```
## Contribute
See [the contribute file](CONTRIBUTING.md)!
## License
MIT © 2018