https://github.com/flochtililoch/node-automatic

API wrapper for the Automatic app
https://github.com/flochtililoch/node-automatic

Last synced: about 5 hours ago
JSON representation

API wrapper for the Automatic app

• Host: GitHub
• URL: https://github.com/flochtililoch/node-automatic
• Owner: flochtililoch
• Created: 2013-12-21T20:23:51.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2014-02-08T19:54:25.000Z (almost 11 years ago)
• Last Synced: 2024-04-13T08:08:25.324Z (7 months ago)
• Language: JavaScript
• Size: 167 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Automatic API wrapper for Node.js

[![NPM](https://nodei.co/npm/automatic.png?downloads=true&stars=true)](https://nodei.co/npm/automatic/)

API wrapper for the Automatic app

## Setup, Usage, and Tests

There is a sample Express app in the root of this repo. Just fire it up and check it out.

    node index.js

The nodeunit tests can be run with Grunt.

    grunt test

## Methods

Any `callback` will be the same callback you would get from using [request](https://github.com/mikeal/request).

### authorizeUrl(scopes, state)

This method will construct the correct URL you should redirect your users to to grant your app authorization.

* `scopes` - array of [scopes](https://www.automatic.com/developer/documentation/#scopes) to grant access to

* `state` - an unguessable random string used to protect against cross-site request forgery attacks

### validateAuthorization(code, state)

This method will set the code from a valid authorization. Throws an `Error` if the states do not match.

* `code` - the `code` from the GET parameter on redirection back from Automatic

* `state` - the same `state` used in `authorizeUrl()`

### requestToken(callback)

This method request the OAuth token from Automatic needed for all REST calls.

### refreshToken(callback)

This method refreshes the OAuth token with the current token.

### isTokenValid()

Returns whether the current token has expired or not.

### trips(options, callback)

Returns a single trip specified by `id` OR multiple trips based on `page` and `per_page` values. The `options` object must contain:

* `id` - specific trip id

```javascript

// returns trip with ID = 5

var trip = automatic.trips({ id: 5 }, function(err, res, body){ ... });

```

OR

* `page` - page number (defaults to 1)

* `per_page` - number of trip to return per page (defaults to 100)

```javascript

// return page 5 with 10 trips

var trips = automatic.trips({ page: 5, per_page: 10 }, function(err, res, body){ ... });

```