Initial import.

This code was extracted from the CBRAIN platform,
and will be maintained separately from now on.

Author: prioux

install_doc.sh

@@ -0,0 +1,59 @@
+#!/bin/bash
+
+if test $# -ne 1 ; then
+  cat  <<USAGE
+
+Usage: $0 doc_install_directory
+
+This script will install the documentation for
+the CBRAIN APIs in the directory given in argument.
+
+It is simply wrapper around the "rdoc" and "perldoc"
+commands, so the documentation will be generated for
+the Perl and Ruby APIs. You will need the commands
+"rdoc", "perldoc" and "pod2html" to generate everything.
+
+USAGE
+  exit 2
+fi
+
+BASE_DOC="$1"
+
+# Run this script where it is.
+if ! test -d "ruby" -a -d "perl" -a -d "java" ; then
+   echo "Error: this script should be run from the directory where the CBRAIN APIs are located."
+   exit 20
+fi
+
+# Directories
+PERLAPI_DOC="$BASE_DOC/perl"
+RUBYAPI_DOC="$BASE_DOC/ruby"
+
+# Check dirs
+if ! test -d "$BASE_DOC" ; then
+  echo "Error: it seems the base directory given in argument doesn't exist?!?"
+  exit 20
+fi
+
+echo "Generating and installing Perl API doc in plain text and HTML ..."
+mkdir -p "$PERLAPI_DOC" || exit 20
+perldoc                         -t perl/CbrainAPI.pm > "$PERLAPI_DOC/CbrainPerlAPI.txt"  || exit 20
+pod2html --title="CBRAIN Perl API" perl/CbrainAPI.pm > "$PERLAPI_DOC/CbrainPerlAPI.html" || exit 20
+test -f pod2htmd.tmp && rm -f pod2htmd.tmp # cleanup of leftover junk
+
+echo "Generating and installing Ruby API doc in HTML ..."
+mkdir -p "$RUBYAPI_DOC" || exit 20
+rdoc -O --op="$RUBYAPI_DOC" ruby/cbrain_ruby_api.rb
+
+
+cat <<FINAL
+
+All done. The documentation is located here:
+
+   Perl doc, plain text: $PERLAPI_DOC/CbrainPerlAPI.txt
+   Perl doc, HTML      : $PERLAPI_DOC/CbrainPerlAPI.html
+   Ruby doc, HTML      : $RUBYAPI_DOC/CbrainRubyAPI.html
+
+FINAL
+
+

node/.gitignore

