andrebot / ac-socialapi

Node API for AC classes

Social API

This is the code example for AvenueCode Node and Express Course.

Installation

npm install

This will install all the dependencies and grunt-cli (the last one as a global package).

###Dependencies

• NodeJS
• Express
• body-parser
• blanket
• bootstrap
• cookie-parser
• jsonwebtoken
• Grunt
• grunt-cli
• grunt-contrib-copy
• grunt-mocha-test
• grunt-nodemon
• Jquery
• Jquery-Cookie
• mocha
• mongoose
• should
• supertest

Run Server

To run the server you just have to execute: $ grunt serverExpress

Interacting With API

After you have set up the server and executed $ grunt serverExpress, you can access http://localhost:3000 and use the interface to test responses and behavior. (This code is in 'serverExpress/public/index.html').

Endpoints Available

• '/users/?q=query' - GET - List of all users or search by name using query
• '/users/' - POST - Create user
• '/users/me' - GET - Get logged user
• '/users/me' - PUT - Update logged user profile
• '/users/available' - GET - Get all users that can be added as a friend
• '/users/:userId' - GET - Get user with given ID
• '/users/:userId' - DELETE - Delete user with given ID
• '/users/password/:userId' - PUT - Change user's password
• '/friendships/' - GET - Get all friendships
• '/friendships/me' - GET - Get all logged user's friendships
• '/friendships/requests' - GET - Get all friendships that requests logged user
• '/friendships/requested' - GET - Get friendships that were requested by logged user
• '/friendships/:friendId' - GET - Get friendships between logged user and user with the ID provided
• '/friendships/:friendId' - POST - Invite user with the ID provided
• '/friendships/:friendId' - PUT - Accept request from user with ID provided
• '/friendships/:friendId' - DELETE - Reject requests from user with ID provided
• '/friendships/vip/:friendId' - POST - Set friendship with user as VIP
• '/friendships/vip/:friendId' - DELETE - Unset friendship with user as VIP
• '/friendships/block/:friendId' - POST - Block friendship with user
• '/friendships/block/:friendId' - DELETE - Block friendship with user

All endpoints are authenticated/authorized, but creating user. This endpoint is public. And the endpoint to delete user is authorized only to a admin.

Auth

Authorization/Authentication is done using token, by JWT. You can choose to use authentication by cookie or by Authorization header in the request.

Test

We are using mocha, supertest and should to do Unit Testing. We also added blanket as a coverage tool.

Obs.: Windows users BE WARNED! To execute the grunt test task you need to perform a change in the blanket lib. In the file node_modules/blanket/src/index.js (lines 128-134) we have this code:

 //instrument js files
 require.extensions['.js'] = function(localModule, filename) {
   var pattern = blanket.options("filter"),
       reporter_options = blanket.options("reporter_options"),
       originalFilename = filename,
 		  inputFilename = filename;
   filename = blanket.normalizeBackslashes(filename);

Please, kindly change it to:

 //instrument js files
 require.extensions['.js'] = function(localModule, filename) {
   var pattern = blanket.options("filter"),
       reporter_options = blanket.options("reporter_options"),
       originalFilename = filename,
 			 inputFilename = blanket.normalizeBackslashes(filename);
   filename = inputFilename;

Otherwise a exception will explode in the console because of windows path. Blanket Issue 491