Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maryayi/restfulpy-client.js
Javascript client for restfulpy
https://github.com/maryayi/restfulpy-client.js
Last synced: 2 days ago
JSON representation
Javascript client for restfulpy
- Host: GitHub
- URL: https://github.com/maryayi/restfulpy-client.js
- Owner: maryayi
- License: mit
- Created: 2019-09-11T08:54:11.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T06:10:25.000Z (almost 2 years ago)
- Last Synced: 2024-03-25T18:16:52.243Z (8 months ago)
- Language: JavaScript
- Size: 2.85 MB
- Stars: 0
- Watchers: 2
- Forks: 3
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# restfulpy-client.js
Javascript client for [restfulpy](https://github.com/pylover/restfulpy)
[](https://www.npmjs.com/package/restfulpy)
[](https://travis-ci.org/Carrene/restfulpy-client.js)
[](https://coveralls.io/github/Carrene/restfulpy-client.js)
## Install
```bash
npm install restfulpy
sudo apt-get install redis-server
```
Create a postgres database named: `restfulpymockupserver`
## Usage
```javascript
import { BrowserSession, Authenticator, httpClient, Response } from 'restfulpy'
class LocalAuthenticator extends Authenticator {
login(credentials) {
// Add your login method for example:
return httpClient(
`http://example.org/api/v1/sessions`,
{
verb: 'POST',
payload: this.constructor.validateCredentials(credentials)
},
(...args) => {
return new Response(null, ...args)
}
)
.then(resp => {
this.token = resp.json.token
return Promise.resolve(resp)
})
.catch(resp => {
this.deleteToken()
return Promise.reject(resp)
})
}
}
let authenticator = new LocalAuthenticator()
const errorHandler = {
401: (status, redirectUrl) => {
// Your handler for 401 error
// You can add handler for each status code
}
}
let client = new BrowserSession(
'http://example.org/api/v1',
undefined,
authenticator,
errorHandlers
)
// Login
client
.login({ email: '[email protected]', password: '123456' })
.then(resp => {
// Authentication success, so
console.log(resp.json.token) // is not null
console.log(client.authenticator.authenticated) // is true
})
.catch(resp => {
throw resp.error
})
// Posting some data to `http://example.org/api/v1/echo`
client
.request('echo', 'POST')
.addParameters({ item1: 'Value1' })
.send()
.then(resp => {
console.log(resp.status) // Is 200
console.log(resp.json)
console.log(resp.getHeader('Content-Type'))
})
.catch(resp => {
console.log(resp.status)
throw resp.error
})
// Logout
client.logout()
```
## Metadata
```javascrypt
client.metadata.ModelName.get(1).done(models => {
// Use model
})
client.metadata.ModelName.load().done(models => {
// Use models
})
```
## Development Environment Setup
```bash
git clone && cd into/cloned/repo
npm install
sudo apt-get install redis-server
```
### Build
```bash
npm run build
```
### Running tests
An instance of the [restfulpy](https://github.com/pylover/restfulpy) is required as a mock-up server before running
tests, see the `mockup-server-karma.py` and `tests` directory to understand why you need to setup a python virtual env
to run tests.
Adding some stuff into the `~/.bashrc` file.
```bash
alias v.activate="source /usr/local/bin/virtualenvwrapper.sh"
export VIRTUALENVWRAPPER_PYTHON="$(which python3.6)"
```
Re-source the `~/.bashrc`
```bash
source ~/.bashrc
```
Sourcing the virtualenv wrapper.
```bash
v.activate
```
Creating a dedicated virtualenv for this project.
```bash
mkvirtualenv --python=$(which python3.6) restfulpy
```
Installing the python dependencies
```bash
pip install "restfulpy >= 1.1.2a1"
```
Finally! Running the tests.
```bash
npm run test
```
Or,
```bash
npm run test -- --no-single-run
```
To keep the browser open for more investigation and watch for changes. see karma documents for more info.
## Browser Support
| ![Firefox] | ![Chrome] | ![IE/Edge] | ![Safari] | ![Opera] |
| ---------- | --------- | ---------- | --------- | -------- |
| 17 | 41 | 12.0 | 9 | 28 |
[firefox]: https://cdnjs.cloudflare.com/ajax/libs/browser-logos/43.2.0/archive/firefox_1.5-3/firefox_1.5-3_32x32.png 'Firefox'
[chrome]: https://cdnjs.cloudflare.com/ajax/libs/browser-logos/43.2.0/chrome/chrome_32x32.png 'Chrome'
[ie/edge]: https://cdnjs.cloudflare.com/ajax/libs/browser-logos/43.2.0/edge/edge_32x32.png 'IE/Edge'
[safari]: https://cdnjs.cloudflare.com/ajax/libs/browser-logos/43.2.0/safari/safari_32x32.png 'Safari'
[opera]: https://cdnjs.cloudflare.com/ajax/libs/browser-logos/43.2.0/opera/opera_32x32.png 'Opera'