rest-parse

Parse REST API for Node js

##Installation##

• Simply run

npm install rest-parse

• Or if you want to save it to package.json

npm install rest-parse --save

• Or add rest-parse in your package.json

"dependencies": {
  "rest-parse": "*",
  ...
},

    then run

npm install

##Setup##

var restParse = require('rest-parse');

//prepare your keys
var APP_ID = '<your-parse-app-id>';
var REST_API_KEY = '<your-parse-rest-api-key>';

//create parse object with your keys
var Parse = new restParse(APP_ID, REST_API_KEY);

##Callback## All callbacks should follow this format: function(error, response, body, success) { ... }. This is because Kaiseki is based on Request and I thought it would be best to pass the same callback parameters. The error and response parameters are passed as is. On most methods, body is changed and parsed from JSON for your convenience.

• error: If there's an error during the request (e.g. no internet connection), this will not be empty. Note that if the API returns a statusCode that is not 2xx, it is not marked as an error.

• response: You can check lots of info about the request in here. For example, the REST API will return a response.statusCode value of 4xx on failures. In these cases, the API will still return a JSON object containing the fields code and error. You can get this in the body parameter.

  { "code": 105,
    "error": "invalid field name: bl!ng" }

    Read more about the Response format here.

• body: On successful requests, this will be an object or array depending on the method called.

• success: A convenience parameter, this is a boolean indicating if the request was a success.

##User## ####Setup#### This is to init the parse user before you could use it.

var parseUser = Parse.user();

####signUp(user, callback)####

var newUser = {
  username: 'boylove142',
  password: '123456',
  email: '[email protected]',
  //...
}

parseUser.signUp(newUser, callback);

####logIn(username, password, callback)####

var username = 'boylove142';
var password = '123456';

parseUser.logIn(username, password, callback);

####get(userId, params, callback)####

var userId = '<random-user-id>';

parseUser.get(userId, callback);

####getCurrent(callback)####

This method is used to check whether you logged in or not.

parseUser.getCurrent(callback);

####getAll(params, callback)####

Get all users

parseUser.getAll(callback);

Get all user with specified params. You can read more how to construct these params at https://parse.com/docs/rest#queries

var params = {
  email: '[email protected]'
}

parseUser.getAll(params, callback);

####update(userId, data, callback)####

var params = {
  var userId = '<random-user-id>';
  var params = {
    name: 'Bob',
    phone: '123456789',
  }
  
  parseUser.update(userId, params, callback);
}

####delete(userId, callback)####

This method will delete a specified user from parse

var params = {
  var userId = '<random-user-id>';
  
  parseUser.delete(userId, callback);
}

####requestResetPassword(email, callback)#### ####logInSocial(authData, callback)#### ####linkWithSocial(userId, authData, callback)#### ####unlinkWithSocial(userId, authData, callback)####

##Object## ####create(data, callback)#### ####get(objectId, params, callback)#### ####getAll(params, callback)#### ####update(objectId, data, callback)#### ####delete(objectId, callback)#### ####count(params, callback)#### ####createMany(objects, callback)#### ####updateMany(objects, callback)#### ####deleteMany(obeccts, callback)#### ##File## ####upload(filePath, fileName, callback)#### ####uploadBuffer(buffer, contentType, fileName, callback)#### ####delete(name, callback)#### ##Role## ####create(role, callback)#### ####get(roleId, params, callback)#### ####update(roleId, data, callback)#### ####delete(roleId, callback)#### ####getAll(params, callback)####