@@ -0,0 +1,4 @@
+lib/exemple.js
+node_modules/*
+test.js
+tracegl/*

node/Gruntfile.js

@@ -0,0 +1,34 @@
+module.exports = function(grunt) {
+  
+  // Project configuration.
+  grunt.initConfig({
+   
+    pkg: grunt.file.readJSON('package.json'),
+     
+    docular: {
+      docular_webapp_target: "docs/docular",
+      docular_partial_home: "docs/node_api_home.html",
+      groups: [
+        {
+          groupTitle: "Node API",
+          groupId: "node API",
+          showSource: false,
+          sections: [
+            {
+              title: "Node API",
+              id: "node API",
+              scripts: ["lib/cbrain_api.js"]
+            },
+          ],
+        },
+      ],
+    },
+  });
+     
+  // Load the plugin that provides the "docular" tasks.
+  grunt.loadNpmTasks('grunt-docular');
+   
+  // Default task(s).
+  grunt.registerTask('default', ['docular']);
+     
+};

node/README.txt

@@ -0,0 +1,5 @@
+
+The node.js API for CBRAIN is preliminary and incomplete.
+
+Please contact the CBRAIN developers for more information.
+

node/lib/cbrain_api.js

@@ -0,0 +1,267 @@
+/*
+* CBRAIN Project
+*
+* Copyright (C) 2008-2012
+* The Royal Institution for the Advancement of Learning
+* McGill University
+*
+* This program is free software: you can redistribute it and/or modify
+* it under the terms of the GNU General Public License as published by
+* the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* This program is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+* GNU General Public License for more details.query
+*
+* You should have received a copy of the GNU General Public License
+* along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*
+*/
+
+/*
+* Author: Natacha Beck <natacha.beck@mcgill.ca>
+*/
+
+/**
+* TODO general doc
+*/
+
+"use strict";
+
+exports.cbrainAPI = function(cbrain_server_url) {
+  if (! cbrain_server_url) { throw new Error("Need to be provided with 'cbrain_server_url'."); };
+  cbrain_server_url = cbrain_server_url.replace(/\/*$/,"/");
+
+  var authenticity_token = undefined;
+
+  var request = require('request').defaults({
+        jar: true,
+        headers: {'Accept': 'application/json'},
+      });
+
+  var session = {
+
+    //////////////////////////////////////////////
+    // Authentication and licenses
+    //////////////////////////////////////////////
+
+    /**
+    * Connects to the server, supplies the credentials
+    * and maintains the tokens necessary for the session.
+    *
+    *   agent.login('jack', '&jill')
+    *
+    */
+    login: function(username, password, callback) {
+      if (!username) {callback("Need to be provided with a username."); return;};
+      if (!password) {callback("Need to be provided with a password."); return;};
+
+      setAuthToken( function(err, response) {
+        createSession(username, password, function(err,response) {
+          err ? callback(err) : callback(null,response);
+        });
+      });
+    },
+
+    //////////////////////////////////////////////
+    // Some generic method
+    //////////////////////////////////////////////
+
+    /**
+    * @doc function
+    * @name index
+    * @param {string} controller name to specify the request.
+    * @param {obj} filters is an optional list of attribute.
+    * @param {function} callback Callback function.
+    * @description
+    * A wrapper method for all index method.
+    */
+    index: function(controller, filters, callback) {
+      if (!controller) {callback("Need to be provided with a controller name."); return;};
+
+      var path = "/" + controller;
+      // Construct the form hash
+      filters = filters === null || (typeof filters !== 'undefined') ? filters : {};
+
+      var form = {
+        update_filter: "filter_hash",
+        clear_filter:  "filter_hash",
+      };
+      merge_options(form,filters);
+
+      // Do the request
+      doRequest("GET", path, form, function (err, response, body) {
+        var parsed = parse_json_body(body);
+        if (!parsed) {
+          var status_code = response.statusCode;
+          callback("Cannot parsed JSON response in index of " + controller + " response status code: " + status_code);
+        } else {
+          callback(null,parsed);
+        };
+      });
+    },
+
+    /**
+    * @doc function
+    * @name show
+    * @param {string} controller name to specify the request.
+
+    * @param {string} path to specify the request.
+    * @param {number} an id.
+    * @param {function} callback Callback function.
+    * @description
+    * A wrapper method for all show method.
+    */
+    show: function(controller, id, callback) {
+      if (!controller) {callback("Need to be provided with a controller name."); return;};
+      if (!id)         {callback("Need to be provided with an id");return;};
+
+      var path = "/" + controller + "/" + id;
+      doRequest("GET", path, {}, function (err, response, body ) {
+        var parsed = parse_json_body(body);
+        if (!parsed) {
+          var status_code = response.statusCode;
+          callback("Cannot parsed JSON response in show, response status code: " + status_code );
+        } else {
+          callback(null,parsed);
+        };
+      });
+    },
+
+    //////////////////////////////////////////////
+    // Data Registration
+    //////////////////////////////////////////////
+
+    //////////////////////////////////////////////
+    // DataProviders Actions
+    //////////////////////////////////////////////
+
+    //////////////////////////////////////////////
+    // Userfiles Actions
+    //////////////////////////////////////////////
+
+    //////////////////////////////////////////////
+    // Userfiles Actions
+    //////////////////////////////////////////////
+
+    //////////////////////////////////////////////
+    // DataProviders Monitoring
+    //////////////////////////////////////////////
+
+    //////////////////////////////////////////////
+    // Computing Site Monitoring
+    //////////////////////////////////////////////
+
+    //////////////////////////////////////////////
+    // Users Actions
+    //////////////////////////////////////////////
+
+    //////////////////////////////////////////////
+    // Tasks Actions
+    //////////////////////////////////////////////
+
+  };
+
+
+  //////////////////////////////////////////////
+  // Low method called by login
+  //////////////////////////////////////////////
+
+  // Set the authenticity_token
+  function setAuthToken(callback) {
+    var form = {};
+    doRequest( "GET", "/session/new", form, function (err, response, body) {
+      if (err) {callback(errorr); return;};
+      var parsed         = parse_json_body(body);
+      authenticity_token = parsed.authenticity_token;
+
+      if (!authenticity_token) {
+        callback("Cannot obtain authentication token?!? Server response:" + parsed);
+      } else {
+        callback(null,authenticity_token);
+      };
+    });
+  };
+
+  // Create a new session
+  function createSession(username, password, callback) {
+    if (!username) {callback("Need to be provided with a username."); return;};
+    if (!password) {callback("Need to be provided with a password."); return;};
+
+    var form = { login: username,
+                 password: password
+               };
+    doRequest("POST", "/session", form, function (err, response, body) {
+     if (err) {callback(err); return;};
+     callback(null,true);
+   });
+  };
+
+
+  //////////////////////////////////////////////
+  // Low level methods
+  //////////////////////////////////////////////
+
+  /**
+  * @doc function
+  * @name doRequest
+  * @param {string} method must be a HTTP action (one of :POST, :GET, :PUT, or :DELETE).
+  * @param {sting} path is a relative path to append to the URL of the main's URI.
+  * @param {obj} form is a hash table to sets body to a querystring representation of value.
+  * @param {function} callback Callback function.
+  * @description
+  * LOW LEVEL METHOD. Used by the other high level methods
+  * of thi API.
+  *
+  */
+  function doRequest(method, path, form, callback) {
+    // TODO: Check if throw works
+    if (!method) { callback("Need HTTP method (POST, GET, etc)."); return; };
+    if (!path)   { callback("Need CBRAIN route."); return; };
+
+    if (method.match(/GET|HEAD/)) {
+      // nothing special to do for the moment
+    }
+    // POST, DELETE etc
+    else {
+      merge_options( form, {authenticity_token: authenticity_token});
+    }
+
+    var url  = cbrain_server_url; // # contains trailing /
+        path = path.replace(/^\/*/,"");
+    var uri  = url + path; // slash is inside url
+
+    var request_options = {
+      method: method,
+      uri:    uri,
+      form:   form,
+    };
+
+    request(request_options, callback);
+  };
+
+  // Decode the json BODY of a reply.
+  // Returns the parsed JSON. If anything went wrong,
+  // set the internal error message and returns nil.
+  function parse_json_body(body) {
+    var parsed = undefined;
+    try {
+      parsed = JSON.parse(body);
+    } catch (e) {
+      return null;
+    }
+    return parsed;
+  };
+
+  return session;
+};
+
+// Utility method in order to concat to obj.
+function merge_options(obj1,obj2){
+  Object.keys(obj2).forEach(function(key) {
+    obj1[key] = obj1[key] || obj2[key];
+  })
+};
+

node/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "cbrain_api",
+  "version": "0.0.0",
+  "description": "CbrainAPI ",
+  "main": "./lib/cbrain_api.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "",
+  "license": "GNU General Public License v3",
+  "dependencies": {
+    "request": "^2.42.0"
+  },
+  "devDependencies": {
+    "grunt": "^0.4.1",
+    "grunt-docular": "^0.1.2"
+  }
+}