jay-npm v0.10.5

JAY-NPM

Server for Single Page App relying on Jay.
Use Node-Jay as sample of usage.

Instant back-end
Database via Kaiseki and Parse.com. Authentication based on FB SDK and jwt-simle tokens.

INSTALLATION
(Assuming you have npm installed)

npm install jay-npm  

Set your settings at config.js. It also accepts process.env variables so you can run it like this:

PARSEID='myParseId' PARSEKEY='MyParseRESTAPIKey' node app.js

In order for everything to work properly Facebook app and parse.com credentials are required.
Set config.jwtSimple.secret into a string of your own choice.

USAGE
Jay front end component calls "/api/j" for GET and POST (JSONP) calls.
Jay-npm helps to respond to these calls. This is an example of receiving and replying with an Express server.

var Jay = require('jay-npm');

app.get('/api/j', function(req, res){
  Jay.get(req, res, config, function(data){
    res.jsonp(data);
  });
});

Please note that for this sample also express needs to be installed.
Check out Node-Jay for a complete example.

API
FB SDK Authentication
Facebook SDK is added and used for authentication.
Greetings for AndrusAsumets for help with this.

ensureAuthenticated
Compares users token with server token. If match is found the functions is fired, else error message is returned with response.

app.post('/api/j', Jay.ensureAuthenticated, function(req, res){
  Jay.post(req, res, config, function(data){
    res.jsonp(data);
  })
});

get
Retrieves data from Parse.com and returns as object.

Jay.get(req, res, config, function(data){
  res.jsonp(data);
});

post
Parses your formdata and saves it to Parse.com. If files are added, they are separately uploaded to Parse and added to the object.
Returns ObjectId.

app.post('/api/j', Jay.ensureAuthenticated, function(req, res){
  Jay.post(req, res, config, function(data){
    res.jsonp(data);
  })
});

put
Updates the post.
Returns ObjectId.

app.put('/api/j', function(req, res){
  Jay.put(req, res, config, function(data){
    res.jsonp(data);
  })
});

delete
Deletes the post.
Returns ObjectId.

app.delete('/api/j', function(req, res){
  Jay.delete(req, res, config, function(data){
    res.jsonp(data);
  })
});

query
Query for data.
Front end comes with this: query(table, limit, key, value, order).

app.get('/api/j/query', function(req, res){
  Jay.query(req, res, config, function(data){
    res.jsonp(data);
  });
});

protectedCallback()
All callbacks to and from Jay are protected with a check to make sure the headers are not already sent.

thumbnails alfa Thumbnails are currently created to your server, so Heroku might not be a good choice for this, because it's ephemeral file system (deletes everything that is not added to your git at least once every 24 h). Add this to config to create thumbnails:

config.thumbnails = {}
config.thumbnails.enabled = false;
config.thumbnails.quality = 20;

Licence

The MIT License (MIT)

Copyright (c) 2015 Martin Sookael

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.