Skip to content

Latest commit

 

History

History
133 lines (90 loc) · 4.09 KB

README.md

File metadata and controls

133 lines (90 loc) · 4.09 KB
Raw

CodePicnic JavaScript SDK

JavaScript Client for the CodePicnic's API

Getting Started

To use this library (and the CodePicnic API) you need to sign up in codepicnic.com and purchase a paid plan.

Installation

Node.js:

npm install codepicnic

Browser:

Use the codepicnic.js file located in the dist folder.

Usage

Node.js:

var CodePicnic = require('codepicnic');

CodePicnic.initialize('CLIENT_ID', 'CLIENT_SECRET');

var newConsole = new CodePicnic.Console({
  containerType: 'bash',
  title: 'My New Bash Console'
});

newConsole.save().then(function() {
  return newConsole.exec('ls -la /');
}).then(function(data) {
  console.log('Files listed in /', data['ls -la /']);
});

Browser:

<script src="codepicnic.js"></script>
<script>
  CodePicnic.initialize('CLIENT_ID', 'CLIENT_SECRET');

  var newConsole = new CodePicnic.Console({
    containerType: 'bash',
    title: 'My New Bash Console'
  });

  newConsole.save().then(function() {
    return newConsole.exec('ls -la /');
  }).then(function(data) {
    console.log('Files listed in /', data['ls -la /']);
  });
</script>

CodePicnic.Console has the following methods:

  • CodePicnic.Console#save() (returns a Promise): Create a console with the attributes passed in the initializer (new CodePicnic.Console(attributes)). Allowed attributes are defined in the API's documentation and the attributes' names must be camelCased. Note: This method creates a new console unless a containerName is passed.
  • CodePicnic.Console#start() (returns a Promise): Start the server attached to the console.
  • CodePicnic.Console#stop() (returns a Promise): Stop the server attached to the console.
  • CodePicnic.Console#restart() (returns a Promise): Restart the server attached to the console.
  • CodePicnic.Console#exec(command1, command2, ...) (returns a Promise): Execute commands inside the server attached to the console.
  • CodePicnic.Console.all() (returns a Promise): Return an array of consoles created by the user.
  • CodePicnic.Console.get(containerName) (returns a Promise): Return a single instance of CodePicnic.Console using its container name.

Testing

Run npm test

Changelog

0.0.8

  • Bump superagent and superagent-use versions.
  • Refactor CodePicnic.Console.uploadFile and add test case.

0.0.7

  • Fix bug in handling response in CodePicnic.Console.get.

0.0.6

  • Add isHeadless field in CodePicnic.Console.
  • New method: CodePicnic.Console.uploadFile to upload files to a console.

0.0.5

  • New feature: Read / write API endpoints with CodePicnic.API_HOST and CodePicnic.OAUTH_HOST.

0.0.4

  • Fix mass assignment in CodePicnic.Console#save.

0.0.3

  • New method: CodePicnic.Console.get to retrieve a console using its container name.

0.0.2

  • Fixing bug at creating a new CodePicnic.Console instance with underscored attributes.

0.0.1

  • Initial version.

License

MIT License. Copyright 2016 CodePicnic. http://github.com/CodePicnic

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.