ng-runabove

Angular service for the RunAbove API.

• Simple to use
• Well documented
• Only 1.9KB minified and gzipped!

The Runabove API Console is available here.

Installation

You can download it with Bower:

$ bower install ng-runabove --save

And include the script in your html:

<script src="components/ng-runabove/ng-runabove.min.js"></script>

Configuration

Simply add the dependency in your Angular app, like this:

var myApp = angular.module('myApp', [
    'ngRunabove'    // Require the ngRunabove module here
]);

After that, you can configure it via the RunaboveProvider:

myApp.config(function (RunaboveProvider) {

    // Set the Application Key (AK):
    RunaboveProvider.setAppKey('YOUR_APPLICATION_KEY');

    // Set the Application Secret (AS):
    RunaboveProvider.setAppSecret('YOUR_APPLICATION_SECRET');

    // [... other options]

});

Options

• setAppKey("AK") : Set the Application Key (AK).
• setAppSecret("AS") : Set the Application Secret (AS).
• setConsumerKey("CK") : Set the Consumer Key (CK).
• setBaseUrl("URL") : Set the API base URL.
• setAccessRules([{ ... }]) : Set the access rules.

The Application Key (AK) and the Application Secret (AS) is mandatory.

Get an Application Key (AK) and an Application Secret (AS)

In order to use the API, you need to create a third party application in RunAbove. Go to this link, and follow the steps. It will give you an AK and an AS to use for your application.

You can find more informations here.

Usage

All functions (except 'isLogged') returns a promise (with success and error). You can catch it like the angular way, e.g.:

Runabove.get('/me').then(function (infos) {
    // Success!
    // The param contains all the datas.
}, function (error) {
    // Error!
    // The param contains the traditional angular error.
});

Functions

• login([urlToRedirect])

Runabove.login('http://www.example.com/home');

Log the user (request a new credential). It will redirect the user to the RunAbove API login page. When logged, user will be redirected to the given URL (or current location if omitted).

The token (the "Consumer Key" ("CK")) will be stored into the localStorage.

• logout()

Runabove.logout();

Log out the user (expire current credential).

• get(url, [config])
• post(url, [config])
• put(url, [config])
• delete(url, [config]) (aliases: del, remove)

Runabove.get('/me');
Runabove.post('/storage', {
    data : {
        containerName   : 'bigmama',
        containerRegion : 'BHS-1'
    }
});
Runabove.put('/me', {
    data : {
        firstname : 'Bobobo-bo',
        name      : 'Bo-bobo'
    }
});
Runabove.delete('/ssh/{name}', {
    params : {
        name : 'mypublickey'    // 'name' will be automatically replaced in the url!
    }
});

The param config is the same than Angular $http (see doc here).

Note that the resolve promise returns directly the datas.

• getSchema(schemaPath)

Runabove.getSchema('/me');

Get specific schema from API (here "/me").

• getModels(schemaPath, [modelsName])

Runabove.getModels('/me', 'account.CountryEnum');

Get all or a specific Models from API (here "/me", "account.CountryEnum"). If second param is omitted, it returns all the Models.

• isLogged()

Runabove.isLogged();

Return true if user is connected.

Examples

You can find examples in the "examples" folder.

License

MIT

Note

This library is not maintained by Runabove or OVH team.