cf-nodejs-client

cf-nodejs-client

Note: This package is not ready for a production App yet.

This project provides a simple client library to interact with the Cloud Foundry Architecture:

The library interacts with:

Cloud Controller:

• Apps
• BuildPacks
• Domains
• Jobs
• Organizations
• Organizations Quota
• Routes
• Service Bindings
• Spaces
• Spaces Quota
• Stacks
• User Provided Services
• Users

Authentication:

• UAA Users

Logging & Metrics:

• Logs

Using this library, you could interact with the following platforms: PWS , Bluemix or a Local Cloud Foundry instance.

Applications

Node.js with Express are a great combination to develop Web applications. If you observe the Sinatra market, you will notice that Node.js has a huge Traction.

The development doesn't cover the whole CC API. Main areas of development are:

App life cycle:

• Create an App
• Upload source code in .zip or .war (Support for Static, Node.js & JEE)
• Create an User Provided Services
• Associate Apps with an User Provided Services
• Start | Stop an App
• Restage Apps
• Scale Apps
• Simple Logs management
• Remove Apps
• Remove User Provided Services

PaaS Management:

• Organization quota
• Organization
• Space
• UAA Users
• Users

Getting Started

If you need to interact with a Cloud Foundry platform try this online tool and use this example:

var CloudFoundry = require("cf-nodejs-client").CloudFoundry;
CloudFoundry = new CloudFoundry();
CloudFoundry.setEndPoint("https://api.run.pivotal.io");
 
CloudFoundry.getInfo().then(function (result) {
    console.log(result);   
}).catch(function (reason) {
    console.error("Error: " + reason);
});

Explore the library and if you like the features, use it on your App:

npm install cf-nodejs-client --save

Online documentation:

JSDoc

Testing

This project has a test suite to ensure the reability of this project. Take a look the Tests cases developed with Mocha & Chai to understand some stuff about Cloud Foundry and the usage of this client. Besides, the project has invested some amount of time in testing phase to be the code with a nice coverage level.

The development has been tested with:

Local Instance	PWS	Bluemix
2.25.0	2.41.0	2.27.0

Note: Last test: 2015/10/29

Test suite:

npm test

Code coverage:

istanbul cover node_modules/mocha/bin/_mocha -- -R spec

Continous integration:

https://travis-ci.org/jabrena/cf-nodejs-client/

Versions

Take a look this doc to check the evolution of this Client for Cloud foundry.

References

• Developer list: https://lists.cloudfoundry.org/archives/list/[e-mail]/
• Issue management: https://overv.io

Issues

If you have any question or doubt, please create an issue.

Juan Antonio

Changelog

Version 0.10.0 2015-11-06

• Adding Online documentation: http://prosociallearneu.github.io/cf-nodejs-client-docs/
• Add method to restage Apps
• Refactor methods: UserProvidedServices.prototype.create Routes.prototype.checkRoute & Routes.prototype.getRoutes Logs.prototype.getRecent CloudFoundry.prototype.login Apps.prototype.associateRoute Apps.prototype.associateRoute Apps.prototype.stopApp & Apps.prototype.startApp Apps.prototype.getAppByName Apps.prototype.getApps Routes.prototype.addRoute Routes.prototype.checkRoute

Environment: LOCAL_INSTANCE_1

71 passing (2m) 25 pending

Environment: PIVOTAL

63 passing (4m) 20 pending

Environment: BLUEMIX

63 passing (4m) 20 pending