resource-client/README.md

# Resource Client

Easily create api clients for your server side resources. Inspired by [Angular Resource](https://docs.angularjs.org/api/ngResource/service/$resource).

[![NPM version](http://img.shields.io/npm/v/resource-client.svg?style=flat-square)](https://www.npmjs.org/package/resource-client)
[![Build Status](http://img.shields.io/travis/goodeggs/resource-client.svg?style=flat-square)](https://travis-ci.org/goodeggs/resource-client)
[![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://github.com/goodeggs/resource-client/blob/master/LICENSE.md)

## Usage

```
npm install resource-client --save
```

```javascript
var resourceClient = require('resource-client');

var Product = resourceClient({
  url: 'http://www.mysite.com/api/products/:_id',
  headers: {
    'X-Secret-Token': 'ABCD1234'
  }
});

Product.query({isActive: true}, function(err, products) {
  product = products[0]
  product.name = 'apple'
  product.save()
});
```

## Creating a Resource

### resourceClient(options)

- **options** - default request options for this resource. You can use any option from the [request](https://github.com/request/request) module. There are a few key differences:
  - **url** - same as request url but can contain variables prefixed with a colon such as `products/:name`
  - **json** - set to true by default


```javascript
var resourceClient = require('resource-client');

var Product = resourceClient({
  url: 'http://www.mysite.com/api/products/:_id',
  headers: {
    'X-Secret-Token': 'ABCD1234'
  }
})
```

## Defining Resource Actions

### Resource.action(name, options)

- **name** - name of action
- **options** - default request options for this action. Overrides defaults set for the resource. You can use any option from the [request](https://github.com/request/request) module. There are a couple extra options available:
  - **url** - same as request url but can contain variables prefixed with a colon such as `products/:name`
  - **isArray** - resource is an array. It will not populate variables in the url.

```javascript
var resourceClient = require('resource-client');

var Product = resourceClient({
  url: 'http://www.mysite.com/api/products/:_id',
  headers: {
    'X-Secret-Token': 'ABCD1234'
  }
});

Product.action('query', {
  method: 'GET'
  isArray: true
});
```

If the method is GET, you can use it as a class method:
```javascript
Product.action('get', {
  method: 'GET'
});
// class method
Product.get({_id: 1234}, function (err, product) { ... })
```
If the method is PUT, POST, DELETE, you can use it as an instance method:
```javascript
Product.action('save', {
  method: 'POST'
});
// class method
Product.save({name: 'apple'}, function (err, product) { ... });

// instance method
product = new Product({name: 'apple'});
product.save()
```

## Default Actions

Every new resource will come with these methods by default

- **get** - {method: 'GET'}
- **query** - {method: 'GET', isArray: true}
- **update** - {method: 'PUT'}
- **save** - {method: 'POST'}
- **remove** - {method: 'DELETE'}

## Contributing

Please follow our [Code of Conduct](https://github.com/goodeggs/mongoose-webdriver/blob/master/CODE_OF_CONDUCT.md)
when contributing to this project.

```
$ git clone https://github.com/goodeggs/resource-client && cd resource-client
$ npm install
$ npm test
```

_Module scaffold generated by [generator-goodeggs-npm](https://github.com/goodeggs/generator-goodeggs-npm)._