SnailJS.Apex-Connect

SnailJS Apex Connection Library

Simple Example Using Express

var ApexConnect = require("apex-connect")
  , express = require("express")
  , app = express()

//do initial connect during startup
app.apex = new ApexConnect("http://my-apex-server","mysecret")
app.apex.connect(function(err,server_token){
  if(err) console.log("Failed to connect to Apex: " + err)
  //do something with auth_token
  //say the connection failure is critical then listen here
  //app.listen()
})

//setup authorize as a route
app.post("/login",function(req,res){
  var data = {
    collection: "staff",
    role: "admin",
    id: req.body.email,
    password: req.body.password
  }
  app.apex.authorize(data,function(err,inst){
    if(err) res.send("Failed to login")
    else {
      //save user instance to session
      req.session.apex = inst
      //notify success
      res.send("Successfully logged in here is your token: " + inst.token)
  })
})

//setup creation as a route
app.post("/staff/create",function(req,res){
  var data = {
    email: req.body.email,
    password: req.body.password,
    name: {
      first: req.body.name.first,
      last: req.body.name.last
    }
  }
  req.session.apex.call("/staff/create",data,function(err,res){
    if(err) res.send("Failed to create staff member")
    else res.send("Success! Staff member created")
  })
})

//say getting started is more important than server now and simply log errors
app.listen()

API Reference

Constructor

var myapex = new Connect("http://server","mysecret")

Constructs the initial instance and stores the secret and server hostname. No connection is made at this time.

Connect

myapex.connect(function(err,server_token){
  if(err) console.log("Failed to connect to Apex: " + err)
  else console.log("Apex Server Token: " + server_token)
})

Issues a connect authorization call the apex server using the secret.

Upon success the server will return a session token to be used by the server to make requests.

Authorize

var data = {collection: "staff", id: "[email protected]", password: "pass", role: "admin"}
myapex.authorize(data,function(err,inst){
  if(err) throw err
  inst.call("myfunction",{data:""},function(err,res){
    if(err) throw err
    console.log(res)
  })
})

Issues an authorization request. Upon success of login success it returns an instance that will use the session token for all further requests.

Note the session token should be used on all subsequent requests.

Object Parameters

Collection - collection to authorize against
ID - user identifier
Password - user password
Role - requested permission role (optional) (use role1,role2 for multiple)

For more information on roles see the apex documentation. http://github.com/snailjs/apex

Request Role

myapex.requestRole("newrole",function(err,roles){
  if(err) throw err
  //show roles permitted by token
  console.log(roles)
})

Requests an additional permission role to be added to the token. Tokens will only receive the role(s) requested at authorize time or if that is omitted the server will assign defaul role(s).

Returns list of roles on success or an error explaining why the request failed.

Call

myapex.call("/my/uri",{blah: "mydata"},function(err,res){
  if(err) throw err
  console.log(res)
})

Issues an arbitrary call the Apex server. This is the main method for making data requests.

Language	javascript
Version	0.1.0
Git URL	https://github.com/nullivex/apx-connect
License	MIT
Description	APX module for connect js
Keywords

apx-connect

SnailJS.Apex-Connect