Sugar Labs - User contributions [en]

Summer of Code/2013/moksaya

2013-09-22T00:46:53Z

Rahul Gaur: /* Site Model */

Summer of Code/2013/moksaya

2013-09-22T00:46:13Z

Rahul Gaur: /* Forking */

Summer of Code/2013/moksaya

2013-09-22T00:45:19Z

Rahul Gaur: /* Site Model */

== [http://sanskritdictionary.org/moksaya Moksaya] Project : ==
==== A Dajngo based web app aimed at sharing and collaboration of sugar activities to foster learning and creativity ====

Goal of this project is to implement a Project Sharing site to foster collaboration and sharing of Sugar Activities over the internet.The website upon the completion would also provide REST-API’s , so that the services of the website could be utilised by the Sugar Activities to share the project on the site from within the Sugar Environment.

== Repository ==

==== RESTful WebServer ====
I am developing this project under the Moksaya branch on my [https://github.com/aregee/moksaya Github].

==== Client Side WebApp ====

Development of web app consuming these RESTful api's can be tracked here https://github.com/aregee/Moksaya-web/

== REST API v1 Resources ==

==== User Creation ====
{| class="wikitable"
|-
! Resource !! Description
|-
| POST /api/v1/register/ || Makes http POST request with the JSON data to create a new user in the database ,if a user already exist raises HTTP 400 badrequest and returns a Json response with error message "the username already exist" . Returns HTTP 201 for successfully Created User
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X POST --data '{"username" :"user101" , "email" :"user@mail.com" , "password" : "password" }' http://moksaya-rahulgaur.rhcloud.com/api/v1/register/
|-
| Response || HTTP/1.1 201 CREATED Date: Thu, 19 Sep 2013 23:49:52 GMT Server: Apache/2.2.15 (Red Hat) Vary: Accept,Accept-Language,Cookie X-Frame-Options: SAMEORIGIN Content-Language: en-us Location:http://moksaya-rahulgaur.rhcloud.com/api/v1/register/19/
Content-Length: 0
Content-Type: text/html; charset=utf-8
|}

==== Authentication and User Login ====

Requires Username and Password for obtaining the api_keys , and rest of the other resources are accessed with the API Keys.
There are two ways to do it, these are Publicly accessible end points.

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/token/auth/ || Returns the apikey for the requested user, we need to supply the username and password in the request headers .
|-
| Example || curl -k --user "aregee:notebook" http://moksaya-rahulgaur.rhcloud.com/api/v1/token/auth/
|-
| Response || {
"key": "531ffb6152171df4f60b1b09f09dd1b4c5aba997"
}

|-
| POST /api/v1/user/login/ || Another way is to POST the user credentials as a JSON data to this end point and returns User Resource with the API_key . Raises HTTP 401 for unauthorized with error response
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X POST --data '{"username":"user101","password":"notebook" }' http://moksaya-rahulgaur.rhcloud.com/api/v1/user/login/
|-
| Response || HTTP/1.1 200 OK
Date: Fri, 20 Sep 2013 22:16:20 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Content-Type: application/json
Set-Cookie: sessionid=ddb4289b9fe8b2a963bfc540f81559c3; expires=Fri, 04-Oct-2013 22:16:20 GMT; httponly; Max-Age=1209600; Path=/
Transfer-Encoding: chunked

{
"apikey": "03f9a40ddd029b0a773a54f189aaa92d5a07c2d2",
"email": "user@mail.com",
"first_name": "",
"id": 14,
"last_name": "",
"resource_uri": "/api/v1/user/14/",
"username": "user101"
}

|}

==== User Resource ====
Authenticated users can access the User Resource , with the api_key and User Resource supports following authenticated options

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/user/ || Returns the list of all user accounts when accessed with authenticated header but returns requested user's resource when username and api_key supplied in url parameters
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/user/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
| Response || HTTP/1.1 200 OK
Date: Fri, 20 Sep 2013 22:32:23 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Type: application/json
Transfer-Encoding: chunked

{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 1
},
"objects": [
{
"apikey": "feea1175cdb9dde076eb68b5d83857fe2a58a186",
"email": "user@mail.com",
"first_name": "",
"id": 19,
"last_name": "",
"resource_uri": "/api/v1/user/19/",
"username": "akshit"
}
]
}
|-
| GET /api/v1/user/<username>/ || We can also access users with their respective usernames and returns HTTP 401 for resource not found
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/user/aregee/?username=spock\&api_key=d2fe32b15b0b395a5d0e0ea4b7eb1e5d6ea15de7
|-
| Response || HTTP/1.1 200 OK
Date: Fri, 20 Sep 2013 23:05:43 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Type: application/json
Transfer-Encoding: chunked

{
"apikey": "531ffb6152171df4f60b1b09f09dd1b4c5aba997",
"email": "iamaregee@gmail.com",
"first_name": "",
"id": 2,
"last_name": "",
"resource_uri": "/api/v1/user/2/",
"username": "aregee"
}
|-
| DELETE /api/v1/user/<username>/ || Removes the requested <username> from the database .
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X DELETE http://moksaya-rahulgaur.rhcloud.com/api/v1/user/akshit/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
| Response || HTTP/1.1 204 NO CONTENT
Date: Fri, 20 Sep 2013 22:36:22 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Content-Length: 0
Content-Type: text/html; charset=utf-8

|}

==== Profile Resource ====

{| class="wikitable"
|-
! Resource !! Description
|-
| POST /api/v1/profile/ || Making http post to this end point with the json data containing the Profile fields creates a new user profile , which is Related to all the other resources.Returns HTTP 201 response for successfully created user profile , returns HTTP 400 bad request with error response for unsuccessful attempts.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X POST --data '{"user":"/api/v1/user/akshit/" , "about_me" :"Profile Create with CURL"}' http://moksaya-rahulgaur.rhcloud.com/api/v1/profile/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
| GET /api/v1/profile/ || Returns list of all user profiles , throttles twenty results per request.
|-
| GET /api/v1/profile/username/ || Returns ProfileResource for the requested user , returns http 404 if resource is not found.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/profile/akshit/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
| Respone || HTTP/1.1 200 OK
Date: Thu, 19 Sep 2013 23:56:13 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Length: 279
Content-Type: application/json

{
"about_me": "Profile Create with CURL",
"followers": [],
"following": [],
"id": 19,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/19/",
"user": "akshit"
}
|-
| PUT /api/v1/profile/<username>/ || Updates the Profile Resource field with the supplied JSON data.Currently works with only about_me field but can be extended to include location and mugshot or Avatar fields
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X PUT --data '{"about_me" :"Profile Create & updated with CURL "}' http://moksaya-rahulgaur.rhcloud.com/api/v1/profile/akshit/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
|}

==== Project Resource ====

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/projects/ || Following query returns the list of all the projects submitted by the user.
|-
| GET /api/v1/projects/<id>/ || We can query a particular project with its id. This would return ProjectResource for the requested project id.It also shows related comments and likes on the project.
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/projects/1/?username=spock\&api_key=d2fe32b15b0b395a5d0e0ea4b7eb1e5d6ea15de7

|-

| Response || HTTP/1.1 200 OK
Date: Fri, 20 Sep 2013 23:40:38 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Type: application/json
Transfer-Encoding: chunked

{
"Likes": 6,
"comment": [
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/3/",
"text": "This is a Comment :)",
"user": "aregee"
},
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/8/",
"text": "Lets Post another Comment here :D",
"user": "aregee"
},
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/9/",
"text": "But This Kinda Looks Sweet :D",
"user": "aregee"
},
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/29/",
"text": "superb :)",
"user": "nikking1793"
},
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/30/",
"text": "superb :)",
"user": "nikking1793"
}
],
"desc": "Hello Project world",
"history": "",
"id": 1,
"resource_uri": "/api/v1/projects/1/",
"screenshot": "/media/projects/lin.jpg",
"shared_date": "2013-09-17T16:44:53.773919",
"src": "/media/projects/try.py",
"title": "This is My Project",
"user": "aregee"
}

|-
| POST /api/v1/projects/ || Making an http POST request to this URI with the Multipart form data in the JSON format creates a new project and Returns HTTP 201 for successfully created projects
|-
| Example || curl -F "user=/api/v1/profile/2/" -F "title=Fiddle with JS" -F "desc=this file documents my PROGRESS with learning JavaScript" -F "src=@projects/objects.js" -F "screenshot=@projects/img_screen.png" http://127.0.0.1:8000/api/v1/projects/?username=aregee\&api_key=531ffb6152171df4f60b1b09f09dd1b4c5aba99
|-
| PATCH /api/v1/projects/<id>/ || Updates the changed field to an existing project in the form of json data.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X PATCH --data '{"title":"Gallery Lock ++ " }' http://127.0.0.1:8000/api/v1/projects/1/?username=aregee\&api_key=531ffb6152171df4f60b1b09f09dd1b4c5aba99
|-
| PUT /api/v1/projects/<id>/ || We can also use the HTTP PUT request to update all the fields of an existing project
|-
| DELETE /api/v1/projects/<id>/ || Destroys the current project and the resource related to it : Likes , Comments
|-
|}

==== Project Forking ====

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/forking/<project_id>/ || Currently to fork a project , authenticated user makes GET request to this end point with the project id they need to fork.This method creates a copy of the requested project and associates it to the requesting User's profile.There is a history field in the Project to hold the data about original creator of the project.
|-
| Example || curl http://moksaya-rahulgaur.rhcloud.com/api/v1/forking/2/?username=vrinda\&api_key=b7c19215d088591e2dee07c2fb4df677ab1c9fbe
|-
| Response || {
"desc": "undefined",
"history": "project undefined created by aregee forked by vrinda ",
"resource_uri": "/api/v1/forking/2/",
"screenshot": "/media/projects/lin.jpg",
"shared_date": "2013-09-20T19:07:57.861892",
"src": "/media/projects/file_rem.py",
"title": "undefined"
}
|-
|}

==== Followers ====

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/relations/ || Returns a list of all the user relations with their resource.
|-
| POST /api/v1/relations/ || To create a follower/followee relation between the two user we pass a JSON data with the resource_uri of the currently logged in user's profile as follower and viewed profile of the user as followee . Returns HTTP 201 Created Response and each relations has its own id and other meta deta.
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X POST --data '{"follower":"/api/v1/profile/3/","followee":"/api/v1/profile/4/"}' http://127.0.0.1:8000/api/v1/relations/?username=vrinda\&api_key=b7c19215d088591e2dee07c2fb4df677ab1c9fbe
|-
| DELETE /api/v1/relations/<id>/ || Making a delete request to a relation , deletes the unilateral relation between the user.
|}

==== Likes ====

{| class="wikitable"
|-
! Resource !! Description
|-
| POST /api/v1/liking/ || Making http post request to this Resource along with the json data with user field containing resource_uri of the currently logged in user and liking_content_type field contains the URI of requested Project creates a liking Relation between the user and project.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X POST --data '{"user":"/api/v1/profile/2/" ,"liked_content_type":"/api/v1/projects/2/" }' http://127.0.0.1:8000/api/v1/liking/?username=vrinda\&api_key=b7c19215d088591e2dee07c2fb4df677ab1c9fbe
|-
| GET /api/v1/liking/ || Returns the list of all the liking relationship with their resource id and other liking resource.
|-
| GET /api/v1/liking/<id> || {
"Liked": "undefined",
"id": 2,
"liked_content_type": {
"Likes": 1,
"comment": [
{
"entry": "undefined",
"resource_uri": "/api/v1/comment/1/",
"text": ":P",
"user": "vrinda"
}
],
"desc": "undefined",
"history": "project undefined created by aregee forked by vrinda ",
"id": 4,
"resource_uri": "/api/v1/projects/4/",
"screenshot": "/media/projects/wb3_1.png",
"shared_date": "2013-09-20T19:09:43.084615",
"src": "/media/projects/feed__1.py",
"title": "undefined",
"user": "vrinda"
},
"resource_uri": "/api/v1/liking/2/",
"shared_date": "2013-09-20T19:09:59.892135",
"user": "vrinda"
}
|-
| DELETE /api/v1/liking/<id>/ || Destroys the requested liked relation.
|-
|}

==== Comment Resource ====

{| class="wikitable"
|-
! Description !! Resource
|-
| POST /api/v1/comment/ || This resource creates a new comment resource with the JSON data supplied to it.Returns 201 response for successfully added comment.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X POST --data '{"user":"/api/v1/profile/1/","entry":"/api/v1/projects/2/" , "text":"Comment posted with REST" }' http://127.0.0.1:8000/api/v1/comment/?username=soeone\&api_key=som23h32gh2g3h3g2h3gh2213ftf32f
|-
| GET /api/v1/comment/ || List all the comments along with their related Project Resource.
|-
| GET /api/v1/comment/<id>/ || Filters the Comment resource by their respective ids.
|-
| PATCH /api/v1/comment/<id>/ || Updates the text field in the comment.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X PATCH --data '{"text":"Comment POSTed with updated with PATCH" }' http://127.0.0.1:8000/api/v1/comment/1/?username=aregee\&api_key=ytg67asdf76asdf76fdsa767asdf67sadtg
|-
| DELETE /api/v1/comment/<id>/ || Making a delete request to the comment id , deletes the comment from the related resource or Project.
|}

=== Site Model ===
I have planed to design the RESTful interface to the Moksaya project , and I have written a web app to consume these APIs using [ http://angularjs.org/ AngularJS ]
Initially Moksaya project offers a RESTful interface to the following interrelated models :
*ProfileResource
*ProjectResource
*CommentResource
*LikeResource
*ForkResource

At the Top most level Profile/list contains all the User Profiles along with their Related Resources.
So , a typical user profile contains User info like About , Birthdays etcs then the Related Resources Projects , Friends List , Likes on Projects (Can be easily extended for comments or other models).
Most of these Related Resources can be accessed individually as well.

* Top Level View :curl --dump-header - -H "Content-Type: application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/profile/?username=spock\&api_key=d2fe32b15b0b395a5d0e0ea4b7eb1e5d6ea15de7
HTTP/1.1 200 OK
Date: Sat, 21 Sep 2013 01:32:01 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Type: application/json
Transfer-Encoding: chunked

{
"meta": {
"limit": 20,
"next": "/api/v1/profile/?username=spock&api_key=d2fe32b15b0b395a5d0e0ea4b7eb1e5d6ea15de7&limit=20&offset=20",
"offset": 0,
"previous": null,
"total_count": 26
},
"objects": [
{
"about_me": "admin",
"followers": [
"aregee"
],
"following": [],
"id": 1,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/1/",
"user": "admin"
},
{
"about_me": "Now I can update About_ME",
"followers": [
"vrinda",
"kirk",
"ned",
"titiksha",
"robStark",
"jarvis",
"satyamyadav",
"user101",
"atif",
"nikking1793",
"tch",
"amigo",
"aregee__"
],
"following": [
"vrinda",
"ned",
"kirk",
"tch",
"admin",
"titiksha",
"jarvis",
"monikagupta",
"satyamyadav",
"surajgillespie",
"nikking1793",
"amigo",
"raju"
],
"id": 2,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [
{
"Likes": 1,
"comment": [],
"desc": "undefined",
"history": "",
"id": 1,
"resource_uri": "/api/v1/projects/1/",
"screenshot": "/media/projects/wb3.png",
"shared_date": "2013-09-20T19:07:29.101309",
"src": "/media/projects/feed_.py",
"title": "undefined",
"user": "aregee"
},
{
"Likes": 0,
"comment": [],
"desc": "undefined",
"history": "",
"id": 2,
"resource_uri": "/api/v1/projects/2/",
"screenshot": "/media/projects/lin.jpg",
"shared_date": "2013-09-20T19:07:57.861892",
"src": "/media/projects/file_rem.py",
"title": "undefined",
"user": "aregee"
},
{
"Likes": 0,
"comment": [],
"desc": "undefined",
"history": "",
"id": 3,
"resource_uri": "/api/v1/projects/3/",
"screenshot": "/media/projects/beautiful_strings.png",
"shared_date": "2013-09-20T19:08:30.575741",
"src": "/media/projects/file_rem_1.py",
"title": "undefined",
"user": "aregee"
}
],
"resource_uri": "/api/v1/profile/2/",
"user": "aregee"
},
{
"about_me": "Oh not it won't happen :0",
"followers": [
"aregee"
],
"following": [
"aregee",
"kirk",
"jarvis"
],
"id": 3,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [
{
"Likes": 1,
"comment": [
{
"entry": "undefined",
"resource_uri": "/api/v1/comment/1/",
"text": ":P",
"user": "vrinda"
}
],
"desc": "undefined",
"history": "project undefined created by aregee forked by vrinda ",
"id": 4,
"resource_uri": "/api/v1/projects/4/",
"screenshot": "/media/projects/wb3_1.png",
"shared_date": "2013-09-20T19:09:43.084615",
"src": "/media/projects/feed__1.py",
"title": "undefined",
"user": "vrinda"
},
{
"Likes": 0,
"comment": [],
"desc": "undefined",
"history": "project undefined created by aregee forked by vrinda ",
"id": 5,
"resource_uri": "/api/v1/projects/5/",
"screenshot": "/media/projects/lin_1.jpg",
"shared_date": "2013-09-20T19:22:22.520212",
"src": "/media/projects/file_rem_2.py",
"title": "undefined",
"user": "vrinda"
}
],
"resource_uri": "/api/v1/profile/3/",
"user": "vrinda"
},
{
"about_me": "I am SPOCK",
"followers": [],
"following": [],
"id": 4,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/4/",
"user": "spock"
},
{
"about_me": "Howdy partner, this is kirk's Moksaya Profile",
"followers": [
"aregee",
"vrinda"
],
"following": [
"aregee"
],
"id": 5,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/5/",
"user": "kirk"
},
{
"about_me": "Howdy partner, this is ned's Moksaya Profile",
"followers": [
"aregee"
],
"following": [
"aregee"
],
"id": 6,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/6/",
"user": "ned"
},
{
"about_me": "sdasd",
"followers": [
"aregee"
],
"following": [
"aregee"
],
"id": 7,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/7/",
"user": "tch"
},
{
"about_me": "I am Titiksha",
"followers": [
"aregee"
],
"following": [
"aregee"
],
"id": 8,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/8/",
"user": "titiksha"
},
{
"about_me": "This is Rob Stark , King in the North ;)",
"followers": [],
"following": [
"aregee"
],
"id": 9,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/9/",
"user": "robStark"
},
{
"about_me": "Howdy partner, this is mronetwo's Moksaya Profile",
"followers": [],
"following": [],
"id": 10,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/10/",
"user": "mronetwo"
},
{
"about_me": "Howdy partner, this is monikagupta's Moksaya Profile",
"followers": [
"aregee"
],
"following": [],
"id": 11,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/11/",
"user": "monikagupta"
},
{
"about_me": "Howdy partner, this is jarvis's Moksaya Profile",
"followers": [
"aregee",
"vrinda"
],
"following": [
"aregee"
],
"id": 12,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/12/",
"user": "jarvis"
},
{
"about_me": "Howdy partner, this is satyamyadav's Moksaya Profile",
"followers": [
"aregee"
],
"following": [
"aregee"
],
"id": 13,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/13/",
"user": "satyamyadav"
},
{
"about_me": "Hello , I am user1010 and I code :)",
"followers": [],
"following": [
"aregee"
],
"id": 14,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/14/",
"user": "user101"
},
{
"about_me": "Howdy atif , this is your Moksaya Profile",
"followers": [],
"following": [
"aregee"
],
"id": 15,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/15/",
"user": "atif"
},
{
"about_me": "Howdy surajgillespie , this is your Moksaya Profile",
"followers": [
"aregee"
],
"following": [],
"id": 16,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/16/",
"user": "surajgillespie"
},
{
"about_me": "Howdy partner, this is moksaya_user's Moksaya Profile",
"followers": [],
"following": [],
"id": 17,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/17/",
"user": "moksaya_user"
},
{
"about_me": "Howdy nikking1793 , this is your Moksaya Profile",
"followers": [
"aregee",
"user102"
],
"following": [
"aregee"
],
"id": 18,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/18/",
"user": "nikking1793"
},
{
"about_me": "Howdy Ayushletsrock , this is your Moksaya Profile",
"followers": [
"user102"
],
"following": [],
"id": 20,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/20/",
"user": "Ayushletsrock"
},
{
"about_me": "Howdy gonzalo , this is your Moksaya Profile",
"followers": [],
"following": [],
"id": 21,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/21/",
"user": "gonzalo"
}
]

==Forking==
Lets take a look at how forking works here , though this is not really the best approach but I am doing this for understanding purpose and would figure out the proper solution for this ..
but for now here it is.

* Lets say these are the projects on the Moksaya submitted by the user :
{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 3
},
"objects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"id": 1,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"id": 2,
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
},
{
"Likes": 3,
"comment": [],
"desc": "This is my first hello world code",
"id": 3,
"owner": "testuser",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-06-27T15:31:22.560494",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
}
]
}

* Now I am logged in as aregee , and here is my profile at 127.0.0.1:8000/api/v1/profile/list/1/?format=json

{
"about_me": "DjangoNaut",
"birth_date": "1991-06-20",
"friends": [
"testuser",
"SomeDude"
],
"gender": 1,
"language": "en",
"location": "India",
"mugshot": "/media/mugshots/d749832b7a.jpg",
"privacy": "registered",
"projects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"id": 1,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"id": 2,
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
}
],
"user": "aregee",
"website": "http://rahulgaur.info/"
}

* Now I want to fork the Project with id = 3 created by testuser , so I will make a GET request to 127.0.0.1:8000/api/v1/forking/3/?format=json
{
"Changes": {
"owner": "testuser",
"shared_date": "2013-06-27T15:31:22.560494"
},
"desc": "This is my first hello world code",
"resource_uri": "/api/v1/forking/3/",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-06-27T15:31:22.560494",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
}

The diffs / metadata could be viewed for the changes made , for instance here the response shows the original author of the project and the date it was shared

* Lets take a look at my Profile again at 127.0.0.1:8000/api/v1/profile/list/1/?format=json
{
"about_me": "DjangoNaut",
"birth_date": "1991-06-20",
"friends": [
"testuser",
"SomeDude"
],
"gender": 1,
"language": "en",
"location": "India",
"mugshot": "/media/mugshots/d749832b7a.jpg",
"privacy": "registered",
"projects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"id": 1,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"id": 2,
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
},
{
"Likes": 0,
"comment": [],
"desc": "This is my first hello world code",
"id": 4,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-07-04T20:46:43.062294",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
}
],
"user": "aregee",
"website": "http://rahulgaur.info/"
}

* And the list of projects at 127.0.0.1:8000/api/v1/projects/

{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 4
},
"objects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"id": 1,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"id": 2,
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
},
{
"Likes": 3,
"comment": [],
"desc": "This is my first hello world code",
"id": 3,
"owner": "testuser",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-06-27T15:31:22.560494",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
},
{
"Likes": 0,
"comment": [],
"desc": "This is my first hello world code",
"id": 4,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-07-04T20:46:43.062294",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
}
]
}

Difference among the two Projects can be tracked by Project.objects.get(pk = 4).diff(Project.objects.get(pk = 3)) , its a method provided by the django-forkit app to view changes / differences in the forkable models.
Meta data field needs to bee added to Projects field so that we can save these differences when a project is forked , and every project should contain a link to original creator.

=== TODOS ===

* Add Authentication
* Provide Full CRUD access to authenticated user to the core site functionalities : Like , Comment , UserProfile, Projects etcs
* Improve the forking functionality
* Implement JavaScript Client to consume APIs to get a minimal functional product up and running

Summer of Code/2013/moksaya

2013-09-22T00:41:50Z

Rahul Gaur: /* Moksaya Project : */

== [http://sanskritdictionary.org/moksaya Moksaya] Project : ==
==== A Dajngo based web app aimed at sharing and collaboration of sugar activities to foster learning and creativity ====

Goal of this project is to implement a Project Sharing site to foster collaboration and sharing of Sugar Activities over the internet.The website upon the completion would also provide REST-API’s , so that the services of the website could be utilised by the Sugar Activities to share the project on the site from within the Sugar Environment.

== Repository ==

==== RESTful WebServer ====
I am developing this project under the Moksaya branch on my [https://github.com/aregee/moksaya Github].

==== Client Side WebApp ====

Development of web app consuming these RESTful api's can be tracked here https://github.com/aregee/Moksaya-web/

== REST API v1 Resources ==

==== User Creation ====
{| class="wikitable"
|-
! Resource !! Description
|-
| POST /api/v1/register/ || Makes http POST request with the JSON data to create a new user in the database ,if a user already exist raises HTTP 400 badrequest and returns a Json response with error message "the username already exist" . Returns HTTP 201 for successfully Created User
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X POST --data '{"username" :"user101" , "email" :"user@mail.com" , "password" : "password" }' http://moksaya-rahulgaur.rhcloud.com/api/v1/register/
|-
| Response || HTTP/1.1 201 CREATED Date: Thu, 19 Sep 2013 23:49:52 GMT Server: Apache/2.2.15 (Red Hat) Vary: Accept,Accept-Language,Cookie X-Frame-Options: SAMEORIGIN Content-Language: en-us Location:http://moksaya-rahulgaur.rhcloud.com/api/v1/register/19/
Content-Length: 0
Content-Type: text/html; charset=utf-8
|}

==== Authentication and User Login ====

Requires Username and Password for obtaining the api_keys , and rest of the other resources are accessed with the API Keys.
There are two ways to do it, these are Publicly accessible end points.

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/token/auth/ || Returns the apikey for the requested user, we need to supply the username and password in the request headers .
|-
| Example || curl -k --user "aregee:notebook" http://moksaya-rahulgaur.rhcloud.com/api/v1/token/auth/
|-
| Response || {
"key": "531ffb6152171df4f60b1b09f09dd1b4c5aba997"
}

|-
| POST /api/v1/user/login/ || Another way is to POST the user credentials as a JSON data to this end point and returns User Resource with the API_key . Raises HTTP 401 for unauthorized with error response
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X POST --data '{"username":"user101","password":"notebook" }' http://moksaya-rahulgaur.rhcloud.com/api/v1/user/login/
|-
| Response || HTTP/1.1 200 OK
Date: Fri, 20 Sep 2013 22:16:20 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Content-Type: application/json
Set-Cookie: sessionid=ddb4289b9fe8b2a963bfc540f81559c3; expires=Fri, 04-Oct-2013 22:16:20 GMT; httponly; Max-Age=1209600; Path=/
Transfer-Encoding: chunked

{
"apikey": "03f9a40ddd029b0a773a54f189aaa92d5a07c2d2",
"email": "user@mail.com",
"first_name": "",
"id": 14,
"last_name": "",
"resource_uri": "/api/v1/user/14/",
"username": "user101"
}

|}

==== User Resource ====
Authenticated users can access the User Resource , with the api_key and User Resource supports following authenticated options

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/user/ || Returns the list of all user accounts when accessed with authenticated header but returns requested user's resource when username and api_key supplied in url parameters
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/user/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
| Response || HTTP/1.1 200 OK
Date: Fri, 20 Sep 2013 22:32:23 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Type: application/json
Transfer-Encoding: chunked

{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 1
},
"objects": [
{
"apikey": "feea1175cdb9dde076eb68b5d83857fe2a58a186",
"email": "user@mail.com",
"first_name": "",
"id": 19,
"last_name": "",
"resource_uri": "/api/v1/user/19/",
"username": "akshit"
}
]
}
|-
| GET /api/v1/user/<username>/ || We can also access users with their respective usernames and returns HTTP 401 for resource not found
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/user/aregee/?username=spock\&api_key=d2fe32b15b0b395a5d0e0ea4b7eb1e5d6ea15de7
|-
| Response || HTTP/1.1 200 OK
Date: Fri, 20 Sep 2013 23:05:43 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Type: application/json
Transfer-Encoding: chunked

{
"apikey": "531ffb6152171df4f60b1b09f09dd1b4c5aba997",
"email": "iamaregee@gmail.com",
"first_name": "",
"id": 2,
"last_name": "",
"resource_uri": "/api/v1/user/2/",
"username": "aregee"
}
|-
| DELETE /api/v1/user/<username>/ || Removes the requested <username> from the database .
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X DELETE http://moksaya-rahulgaur.rhcloud.com/api/v1/user/akshit/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
| Response || HTTP/1.1 204 NO CONTENT
Date: Fri, 20 Sep 2013 22:36:22 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Content-Length: 0
Content-Type: text/html; charset=utf-8

|}

==== Profile Resource ====

{| class="wikitable"
|-
! Resource !! Description
|-
| POST /api/v1/profile/ || Making http post to this end point with the json data containing the Profile fields creates a new user profile , which is Related to all the other resources.Returns HTTP 201 response for successfully created user profile , returns HTTP 400 bad request with error response for unsuccessful attempts.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X POST --data '{"user":"/api/v1/user/akshit/" , "about_me" :"Profile Create with CURL"}' http://moksaya-rahulgaur.rhcloud.com/api/v1/profile/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
| GET /api/v1/profile/ || Returns list of all user profiles , throttles twenty results per request.
|-
| GET /api/v1/profile/username/ || Returns ProfileResource for the requested user , returns http 404 if resource is not found.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/profile/akshit/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
| Respone || HTTP/1.1 200 OK
Date: Thu, 19 Sep 2013 23:56:13 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Length: 279
Content-Type: application/json

{
"about_me": "Profile Create with CURL",
"followers": [],
"following": [],
"id": 19,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/19/",
"user": "akshit"
}
|-
| PUT /api/v1/profile/<username>/ || Updates the Profile Resource field with the supplied JSON data.Currently works with only about_me field but can be extended to include location and mugshot or Avatar fields
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X PUT --data '{"about_me" :"Profile Create & updated with CURL "}' http://moksaya-rahulgaur.rhcloud.com/api/v1/profile/akshit/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
|}

==== Project Resource ====

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/projects/ || Following query returns the list of all the projects submitted by the user.
|-
| GET /api/v1/projects/<id>/ || We can query a particular project with its id. This would return ProjectResource for the requested project id.It also shows related comments and likes on the project.
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/projects/1/?username=spock\&api_key=d2fe32b15b0b395a5d0e0ea4b7eb1e5d6ea15de7

|-

| Response || HTTP/1.1 200 OK
Date: Fri, 20 Sep 2013 23:40:38 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Type: application/json
Transfer-Encoding: chunked

{
"Likes": 6,
"comment": [
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/3/",
"text": "This is a Comment :)",
"user": "aregee"
},
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/8/",
"text": "Lets Post another Comment here :D",
"user": "aregee"
},
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/9/",
"text": "But This Kinda Looks Sweet :D",
"user": "aregee"
},
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/29/",
"text": "superb :)",
"user": "nikking1793"
},
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/30/",
"text": "superb :)",
"user": "nikking1793"
}
],
"desc": "Hello Project world",
"history": "",
"id": 1,
"resource_uri": "/api/v1/projects/1/",
"screenshot": "/media/projects/lin.jpg",
"shared_date": "2013-09-17T16:44:53.773919",
"src": "/media/projects/try.py",
"title": "This is My Project",
"user": "aregee"
}

|-
| POST /api/v1/projects/ || Making an http POST request to this URI with the Multipart form data in the JSON format creates a new project and Returns HTTP 201 for successfully created projects
|-
| Example || curl -F "user=/api/v1/profile/2/" -F "title=Fiddle with JS" -F "desc=this file documents my PROGRESS with learning JavaScript" -F "src=@projects/objects.js" -F "screenshot=@projects/img_screen.png" http://127.0.0.1:8000/api/v1/projects/?username=aregee\&api_key=531ffb6152171df4f60b1b09f09dd1b4c5aba99
|-
| PATCH /api/v1/projects/<id>/ || Updates the changed field to an existing project in the form of json data.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X PATCH --data '{"title":"Gallery Lock ++ " }' http://127.0.0.1:8000/api/v1/projects/1/?username=aregee\&api_key=531ffb6152171df4f60b1b09f09dd1b4c5aba99
|-
| PUT /api/v1/projects/<id>/ || We can also use the HTTP PUT request to update all the fields of an existing project
|-
| DELETE /api/v1/projects/<id>/ || Destroys the current project and the resource related to it : Likes , Comments
|-
|}

==== Project Forking ====

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/forking/<project_id>/ || Currently to fork a project , authenticated user makes GET request to this end point with the project id they need to fork.This method creates a copy of the requested project and associates it to the requesting User's profile.There is a history field in the Project to hold the data about original creator of the project.
|-
| Example || curl http://moksaya-rahulgaur.rhcloud.com/api/v1/forking/2/?username=vrinda\&api_key=b7c19215d088591e2dee07c2fb4df677ab1c9fbe
|-
| Response || {
"desc": "undefined",
"history": "project undefined created by aregee forked by vrinda ",
"resource_uri": "/api/v1/forking/2/",
"screenshot": "/media/projects/lin.jpg",
"shared_date": "2013-09-20T19:07:57.861892",
"src": "/media/projects/file_rem.py",
"title": "undefined"
}
|-
|}

==== Followers ====

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/relations/ || Returns a list of all the user relations with their resource.
|-
| POST /api/v1/relations/ || To create a follower/followee relation between the two user we pass a JSON data with the resource_uri of the currently logged in user's profile as follower and viewed profile of the user as followee . Returns HTTP 201 Created Response and each relations has its own id and other meta deta.
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X POST --data '{"follower":"/api/v1/profile/3/","followee":"/api/v1/profile/4/"}' http://127.0.0.1:8000/api/v1/relations/?username=vrinda\&api_key=b7c19215d088591e2dee07c2fb4df677ab1c9fbe
|-
| DELETE /api/v1/relations/<id>/ || Making a delete request to a relation , deletes the unilateral relation between the user.
|}

==== Likes ====

{| class="wikitable"
|-
! Resource !! Description
|-
| POST /api/v1/liking/ || Making http post request to this Resource along with the json data with user field containing resource_uri of the currently logged in user and liking_content_type field contains the URI of requested Project creates a liking Relation between the user and project.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X POST --data '{"user":"/api/v1/profile/2/" ,"liked_content_type":"/api/v1/projects/2/" }' http://127.0.0.1:8000/api/v1/liking/?username=vrinda\&api_key=b7c19215d088591e2dee07c2fb4df677ab1c9fbe
|-
| GET /api/v1/liking/ || Returns the list of all the liking relationship with their resource id and other liking resource.
|-
| GET /api/v1/liking/<id> || {
"Liked": "undefined",
"id": 2,
"liked_content_type": {
"Likes": 1,
"comment": [
{
"entry": "undefined",
"resource_uri": "/api/v1/comment/1/",
"text": ":P",
"user": "vrinda"
}
],
"desc": "undefined",
"history": "project undefined created by aregee forked by vrinda ",
"id": 4,
"resource_uri": "/api/v1/projects/4/",
"screenshot": "/media/projects/wb3_1.png",
"shared_date": "2013-09-20T19:09:43.084615",
"src": "/media/projects/feed__1.py",
"title": "undefined",
"user": "vrinda"
},
"resource_uri": "/api/v1/liking/2/",
"shared_date": "2013-09-20T19:09:59.892135",
"user": "vrinda"
}
|-
| DELETE /api/v1/liking/<id>/ || Destroys the requested liked relation.
|-
|}

==== Comment Resource ====

{| class="wikitable"
|-
! Description !! Resource
|-
| POST /api/v1/comment/ || This resource creates a new comment resource with the JSON data supplied to it.Returns 201 response for successfully added comment.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X POST --data '{"user":"/api/v1/profile/1/","entry":"/api/v1/projects/2/" , "text":"Comment posted with REST" }' http://127.0.0.1:8000/api/v1/comment/?username=soeone\&api_key=som23h32gh2g3h3g2h3gh2213ftf32f
|-
| GET /api/v1/comment/ || List all the comments along with their related Project Resource.
|-
| GET /api/v1/comment/<id>/ || Filters the Comment resource by their respective ids.
|-
| PATCH /api/v1/comment/<id>/ || Updates the text field in the comment.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X PATCH --data '{"text":"Comment POSTed with updated with PATCH" }' http://127.0.0.1:8000/api/v1/comment/1/?username=aregee\&api_key=ytg67asdf76asdf76fdsa767asdf67sadtg
|-
| DELETE /api/v1/comment/<id>/ || Making a delete request to the comment id , deletes the comment from the related resource or Project.
|}

=== Site Model ===
I have planed to design the RESTful interface to the Moksaya project , and I have written a web app to consume these APIs using [ http://angularjs.org/ AngularJS ]
Initially Moksaya project offers a RESTful interface to the following interrelated models :
*ProfileResource
*ProjectResource
*CommentResource
*LikeResource
*ForkResource

At the Top most level Profile/list contains all the User Profiles along with their Related Resources.
So , a typical user profile contains User info like About , Birthdays etcs then the Related Resources Projects , Friends List , Likes on Projects (Can be easily extended for comments or other models).
Most of these Related Resources can be accessed individually as well.

* Top Level View :curl --dump-header - -H "Content-Type: application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/profile/?username=spock\&api_key=d2fe32b15b0b395a5d0e0ea4b7eb1e5d6ea15de7
HTTP/1.1 200 OK
Date: Sat, 21 Sep 2013 01:32:01 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Type: application/json
Transfer-Encoding: chunked

{
"meta": {
"limit": 20,
"next": "/api/v1/profile/?username=spock&api_key=d2fe32b15b0b395a5d0e0ea4b7eb1e5d6ea15de7&limit=20&offset=20",
"offset": 0,
"previous": null,
"total_count": 26
},
"objects": [
{
"about_me": "admin",
"followers": [
"aregee"
],
"following": [],
"id": 1,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/1/",
"user": "admin"
},
{
"about_me": "Now I can update About_ME",
"followers": [
"vrinda",
"kirk",
"ned",
"titiksha",
"robStark",
"jarvis",
"satyamyadav",
"user101",
"atif",
"nikking1793",
"tch",
"amigo",
"aregee__"
],
"following": [
"vrinda",
"ned",
"kirk",
"tch",
"admin",
"titiksha",
"jarvis",
"monikagupta",
"satyamyadav",
"surajgillespie",
"nikking1793",
"amigo",
"raju"
],
"id": 2,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [
{
"Likes": 1,
"comment": [],
"desc": "undefined",
"history": "",
"id": 1,
"resource_uri": "/api/v1/projects/1/",
"screenshot": "/media/projects/wb3.png",
"shared_date": "2013-09-20T19:07:29.101309",
"src": "/media/projects/feed_.py",
"title": "undefined",
"user": "aregee"
},
{
"Likes": 0,
"comment": [],
"desc": "undefined",
"history": "",
"id": 2,
"resource_uri": "/api/v1/projects/2/",
"screenshot": "/media/projects/lin.jpg",
"shared_date": "2013-09-20T19:07:57.861892",
"src": "/media/projects/file_rem.py",
"title": "undefined",
"user": "aregee"
},
{
"Likes": 0,
"comment": [],
"desc": "undefined",
"history": "",
"id": 3,
"resource_uri": "/api/v1/projects/3/",
"screenshot": "/media/projects/beautiful_strings.png",
"shared_date": "2013-09-20T19:08:30.575741",
"src": "/media/projects/file_rem_1.py",
"title": "undefined",
"user": "aregee"
}
],
"resource_uri": "/api/v1/profile/2/",
"user": "aregee"
},
{
"about_me": "Oh not it won't happen :0",
"followers": [
"aregee"
],
"following": [
"aregee",
"kirk",
"jarvis"
],
"id": 3,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [
{
"Likes": 1,
"comment": [
{
"entry": "undefined",
"resource_uri": "/api/v1/comment/1/",
"text": ":P",
"user": "vrinda"
}
],
"desc": "undefined",
"history": "project undefined created by aregee forked by vrinda ",
"id": 4,
"resource_uri": "/api/v1/projects/4/",
"screenshot": "/media/projects/wb3_1.png",
"shared_date": "2013-09-20T19:09:43.084615",
"src": "/media/projects/feed__1.py",
"title": "undefined",
"user": "vrinda"
},
{
"Likes": 0,
"comment": [],
"desc": "undefined",
"history": "project undefined created by aregee forked by vrinda ",
"id": 5,
"resource_uri": "/api/v1/projects/5/",
"screenshot": "/media/projects/lin_1.jpg",
"shared_date": "2013-09-20T19:22:22.520212",
"src": "/media/projects/file_rem_2.py",
"title": "undefined",
"user": "vrinda"
}
],
"resource_uri": "/api/v1/profile/3/",
"user": "vrinda"
},
{
"about_me": "I am SPOCK",
"followers": [],
"following": [],
"id": 4,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/4/",
"user": "spock"
},
{
"about_me": "Howdy partner, this is kirk's Moksaya Profile",
"followers": [
"aregee",
"vrinda"
],
"following": [
"aregee"
],
"id": 5,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/5/",
"user": "kirk"
},
{
"about_me": "Howdy partner, this is ned's Moksaya Profile",
"followers": [
"aregee"
],
"following": [
"aregee"
],
"id": 6,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/6/",
"user": "ned"
},
{
"about_me": "sdasd",
"followers": [
"aregee"
],
"following": [
"aregee"
],
"id": 7,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/7/",
"user": "tch"
},
{
"about_me": "I am Titiksha",
"followers": [
"aregee"
],
"following": [
"aregee"
],
"id": 8,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/8/",
"user": "titiksha"
},
{
"about_me": "This is Rob Stark , King in the North ;)",
"followers": [],
"following": [
"aregee"
],
"id": 9,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/9/",
"user": "robStark"
},
{
"about_me": "Howdy partner, this is mronetwo's Moksaya Profile",
"followers": [],
"following": [],
"id": 10,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/10/",
"user": "mronetwo"
},
{
"about_me": "Howdy partner, this is monikagupta's Moksaya Profile",
"followers": [
"aregee"
],
"following": [],
"id": 11,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/11/",
"user": "monikagupta"
},
{
"about_me": "Howdy partner, this is jarvis's Moksaya Profile",
"followers": [
"aregee",
"vrinda"
],
"following": [
"aregee"
],
"id": 12,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/12/",
"user": "jarvis"
},
{
"about_me": "Howdy partner, this is satyamyadav's Moksaya Profile",
"followers": [
"aregee"
],
"following": [
"aregee"
],
"id": 13,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/13/",
"user": "satyamyadav"
},
{
"about_me": "Hello , I am user1010 and I code :)",
"followers": [],
"following": [
"aregee"
],
"id": 14,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/14/",
"user": "user101"
},
{
"about_me": "Howdy atif , this is your Moksaya Profile",
"followers": [],
"following": [
"aregee"
],
"id": 15,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/15/",
"user": "atif"
},
{
"about_me": "Howdy surajgillespie , this is your Moksaya Profile",
"followers": [
"aregee"
],
"following": [],
"id": 16,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/16/",
"user": "surajgillespie"
},
{
"about_me": "Howdy partner, this is moksaya_user's Moksaya Profile",
"followers": [],
"following": [],
"id": 17,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/17/",
"user": "moksaya_user"
},
{
"about_me": "Howdy nikking1793 , this is your Moksaya Profile",
"followers": [
"aregee",
"user102"
],
"following": [
"aregee"
],
"id": 18,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/18/",
"user": "nikking1793"
},
{
"about_me": "Howdy Ayushletsrock , this is your Moksaya Profile",
"followers": [
"user102"
],
"following": [],
"id": 20,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/20/",
"user": "Ayushletsrock"
},
{
"about_me": "Howdy gonzalo , this is your Moksaya Profile",
"followers": [],
"following": [],
"id": 21,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/21/",
"user": "gonzalo"
}
]
}

* Related Resource Projects here can be accessed by http://127.0.0.1:8000/api/v1/projects/?format=json
{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 5
},
"objects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
},
{
"Likes": 3,
"comment": [],
"desc": "This is my first hello world code",
"owner": "testuser",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-06-27T15:31:22.560494",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
},
{
"Likes": 0,
"comment": [],
"desc": "This is my first hello world code",
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-07-04T19:18:23.307241",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
},
{
"Likes": 0,
"comment": [],
"desc": "Wired Hack ",
"owner": "testuser",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-07-04T19:37:54.184572",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
}
]
}

In the above results I have excluded Project ids from the json Response, but similarly each individual project could be accessed and updated by making GET or Post or Put request to http://127.0.0.1:8000/api/v1/projects/<pk>?format=json

* Accessing particular project http://127.0.0.1:8000/api/v1/projects/2/?format=json

{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
}

==Forking==
Lets take a look at how forking works here , though this is not really the best approach but I am doing this for understanding purpose and would figure out the proper solution for this ..
but for now here it is.

* Lets say these are the projects on the Moksaya submitted by the user :
{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 3
},
"objects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"id": 1,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"id": 2,
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
},
{
"Likes": 3,
"comment": [],
"desc": "This is my first hello world code",
"id": 3,
"owner": "testuser",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-06-27T15:31:22.560494",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
}
]
}

* Now I am logged in as aregee , and here is my profile at 127.0.0.1:8000/api/v1/profile/list/1/?format=json

{
"about_me": "DjangoNaut",
"birth_date": "1991-06-20",
"friends": [
"testuser",
"SomeDude"
],
"gender": 1,
"language": "en",
"location": "India",
"mugshot": "/media/mugshots/d749832b7a.jpg",
"privacy": "registered",
"projects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"id": 1,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"id": 2,
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
}
],
"user": "aregee",
"website": "http://rahulgaur.info/"
}

* Now I want to fork the Project with id = 3 created by testuser , so I will make a GET request to 127.0.0.1:8000/api/v1/forking/3/?format=json
{
"Changes": {
"owner": "testuser",
"shared_date": "2013-06-27T15:31:22.560494"
},
"desc": "This is my first hello world code",
"resource_uri": "/api/v1/forking/3/",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-06-27T15:31:22.560494",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
}

The diffs / metadata could be viewed for the changes made , for instance here the response shows the original author of the project and the date it was shared

* Lets take a look at my Profile again at 127.0.0.1:8000/api/v1/profile/list/1/?format=json
{
"about_me": "DjangoNaut",
"birth_date": "1991-06-20",
"friends": [
"testuser",
"SomeDude"
],
"gender": 1,
"language": "en",
"location": "India",
"mugshot": "/media/mugshots/d749832b7a.jpg",
"privacy": "registered",
"projects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"id": 1,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"id": 2,
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
},
{
"Likes": 0,
"comment": [],
"desc": "This is my first hello world code",
"id": 4,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-07-04T20:46:43.062294",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
}
],
"user": "aregee",
"website": "http://rahulgaur.info/"
}

* And the list of projects at 127.0.0.1:8000/api/v1/projects/

{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 4
},
"objects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"id": 1,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"id": 2,
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
},
{
"Likes": 3,
"comment": [],
"desc": "This is my first hello world code",
"id": 3,
"owner": "testuser",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-06-27T15:31:22.560494",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
},
{
"Likes": 0,
"comment": [],
"desc": "This is my first hello world code",
"id": 4,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-07-04T20:46:43.062294",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
}
]
}

Difference among the two Projects can be tracked by Project.objects.get(pk = 4).diff(Project.objects.get(pk = 3)) , its a method provided by the django-forkit app to view changes / differences in the forkable models.
Meta data field needs to bee added to Projects field so that we can save these differences when a project is forked , and every project should contain a link to original creator.

=== TODOS ===

* Add Authentication
* Provide Full CRUD access to authenticated user to the core site functionalities : Like , Comment , UserProfile, Projects etcs
* Improve the forking functionality
* Implement JavaScript Client to consume APIs to get a minimal functional product up and running

Summer of Code/2013/moksaya

2013-09-21T03:15:13Z

Rahul Gaur: /* Site Model */

== [http://sanskritdictionary.org/moksaya Moksaya] Project : ==
==== A Dajngo based web app aimed at sharing and collaboration of sugar activities to foster learning and creativity ====

Goal of this project is to implement a Project Sharing site to foster collaboration and sharing of Sugar Activities over the internet.The website upon the completion would also provide REST-API’s , so that the services of the website could be utilised by the Sugar Activities to share the project on the site from within the Sugar Environment.

=== Key Deliverables : ===
Here I have listed the Key features that I am currently working on , however as we go through the course of GSoC new features will be added ,once we have a concrete and stable base infrastructure for the Social Project Sharing site.

* Social Features : Following/Followers , Like , favourites , share , Comments .etc
* Authenticated RESTful API's :Ability to interact with website from various Sugar Activities
* Gallery : Ability for users to create portfolio of their projects.

== Repository ==

==== RESTful WebServer ====
I am developing this project under the Moksaya branch on my [https://github.com/aregee/moksaya Github].

==== Client Side WebApp ====

Development of web app consuming these RESTful api's can be tracked here https://github.com/aregee/Moksaya-web/

== REST API v1 Resources ==

==== User Creation ====
{| class="wikitable"
|-
! Resource !! Description
|-
| POST /api/v1/register/ || Makes http POST request with the JSON data to create a new user in the database ,if a user already exist raises HTTP 400 badrequest and returns a Json response with error message "the username already exist" . Returns HTTP 201 for successfully Created User
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X POST --data '{"username" :"user101" , "email" :"user@mail.com" , "password" : "password" }' http://moksaya-rahulgaur.rhcloud.com/api/v1/register/
|-
| Response || HTTP/1.1 201 CREATED Date: Thu, 19 Sep 2013 23:49:52 GMT Server: Apache/2.2.15 (Red Hat) Vary: Accept,Accept-Language,Cookie X-Frame-Options: SAMEORIGIN Content-Language: en-us Location:http://moksaya-rahulgaur.rhcloud.com/api/v1/register/19/
Content-Length: 0
Content-Type: text/html; charset=utf-8
|}

==== Authentication and User Login ====

Requires Username and Password for obtaining the api_keys , and rest of the other resources are accessed with the API Keys.
There are two ways to do it, these are Publicly accessible end points.

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/token/auth/ || Returns the apikey for the requested user, we need to supply the username and password in the request headers .
|-
| Example || curl -k --user "aregee:notebook" http://moksaya-rahulgaur.rhcloud.com/api/v1/token/auth/
|-
| Response || {
"key": "531ffb6152171df4f60b1b09f09dd1b4c5aba997"
}

|-
| POST /api/v1/user/login/ || Another way is to POST the user credentials as a JSON data to this end point and returns User Resource with the API_key . Raises HTTP 401 for unauthorized with error response
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X POST --data '{"username":"user101","password":"notebook" }' http://moksaya-rahulgaur.rhcloud.com/api/v1/user/login/
|-
| Response || HTTP/1.1 200 OK
Date: Fri, 20 Sep 2013 22:16:20 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Content-Type: application/json
Set-Cookie: sessionid=ddb4289b9fe8b2a963bfc540f81559c3; expires=Fri, 04-Oct-2013 22:16:20 GMT; httponly; Max-Age=1209600; Path=/
Transfer-Encoding: chunked

{
"apikey": "03f9a40ddd029b0a773a54f189aaa92d5a07c2d2",
"email": "user@mail.com",
"first_name": "",
"id": 14,
"last_name": "",
"resource_uri": "/api/v1/user/14/",
"username": "user101"
}

|}

==== User Resource ====
Authenticated users can access the User Resource , with the api_key and User Resource supports following authenticated options

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/user/ || Returns the list of all user accounts when accessed with authenticated header but returns requested user's resource when username and api_key supplied in url parameters
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/user/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
| Response || HTTP/1.1 200 OK
Date: Fri, 20 Sep 2013 22:32:23 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Type: application/json
Transfer-Encoding: chunked

{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 1
},
"objects": [
{
"apikey": "feea1175cdb9dde076eb68b5d83857fe2a58a186",
"email": "user@mail.com",
"first_name": "",
"id": 19,
"last_name": "",
"resource_uri": "/api/v1/user/19/",
"username": "akshit"
}
]
}
|-
| GET /api/v1/user/<username>/ || We can also access users with their respective usernames and returns HTTP 401 for resource not found
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/user/aregee/?username=spock\&api_key=d2fe32b15b0b395a5d0e0ea4b7eb1e5d6ea15de7
|-
| Response || HTTP/1.1 200 OK
Date: Fri, 20 Sep 2013 23:05:43 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Type: application/json
Transfer-Encoding: chunked

{
"apikey": "531ffb6152171df4f60b1b09f09dd1b4c5aba997",
"email": "iamaregee@gmail.com",
"first_name": "",
"id": 2,
"last_name": "",
"resource_uri": "/api/v1/user/2/",
"username": "aregee"
}
|-
| DELETE /api/v1/user/<username>/ || Removes the requested <username> from the database .
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X DELETE http://moksaya-rahulgaur.rhcloud.com/api/v1/user/akshit/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
| Response || HTTP/1.1 204 NO CONTENT
Date: Fri, 20 Sep 2013 22:36:22 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Content-Length: 0
Content-Type: text/html; charset=utf-8

|}

==== Profile Resource ====

{| class="wikitable"
|-
! Resource !! Description
|-
| POST /api/v1/profile/ || Making http post to this end point with the json data containing the Profile fields creates a new user profile , which is Related to all the other resources.Returns HTTP 201 response for successfully created user profile , returns HTTP 400 bad request with error response for unsuccessful attempts.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X POST --data '{"user":"/api/v1/user/akshit/" , "about_me" :"Profile Create with CURL"}' http://moksaya-rahulgaur.rhcloud.com/api/v1/profile/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
| GET /api/v1/profile/ || Returns list of all user profiles , throttles twenty results per request.
|-
| GET /api/v1/profile/username/ || Returns ProfileResource for the requested user , returns http 404 if resource is not found.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/profile/akshit/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
| Respone || HTTP/1.1 200 OK
Date: Thu, 19 Sep 2013 23:56:13 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Length: 279
Content-Type: application/json

{
"about_me": "Profile Create with CURL",
"followers": [],
"following": [],
"id": 19,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/19/",
"user": "akshit"
}
|-
| PUT /api/v1/profile/<username>/ || Updates the Profile Resource field with the supplied JSON data.Currently works with only about_me field but can be extended to include location and mugshot or Avatar fields
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X PUT --data '{"about_me" :"Profile Create & updated with CURL "}' http://moksaya-rahulgaur.rhcloud.com/api/v1/profile/akshit/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
|}

==== Project Resource ====

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/projects/ || Following query returns the list of all the projects submitted by the user.
|-
| GET /api/v1/projects/<id>/ || We can query a particular project with its id. This would return ProjectResource for the requested project id.It also shows related comments and likes on the project.
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/projects/1/?username=spock\&api_key=d2fe32b15b0b395a5d0e0ea4b7eb1e5d6ea15de7

|-

| Response || HTTP/1.1 200 OK
Date: Fri, 20 Sep 2013 23:40:38 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Type: application/json
Transfer-Encoding: chunked

{
"Likes": 6,
"comment": [
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/3/",
"text": "This is a Comment :)",
"user": "aregee"
},
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/8/",
"text": "Lets Post another Comment here :D",
"user": "aregee"
},
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/9/",
"text": "But This Kinda Looks Sweet :D",
"user": "aregee"
},
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/29/",
"text": "superb :)",
"user": "nikking1793"
},
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/30/",
"text": "superb :)",
"user": "nikking1793"
}
],
"desc": "Hello Project world",
"history": "",
"id": 1,
"resource_uri": "/api/v1/projects/1/",
"screenshot": "/media/projects/lin.jpg",
"shared_date": "2013-09-17T16:44:53.773919",
"src": "/media/projects/try.py",
"title": "This is My Project",
"user": "aregee"
}

|-
| POST /api/v1/projects/ || Making an http POST request to this URI with the Multipart form data in the JSON format creates a new project and Returns HTTP 201 for successfully created projects
|-
| Example || curl -F "user=/api/v1/profile/2/" -F "title=Fiddle with JS" -F "desc=this file documents my PROGRESS with learning JavaScript" -F "src=@projects/objects.js" -F "screenshot=@projects/img_screen.png" http://127.0.0.1:8000/api/v1/projects/?username=aregee\&api_key=531ffb6152171df4f60b1b09f09dd1b4c5aba99
|-
| PATCH /api/v1/projects/<id>/ || Updates the changed field to an existing project in the form of json data.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X PATCH --data '{"title":"Gallery Lock ++ " }' http://127.0.0.1:8000/api/v1/projects/1/?username=aregee\&api_key=531ffb6152171df4f60b1b09f09dd1b4c5aba99
|-
| PUT /api/v1/projects/<id>/ || We can also use the HTTP PUT request to update all the fields of an existing project
|-
| DELETE /api/v1/projects/<id>/ || Destroys the current project and the resource related to it : Likes , Comments
|-
|}

==== Project Forking ====

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/forking/<project_id>/ || Currently to fork a project , authenticated user makes GET request to this end point with the project id they need to fork.This method creates a copy of the requested project and associates it to the requesting User's profile.There is a history field in the Project to hold the data about original creator of the project.
|-
| Example || curl http://moksaya-rahulgaur.rhcloud.com/api/v1/forking/2/?username=vrinda\&api_key=b7c19215d088591e2dee07c2fb4df677ab1c9fbe
|-
| Response || {
"desc": "undefined",
"history": "project undefined created by aregee forked by vrinda ",
"resource_uri": "/api/v1/forking/2/",
"screenshot": "/media/projects/lin.jpg",
"shared_date": "2013-09-20T19:07:57.861892",
"src": "/media/projects/file_rem.py",
"title": "undefined"
}
|-
|}

==== Followers ====

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/relations/ || Returns a list of all the user relations with their resource.
|-
| POST /api/v1/relations/ || To create a follower/followee relation between the two user we pass a JSON data with the resource_uri of the currently logged in user's profile as follower and viewed profile of the user as followee . Returns HTTP 201 Created Response and each relations has its own id and other meta deta.
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X POST --data '{"follower":"/api/v1/profile/3/","followee":"/api/v1/profile/4/"}' http://127.0.0.1:8000/api/v1/relations/?username=vrinda\&api_key=b7c19215d088591e2dee07c2fb4df677ab1c9fbe
|-
| DELETE /api/v1/relations/<id>/ || Making a delete request to a relation , deletes the unilateral relation between the user.
|}

==== Likes ====

{| class="wikitable"
|-
! Resource !! Description
|-
| POST /api/v1/liking/ || Making http post request to this Resource along with the json data with user field containing resource_uri of the currently logged in user and liking_content_type field contains the URI of requested Project creates a liking Relation between the user and project.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X POST --data '{"user":"/api/v1/profile/2/" ,"liked_content_type":"/api/v1/projects/2/" }' http://127.0.0.1:8000/api/v1/liking/?username=vrinda\&api_key=b7c19215d088591e2dee07c2fb4df677ab1c9fbe
|-
| GET /api/v1/liking/ || Returns the list of all the liking relationship with their resource id and other liking resource.
|-
| GET /api/v1/liking/<id> || {
"Liked": "undefined",
"id": 2,
"liked_content_type": {
"Likes": 1,
"comment": [
{
"entry": "undefined",
"resource_uri": "/api/v1/comment/1/",
"text": ":P",
"user": "vrinda"
}
],
"desc": "undefined",
"history": "project undefined created by aregee forked by vrinda ",
"id": 4,
"resource_uri": "/api/v1/projects/4/",
"screenshot": "/media/projects/wb3_1.png",
"shared_date": "2013-09-20T19:09:43.084615",
"src": "/media/projects/feed__1.py",
"title": "undefined",
"user": "vrinda"
},
"resource_uri": "/api/v1/liking/2/",
"shared_date": "2013-09-20T19:09:59.892135",
"user": "vrinda"
}
|-
| DELETE /api/v1/liking/<id>/ || Destroys the requested liked relation.
|-
|}

==== Comment Resource ====

{| class="wikitable"
|-
! Description !! Resource
|-
| POST /api/v1/comment/ || This resource creates a new comment resource with the JSON data supplied to it.Returns 201 response for successfully added comment.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X POST --data '{"user":"/api/v1/profile/1/","entry":"/api/v1/projects/2/" , "text":"Comment posted with REST" }' http://127.0.0.1:8000/api/v1/comment/?username=soeone\&api_key=som23h32gh2g3h3g2h3gh2213ftf32f
|-
| GET /api/v1/comment/ || List all the comments along with their related Project Resource.
|-
| GET /api/v1/comment/<id>/ || Filters the Comment resource by their respective ids.
|-
| PATCH /api/v1/comment/<id>/ || Updates the text field in the comment.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X PATCH --data '{"text":"Comment POSTed with updated with PATCH" }' http://127.0.0.1:8000/api/v1/comment/1/?username=aregee\&api_key=ytg67asdf76asdf76fdsa767asdf67sadtg
|-
| DELETE /api/v1/comment/<id>/ || Making a delete request to the comment id , deletes the comment from the related resource or Project.
|}

=== Site Model ===
I have planed to design the RESTful interface to the Moksaya project , and I have written a web app to consume these APIs using [ http://angularjs.org/ AngularJS ]
Initially Moksaya project offers a RESTful interface to the following interrelated models :
*ProfileResource
*ProjectResource
*CommentResource
*LikeResource
*ForkResource

At the Top most level Profile/list contains all the User Profiles along with their Related Resources.
So , a typical user profile contains User info like About , Birthdays etcs then the Related Resources Projects , Friends List , Likes on Projects (Can be easily extended for comments or other models).
Most of these Related Resources can be accessed individually as well.

* Top Level View :curl --dump-header - -H "Content-Type: application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/profile/?username=spock\&api_key=d2fe32b15b0b395a5d0e0ea4b7eb1e5d6ea15de7
HTTP/1.1 200 OK
Date: Sat, 21 Sep 2013 01:32:01 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Type: application/json
Transfer-Encoding: chunked

{
"meta": {
"limit": 20,
"next": "/api/v1/profile/?username=spock&api_key=d2fe32b15b0b395a5d0e0ea4b7eb1e5d6ea15de7&limit=20&offset=20",
"offset": 0,
"previous": null,
"total_count": 26
},
"objects": [
{
"about_me": "admin",
"followers": [
"aregee"
],
"following": [],
"id": 1,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/1/",
"user": "admin"
},
{
"about_me": "Now I can update About_ME",
"followers": [
"vrinda",
"kirk",
"ned",
"titiksha",
"robStark",
"jarvis",
"satyamyadav",
"user101",
"atif",
"nikking1793",
"tch",
"amigo",
"aregee__"
],
"following": [
"vrinda",
"ned",
"kirk",
"tch",
"admin",
"titiksha",
"jarvis",
"monikagupta",
"satyamyadav",
"surajgillespie",
"nikking1793",
"amigo",
"raju"
],
"id": 2,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [
{
"Likes": 1,
"comment": [],
"desc": "undefined",
"history": "",
"id": 1,
"resource_uri": "/api/v1/projects/1/",
"screenshot": "/media/projects/wb3.png",
"shared_date": "2013-09-20T19:07:29.101309",
"src": "/media/projects/feed_.py",
"title": "undefined",
"user": "aregee"
},
{
"Likes": 0,
"comment": [],
"desc": "undefined",
"history": "",
"id": 2,
"resource_uri": "/api/v1/projects/2/",
"screenshot": "/media/projects/lin.jpg",
"shared_date": "2013-09-20T19:07:57.861892",
"src": "/media/projects/file_rem.py",
"title": "undefined",
"user": "aregee"
},
{
"Likes": 0,
"comment": [],
"desc": "undefined",
"history": "",
"id": 3,
"resource_uri": "/api/v1/projects/3/",
"screenshot": "/media/projects/beautiful_strings.png",
"shared_date": "2013-09-20T19:08:30.575741",
"src": "/media/projects/file_rem_1.py",
"title": "undefined",
"user": "aregee"
}
],
"resource_uri": "/api/v1/profile/2/",
"user": "aregee"
},
{
"about_me": "Oh not it won't happen :0",
"followers": [
"aregee"
],
"following": [
"aregee",
"kirk",
"jarvis"
],
"id": 3,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [
{
"Likes": 1,
"comment": [
{
"entry": "undefined",
"resource_uri": "/api/v1/comment/1/",
"text": ":P",
"user": "vrinda"
}
],
"desc": "undefined",
"history": "project undefined created by aregee forked by vrinda ",
"id": 4,
"resource_uri": "/api/v1/projects/4/",
"screenshot": "/media/projects/wb3_1.png",
"shared_date": "2013-09-20T19:09:43.084615",
"src": "/media/projects/feed__1.py",
"title": "undefined",
"user": "vrinda"
},
{
"Likes": 0,
"comment": [],
"desc": "undefined",
"history": "project undefined created by aregee forked by vrinda ",
"id": 5,
"resource_uri": "/api/v1/projects/5/",
"screenshot": "/media/projects/lin_1.jpg",
"shared_date": "2013-09-20T19:22:22.520212",
"src": "/media/projects/file_rem_2.py",
"title": "undefined",
"user": "vrinda"
}
],
"resource_uri": "/api/v1/profile/3/",
"user": "vrinda"
},
{
"about_me": "I am SPOCK",
"followers": [],
"following": [],
"id": 4,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/4/",
"user": "spock"
},
{
"about_me": "Howdy partner, this is kirk's Moksaya Profile",
"followers": [
"aregee",
"vrinda"
],
"following": [
"aregee"
],
"id": 5,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/5/",
"user": "kirk"
},
{
"about_me": "Howdy partner, this is ned's Moksaya Profile",
"followers": [
"aregee"
],
"following": [
"aregee"
],
"id": 6,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/6/",
"user": "ned"
},
{
"about_me": "sdasd",
"followers": [
"aregee"
],
"following": [
"aregee"
],
"id": 7,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/7/",
"user": "tch"
},
{
"about_me": "I am Titiksha",
"followers": [
"aregee"
],
"following": [
"aregee"
],
"id": 8,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/8/",
"user": "titiksha"
},
{
"about_me": "This is Rob Stark , King in the North ;)",
"followers": [],
"following": [
"aregee"
],
"id": 9,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/9/",
"user": "robStark"
},
{
"about_me": "Howdy partner, this is mronetwo's Moksaya Profile",
"followers": [],
"following": [],
"id": 10,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/10/",
"user": "mronetwo"
},
{
"about_me": "Howdy partner, this is monikagupta's Moksaya Profile",
"followers": [
"aregee"
],
"following": [],
"id": 11,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/11/",
"user": "monikagupta"
},
{
"about_me": "Howdy partner, this is jarvis's Moksaya Profile",
"followers": [
"aregee",
"vrinda"
],
"following": [
"aregee"
],
"id": 12,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/12/",
"user": "jarvis"
},
{
"about_me": "Howdy partner, this is satyamyadav's Moksaya Profile",
"followers": [
"aregee"
],
"following": [
"aregee"
],
"id": 13,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/13/",
"user": "satyamyadav"
},
{
"about_me": "Hello , I am user1010 and I code :)",
"followers": [],
"following": [
"aregee"
],
"id": 14,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/14/",
"user": "user101"
},
{
"about_me": "Howdy atif , this is your Moksaya Profile",
"followers": [],
"following": [
"aregee"
],
"id": 15,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/15/",
"user": "atif"
},
{
"about_me": "Howdy surajgillespie , this is your Moksaya Profile",
"followers": [
"aregee"
],
"following": [],
"id": 16,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/16/",
"user": "surajgillespie"
},
{
"about_me": "Howdy partner, this is moksaya_user's Moksaya Profile",
"followers": [],
"following": [],
"id": 17,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/17/",
"user": "moksaya_user"
},
{
"about_me": "Howdy nikking1793 , this is your Moksaya Profile",
"followers": [
"aregee",
"user102"
],
"following": [
"aregee"
],
"id": 18,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/18/",
"user": "nikking1793"
},
{
"about_me": "Howdy Ayushletsrock , this is your Moksaya Profile",
"followers": [
"user102"
],
"following": [],
"id": 20,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/20/",
"user": "Ayushletsrock"
},
{
"about_me": "Howdy gonzalo , this is your Moksaya Profile",
"followers": [],
"following": [],
"id": 21,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/21/",
"user": "gonzalo"
}
]
}

* Related Resource Projects here can be accessed by http://127.0.0.1:8000/api/v1/projects/?format=json
{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 5
},
"objects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
},
{
"Likes": 3,
"comment": [],
"desc": "This is my first hello world code",
"owner": "testuser",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-06-27T15:31:22.560494",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
},
{
"Likes": 0,
"comment": [],
"desc": "This is my first hello world code",
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-07-04T19:18:23.307241",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
},
{
"Likes": 0,
"comment": [],
"desc": "Wired Hack ",
"owner": "testuser",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-07-04T19:37:54.184572",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
}
]
}

In the above results I have excluded Project ids from the json Response, but similarly each individual project could be accessed and updated by making GET or Post or Put request to http://127.0.0.1:8000/api/v1/projects/<pk>?format=json

* Accessing particular project http://127.0.0.1:8000/api/v1/projects/2/?format=json

{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
}

==Forking==
Lets take a look at how forking works here , though this is not really the best approach but I am doing this for understanding purpose and would figure out the proper solution for this ..
but for now here it is.

* Lets say these are the projects on the Moksaya submitted by the user :
{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 3
},
"objects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"id": 1,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"id": 2,
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
},
{
"Likes": 3,
"comment": [],
"desc": "This is my first hello world code",
"id": 3,
"owner": "testuser",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-06-27T15:31:22.560494",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
}
]
}

* Now I am logged in as aregee , and here is my profile at 127.0.0.1:8000/api/v1/profile/list/1/?format=json

{
"about_me": "DjangoNaut",
"birth_date": "1991-06-20",
"friends": [
"testuser",
"SomeDude"
],
"gender": 1,
"language": "en",
"location": "India",
"mugshot": "/media/mugshots/d749832b7a.jpg",
"privacy": "registered",
"projects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"id": 1,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"id": 2,
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
}
],
"user": "aregee",
"website": "http://rahulgaur.info/"
}

* Now I want to fork the Project with id = 3 created by testuser , so I will make a GET request to 127.0.0.1:8000/api/v1/forking/3/?format=json
{
"Changes": {
"owner": "testuser",
"shared_date": "2013-06-27T15:31:22.560494"
},
"desc": "This is my first hello world code",
"resource_uri": "/api/v1/forking/3/",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-06-27T15:31:22.560494",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
}

The diffs / metadata could be viewed for the changes made , for instance here the response shows the original author of the project and the date it was shared

* Lets take a look at my Profile again at 127.0.0.1:8000/api/v1/profile/list/1/?format=json
{
"about_me": "DjangoNaut",
"birth_date": "1991-06-20",
"friends": [
"testuser",
"SomeDude"
],
"gender": 1,
"language": "en",
"location": "India",
"mugshot": "/media/mugshots/d749832b7a.jpg",
"privacy": "registered",
"projects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"id": 1,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"id": 2,
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
},
{
"Likes": 0,
"comment": [],
"desc": "This is my first hello world code",
"id": 4,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-07-04T20:46:43.062294",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
}
],
"user": "aregee",
"website": "http://rahulgaur.info/"
}

* And the list of projects at 127.0.0.1:8000/api/v1/projects/

{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 4
},
"objects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"id": 1,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"id": 2,
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
},
{
"Likes": 3,
"comment": [],
"desc": "This is my first hello world code",
"id": 3,
"owner": "testuser",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-06-27T15:31:22.560494",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
},
{
"Likes": 0,
"comment": [],
"desc": "This is my first hello world code",
"id": 4,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-07-04T20:46:43.062294",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
}
]
}

Difference among the two Projects can be tracked by Project.objects.get(pk = 4).diff(Project.objects.get(pk = 3)) , its a method provided by the django-forkit app to view changes / differences in the forkable models.
Meta data field needs to bee added to Projects field so that we can save these differences when a project is forked , and every project should contain a link to original creator.

=== TODOS ===

* Add Authentication
* Provide Full CRUD access to authenticated user to the core site functionalities : Like , Comment , UserProfile, Projects etcs
* Improve the forking functionality
* Implement JavaScript Client to consume APIs to get a minimal functional product up and running

Summer of Code/2013/moksaya

2013-09-21T01:36:46Z

Rahul Gaur: /* Key Deliverables : */

== [http://sanskritdictionary.org/moksaya Moksaya] Project : ==
==== A Dajngo based web app aimed at sharing and collaboration of sugar activities to foster learning and creativity ====

Goal of this project is to implement a Project Sharing site to foster collaboration and sharing of Sugar Activities over the internet.The website upon the completion would also provide REST-API’s , so that the services of the website could be utilised by the Sugar Activities to share the project on the site from within the Sugar Environment.

=== Key Deliverables : ===
Here I have listed the Key features that I am currently working on , however as we go through the course of GSoC new features will be added ,once we have a concrete and stable base infrastructure for the Social Project Sharing site.

* Social Features : Following/Followers , Like , favourites , share , Comments .etc
* Authenticated RESTful API's :Ability to interact with website from various Sugar Activities
* Gallery : Ability for users to create portfolio of their projects.

== Repository ==

==== RESTful WebServer ====
I am developing this project under the Moksaya branch on my [https://github.com/aregee/moksaya Github].

==== Client Side WebApp ====

Development of web app consuming these RESTful api's can be tracked here https://github.com/aregee/Moksaya-web/

== REST API v1 Resources ==

==== User Creation ====
{| class="wikitable"
|-
! Resource !! Description
|-
| POST /api/v1/register/ || Makes http POST request with the JSON data to create a new user in the database ,if a user already exist raises HTTP 400 badrequest and returns a Json response with error message "the username already exist" . Returns HTTP 201 for successfully Created User
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X POST --data '{"username" :"user101" , "email" :"user@mail.com" , "password" : "password" }' http://moksaya-rahulgaur.rhcloud.com/api/v1/register/
|-
| Response || HTTP/1.1 201 CREATED Date: Thu, 19 Sep 2013 23:49:52 GMT Server: Apache/2.2.15 (Red Hat) Vary: Accept,Accept-Language,Cookie X-Frame-Options: SAMEORIGIN Content-Language: en-us Location:http://moksaya-rahulgaur.rhcloud.com/api/v1/register/19/
Content-Length: 0
Content-Type: text/html; charset=utf-8
|}

==== Authentication and User Login ====

Requires Username and Password for obtaining the api_keys , and rest of the other resources are accessed with the API Keys.
There are two ways to do it, these are Publicly accessible end points.

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/token/auth/ || Returns the apikey for the requested user, we need to supply the username and password in the request headers .
|-
| Example || curl -k --user "aregee:notebook" http://moksaya-rahulgaur.rhcloud.com/api/v1/token/auth/
|-
| Response || {
"key": "531ffb6152171df4f60b1b09f09dd1b4c5aba997"
}

|-
| POST /api/v1/user/login/ || Another way is to POST the user credentials as a JSON data to this end point and returns User Resource with the API_key . Raises HTTP 401 for unauthorized with error response
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X POST --data '{"username":"user101","password":"notebook" }' http://moksaya-rahulgaur.rhcloud.com/api/v1/user/login/
|-
| Response || HTTP/1.1 200 OK
Date: Fri, 20 Sep 2013 22:16:20 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Content-Type: application/json
Set-Cookie: sessionid=ddb4289b9fe8b2a963bfc540f81559c3; expires=Fri, 04-Oct-2013 22:16:20 GMT; httponly; Max-Age=1209600; Path=/
Transfer-Encoding: chunked

{
"apikey": "03f9a40ddd029b0a773a54f189aaa92d5a07c2d2",
"email": "user@mail.com",
"first_name": "",
"id": 14,
"last_name": "",
"resource_uri": "/api/v1/user/14/",
"username": "user101"
}

|}

==== User Resource ====
Authenticated users can access the User Resource , with the api_key and User Resource supports following authenticated options

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/user/ || Returns the list of all user accounts when accessed with authenticated header but returns requested user's resource when username and api_key supplied in url parameters
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/user/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
| Response || HTTP/1.1 200 OK
Date: Fri, 20 Sep 2013 22:32:23 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Type: application/json
Transfer-Encoding: chunked

{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 1
},
"objects": [
{
"apikey": "feea1175cdb9dde076eb68b5d83857fe2a58a186",
"email": "user@mail.com",
"first_name": "",
"id": 19,
"last_name": "",
"resource_uri": "/api/v1/user/19/",
"username": "akshit"
}
]
}
|-
| GET /api/v1/user/<username>/ || We can also access users with their respective usernames and returns HTTP 401 for resource not found
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/user/aregee/?username=spock\&api_key=d2fe32b15b0b395a5d0e0ea4b7eb1e5d6ea15de7
|-
| Response || HTTP/1.1 200 OK
Date: Fri, 20 Sep 2013 23:05:43 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Type: application/json
Transfer-Encoding: chunked

{
"apikey": "531ffb6152171df4f60b1b09f09dd1b4c5aba997",
"email": "iamaregee@gmail.com",
"first_name": "",
"id": 2,
"last_name": "",
"resource_uri": "/api/v1/user/2/",
"username": "aregee"
}
|-
| DELETE /api/v1/user/<username>/ || Removes the requested <username> from the database .
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X DELETE http://moksaya-rahulgaur.rhcloud.com/api/v1/user/akshit/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
| Response || HTTP/1.1 204 NO CONTENT
Date: Fri, 20 Sep 2013 22:36:22 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Content-Length: 0
Content-Type: text/html; charset=utf-8

|}

==== Profile Resource ====

{| class="wikitable"
|-
! Resource !! Description
|-
| POST /api/v1/profile/ || Making http post to this end point with the json data containing the Profile fields creates a new user profile , which is Related to all the other resources.Returns HTTP 201 response for successfully created user profile , returns HTTP 400 bad request with error response for unsuccessful attempts.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X POST --data '{"user":"/api/v1/user/akshit/" , "about_me" :"Profile Create with CURL"}' http://moksaya-rahulgaur.rhcloud.com/api/v1/profile/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
| GET /api/v1/profile/ || Returns list of all user profiles , throttles twenty results per request.
|-
| GET /api/v1/profile/username/ || Returns ProfileResource for the requested user , returns http 404 if resource is not found.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/profile/akshit/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
| Respone || HTTP/1.1 200 OK
Date: Thu, 19 Sep 2013 23:56:13 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Length: 279
Content-Type: application/json

{
"about_me": "Profile Create with CURL",
"followers": [],
"following": [],
"id": 19,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/19/",
"user": "akshit"
}
|-
| PUT /api/v1/profile/<username>/ || Updates the Profile Resource field with the supplied JSON data.Currently works with only about_me field but can be extended to include location and mugshot or Avatar fields
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X PUT --data '{"about_me" :"Profile Create & updated with CURL "}' http://moksaya-rahulgaur.rhcloud.com/api/v1/profile/akshit/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
|}

==== Project Resource ====

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/projects/ || Following query returns the list of all the projects submitted by the user.
|-
| GET /api/v1/projects/<id>/ || We can query a particular project with its id. This would return ProjectResource for the requested project id.It also shows related comments and likes on the project.
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/projects/1/?username=spock\&api_key=d2fe32b15b0b395a5d0e0ea4b7eb1e5d6ea15de7

|-

| Response || HTTP/1.1 200 OK
Date: Fri, 20 Sep 2013 23:40:38 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Type: application/json
Transfer-Encoding: chunked

{
"Likes": 6,
"comment": [
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/3/",
"text": "This is a Comment :)",
"user": "aregee"
},
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/8/",
"text": "Lets Post another Comment here :D",
"user": "aregee"
},
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/9/",
"text": "But This Kinda Looks Sweet :D",
"user": "aregee"
},
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/29/",
"text": "superb :)",
"user": "nikking1793"
},
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/30/",
"text": "superb :)",
"user": "nikking1793"
}
],
"desc": "Hello Project world",
"history": "",
"id": 1,
"resource_uri": "/api/v1/projects/1/",
"screenshot": "/media/projects/lin.jpg",
"shared_date": "2013-09-17T16:44:53.773919",
"src": "/media/projects/try.py",
"title": "This is My Project",
"user": "aregee"
}

|-
| POST /api/v1/projects/ || Making an http POST request to this URI with the Multipart form data in the JSON format creates a new project and Returns HTTP 201 for successfully created projects
|-
| Example || curl -F "user=/api/v1/profile/2/" -F "title=Fiddle with JS" -F "desc=this file documents my PROGRESS with learning JavaScript" -F "src=@projects/objects.js" -F "screenshot=@projects/img_screen.png" http://127.0.0.1:8000/api/v1/projects/?username=aregee\&api_key=531ffb6152171df4f60b1b09f09dd1b4c5aba99
|-
| PATCH /api/v1/projects/<id>/ || Updates the changed field to an existing project in the form of json data.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X PATCH --data '{"title":"Gallery Lock ++ " }' http://127.0.0.1:8000/api/v1/projects/1/?username=aregee\&api_key=531ffb6152171df4f60b1b09f09dd1b4c5aba99
|-
| PUT /api/v1/projects/<id>/ || We can also use the HTTP PUT request to update all the fields of an existing project
|-
| DELETE /api/v1/projects/<id>/ || Destroys the current project and the resource related to it : Likes , Comments
|-
|}

==== Project Forking ====

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/forking/<project_id>/ || Currently to fork a project , authenticated user makes GET request to this end point with the project id they need to fork.This method creates a copy of the requested project and associates it to the requesting User's profile.There is a history field in the Project to hold the data about original creator of the project.
|-
| Example || curl http://moksaya-rahulgaur.rhcloud.com/api/v1/forking/2/?username=vrinda\&api_key=b7c19215d088591e2dee07c2fb4df677ab1c9fbe
|-
| Response || {
"desc": "undefined",
"history": "project undefined created by aregee forked by vrinda ",
"resource_uri": "/api/v1/forking/2/",
"screenshot": "/media/projects/lin.jpg",
"shared_date": "2013-09-20T19:07:57.861892",
"src": "/media/projects/file_rem.py",
"title": "undefined"
}
|-
|}

==== Followers ====

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/relations/ || Returns a list of all the user relations with their resource.
|-
| POST /api/v1/relations/ || To create a follower/followee relation between the two user we pass a JSON data with the resource_uri of the currently logged in user's profile as follower and viewed profile of the user as followee . Returns HTTP 201 Created Response and each relations has its own id and other meta deta.
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X POST --data '{"follower":"/api/v1/profile/3/","followee":"/api/v1/profile/4/"}' http://127.0.0.1:8000/api/v1/relations/?username=vrinda\&api_key=b7c19215d088591e2dee07c2fb4df677ab1c9fbe
|-
| DELETE /api/v1/relations/<id>/ || Making a delete request to a relation , deletes the unilateral relation between the user.
|}

==== Likes ====

{| class="wikitable"
|-
! Resource !! Description
|-
| POST /api/v1/liking/ || Making http post request to this Resource along with the json data with user field containing resource_uri of the currently logged in user and liking_content_type field contains the URI of requested Project creates a liking Relation between the user and project.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X POST --data '{"user":"/api/v1/profile/2/" ,"liked_content_type":"/api/v1/projects/2/" }' http://127.0.0.1:8000/api/v1/liking/?username=vrinda\&api_key=b7c19215d088591e2dee07c2fb4df677ab1c9fbe
|-
| GET /api/v1/liking/ || Returns the list of all the liking relationship with their resource id and other liking resource.
|-
| GET /api/v1/liking/<id> || {
"Liked": "undefined",
"id": 2,
"liked_content_type": {
"Likes": 1,
"comment": [
{
"entry": "undefined",
"resource_uri": "/api/v1/comment/1/",
"text": ":P",
"user": "vrinda"
}
],
"desc": "undefined",
"history": "project undefined created by aregee forked by vrinda ",
"id": 4,
"resource_uri": "/api/v1/projects/4/",
"screenshot": "/media/projects/wb3_1.png",
"shared_date": "2013-09-20T19:09:43.084615",
"src": "/media/projects/feed__1.py",
"title": "undefined",
"user": "vrinda"
},
"resource_uri": "/api/v1/liking/2/",
"shared_date": "2013-09-20T19:09:59.892135",
"user": "vrinda"
}
|-
| DELETE /api/v1/liking/<id>/ || Destroys the requested liked relation.
|-
|}

==== Comment Resource ====

{| class="wikitable"
|-
! Description !! Resource
|-
| POST /api/v1/comment/ || This resource creates a new comment resource with the JSON data supplied to it.Returns 201 response for successfully added comment.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X POST --data '{"user":"/api/v1/profile/1/","entry":"/api/v1/projects/2/" , "text":"Comment posted with REST" }' http://127.0.0.1:8000/api/v1/comment/?username=soeone\&api_key=som23h32gh2g3h3g2h3gh2213ftf32f
|-
| GET /api/v1/comment/ || List all the comments along with their related Project Resource.
|-
| GET /api/v1/comment/<id>/ || Filters the Comment resource by their respective ids.
|-
| PATCH /api/v1/comment/<id>/ || Updates the text field in the comment.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X PATCH --data '{"text":"Comment POSTed with updated with PATCH" }' http://127.0.0.1:8000/api/v1/comment/1/?username=aregee\&api_key=ytg67asdf76asdf76fdsa767asdf67sadtg
|-
| DELETE /api/v1/comment/<id>/ || Making a delete request to the comment id , deletes the comment from the related resource or Project.
|}

=== Site Model ===
I have planed to design the RESTful interface to the Moksaya project , and I plan to consume these APIs with a webapp possibly written with [http://backbonejs.org/ Backbone.js]
Initially Moksaya project offers a RESTful interface to the following interrelated models :
*ProfileResource
*ProjectResource
*CommentResource
*LikeResource
*ForkResource

At the Top most level Profile/list contains all the User Profiles along with their Related Resources.
So , a typical user profile contains User info like About , Birthdays etcs then the Related Resources Projects , Friends List , Likes on Projects (Can be easily extended for comments or other models).
Most of these Related Resources can be accessed individually as well.

* Top Level View :curl --dump-header - -H "Content-Type: application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/profile/?username=spock\&api_key=d2fe32b15b0b395a5d0e0ea4b7eb1e5d6ea15de7
HTTP/1.1 200 OK
Date: Sat, 21 Sep 2013 01:32:01 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Type: application/json
Transfer-Encoding: chunked

{
"meta": {
"limit": 20,
"next": "/api/v1/profile/?username=spock&api_key=d2fe32b15b0b395a5d0e0ea4b7eb1e5d6ea15de7&limit=20&offset=20",
"offset": 0,
"previous": null,
"total_count": 26
},
"objects": [
{
"about_me": "admin",
"followers": [
"aregee"
],
"following": [],
"id": 1,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/1/",
"user": "admin"
},
{
"about_me": "Now I can update About_ME",
"followers": [
"vrinda",
"kirk",
"ned",
"titiksha",
"robStark",
"jarvis",
"satyamyadav",
"user101",
"atif",
"nikking1793",
"tch",
"amigo",
"aregee__"
],
"following": [
"vrinda",
"ned",
"kirk",
"tch",
"admin",
"titiksha",
"jarvis",
"monikagupta",
"satyamyadav",
"surajgillespie",
"nikking1793",
"amigo",
"raju"
],
"id": 2,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [
{
"Likes": 1,
"comment": [],
"desc": "undefined",
"history": "",
"id": 1,
"resource_uri": "/api/v1/projects/1/",
"screenshot": "/media/projects/wb3.png",
"shared_date": "2013-09-20T19:07:29.101309",
"src": "/media/projects/feed_.py",
"title": "undefined",
"user": "aregee"
},
{
"Likes": 0,
"comment": [],
"desc": "undefined",
"history": "",
"id": 2,
"resource_uri": "/api/v1/projects/2/",
"screenshot": "/media/projects/lin.jpg",
"shared_date": "2013-09-20T19:07:57.861892",
"src": "/media/projects/file_rem.py",
"title": "undefined",
"user": "aregee"
},
{
"Likes": 0,
"comment": [],
"desc": "undefined",
"history": "",
"id": 3,
"resource_uri": "/api/v1/projects/3/",
"screenshot": "/media/projects/beautiful_strings.png",
"shared_date": "2013-09-20T19:08:30.575741",
"src": "/media/projects/file_rem_1.py",
"title": "undefined",
"user": "aregee"
}
],
"resource_uri": "/api/v1/profile/2/",
"user": "aregee"
},
{
"about_me": "Oh not it won't happen :0",
"followers": [
"aregee"
],
"following": [
"aregee",
"kirk",
"jarvis"
],
"id": 3,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [
{
"Likes": 1,
"comment": [
{
"entry": "undefined",
"resource_uri": "/api/v1/comment/1/",
"text": ":P",
"user": "vrinda"
}
],
"desc": "undefined",
"history": "project undefined created by aregee forked by vrinda ",
"id": 4,
"resource_uri": "/api/v1/projects/4/",
"screenshot": "/media/projects/wb3_1.png",
"shared_date": "2013-09-20T19:09:43.084615",
"src": "/media/projects/feed__1.py",
"title": "undefined",
"user": "vrinda"
},
{
"Likes": 0,
"comment": [],
"desc": "undefined",
"history": "project undefined created by aregee forked by vrinda ",
"id": 5,
"resource_uri": "/api/v1/projects/5/",
"screenshot": "/media/projects/lin_1.jpg",
"shared_date": "2013-09-20T19:22:22.520212",
"src": "/media/projects/file_rem_2.py",
"title": "undefined",
"user": "vrinda"
}
],
"resource_uri": "/api/v1/profile/3/",
"user": "vrinda"
},
{
"about_me": "I am SPOCK",
"followers": [],
"following": [],
"id": 4,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/4/",
"user": "spock"
},
{
"about_me": "Howdy partner, this is kirk's Moksaya Profile",
"followers": [
"aregee",
"vrinda"
],
"following": [
"aregee"
],
"id": 5,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/5/",
"user": "kirk"
},
{
"about_me": "Howdy partner, this is ned's Moksaya Profile",
"followers": [
"aregee"
],
"following": [
"aregee"
],
"id": 6,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/6/",
"user": "ned"
},
{
"about_me": "sdasd",
"followers": [
"aregee"
],
"following": [
"aregee"
],
"id": 7,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/7/",
"user": "tch"
},
{
"about_me": "I am Titiksha",
"followers": [
"aregee"
],
"following": [
"aregee"
],
"id": 8,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/8/",
"user": "titiksha"
},
{
"about_me": "This is Rob Stark , King in the North ;)",
"followers": [],
"following": [
"aregee"
],
"id": 9,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/9/",
"user": "robStark"
},
{
"about_me": "Howdy partner, this is mronetwo's Moksaya Profile",
"followers": [],
"following": [],
"id": 10,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/10/",
"user": "mronetwo"
},
{
"about_me": "Howdy partner, this is monikagupta's Moksaya Profile",
"followers": [
"aregee"
],
"following": [],
"id": 11,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/11/",
"user": "monikagupta"
},
{
"about_me": "Howdy partner, this is jarvis's Moksaya Profile",
"followers": [
"aregee",
"vrinda"
],
"following": [
"aregee"
],
"id": 12,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/12/",
"user": "jarvis"
},
{
"about_me": "Howdy partner, this is satyamyadav's Moksaya Profile",
"followers": [
"aregee"
],
"following": [
"aregee"
],
"id": 13,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/13/",
"user": "satyamyadav"
},
{
"about_me": "Hello , I am user1010 and I code :)",
"followers": [],
"following": [
"aregee"
],
"id": 14,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/14/",
"user": "user101"
},
{
"about_me": "Howdy atif , this is your Moksaya Profile",
"followers": [],
"following": [
"aregee"
],
"id": 15,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/15/",
"user": "atif"
},
{
"about_me": "Howdy surajgillespie , this is your Moksaya Profile",
"followers": [
"aregee"
],
"following": [],
"id": 16,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/16/",
"user": "surajgillespie"
},
{
"about_me": "Howdy partner, this is moksaya_user's Moksaya Profile",
"followers": [],
"following": [],
"id": 17,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/17/",
"user": "moksaya_user"
},
{
"about_me": "Howdy nikking1793 , this is your Moksaya Profile",
"followers": [
"aregee",
"user102"
],
"following": [
"aregee"
],
"id": 18,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/18/",
"user": "nikking1793"
},
{
"about_me": "Howdy Ayushletsrock , this is your Moksaya Profile",
"followers": [
"user102"
],
"following": [],
"id": 20,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/20/",
"user": "Ayushletsrock"
},
{
"about_me": "Howdy gonzalo , this is your Moksaya Profile",
"followers": [],
"following": [],
"id": 21,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/21/",
"user": "gonzalo"
}
]
}

* Related Resource Projects here can be accessed by http://127.0.0.1:8000/api/v1/projects/?format=json
{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 5
},
"objects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
},
{
"Likes": 3,
"comment": [],
"desc": "This is my first hello world code",
"owner": "testuser",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-06-27T15:31:22.560494",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
},
{
"Likes": 0,
"comment": [],
"desc": "This is my first hello world code",
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-07-04T19:18:23.307241",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
},
{
"Likes": 0,
"comment": [],
"desc": "Wired Hack ",
"owner": "testuser",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-07-04T19:37:54.184572",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
}
]
}

In the above results I have excluded Project ids from the json Response, but similarly each individual project could be accessed and updated by making GET or Post or Put request to http://127.0.0.1:8000/api/v1/projects/<pk>?format=json

* Accessing particular project http://127.0.0.1:8000/api/v1/projects/2/?format=json

{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
}

==Forking==
Lets take a look at how forking works here , though this is not really the best approach but I am doing this for understanding purpose and would figure out the proper solution for this ..
but for now here it is.

* Lets say these are the projects on the Moksaya submitted by the user :
{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 3
},
"objects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"id": 1,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"id": 2,
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
},
{
"Likes": 3,
"comment": [],
"desc": "This is my first hello world code",
"id": 3,
"owner": "testuser",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-06-27T15:31:22.560494",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
}
]
}

* Now I am logged in as aregee , and here is my profile at 127.0.0.1:8000/api/v1/profile/list/1/?format=json

{
"about_me": "DjangoNaut",
"birth_date": "1991-06-20",
"friends": [
"testuser",
"SomeDude"
],
"gender": 1,
"language": "en",
"location": "India",
"mugshot": "/media/mugshots/d749832b7a.jpg",
"privacy": "registered",
"projects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"id": 1,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"id": 2,
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
}
],
"user": "aregee",
"website": "http://rahulgaur.info/"
}

* Now I want to fork the Project with id = 3 created by testuser , so I will make a GET request to 127.0.0.1:8000/api/v1/forking/3/?format=json
{
"Changes": {
"owner": "testuser",
"shared_date": "2013-06-27T15:31:22.560494"
},
"desc": "This is my first hello world code",
"resource_uri": "/api/v1/forking/3/",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-06-27T15:31:22.560494",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
}

The diffs / metadata could be viewed for the changes made , for instance here the response shows the original author of the project and the date it was shared

* Lets take a look at my Profile again at 127.0.0.1:8000/api/v1/profile/list/1/?format=json
{
"about_me": "DjangoNaut",
"birth_date": "1991-06-20",
"friends": [
"testuser",
"SomeDude"
],
"gender": 1,
"language": "en",
"location": "India",
"mugshot": "/media/mugshots/d749832b7a.jpg",
"privacy": "registered",
"projects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"id": 1,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"id": 2,
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
},
{
"Likes": 0,
"comment": [],
"desc": "This is my first hello world code",
"id": 4,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-07-04T20:46:43.062294",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
}
],
"user": "aregee",
"website": "http://rahulgaur.info/"
}

* And the list of projects at 127.0.0.1:8000/api/v1/projects/

{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 4
},
"objects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"id": 1,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"id": 2,
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
},
{
"Likes": 3,
"comment": [],
"desc": "This is my first hello world code",
"id": 3,
"owner": "testuser",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-06-27T15:31:22.560494",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
},
{
"Likes": 0,
"comment": [],
"desc": "This is my first hello world code",
"id": 4,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-07-04T20:46:43.062294",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
}
]
}

Difference among the two Projects can be tracked by Project.objects.get(pk = 4).diff(Project.objects.get(pk = 3)) , its a method provided by the django-forkit app to view changes / differences in the forkable models.
Meta data field needs to bee added to Projects field so that we can save these differences when a project is forked , and every project should contain a link to original creator.

=== TODOS ===

* Add Authentication
* Provide Full CRUD access to authenticated user to the core site functionalities : Like , Comment , UserProfile, Projects etcs
* Improve the forking functionality
* Implement JavaScript Client to consume APIs to get a minimal functional product up and running

Summer of Code/2013/moksaya

2013-09-21T01:36:11Z

Rahul Gaur: /* Repository */

== [http://sanskritdictionary.org/moksaya Moksaya] Project : ==
==== A Dajngo based web app aimed at sharing and collaboration of sugar activities to foster learning and creativity ====

Goal of this project is to implement a Project Sharing site to foster collaboration and sharing of Sugar Activities over the internet.The website upon the completion would also provide REST-API’s , so that the services of the website could be utilised by the Sugar Activities to share the project on the site from within the Sugar Environment.

=== Key Deliverables : ===
Here I have listed the Key features that I am currently working on , however as we go through the course of GSoC new features will be added ,once we have a concrete and stable base infrastructure for the Social Project Sharing site.

* Social Features : Following/Followers , Like , favourites , share , Comments .etc
* Authenticated RESTful API's :Ability to interact with website from various Sugar Activities
* Separate landing pages for different audiences (kids, teachers, parents, etc.)
* Gallery : Ability for users to create portfolio of their projects.

== Repository ==

==== RESTful WebServer ====
I am developing this project under the Moksaya branch on my [https://github.com/aregee/moksaya Github].

==== Client Side WebApp ====

Development of web app consuming these RESTful api's can be tracked here https://github.com/aregee/Moksaya-web/

== REST API v1 Resources ==

==== User Creation ====
{| class="wikitable"
|-
! Resource !! Description
|-
| POST /api/v1/register/ || Makes http POST request with the JSON data to create a new user in the database ,if a user already exist raises HTTP 400 badrequest and returns a Json response with error message "the username already exist" . Returns HTTP 201 for successfully Created User
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X POST --data '{"username" :"user101" , "email" :"user@mail.com" , "password" : "password" }' http://moksaya-rahulgaur.rhcloud.com/api/v1/register/
|-
| Response || HTTP/1.1 201 CREATED Date: Thu, 19 Sep 2013 23:49:52 GMT Server: Apache/2.2.15 (Red Hat) Vary: Accept,Accept-Language,Cookie X-Frame-Options: SAMEORIGIN Content-Language: en-us Location:http://moksaya-rahulgaur.rhcloud.com/api/v1/register/19/
Content-Length: 0
Content-Type: text/html; charset=utf-8
|}

==== Authentication and User Login ====

Requires Username and Password for obtaining the api_keys , and rest of the other resources are accessed with the API Keys.
There are two ways to do it, these are Publicly accessible end points.

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/token/auth/ || Returns the apikey for the requested user, we need to supply the username and password in the request headers .
|-
| Example || curl -k --user "aregee:notebook" http://moksaya-rahulgaur.rhcloud.com/api/v1/token/auth/
|-
| Response || {
"key": "531ffb6152171df4f60b1b09f09dd1b4c5aba997"
}

|-
| POST /api/v1/user/login/ || Another way is to POST the user credentials as a JSON data to this end point and returns User Resource with the API_key . Raises HTTP 401 for unauthorized with error response
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X POST --data '{"username":"user101","password":"notebook" }' http://moksaya-rahulgaur.rhcloud.com/api/v1/user/login/
|-
| Response || HTTP/1.1 200 OK
Date: Fri, 20 Sep 2013 22:16:20 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Content-Type: application/json
Set-Cookie: sessionid=ddb4289b9fe8b2a963bfc540f81559c3; expires=Fri, 04-Oct-2013 22:16:20 GMT; httponly; Max-Age=1209600; Path=/
Transfer-Encoding: chunked

{
"apikey": "03f9a40ddd029b0a773a54f189aaa92d5a07c2d2",
"email": "user@mail.com",
"first_name": "",
"id": 14,
"last_name": "",
"resource_uri": "/api/v1/user/14/",
"username": "user101"
}

|}

==== User Resource ====
Authenticated users can access the User Resource , with the api_key and User Resource supports following authenticated options

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/user/ || Returns the list of all user accounts when accessed with authenticated header but returns requested user's resource when username and api_key supplied in url parameters
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/user/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
| Response || HTTP/1.1 200 OK
Date: Fri, 20 Sep 2013 22:32:23 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Type: application/json
Transfer-Encoding: chunked

{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 1
},
"objects": [
{
"apikey": "feea1175cdb9dde076eb68b5d83857fe2a58a186",
"email": "user@mail.com",
"first_name": "",
"id": 19,
"last_name": "",
"resource_uri": "/api/v1/user/19/",
"username": "akshit"
}
]
}
|-
| GET /api/v1/user/<username>/ || We can also access users with their respective usernames and returns HTTP 401 for resource not found
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/user/aregee/?username=spock\&api_key=d2fe32b15b0b395a5d0e0ea4b7eb1e5d6ea15de7
|-
| Response || HTTP/1.1 200 OK
Date: Fri, 20 Sep 2013 23:05:43 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Type: application/json
Transfer-Encoding: chunked

{
"apikey": "531ffb6152171df4f60b1b09f09dd1b4c5aba997",
"email": "iamaregee@gmail.com",
"first_name": "",
"id": 2,
"last_name": "",
"resource_uri": "/api/v1/user/2/",
"username": "aregee"
}
|-
| DELETE /api/v1/user/<username>/ || Removes the requested <username> from the database .
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X DELETE http://moksaya-rahulgaur.rhcloud.com/api/v1/user/akshit/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
| Response || HTTP/1.1 204 NO CONTENT
Date: Fri, 20 Sep 2013 22:36:22 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Content-Length: 0
Content-Type: text/html; charset=utf-8

|}

==== Profile Resource ====

{| class="wikitable"
|-
! Resource !! Description
|-
| POST /api/v1/profile/ || Making http post to this end point with the json data containing the Profile fields creates a new user profile , which is Related to all the other resources.Returns HTTP 201 response for successfully created user profile , returns HTTP 400 bad request with error response for unsuccessful attempts.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X POST --data '{"user":"/api/v1/user/akshit/" , "about_me" :"Profile Create with CURL"}' http://moksaya-rahulgaur.rhcloud.com/api/v1/profile/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
| GET /api/v1/profile/ || Returns list of all user profiles , throttles twenty results per request.
|-
| GET /api/v1/profile/username/ || Returns ProfileResource for the requested user , returns http 404 if resource is not found.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/profile/akshit/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
| Respone || HTTP/1.1 200 OK
Date: Thu, 19 Sep 2013 23:56:13 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Length: 279
Content-Type: application/json

{
"about_me": "Profile Create with CURL",
"followers": [],
"following": [],
"id": 19,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/19/",
"user": "akshit"
}
|-
| PUT /api/v1/profile/<username>/ || Updates the Profile Resource field with the supplied JSON data.Currently works with only about_me field but can be extended to include location and mugshot or Avatar fields
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X PUT --data '{"about_me" :"Profile Create & updated with CURL "}' http://moksaya-rahulgaur.rhcloud.com/api/v1/profile/akshit/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
|}

==== Project Resource ====

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/projects/ || Following query returns the list of all the projects submitted by the user.
|-
| GET /api/v1/projects/<id>/ || We can query a particular project with its id. This would return ProjectResource for the requested project id.It also shows related comments and likes on the project.
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/projects/1/?username=spock\&api_key=d2fe32b15b0b395a5d0e0ea4b7eb1e5d6ea15de7

|-

| Response || HTTP/1.1 200 OK
Date: Fri, 20 Sep 2013 23:40:38 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Type: application/json
Transfer-Encoding: chunked

{
"Likes": 6,
"comment": [
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/3/",
"text": "This is a Comment :)",
"user": "aregee"
},
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/8/",
"text": "Lets Post another Comment here :D",
"user": "aregee"
},
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/9/",
"text": "But This Kinda Looks Sweet :D",
"user": "aregee"
},
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/29/",
"text": "superb :)",
"user": "nikking1793"
},
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/30/",
"text": "superb :)",
"user": "nikking1793"
}
],
"desc": "Hello Project world",
"history": "",
"id": 1,
"resource_uri": "/api/v1/projects/1/",
"screenshot": "/media/projects/lin.jpg",
"shared_date": "2013-09-17T16:44:53.773919",
"src": "/media/projects/try.py",
"title": "This is My Project",
"user": "aregee"
}

|-
| POST /api/v1/projects/ || Making an http POST request to this URI with the Multipart form data in the JSON format creates a new project and Returns HTTP 201 for successfully created projects
|-
| Example || curl -F "user=/api/v1/profile/2/" -F "title=Fiddle with JS" -F "desc=this file documents my PROGRESS with learning JavaScript" -F "src=@projects/objects.js" -F "screenshot=@projects/img_screen.png" http://127.0.0.1:8000/api/v1/projects/?username=aregee\&api_key=531ffb6152171df4f60b1b09f09dd1b4c5aba99
|-
| PATCH /api/v1/projects/<id>/ || Updates the changed field to an existing project in the form of json data.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X PATCH --data '{"title":"Gallery Lock ++ " }' http://127.0.0.1:8000/api/v1/projects/1/?username=aregee\&api_key=531ffb6152171df4f60b1b09f09dd1b4c5aba99
|-
| PUT /api/v1/projects/<id>/ || We can also use the HTTP PUT request to update all the fields of an existing project
|-
| DELETE /api/v1/projects/<id>/ || Destroys the current project and the resource related to it : Likes , Comments
|-
|}

==== Project Forking ====

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/forking/<project_id>/ || Currently to fork a project , authenticated user makes GET request to this end point with the project id they need to fork.This method creates a copy of the requested project and associates it to the requesting User's profile.There is a history field in the Project to hold the data about original creator of the project.
|-
| Example || curl http://moksaya-rahulgaur.rhcloud.com/api/v1/forking/2/?username=vrinda\&api_key=b7c19215d088591e2dee07c2fb4df677ab1c9fbe
|-
| Response || {
"desc": "undefined",
"history": "project undefined created by aregee forked by vrinda ",
"resource_uri": "/api/v1/forking/2/",
"screenshot": "/media/projects/lin.jpg",
"shared_date": "2013-09-20T19:07:57.861892",
"src": "/media/projects/file_rem.py",
"title": "undefined"
}
|-
|}

==== Followers ====

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/relations/ || Returns a list of all the user relations with their resource.
|-
| POST /api/v1/relations/ || To create a follower/followee relation between the two user we pass a JSON data with the resource_uri of the currently logged in user's profile as follower and viewed profile of the user as followee . Returns HTTP 201 Created Response and each relations has its own id and other meta deta.
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X POST --data '{"follower":"/api/v1/profile/3/","followee":"/api/v1/profile/4/"}' http://127.0.0.1:8000/api/v1/relations/?username=vrinda\&api_key=b7c19215d088591e2dee07c2fb4df677ab1c9fbe
|-
| DELETE /api/v1/relations/<id>/ || Making a delete request to a relation , deletes the unilateral relation between the user.
|}

==== Likes ====

{| class="wikitable"
|-
! Resource !! Description
|-
| POST /api/v1/liking/ || Making http post request to this Resource along with the json data with user field containing resource_uri of the currently logged in user and liking_content_type field contains the URI of requested Project creates a liking Relation between the user and project.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X POST --data '{"user":"/api/v1/profile/2/" ,"liked_content_type":"/api/v1/projects/2/" }' http://127.0.0.1:8000/api/v1/liking/?username=vrinda\&api_key=b7c19215d088591e2dee07c2fb4df677ab1c9fbe
|-
| GET /api/v1/liking/ || Returns the list of all the liking relationship with their resource id and other liking resource.
|-
| GET /api/v1/liking/<id> || {
"Liked": "undefined",
"id": 2,
"liked_content_type": {
"Likes": 1,
"comment": [
{
"entry": "undefined",
"resource_uri": "/api/v1/comment/1/",
"text": ":P",
"user": "vrinda"
}
],
"desc": "undefined",
"history": "project undefined created by aregee forked by vrinda ",
"id": 4,
"resource_uri": "/api/v1/projects/4/",
"screenshot": "/media/projects/wb3_1.png",
"shared_date": "2013-09-20T19:09:43.084615",
"src": "/media/projects/feed__1.py",
"title": "undefined",
"user": "vrinda"
},
"resource_uri": "/api/v1/liking/2/",
"shared_date": "2013-09-20T19:09:59.892135",
"user": "vrinda"
}
|-
| DELETE /api/v1/liking/<id>/ || Destroys the requested liked relation.
|-
|}

==== Comment Resource ====

{| class="wikitable"
|-
! Description !! Resource
|-
| POST /api/v1/comment/ || This resource creates a new comment resource with the JSON data supplied to it.Returns 201 response for successfully added comment.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X POST --data '{"user":"/api/v1/profile/1/","entry":"/api/v1/projects/2/" , "text":"Comment posted with REST" }' http://127.0.0.1:8000/api/v1/comment/?username=soeone\&api_key=som23h32gh2g3h3g2h3gh2213ftf32f
|-
| GET /api/v1/comment/ || List all the comments along with their related Project Resource.
|-
| GET /api/v1/comment/<id>/ || Filters the Comment resource by their respective ids.
|-
| PATCH /api/v1/comment/<id>/ || Updates the text field in the comment.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X PATCH --data '{"text":"Comment POSTed with updated with PATCH" }' http://127.0.0.1:8000/api/v1/comment/1/?username=aregee\&api_key=ytg67asdf76asdf76fdsa767asdf67sadtg
|-
| DELETE /api/v1/comment/<id>/ || Making a delete request to the comment id , deletes the comment from the related resource or Project.
|}

=== Site Model ===
I have planed to design the RESTful interface to the Moksaya project , and I plan to consume these APIs with a webapp possibly written with [http://backbonejs.org/ Backbone.js]
Initially Moksaya project offers a RESTful interface to the following interrelated models :
*ProfileResource
*ProjectResource
*CommentResource
*LikeResource
*ForkResource

At the Top most level Profile/list contains all the User Profiles along with their Related Resources.
So , a typical user profile contains User info like About , Birthdays etcs then the Related Resources Projects , Friends List , Likes on Projects (Can be easily extended for comments or other models).
Most of these Related Resources can be accessed individually as well.

* Top Level View :curl --dump-header - -H "Content-Type: application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/profile/?username=spock\&api_key=d2fe32b15b0b395a5d0e0ea4b7eb1e5d6ea15de7
HTTP/1.1 200 OK
Date: Sat, 21 Sep 2013 01:32:01 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Type: application/json
Transfer-Encoding: chunked

{
"meta": {
"limit": 20,
"next": "/api/v1/profile/?username=spock&api_key=d2fe32b15b0b395a5d0e0ea4b7eb1e5d6ea15de7&limit=20&offset=20",
"offset": 0,
"previous": null,
"total_count": 26
},
"objects": [
{
"about_me": "admin",
"followers": [
"aregee"
],
"following": [],
"id": 1,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/1/",
"user": "admin"
},
{
"about_me": "Now I can update About_ME",
"followers": [
"vrinda",
"kirk",
"ned",
"titiksha",
"robStark",
"jarvis",
"satyamyadav",
"user101",
"atif",
"nikking1793",
"tch",
"amigo",
"aregee__"
],
"following": [
"vrinda",
"ned",
"kirk",
"tch",
"admin",
"titiksha",
"jarvis",
"monikagupta",
"satyamyadav",
"surajgillespie",
"nikking1793",
"amigo",
"raju"
],
"id": 2,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [
{
"Likes": 1,
"comment": [],
"desc": "undefined",
"history": "",
"id": 1,
"resource_uri": "/api/v1/projects/1/",
"screenshot": "/media/projects/wb3.png",
"shared_date": "2013-09-20T19:07:29.101309",
"src": "/media/projects/feed_.py",
"title": "undefined",
"user": "aregee"
},
{
"Likes": 0,
"comment": [],
"desc": "undefined",
"history": "",
"id": 2,
"resource_uri": "/api/v1/projects/2/",
"screenshot": "/media/projects/lin.jpg",
"shared_date": "2013-09-20T19:07:57.861892",
"src": "/media/projects/file_rem.py",
"title": "undefined",
"user": "aregee"
},
{
"Likes": 0,
"comment": [],
"desc": "undefined",
"history": "",
"id": 3,
"resource_uri": "/api/v1/projects/3/",
"screenshot": "/media/projects/beautiful_strings.png",
"shared_date": "2013-09-20T19:08:30.575741",
"src": "/media/projects/file_rem_1.py",
"title": "undefined",
"user": "aregee"
}
],
"resource_uri": "/api/v1/profile/2/",
"user": "aregee"
},
{
"about_me": "Oh not it won't happen :0",
"followers": [
"aregee"
],
"following": [
"aregee",
"kirk",
"jarvis"
],
"id": 3,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [
{
"Likes": 1,
"comment": [
{
"entry": "undefined",
"resource_uri": "/api/v1/comment/1/",
"text": ":P",
"user": "vrinda"
}
],
"desc": "undefined",
"history": "project undefined created by aregee forked by vrinda ",
"id": 4,
"resource_uri": "/api/v1/projects/4/",
"screenshot": "/media/projects/wb3_1.png",
"shared_date": "2013-09-20T19:09:43.084615",
"src": "/media/projects/feed__1.py",
"title": "undefined",
"user": "vrinda"
},
{
"Likes": 0,
"comment": [],
"desc": "undefined",
"history": "project undefined created by aregee forked by vrinda ",
"id": 5,
"resource_uri": "/api/v1/projects/5/",
"screenshot": "/media/projects/lin_1.jpg",
"shared_date": "2013-09-20T19:22:22.520212",
"src": "/media/projects/file_rem_2.py",
"title": "undefined",
"user": "vrinda"
}
],
"resource_uri": "/api/v1/profile/3/",
"user": "vrinda"
},
{
"about_me": "I am SPOCK",
"followers": [],
"following": [],
"id": 4,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/4/",
"user": "spock"
},
{
"about_me": "Howdy partner, this is kirk's Moksaya Profile",
"followers": [
"aregee",
"vrinda"
],
"following": [
"aregee"
],
"id": 5,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/5/",
"user": "kirk"
},
{
"about_me": "Howdy partner, this is ned's Moksaya Profile",
"followers": [
"aregee"
],
"following": [
"aregee"
],
"id": 6,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/6/",
"user": "ned"
},
{
"about_me": "sdasd",
"followers": [
"aregee"
],
"following": [
"aregee"
],
"id": 7,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/7/",
"user": "tch"
},
{
"about_me": "I am Titiksha",
"followers": [
"aregee"
],
"following": [
"aregee"
],
"id": 8,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/8/",
"user": "titiksha"
},
{
"about_me": "This is Rob Stark , King in the North ;)",
"followers": [],
"following": [
"aregee"
],
"id": 9,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/9/",
"user": "robStark"
},
{
"about_me": "Howdy partner, this is mronetwo's Moksaya Profile",
"followers": [],
"following": [],
"id": 10,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/10/",
"user": "mronetwo"
},
{
"about_me": "Howdy partner, this is monikagupta's Moksaya Profile",
"followers": [
"aregee"
],
"following": [],
"id": 11,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/11/",
"user": "monikagupta"
},
{
"about_me": "Howdy partner, this is jarvis's Moksaya Profile",
"followers": [
"aregee",
"vrinda"
],
"following": [
"aregee"
],
"id": 12,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/12/",
"user": "jarvis"
},
{
"about_me": "Howdy partner, this is satyamyadav's Moksaya Profile",
"followers": [
"aregee"
],
"following": [
"aregee"
],
"id": 13,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/13/",
"user": "satyamyadav"
},
{
"about_me": "Hello , I am user1010 and I code :)",
"followers": [],
"following": [
"aregee"
],
"id": 14,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/14/",
"user": "user101"
},
{
"about_me": "Howdy atif , this is your Moksaya Profile",
"followers": [],
"following": [
"aregee"
],
"id": 15,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/15/",
"user": "atif"
},
{
"about_me": "Howdy surajgillespie , this is your Moksaya Profile",
"followers": [
"aregee"
],
"following": [],
"id": 16,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/16/",
"user": "surajgillespie"
},
{
"about_me": "Howdy partner, this is moksaya_user's Moksaya Profile",
"followers": [],
"following": [],
"id": 17,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/17/",
"user": "moksaya_user"
},
{
"about_me": "Howdy nikking1793 , this is your Moksaya Profile",
"followers": [
"aregee",
"user102"
],
"following": [
"aregee"
],
"id": 18,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/18/",
"user": "nikking1793"
},
{
"about_me": "Howdy Ayushletsrock , this is your Moksaya Profile",
"followers": [
"user102"
],
"following": [],
"id": 20,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/20/",
"user": "Ayushletsrock"
},
{
"about_me": "Howdy gonzalo , this is your Moksaya Profile",
"followers": [],
"following": [],
"id": 21,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/21/",
"user": "gonzalo"
}
]
}

* Related Resource Projects here can be accessed by http://127.0.0.1:8000/api/v1/projects/?format=json
{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 5
},
"objects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
},
{
"Likes": 3,
"comment": [],
"desc": "This is my first hello world code",
"owner": "testuser",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-06-27T15:31:22.560494",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
},
{
"Likes": 0,
"comment": [],
"desc": "This is my first hello world code",
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-07-04T19:18:23.307241",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
},
{
"Likes": 0,
"comment": [],
"desc": "Wired Hack ",
"owner": "testuser",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-07-04T19:37:54.184572",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
}
]
}

In the above results I have excluded Project ids from the json Response, but similarly each individual project could be accessed and updated by making GET or Post or Put request to http://127.0.0.1:8000/api/v1/projects/<pk>?format=json

* Accessing particular project http://127.0.0.1:8000/api/v1/projects/2/?format=json

{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
}

==Forking==
Lets take a look at how forking works here , though this is not really the best approach but I am doing this for understanding purpose and would figure out the proper solution for this ..
but for now here it is.

* Lets say these are the projects on the Moksaya submitted by the user :
{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 3
},
"objects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"id": 1,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"id": 2,
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
},
{
"Likes": 3,
"comment": [],
"desc": "This is my first hello world code",
"id": 3,
"owner": "testuser",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-06-27T15:31:22.560494",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
}
]
}

* Now I am logged in as aregee , and here is my profile at 127.0.0.1:8000/api/v1/profile/list/1/?format=json

{
"about_me": "DjangoNaut",
"birth_date": "1991-06-20",
"friends": [
"testuser",
"SomeDude"
],
"gender": 1,
"language": "en",
"location": "India",
"mugshot": "/media/mugshots/d749832b7a.jpg",
"privacy": "registered",
"projects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"id": 1,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"id": 2,
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
}
],
"user": "aregee",
"website": "http://rahulgaur.info/"
}

* Now I want to fork the Project with id = 3 created by testuser , so I will make a GET request to 127.0.0.1:8000/api/v1/forking/3/?format=json
{
"Changes": {
"owner": "testuser",
"shared_date": "2013-06-27T15:31:22.560494"
},
"desc": "This is my first hello world code",
"resource_uri": "/api/v1/forking/3/",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-06-27T15:31:22.560494",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
}

The diffs / metadata could be viewed for the changes made , for instance here the response shows the original author of the project and the date it was shared

* Lets take a look at my Profile again at 127.0.0.1:8000/api/v1/profile/list/1/?format=json
{
"about_me": "DjangoNaut",
"birth_date": "1991-06-20",
"friends": [
"testuser",
"SomeDude"
],
"gender": 1,
"language": "en",
"location": "India",
"mugshot": "/media/mugshots/d749832b7a.jpg",
"privacy": "registered",
"projects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"id": 1,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"id": 2,
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
},
{
"Likes": 0,
"comment": [],
"desc": "This is my first hello world code",
"id": 4,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-07-04T20:46:43.062294",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
}
],
"user": "aregee",
"website": "http://rahulgaur.info/"
}

* And the list of projects at 127.0.0.1:8000/api/v1/projects/

{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 4
},
"objects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"id": 1,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"id": 2,
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
},
{
"Likes": 3,
"comment": [],
"desc": "This is my first hello world code",
"id": 3,
"owner": "testuser",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-06-27T15:31:22.560494",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
},
{
"Likes": 0,
"comment": [],
"desc": "This is my first hello world code",
"id": 4,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-07-04T20:46:43.062294",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
}
]
}

Difference among the two Projects can be tracked by Project.objects.get(pk = 4).diff(Project.objects.get(pk = 3)) , its a method provided by the django-forkit app to view changes / differences in the forkable models.
Meta data field needs to bee added to Projects field so that we can save these differences when a project is forked , and every project should contain a link to original creator.

=== TODOS ===

* Add Authentication
* Provide Full CRUD access to authenticated user to the core site functionalities : Like , Comment , UserProfile, Projects etcs
* Improve the forking functionality
* Implement JavaScript Client to consume APIs to get a minimal functional product up and running

Summer of Code/2013/moksaya

2013-09-21T01:33:38Z

Rahul Gaur: /* REST API v1 Resources */

== [http://sanskritdictionary.org/moksaya Moksaya] Project : ==
==== A Dajngo based web app aimed at sharing and collaboration of sugar activities to foster learning and creativity ====

Goal of this project is to implement a Project Sharing site to foster collaboration and sharing of Sugar Activities over the internet.The website upon the completion would also provide REST-API’s , so that the services of the website could be utilised by the Sugar Activities to share the project on the site from within the Sugar Environment.

=== Key Deliverables : ===
Here I have listed the Key features that I am currently working on , however as we go through the course of GSoC new features will be added ,once we have a concrete and stable base infrastructure for the Social Project Sharing site.

* Social Features : Following/Followers , Like , favourites , share , Comments .etc
* Authenticated RESTful API's :Ability to interact with website from various Sugar Activities
* Separate landing pages for different audiences (kids, teachers, parents, etc.)
* Gallery : Ability for users to create portfolio of their projects.

== Repository ==
I am developing this project under the Moksaya branch on my [https://github.com/aregee/moksaya Github].

== REST API v1 Resources ==

==== User Creation ====
{| class="wikitable"
|-
! Resource !! Description
|-
| POST /api/v1/register/ || Makes http POST request with the JSON data to create a new user in the database ,if a user already exist raises HTTP 400 badrequest and returns a Json response with error message "the username already exist" . Returns HTTP 201 for successfully Created User
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X POST --data '{"username" :"user101" , "email" :"user@mail.com" , "password" : "password" }' http://moksaya-rahulgaur.rhcloud.com/api/v1/register/
|-
| Response || HTTP/1.1 201 CREATED Date: Thu, 19 Sep 2013 23:49:52 GMT Server: Apache/2.2.15 (Red Hat) Vary: Accept,Accept-Language,Cookie X-Frame-Options: SAMEORIGIN Content-Language: en-us Location:http://moksaya-rahulgaur.rhcloud.com/api/v1/register/19/
Content-Length: 0
Content-Type: text/html; charset=utf-8
|}

==== Authentication and User Login ====

Requires Username and Password for obtaining the api_keys , and rest of the other resources are accessed with the API Keys.
There are two ways to do it, these are Publicly accessible end points.

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/token/auth/ || Returns the apikey for the requested user, we need to supply the username and password in the request headers .
|-
| Example || curl -k --user "aregee:notebook" http://moksaya-rahulgaur.rhcloud.com/api/v1/token/auth/
|-
| Response || {
"key": "531ffb6152171df4f60b1b09f09dd1b4c5aba997"
}

|-
| POST /api/v1/user/login/ || Another way is to POST the user credentials as a JSON data to this end point and returns User Resource with the API_key . Raises HTTP 401 for unauthorized with error response
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X POST --data '{"username":"user101","password":"notebook" }' http://moksaya-rahulgaur.rhcloud.com/api/v1/user/login/
|-
| Response || HTTP/1.1 200 OK
Date: Fri, 20 Sep 2013 22:16:20 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Content-Type: application/json
Set-Cookie: sessionid=ddb4289b9fe8b2a963bfc540f81559c3; expires=Fri, 04-Oct-2013 22:16:20 GMT; httponly; Max-Age=1209600; Path=/
Transfer-Encoding: chunked

{
"apikey": "03f9a40ddd029b0a773a54f189aaa92d5a07c2d2",
"email": "user@mail.com",
"first_name": "",
"id": 14,
"last_name": "",
"resource_uri": "/api/v1/user/14/",
"username": "user101"
}

|}

==== User Resource ====
Authenticated users can access the User Resource , with the api_key and User Resource supports following authenticated options

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/user/ || Returns the list of all user accounts when accessed with authenticated header but returns requested user's resource when username and api_key supplied in url parameters
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/user/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
| Response || HTTP/1.1 200 OK
Date: Fri, 20 Sep 2013 22:32:23 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Type: application/json
Transfer-Encoding: chunked

{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 1
},
"objects": [
{
"apikey": "feea1175cdb9dde076eb68b5d83857fe2a58a186",
"email": "user@mail.com",
"first_name": "",
"id": 19,
"last_name": "",
"resource_uri": "/api/v1/user/19/",
"username": "akshit"
}
]
}
|-
| GET /api/v1/user/<username>/ || We can also access users with their respective usernames and returns HTTP 401 for resource not found
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/user/aregee/?username=spock\&api_key=d2fe32b15b0b395a5d0e0ea4b7eb1e5d6ea15de7
|-
| Response || HTTP/1.1 200 OK
Date: Fri, 20 Sep 2013 23:05:43 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Type: application/json
Transfer-Encoding: chunked

{
"apikey": "531ffb6152171df4f60b1b09f09dd1b4c5aba997",
"email": "iamaregee@gmail.com",
"first_name": "",
"id": 2,
"last_name": "",
"resource_uri": "/api/v1/user/2/",
"username": "aregee"
}
|-
| DELETE /api/v1/user/<username>/ || Removes the requested <username> from the database .
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X DELETE http://moksaya-rahulgaur.rhcloud.com/api/v1/user/akshit/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
| Response || HTTP/1.1 204 NO CONTENT
Date: Fri, 20 Sep 2013 22:36:22 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Content-Length: 0
Content-Type: text/html; charset=utf-8

|}

==== Profile Resource ====

{| class="wikitable"
|-
! Resource !! Description
|-
| POST /api/v1/profile/ || Making http post to this end point with the json data containing the Profile fields creates a new user profile , which is Related to all the other resources.Returns HTTP 201 response for successfully created user profile , returns HTTP 400 bad request with error response for unsuccessful attempts.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X POST --data '{"user":"/api/v1/user/akshit/" , "about_me" :"Profile Create with CURL"}' http://moksaya-rahulgaur.rhcloud.com/api/v1/profile/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
| GET /api/v1/profile/ || Returns list of all user profiles , throttles twenty results per request.
|-
| GET /api/v1/profile/username/ || Returns ProfileResource for the requested user , returns http 404 if resource is not found.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/profile/akshit/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
| Respone || HTTP/1.1 200 OK
Date: Thu, 19 Sep 2013 23:56:13 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Length: 279
Content-Type: application/json

{
"about_me": "Profile Create with CURL",
"followers": [],
"following": [],
"id": 19,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/19/",
"user": "akshit"
}
|-
| PUT /api/v1/profile/<username>/ || Updates the Profile Resource field with the supplied JSON data.Currently works with only about_me field but can be extended to include location and mugshot or Avatar fields
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X PUT --data '{"about_me" :"Profile Create & updated with CURL "}' http://moksaya-rahulgaur.rhcloud.com/api/v1/profile/akshit/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
|}

==== Project Resource ====

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/projects/ || Following query returns the list of all the projects submitted by the user.
|-
| GET /api/v1/projects/<id>/ || We can query a particular project with its id. This would return ProjectResource for the requested project id.It also shows related comments and likes on the project.
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/projects/1/?username=spock\&api_key=d2fe32b15b0b395a5d0e0ea4b7eb1e5d6ea15de7

|-

| Response || HTTP/1.1 200 OK
Date: Fri, 20 Sep 2013 23:40:38 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Type: application/json
Transfer-Encoding: chunked

{
"Likes": 6,
"comment": [
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/3/",
"text": "This is a Comment :)",
"user": "aregee"
},
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/8/",
"text": "Lets Post another Comment here :D",
"user": "aregee"
},
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/9/",
"text": "But This Kinda Looks Sweet :D",
"user": "aregee"
},
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/29/",
"text": "superb :)",
"user": "nikking1793"
},
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/30/",
"text": "superb :)",
"user": "nikking1793"
}
],
"desc": "Hello Project world",
"history": "",
"id": 1,
"resource_uri": "/api/v1/projects/1/",
"screenshot": "/media/projects/lin.jpg",
"shared_date": "2013-09-17T16:44:53.773919",
"src": "/media/projects/try.py",
"title": "This is My Project",
"user": "aregee"
}

|-
| POST /api/v1/projects/ || Making an http POST request to this URI with the Multipart form data in the JSON format creates a new project and Returns HTTP 201 for successfully created projects
|-
| Example || curl -F "user=/api/v1/profile/2/" -F "title=Fiddle with JS" -F "desc=this file documents my PROGRESS with learning JavaScript" -F "src=@projects/objects.js" -F "screenshot=@projects/img_screen.png" http://127.0.0.1:8000/api/v1/projects/?username=aregee\&api_key=531ffb6152171df4f60b1b09f09dd1b4c5aba99
|-
| PATCH /api/v1/projects/<id>/ || Updates the changed field to an existing project in the form of json data.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X PATCH --data '{"title":"Gallery Lock ++ " }' http://127.0.0.1:8000/api/v1/projects/1/?username=aregee\&api_key=531ffb6152171df4f60b1b09f09dd1b4c5aba99
|-
| PUT /api/v1/projects/<id>/ || We can also use the HTTP PUT request to update all the fields of an existing project
|-
| DELETE /api/v1/projects/<id>/ || Destroys the current project and the resource related to it : Likes , Comments
|-
|}

==== Project Forking ====

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/forking/<project_id>/ || Currently to fork a project , authenticated user makes GET request to this end point with the project id they need to fork.This method creates a copy of the requested project and associates it to the requesting User's profile.There is a history field in the Project to hold the data about original creator of the project.
|-
| Example || curl http://moksaya-rahulgaur.rhcloud.com/api/v1/forking/2/?username=vrinda\&api_key=b7c19215d088591e2dee07c2fb4df677ab1c9fbe
|-
| Response || {
"desc": "undefined",
"history": "project undefined created by aregee forked by vrinda ",
"resource_uri": "/api/v1/forking/2/",
"screenshot": "/media/projects/lin.jpg",
"shared_date": "2013-09-20T19:07:57.861892",
"src": "/media/projects/file_rem.py",
"title": "undefined"
}
|-
|}

==== Followers ====

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/relations/ || Returns a list of all the user relations with their resource.
|-
| POST /api/v1/relations/ || To create a follower/followee relation between the two user we pass a JSON data with the resource_uri of the currently logged in user's profile as follower and viewed profile of the user as followee . Returns HTTP 201 Created Response and each relations has its own id and other meta deta.
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X POST --data '{"follower":"/api/v1/profile/3/","followee":"/api/v1/profile/4/"}' http://127.0.0.1:8000/api/v1/relations/?username=vrinda\&api_key=b7c19215d088591e2dee07c2fb4df677ab1c9fbe
|-
| DELETE /api/v1/relations/<id>/ || Making a delete request to a relation , deletes the unilateral relation between the user.
|}

==== Likes ====

{| class="wikitable"
|-
! Resource !! Description
|-
| POST /api/v1/liking/ || Making http post request to this Resource along with the json data with user field containing resource_uri of the currently logged in user and liking_content_type field contains the URI of requested Project creates a liking Relation between the user and project.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X POST --data '{"user":"/api/v1/profile/2/" ,"liked_content_type":"/api/v1/projects/2/" }' http://127.0.0.1:8000/api/v1/liking/?username=vrinda\&api_key=b7c19215d088591e2dee07c2fb4df677ab1c9fbe
|-
| GET /api/v1/liking/ || Returns the list of all the liking relationship with their resource id and other liking resource.
|-
| GET /api/v1/liking/<id> || {
"Liked": "undefined",
"id": 2,
"liked_content_type": {
"Likes": 1,
"comment": [
{
"entry": "undefined",
"resource_uri": "/api/v1/comment/1/",
"text": ":P",
"user": "vrinda"
}
],
"desc": "undefined",
"history": "project undefined created by aregee forked by vrinda ",
"id": 4,
"resource_uri": "/api/v1/projects/4/",
"screenshot": "/media/projects/wb3_1.png",
"shared_date": "2013-09-20T19:09:43.084615",
"src": "/media/projects/feed__1.py",
"title": "undefined",
"user": "vrinda"
},
"resource_uri": "/api/v1/liking/2/",
"shared_date": "2013-09-20T19:09:59.892135",
"user": "vrinda"
}
|-
| DELETE /api/v1/liking/<id>/ || Destroys the requested liked relation.
|-
|}

==== Comment Resource ====

{| class="wikitable"
|-
! Description !! Resource
|-
| POST /api/v1/comment/ || This resource creates a new comment resource with the JSON data supplied to it.Returns 201 response for successfully added comment.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X POST --data '{"user":"/api/v1/profile/1/","entry":"/api/v1/projects/2/" , "text":"Comment posted with REST" }' http://127.0.0.1:8000/api/v1/comment/?username=soeone\&api_key=som23h32gh2g3h3g2h3gh2213ftf32f
|-
| GET /api/v1/comment/ || List all the comments along with their related Project Resource.
|-
| GET /api/v1/comment/<id>/ || Filters the Comment resource by their respective ids.
|-
| PATCH /api/v1/comment/<id>/ || Updates the text field in the comment.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X PATCH --data '{"text":"Comment POSTed with updated with PATCH" }' http://127.0.0.1:8000/api/v1/comment/1/?username=aregee\&api_key=ytg67asdf76asdf76fdsa767asdf67sadtg
|-
| DELETE /api/v1/comment/<id>/ || Making a delete request to the comment id , deletes the comment from the related resource or Project.
|}

=== Site Model ===
I have planed to design the RESTful interface to the Moksaya project , and I plan to consume these APIs with a webapp possibly written with [http://backbonejs.org/ Backbone.js]
Initially Moksaya project offers a RESTful interface to the following interrelated models :
*ProfileResource
*ProjectResource
*CommentResource
*LikeResource
*ForkResource

At the Top most level Profile/list contains all the User Profiles along with their Related Resources.
So , a typical user profile contains User info like About , Birthdays etcs then the Related Resources Projects , Friends List , Likes on Projects (Can be easily extended for comments or other models).
Most of these Related Resources can be accessed individually as well.

* Top Level View :curl --dump-header - -H "Content-Type: application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/profile/?username=spock\&api_key=d2fe32b15b0b395a5d0e0ea4b7eb1e5d6ea15de7
HTTP/1.1 200 OK
Date: Sat, 21 Sep 2013 01:32:01 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Type: application/json
Transfer-Encoding: chunked

{
"meta": {
"limit": 20,
"next": "/api/v1/profile/?username=spock&api_key=d2fe32b15b0b395a5d0e0ea4b7eb1e5d6ea15de7&limit=20&offset=20",
"offset": 0,
"previous": null,
"total_count": 26
},
"objects": [
{
"about_me": "admin",
"followers": [
"aregee"
],
"following": [],
"id": 1,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/1/",
"user": "admin"
},
{
"about_me": "Now I can update About_ME",
"followers": [
"vrinda",
"kirk",
"ned",
"titiksha",
"robStark",
"jarvis",
"satyamyadav",
"user101",
"atif",
"nikking1793",
"tch",
"amigo",
"aregee__"
],
"following": [
"vrinda",
"ned",
"kirk",
"tch",
"admin",
"titiksha",
"jarvis",
"monikagupta",
"satyamyadav",
"surajgillespie",
"nikking1793",
"amigo",
"raju"
],
"id": 2,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [
{
"Likes": 1,
"comment": [],
"desc": "undefined",
"history": "",
"id": 1,
"resource_uri": "/api/v1/projects/1/",
"screenshot": "/media/projects/wb3.png",
"shared_date": "2013-09-20T19:07:29.101309",
"src": "/media/projects/feed_.py",
"title": "undefined",
"user": "aregee"
},
{
"Likes": 0,
"comment": [],
"desc": "undefined",
"history": "",
"id": 2,
"resource_uri": "/api/v1/projects/2/",
"screenshot": "/media/projects/lin.jpg",
"shared_date": "2013-09-20T19:07:57.861892",
"src": "/media/projects/file_rem.py",
"title": "undefined",
"user": "aregee"
},
{
"Likes": 0,
"comment": [],
"desc": "undefined",
"history": "",
"id": 3,
"resource_uri": "/api/v1/projects/3/",
"screenshot": "/media/projects/beautiful_strings.png",
"shared_date": "2013-09-20T19:08:30.575741",
"src": "/media/projects/file_rem_1.py",
"title": "undefined",
"user": "aregee"
}
],
"resource_uri": "/api/v1/profile/2/",
"user": "aregee"
},
{
"about_me": "Oh not it won't happen :0",
"followers": [
"aregee"
],
"following": [
"aregee",
"kirk",
"jarvis"
],
"id": 3,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [
{
"Likes": 1,
"comment": [
{
"entry": "undefined",
"resource_uri": "/api/v1/comment/1/",
"text": ":P",
"user": "vrinda"
}
],
"desc": "undefined",
"history": "project undefined created by aregee forked by vrinda ",
"id": 4,
"resource_uri": "/api/v1/projects/4/",
"screenshot": "/media/projects/wb3_1.png",
"shared_date": "2013-09-20T19:09:43.084615",
"src": "/media/projects/feed__1.py",
"title": "undefined",
"user": "vrinda"
},
{
"Likes": 0,
"comment": [],
"desc": "undefined",
"history": "project undefined created by aregee forked by vrinda ",
"id": 5,
"resource_uri": "/api/v1/projects/5/",
"screenshot": "/media/projects/lin_1.jpg",
"shared_date": "2013-09-20T19:22:22.520212",
"src": "/media/projects/file_rem_2.py",
"title": "undefined",
"user": "vrinda"
}
],
"resource_uri": "/api/v1/profile/3/",
"user": "vrinda"
},
{
"about_me": "I am SPOCK",
"followers": [],
"following": [],
"id": 4,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/4/",
"user": "spock"
},
{
"about_me": "Howdy partner, this is kirk's Moksaya Profile",
"followers": [
"aregee",
"vrinda"
],
"following": [
"aregee"
],
"id": 5,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/5/",
"user": "kirk"
},
{
"about_me": "Howdy partner, this is ned's Moksaya Profile",
"followers": [
"aregee"
],
"following": [
"aregee"
],
"id": 6,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/6/",
"user": "ned"
},
{
"about_me": "sdasd",
"followers": [
"aregee"
],
"following": [
"aregee"
],
"id": 7,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/7/",
"user": "tch"
},
{
"about_me": "I am Titiksha",
"followers": [
"aregee"
],
"following": [
"aregee"
],
"id": 8,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/8/",
"user": "titiksha"
},
{
"about_me": "This is Rob Stark , King in the North ;)",
"followers": [],
"following": [
"aregee"
],
"id": 9,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/9/",
"user": "robStark"
},
{
"about_me": "Howdy partner, this is mronetwo's Moksaya Profile",
"followers": [],
"following": [],
"id": 10,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/10/",
"user": "mronetwo"
},
{
"about_me": "Howdy partner, this is monikagupta's Moksaya Profile",
"followers": [
"aregee"
],
"following": [],
"id": 11,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/11/",
"user": "monikagupta"
},
{
"about_me": "Howdy partner, this is jarvis's Moksaya Profile",
"followers": [
"aregee",
"vrinda"
],
"following": [
"aregee"
],
"id": 12,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/12/",
"user": "jarvis"
},
{
"about_me": "Howdy partner, this is satyamyadav's Moksaya Profile",
"followers": [
"aregee"
],
"following": [
"aregee"
],
"id": 13,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/13/",
"user": "satyamyadav"
},
{
"about_me": "Hello , I am user1010 and I code :)",
"followers": [],
"following": [
"aregee"
],
"id": 14,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/14/",
"user": "user101"
},
{
"about_me": "Howdy atif , this is your Moksaya Profile",
"followers": [],
"following": [
"aregee"
],
"id": 15,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/15/",
"user": "atif"
},
{
"about_me": "Howdy surajgillespie , this is your Moksaya Profile",
"followers": [
"aregee"
],
"following": [],
"id": 16,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/16/",
"user": "surajgillespie"
},
{
"about_me": "Howdy partner, this is moksaya_user's Moksaya Profile",
"followers": [],
"following": [],
"id": 17,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/17/",
"user": "moksaya_user"
},
{
"about_me": "Howdy nikking1793 , this is your Moksaya Profile",
"followers": [
"aregee",
"user102"
],
"following": [
"aregee"
],
"id": 18,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/18/",
"user": "nikking1793"
},
{
"about_me": "Howdy Ayushletsrock , this is your Moksaya Profile",
"followers": [
"user102"
],
"following": [],
"id": 20,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/20/",
"user": "Ayushletsrock"
},
{
"about_me": "Howdy gonzalo , this is your Moksaya Profile",
"followers": [],
"following": [],
"id": 21,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/21/",
"user": "gonzalo"
}
]
}

* Related Resource Projects here can be accessed by http://127.0.0.1:8000/api/v1/projects/?format=json
{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 5
},
"objects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
},
{
"Likes": 3,
"comment": [],
"desc": "This is my first hello world code",
"owner": "testuser",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-06-27T15:31:22.560494",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
},
{
"Likes": 0,
"comment": [],
"desc": "This is my first hello world code",
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-07-04T19:18:23.307241",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
},
{
"Likes": 0,
"comment": [],
"desc": "Wired Hack ",
"owner": "testuser",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-07-04T19:37:54.184572",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
}
]
}

In the above results I have excluded Project ids from the json Response, but similarly each individual project could be accessed and updated by making GET or Post or Put request to http://127.0.0.1:8000/api/v1/projects/<pk>?format=json

* Accessing particular project http://127.0.0.1:8000/api/v1/projects/2/?format=json

{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
}

==Forking==
Lets take a look at how forking works here , though this is not really the best approach but I am doing this for understanding purpose and would figure out the proper solution for this ..
but for now here it is.

* Lets say these are the projects on the Moksaya submitted by the user :
{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 3
},
"objects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"id": 1,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"id": 2,
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
},
{
"Likes": 3,
"comment": [],
"desc": "This is my first hello world code",
"id": 3,
"owner": "testuser",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-06-27T15:31:22.560494",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
}
]
}

* Now I am logged in as aregee , and here is my profile at 127.0.0.1:8000/api/v1/profile/list/1/?format=json

{
"about_me": "DjangoNaut",
"birth_date": "1991-06-20",
"friends": [
"testuser",
"SomeDude"
],
"gender": 1,
"language": "en",
"location": "India",
"mugshot": "/media/mugshots/d749832b7a.jpg",
"privacy": "registered",
"projects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"id": 1,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"id": 2,
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
}
],
"user": "aregee",
"website": "http://rahulgaur.info/"
}

* Now I want to fork the Project with id = 3 created by testuser , so I will make a GET request to 127.0.0.1:8000/api/v1/forking/3/?format=json
{
"Changes": {
"owner": "testuser",
"shared_date": "2013-06-27T15:31:22.560494"
},
"desc": "This is my first hello world code",
"resource_uri": "/api/v1/forking/3/",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-06-27T15:31:22.560494",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
}

The diffs / metadata could be viewed for the changes made , for instance here the response shows the original author of the project and the date it was shared

* Lets take a look at my Profile again at 127.0.0.1:8000/api/v1/profile/list/1/?format=json
{
"about_me": "DjangoNaut",
"birth_date": "1991-06-20",
"friends": [
"testuser",
"SomeDude"
],
"gender": 1,
"language": "en",
"location": "India",
"mugshot": "/media/mugshots/d749832b7a.jpg",
"privacy": "registered",
"projects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"id": 1,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"id": 2,
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
},
{
"Likes": 0,
"comment": [],
"desc": "This is my first hello world code",
"id": 4,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-07-04T20:46:43.062294",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
}
],
"user": "aregee",
"website": "http://rahulgaur.info/"
}

* And the list of projects at 127.0.0.1:8000/api/v1/projects/

{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 4
},
"objects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"id": 1,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"id": 2,
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
},
{
"Likes": 3,
"comment": [],
"desc": "This is my first hello world code",
"id": 3,
"owner": "testuser",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-06-27T15:31:22.560494",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
},
{
"Likes": 0,
"comment": [],
"desc": "This is my first hello world code",
"id": 4,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-07-04T20:46:43.062294",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
}
]
}

Difference among the two Projects can be tracked by Project.objects.get(pk = 4).diff(Project.objects.get(pk = 3)) , its a method provided by the django-forkit app to view changes / differences in the forkable models.
Meta data field needs to bee added to Projects field so that we can save these differences when a project is forked , and every project should contain a link to original creator.

=== TODOS ===

* Add Authentication
* Provide Full CRUD access to authenticated user to the core site functionalities : Like , Comment , UserProfile, Projects etcs
* Improve the forking functionality
* Implement JavaScript Client to consume APIs to get a minimal functional product up and running

Summer of Code/2013/moksaya

2013-09-21T01:02:18Z

Rahul Gaur: /* Followers */

== [http://sanskritdictionary.org/moksaya Moksaya] Project : ==
==== A Dajngo based web app aimed at sharing and collaboration of sugar activities to foster learning and creativity ====

Goal of this project is to implement a Project Sharing site to foster collaboration and sharing of Sugar Activities over the internet.The website upon the completion would also provide REST-API’s , so that the services of the website could be utilised by the Sugar Activities to share the project on the site from within the Sugar Environment.

=== Key Deliverables : ===
Here I have listed the Key features that I am currently working on , however as we go through the course of GSoC new features will be added ,once we have a concrete and stable base infrastructure for the Social Project Sharing site.

* Social Features : Following/Followers , Like , favourites , share , Comments .etc
* Authenticated RESTful API's :Ability to interact with website from various Sugar Activities
* Separate landing pages for different audiences (kids, teachers, parents, etc.)
* Gallery : Ability for users to create portfolio of their projects.

== Repository ==
I am developing this project under the Moksaya branch on my [https://github.com/aregee/moksaya Github].

== REST API v1 Resources ==

==== User Creation ====
{| class="wikitable"
|-
! Resource !! Description
|-
| POST /api/v1/register/ || Makes http POST request with the JSON data to create a new user in the database ,if a user already exist raises HTTP 400 badrequest and returns a Json response with error message "the username already exist" . Returns HTTP 201 for successfully Created User
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X POST --data '{"username" :"user101" , "email" :"user@mail.com" , "password" : "password" }' http://moksaya-rahulgaur.rhcloud.com/api/v1/register/
|-
| Response || HTTP/1.1 201 CREATED Date: Thu, 19 Sep 2013 23:49:52 GMT Server: Apache/2.2.15 (Red Hat) Vary: Accept,Accept-Language,Cookie X-Frame-Options: SAMEORIGIN Content-Language: en-us Location:http://moksaya-rahulgaur.rhcloud.com/api/v1/register/19/
Content-Length: 0
Content-Type: text/html; charset=utf-8
|}

==== Authentication and User Login ====

Requires Username and Password for obtaining the api_keys , and rest of the other resources are accessed with the API Keys.
There are two ways to do it, these are Publicly accessible end points.

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/token/auth/ || Returns the apikey for the requested user, we need to supply the username and password in the request headers .
|-
| Example || curl -k --user "aregee:notebook" http://moksaya-rahulgaur.rhcloud.com/api/v1/token/auth/
|-
| Response || {
"key": "531ffb6152171df4f60b1b09f09dd1b4c5aba997"
}

|-
| POST /api/v1/user/login/ || Another way is to POST the user credentials as a JSON data to this end point and returns User Resource with the API_key . Raises HTTP 401 for unauthorized with error response
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X POST --data '{"username":"user101","password":"notebook" }' http://moksaya-rahulgaur.rhcloud.com/api/v1/user/login/
|-
| Response || HTTP/1.1 200 OK
Date: Fri, 20 Sep 2013 22:16:20 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Content-Type: application/json
Set-Cookie: sessionid=ddb4289b9fe8b2a963bfc540f81559c3; expires=Fri, 04-Oct-2013 22:16:20 GMT; httponly; Max-Age=1209600; Path=/
Transfer-Encoding: chunked

{
"apikey": "03f9a40ddd029b0a773a54f189aaa92d5a07c2d2",
"email": "user@mail.com",
"first_name": "",
"id": 14,
"last_name": "",
"resource_uri": "/api/v1/user/14/",
"username": "user101"
}

|}

==== User Resource ====
Authenticated users can access the User Resource , with the api_key and User Resource supports following authenticated options

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/user/ || Returns the list of all user accounts when accessed with authenticated header but returns requested user's resource when username and api_key supplied in url parameters
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/user/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
| Response || HTTP/1.1 200 OK
Date: Fri, 20 Sep 2013 22:32:23 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Type: application/json
Transfer-Encoding: chunked

{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 1
},
"objects": [
{
"apikey": "feea1175cdb9dde076eb68b5d83857fe2a58a186",
"email": "user@mail.com",
"first_name": "",
"id": 19,
"last_name": "",
"resource_uri": "/api/v1/user/19/",
"username": "akshit"
}
]
}
|-
| GET /api/v1/user/<username>/ || We can also access users with their respective usernames and returns HTTP 401 for resource not found
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/user/aregee/?username=spock\&api_key=d2fe32b15b0b395a5d0e0ea4b7eb1e5d6ea15de7
|-
| Response || HTTP/1.1 200 OK
Date: Fri, 20 Sep 2013 23:05:43 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Type: application/json
Transfer-Encoding: chunked

{
"apikey": "531ffb6152171df4f60b1b09f09dd1b4c5aba997",
"email": "iamaregee@gmail.com",
"first_name": "",
"id": 2,
"last_name": "",
"resource_uri": "/api/v1/user/2/",
"username": "aregee"
}
|-
| DELETE /api/v1/user/<username>/ || Removes the requested <username> from the database .
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X DELETE http://moksaya-rahulgaur.rhcloud.com/api/v1/user/akshit/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
| Response || HTTP/1.1 204 NO CONTENT
Date: Fri, 20 Sep 2013 22:36:22 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Content-Length: 0
Content-Type: text/html; charset=utf-8

|}

==== Profile Resource ====

{| class="wikitable"
|-
! Resource !! Description
|-
| POST /api/v1/profile/ || Making http post to this end point with the json data containing the Profile fields creates a new user profile , which is Related to all the other resources.Returns HTTP 201 response for successfully created user profile , returns HTTP 400 bad request with error response for unsuccessful attempts.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X POST --data '{"user":"/api/v1/user/akshit/" , "about_me" :"Profile Create with CURL"}' http://moksaya-rahulgaur.rhcloud.com/api/v1/profile/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
| GET /api/v1/profile/ || Returns list of all user profiles , throttles twenty results per request.
|-
| GET /api/v1/profile/username/ || Returns ProfileResource for the requested user , returns http 404 if resource is not found.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/profile/akshit/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
| Respone || HTTP/1.1 200 OK
Date: Thu, 19 Sep 2013 23:56:13 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Length: 279
Content-Type: application/json

{
"about_me": "Profile Create with CURL",
"followers": [],
"following": [],
"id": 19,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/19/",
"user": "akshit"
}
|-
| PUT /api/v1/profile/<username>/ || Updates the Profile Resource field with the supplied JSON data.Currently works with only about_me field but can be extended to include location and mugshot or Avatar fields
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X PUT --data '{"about_me" :"Profile Create & updated with CURL "}' http://moksaya-rahulgaur.rhcloud.com/api/v1/profile/akshit/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
|}

==== Project Resource ====

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/projects/ || Following query returns the list of all the projects submitted by the user.
|-
| GET /api/v1/projects/<id>/ || We can query a particular project with its id. This would return ProjectResource for the requested project id.It also shows related comments and likes on the project.
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/projects/1/?username=spock\&api_key=d2fe32b15b0b395a5d0e0ea4b7eb1e5d6ea15de7

|-

| Response || HTTP/1.1 200 OK
Date: Fri, 20 Sep 2013 23:40:38 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Type: application/json
Transfer-Encoding: chunked

{
"Likes": 6,
"comment": [
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/3/",
"text": "This is a Comment :)",
"user": "aregee"
},
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/8/",
"text": "Lets Post another Comment here :D",
"user": "aregee"
},
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/9/",
"text": "But This Kinda Looks Sweet :D",
"user": "aregee"
},
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/29/",
"text": "superb :)",
"user": "nikking1793"
},
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/30/",
"text": "superb :)",
"user": "nikking1793"
}
],
"desc": "Hello Project world",
"history": "",
"id": 1,
"resource_uri": "/api/v1/projects/1/",
"screenshot": "/media/projects/lin.jpg",
"shared_date": "2013-09-17T16:44:53.773919",
"src": "/media/projects/try.py",
"title": "This is My Project",
"user": "aregee"
}

|-
| POST /api/v1/projects/ || Making an http POST request to this URI with the Multipart form data in the JSON format creates a new project and Returns HTTP 201 for successfully created projects
|-
| Example || curl -F "user=/api/v1/profile/2/" -F "title=Fiddle with JS" -F "desc=this file documents my PROGRESS with learning JavaScript" -F "src=@projects/objects.js" -F "screenshot=@projects/img_screen.png" http://127.0.0.1:8000/api/v1/projects/?username=aregee\&api_key=531ffb6152171df4f60b1b09f09dd1b4c5aba99
|-
| PATCH /api/v1/projects/<id>/ || Updates the changed field to an existing project in the form of json data.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X PATCH --data '{"title":"Gallery Lock ++ " }' http://127.0.0.1:8000/api/v1/projects/1/?username=aregee\&api_key=531ffb6152171df4f60b1b09f09dd1b4c5aba99
|-
| PUT /api/v1/projects/<id>/ || We can also use the HTTP PUT request to update all the fields of an existing project
|-
| DELETE /api/v1/projects/<id>/ || Destroys the current project and the resource related to it : Likes , Comments
|-
|}

==== Project Forking ====

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/forking/<project_id>/ || Currently to fork a project , authenticated user makes GET request to this end point with the project id they need to fork.This method creates a copy of the requested project and associates it to the requesting User's profile.There is a history field in the Project to hold the data about original creator of the project.
|-
| Example || curl http://moksaya-rahulgaur.rhcloud.com/api/v1/forking/2/?username=vrinda\&api_key=b7c19215d088591e2dee07c2fb4df677ab1c9fbe
|-
| Response || {
"desc": "undefined",
"history": "project undefined created by aregee forked by vrinda ",
"resource_uri": "/api/v1/forking/2/",
"screenshot": "/media/projects/lin.jpg",
"shared_date": "2013-09-20T19:07:57.861892",
"src": "/media/projects/file_rem.py",
"title": "undefined"
}
|-
|}

==== Followers ====

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/relations/ || Returns a list of all the user relations with their resource.
|-
| POST /api/v1/relations/ || To create a follower/followee relation between the two user we pass a JSON data with the resource_uri of the currently logged in user's profile as follower and viewed profile of the user as followee . Returns HTTP 201 Created Response and each relations has its own id and other meta deta.
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X POST --data '{"follower":"/api/v1/profile/3/","followee":"/api/v1/profile/4/"}' http://127.0.0.1:8000/api/v1/relations/?username=vrinda\&api_key=b7c19215d088591e2dee07c2fb4df677ab1c9fbe
|-
| DELETE /api/v1/relations/<id>/ || Making a delete request to a relation , deletes the unilateral relation between the user.
|}

==== UI/UX ====
The User interface and user experience of the site is an essential feature , we have to get this part right as this whole project's target audience is Kids so the UI should be simple yet should be attractive to kids and the user experience should be done in a way such that if kids use the site ,they are comfortable with all the functionality being offered by the site and engage on the site.
Here are some of my Design Approach :
<gallery>
File:Moksha_1.png|Landing Page
File:Moksha_2.png|User Profiles
File:Moksha_3.png|Responsive Design
</gallery>

I am planning to stage the site on PaaS platform maybe like OpenShift , however there have been certains glitches with my Openshift account but I will try to work it out or consider some other feasible alternative.
I am doing this because with this approach I would be able to get user feedback from community members side by side with my development efforts and hence I can iterate and improve with their feedbacks.

=== Site Model ===
I have planed to design the RESTful interface to the Moksaya project , and I plan to consume these APIs with a webapp possibly written with [http://backbonejs.org/ Backbone.js]
Initially Moksaya project offers a RESTful interface to the following interrelated models :
*ProfileResource
*ProjectResource
*CommentResource
*LikeResource
*ForkResource

At the Top most level Profile/list contains all the User Profiles along with their Related Resources.
So , a typical user profile contains User info like About , Birthdays etcs then the Related Resources Projects , Friends List , Likes on Projects (Can be easily extended for comments or other models).
Most of these Related Resources can be accessed individually as well.

* Top Level View : http://127.0.0.1:8000/api/v1/profile/list/

{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 3
},
"objects": [
{
"about_me": "DjangoNaut",
"birth_date": "1991-06-20",
"friends": [
"testuser",
"SomeDude"
],
"gender": 1,
"language": "en",
"location": "India",
"mugshot": "/media/mugshots/d749832b7a.jpg",
"privacy": "registered",
"projects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
},
{
"Likes": 0,
"comment": [],
"desc": "This is my first hello world code",
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-07-04T19:18:23.307241",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
}
],
"user": "aregee",
"website": "http://rahulgaur.info/"
},
{
"about_me": "Profile BIO",
"birth_date": "2013-06-26",
"friends": [
"aregee",
"SomeDude"
],
"gender": 2,
"language": "en",
"location": "Delhi",
"mugshot": null,
"privacy": "registered",
"projects": [
{
"Likes": 3,
"comment": [],
"desc": "This is my first hello world code",
"owner": "testuser",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-06-27T15:31:22.560494",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
},
{
"Likes": 0,
"comment": [],
"desc": "Wired Hack ",
"owner": "testuser",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-07-04T19:37:54.184572",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
}
],
"user": "testuser",
"website": "http://Something.com/"
},
{
"about_me": "Hello I am a dummy User here and I am doing something very amazing",
"birth_date": "2013-07-02",
"friends": [
"aregee",
"testuser"
],
"gender": 1,
"language": "en",
"location": "India",
"mugshot": "/media/mugshots/0ebb9512eb.jpg",
"privacy": "registered",
"projects": [],
"user": "SomeDude",
"website": "http://somedude.com/"
}
]
}

* Individual User Profiles could be further requested as http://127.0.0.1:8000/api/v1/profile/list/2/?format=json
{
"about_me": "Profile BIO",
"birth_date": "2013-06-26",
"friends": [
"aregee",
"SomeDude"
],
"gender": 2,
"language": "en",
"location": "Delhi",
"mugshot": null,
"privacy": "registered",
"projects": [
{
"Likes": 3,
"comment": [],
"desc": "This is my first hello world code",
"owner": "testuser",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-06-27T15:31:22.560494",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
},
{
"Likes": 0,
"comment": [],
"desc": "Wired Hack ",
"owner": "testuser",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-07-04T19:37:54.184572",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
}
],
"user": "testuser",
"website": "http://Something.com/"
}

* Related Resource Projects here can be accessed by http://127.0.0.1:8000/api/v1/projects/?format=json
{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 5
},
"objects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
},
{
"Likes": 3,
"comment": [],
"desc": "This is my first hello world code",
"owner": "testuser",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-06-27T15:31:22.560494",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
},
{
"Likes": 0,
"comment": [],
"desc": "This is my first hello world code",
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-07-04T19:18:23.307241",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
},
{
"Likes": 0,
"comment": [],
"desc": "Wired Hack ",
"owner": "testuser",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-07-04T19:37:54.184572",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
}
]
}

In the above results I have excluded Project ids from the json Response, but similarly each individual project could be accessed and updated by making GET or Post or Put request to http://127.0.0.1:8000/api/v1/projects/<pk>?format=json

* Accessing particular project http://127.0.0.1:8000/api/v1/projects/2/?format=json

{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
}

==Forking==
Lets take a look at how forking works here , though this is not really the best approach but I am doing this for understanding purpose and would figure out the proper solution for this ..
but for now here it is.

* Lets say these are the projects on the Moksaya submitted by the user :
{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 3
},
"objects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"id": 1,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"id": 2,
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
},
{
"Likes": 3,
"comment": [],
"desc": "This is my first hello world code",
"id": 3,
"owner": "testuser",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-06-27T15:31:22.560494",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
}
]
}

* Now I am logged in as aregee , and here is my profile at 127.0.0.1:8000/api/v1/profile/list/1/?format=json

{
"about_me": "DjangoNaut",
"birth_date": "1991-06-20",
"friends": [
"testuser",
"SomeDude"
],
"gender": 1,
"language": "en",
"location": "India",
"mugshot": "/media/mugshots/d749832b7a.jpg",
"privacy": "registered",
"projects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"id": 1,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"id": 2,
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
}
],
"user": "aregee",
"website": "http://rahulgaur.info/"
}

* Now I want to fork the Project with id = 3 created by testuser , so I will make a GET request to 127.0.0.1:8000/api/v1/forking/3/?format=json
{
"Changes": {
"owner": "testuser",
"shared_date": "2013-06-27T15:31:22.560494"
},
"desc": "This is my first hello world code",
"resource_uri": "/api/v1/forking/3/",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-06-27T15:31:22.560494",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
}

The diffs / metadata could be viewed for the changes made , for instance here the response shows the original author of the project and the date it was shared

* Lets take a look at my Profile again at 127.0.0.1:8000/api/v1/profile/list/1/?format=json
{
"about_me": "DjangoNaut",
"birth_date": "1991-06-20",
"friends": [
"testuser",
"SomeDude"
],
"gender": 1,
"language": "en",
"location": "India",
"mugshot": "/media/mugshots/d749832b7a.jpg",
"privacy": "registered",
"projects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"id": 1,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"id": 2,
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
},
{
"Likes": 0,
"comment": [],
"desc": "This is my first hello world code",
"id": 4,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-07-04T20:46:43.062294",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
}
],
"user": "aregee",
"website": "http://rahulgaur.info/"
}

* And the list of projects at 127.0.0.1:8000/api/v1/projects/

{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 4
},
"objects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"id": 1,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"id": 2,
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
},
{
"Likes": 3,
"comment": [],
"desc": "This is my first hello world code",
"id": 3,
"owner": "testuser",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-06-27T15:31:22.560494",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
},
{
"Likes": 0,
"comment": [],
"desc": "This is my first hello world code",
"id": 4,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-07-04T20:46:43.062294",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
}
]
}

Difference among the two Projects can be tracked by Project.objects.get(pk = 4).diff(Project.objects.get(pk = 3)) , its a method provided by the django-forkit app to view changes / differences in the forkable models.
Meta data field needs to bee added to Projects field so that we can save these differences when a project is forked , and every project should contain a link to original creator.

=== TODOS ===

* Add Authentication
* Provide Full CRUD access to authenticated user to the core site functionalities : Like , Comment , UserProfile, Projects etcs
* Improve the forking functionality
* Implement JavaScript Client to consume APIs to get a minimal functional product up and running

Summer of Code/2013/moksaya

2013-09-21T01:01:02Z

Rahul Gaur: /* REST API v1 Resources */

== [http://sanskritdictionary.org/moksaya Moksaya] Project : ==
==== A Dajngo based web app aimed at sharing and collaboration of sugar activities to foster learning and creativity ====

Goal of this project is to implement a Project Sharing site to foster collaboration and sharing of Sugar Activities over the internet.The website upon the completion would also provide REST-API’s , so that the services of the website could be utilised by the Sugar Activities to share the project on the site from within the Sugar Environment.

=== Key Deliverables : ===
Here I have listed the Key features that I am currently working on , however as we go through the course of GSoC new features will be added ,once we have a concrete and stable base infrastructure for the Social Project Sharing site.

* Social Features : Following/Followers , Like , favourites , share , Comments .etc
* Authenticated RESTful API's :Ability to interact with website from various Sugar Activities
* Separate landing pages for different audiences (kids, teachers, parents, etc.)
* Gallery : Ability for users to create portfolio of their projects.

== Repository ==
I am developing this project under the Moksaya branch on my [https://github.com/aregee/moksaya Github].

== REST API v1 Resources ==

==== User Creation ====
{| class="wikitable"
|-
! Resource !! Description
|-
| POST /api/v1/register/ || Makes http POST request with the JSON data to create a new user in the database ,if a user already exist raises HTTP 400 badrequest and returns a Json response with error message "the username already exist" . Returns HTTP 201 for successfully Created User
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X POST --data '{"username" :"user101" , "email" :"user@mail.com" , "password" : "password" }' http://moksaya-rahulgaur.rhcloud.com/api/v1/register/
|-
| Response || HTTP/1.1 201 CREATED Date: Thu, 19 Sep 2013 23:49:52 GMT Server: Apache/2.2.15 (Red Hat) Vary: Accept,Accept-Language,Cookie X-Frame-Options: SAMEORIGIN Content-Language: en-us Location:http://moksaya-rahulgaur.rhcloud.com/api/v1/register/19/
Content-Length: 0
Content-Type: text/html; charset=utf-8
|}

==== Authentication and User Login ====

Requires Username and Password for obtaining the api_keys , and rest of the other resources are accessed with the API Keys.
There are two ways to do it, these are Publicly accessible end points.

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/token/auth/ || Returns the apikey for the requested user, we need to supply the username and password in the request headers .
|-
| Example || curl -k --user "aregee:notebook" http://moksaya-rahulgaur.rhcloud.com/api/v1/token/auth/
|-
| Response || {
"key": "531ffb6152171df4f60b1b09f09dd1b4c5aba997"
}

|-
| POST /api/v1/user/login/ || Another way is to POST the user credentials as a JSON data to this end point and returns User Resource with the API_key . Raises HTTP 401 for unauthorized with error response
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X POST --data '{"username":"user101","password":"notebook" }' http://moksaya-rahulgaur.rhcloud.com/api/v1/user/login/
|-
| Response || HTTP/1.1 200 OK
Date: Fri, 20 Sep 2013 22:16:20 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Content-Type: application/json
Set-Cookie: sessionid=ddb4289b9fe8b2a963bfc540f81559c3; expires=Fri, 04-Oct-2013 22:16:20 GMT; httponly; Max-Age=1209600; Path=/
Transfer-Encoding: chunked

{
"apikey": "03f9a40ddd029b0a773a54f189aaa92d5a07c2d2",
"email": "user@mail.com",
"first_name": "",
"id": 14,
"last_name": "",
"resource_uri": "/api/v1/user/14/",
"username": "user101"
}

|}

==== User Resource ====
Authenticated users can access the User Resource , with the api_key and User Resource supports following authenticated options

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/user/ || Returns the list of all user accounts when accessed with authenticated header but returns requested user's resource when username and api_key supplied in url parameters
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/user/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
| Response || HTTP/1.1 200 OK
Date: Fri, 20 Sep 2013 22:32:23 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Type: application/json
Transfer-Encoding: chunked

{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 1
},
"objects": [
{
"apikey": "feea1175cdb9dde076eb68b5d83857fe2a58a186",
"email": "user@mail.com",
"first_name": "",
"id": 19,
"last_name": "",
"resource_uri": "/api/v1/user/19/",
"username": "akshit"
}
]
}
|-
| GET /api/v1/user/<username>/ || We can also access users with their respective usernames and returns HTTP 401 for resource not found
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/user/aregee/?username=spock\&api_key=d2fe32b15b0b395a5d0e0ea4b7eb1e5d6ea15de7
|-
| Response || HTTP/1.1 200 OK
Date: Fri, 20 Sep 2013 23:05:43 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Type: application/json
Transfer-Encoding: chunked

{
"apikey": "531ffb6152171df4f60b1b09f09dd1b4c5aba997",
"email": "iamaregee@gmail.com",
"first_name": "",
"id": 2,
"last_name": "",
"resource_uri": "/api/v1/user/2/",
"username": "aregee"
}
|-
| DELETE /api/v1/user/<username>/ || Removes the requested <username> from the database .
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X DELETE http://moksaya-rahulgaur.rhcloud.com/api/v1/user/akshit/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
| Response || HTTP/1.1 204 NO CONTENT
Date: Fri, 20 Sep 2013 22:36:22 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Content-Length: 0
Content-Type: text/html; charset=utf-8

|}

==== Profile Resource ====

{| class="wikitable"
|-
! Resource !! Description
|-
| POST /api/v1/profile/ || Making http post to this end point with the json data containing the Profile fields creates a new user profile , which is Related to all the other resources.Returns HTTP 201 response for successfully created user profile , returns HTTP 400 bad request with error response for unsuccessful attempts.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X POST --data '{"user":"/api/v1/user/akshit/" , "about_me" :"Profile Create with CURL"}' http://moksaya-rahulgaur.rhcloud.com/api/v1/profile/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
| GET /api/v1/profile/ || Returns list of all user profiles , throttles twenty results per request.
|-
| GET /api/v1/profile/username/ || Returns ProfileResource for the requested user , returns http 404 if resource is not found.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/profile/akshit/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
| Respone || HTTP/1.1 200 OK
Date: Thu, 19 Sep 2013 23:56:13 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Length: 279
Content-Type: application/json

{
"about_me": "Profile Create with CURL",
"followers": [],
"following": [],
"id": 19,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/19/",
"user": "akshit"
}
|-
| PUT /api/v1/profile/<username>/ || Updates the Profile Resource field with the supplied JSON data.Currently works with only about_me field but can be extended to include location and mugshot or Avatar fields
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X PUT --data '{"about_me" :"Profile Create & updated with CURL "}' http://moksaya-rahulgaur.rhcloud.com/api/v1/profile/akshit/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
|}

==== Project Resource ====

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/projects/ || Following query returns the list of all the projects submitted by the user.
|-
| GET /api/v1/projects/<id>/ || We can query a particular project with its id. This would return ProjectResource for the requested project id.It also shows related comments and likes on the project.
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/projects/1/?username=spock\&api_key=d2fe32b15b0b395a5d0e0ea4b7eb1e5d6ea15de7

|-

| Response || HTTP/1.1 200 OK
Date: Fri, 20 Sep 2013 23:40:38 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Type: application/json
Transfer-Encoding: chunked

{
"Likes": 6,
"comment": [
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/3/",
"text": "This is a Comment :)",
"user": "aregee"
},
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/8/",
"text": "Lets Post another Comment here :D",
"user": "aregee"
},
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/9/",
"text": "But This Kinda Looks Sweet :D",
"user": "aregee"
},
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/29/",
"text": "superb :)",
"user": "nikking1793"
},
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/30/",
"text": "superb :)",
"user": "nikking1793"
}
],
"desc": "Hello Project world",
"history": "",
"id": 1,
"resource_uri": "/api/v1/projects/1/",
"screenshot": "/media/projects/lin.jpg",
"shared_date": "2013-09-17T16:44:53.773919",
"src": "/media/projects/try.py",
"title": "This is My Project",
"user": "aregee"
}

|-
| POST /api/v1/projects/ || Making an http POST request to this URI with the Multipart form data in the JSON format creates a new project and Returns HTTP 201 for successfully created projects
|-
| Example || curl -F "user=/api/v1/profile/2/" -F "title=Fiddle with JS" -F "desc=this file documents my PROGRESS with learning JavaScript" -F "src=@projects/objects.js" -F "screenshot=@projects/img_screen.png" http://127.0.0.1:8000/api/v1/projects/?username=aregee\&api_key=531ffb6152171df4f60b1b09f09dd1b4c5aba99
|-
| PATCH /api/v1/projects/<id>/ || Updates the changed field to an existing project in the form of json data.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X PATCH --data '{"title":"Gallery Lock ++ " }' http://127.0.0.1:8000/api/v1/projects/1/?username=aregee\&api_key=531ffb6152171df4f60b1b09f09dd1b4c5aba99
|-
| PUT /api/v1/projects/<id>/ || We can also use the HTTP PUT request to update all the fields of an existing project
|-
| DELETE /api/v1/projects/<id>/ || Destroys the current project and the resource related to it : Likes , Comments
|-
|}

==== Project Forking ====

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/forking/<project_id>/ || Currently to fork a project , authenticated user makes GET request to this end point with the project id they need to fork.This method creates a copy of the requested project and associates it to the requesting User's profile.There is a history field in the Project to hold the data about original creator of the project.
|-
| Example || curl http://moksaya-rahulgaur.rhcloud.com/api/v1/forking/2/?username=vrinda\&api_key=b7c19215d088591e2dee07c2fb4df677ab1c9fbe
|-
| Response || {
"desc": "undefined",
"history": "project undefined created by aregee forked by vrinda ",
"resource_uri": "/api/v1/forking/2/",
"screenshot": "/media/projects/lin.jpg",
"shared_date": "2013-09-20T19:07:57.861892",
"src": "/media/projects/file_rem.py",
"title": "undefined"
}
|-
|}

==== Followers ====

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/relations/ || Returns a list of all the user relations with their resource.
|-
| POST /api/v1/relations/ || To create a follower/followee relation between the two user we pass a JSON data with the resource_uri of the currently logged in user's profile as follower and viewed profile of the user as followee . Returns HTTP 201 Created Response and each relations has its own id and other meta deta.
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X POST --data '{"follower":"/api/v1/profile/3/","followee":"/api/v1/profile/4/"}' http://127.0.0.1:8000/api/v1/relations/?username=vrinda\&api_key=b7c19215d088591e2dee07c2fb4df677ab1c9fbe
|-
| DELETE /api/v1/relations/<id>/ || Making a delete request to a relation , deletes the unilateral relation between the user.
|}

==== UI/UX ====
The User interface and user experience of the site is an essential feature , we have to get this part right as this whole project's target audience is Kids so the UI should be simple yet should be attractive to kids and the user experience should be done in a way such that if kids use the site ,they are comfortable with all the functionality being offered by the site and engage on the site.
Here are some of my Design Approach :
<gallery>
File:Moksha_1.png|Landing Page
File:Moksha_2.png|User Profiles
File:Moksha_3.png|Responsive Design
</gallery>

I am planning to stage the site on PaaS platform maybe like OpenShift , however there have been certains glitches with my Openshift account but I will try to work it out or consider some other feasible alternative.
I am doing this because with this approach I would be able to get user feedback from community members side by side with my development efforts and hence I can iterate and improve with their feedbacks.

=== Site Model ===
I have planed to design the RESTful interface to the Moksaya project , and I plan to consume these APIs with a webapp possibly written with [http://backbonejs.org/ Backbone.js]
Initially Moksaya project offers a RESTful interface to the following interrelated models :
*ProfileResource
*ProjectResource
*CommentResource
*LikeResource
*ForkResource

At the Top most level Profile/list contains all the User Profiles along with their Related Resources.
So , a typical user profile contains User info like About , Birthdays etcs then the Related Resources Projects , Friends List , Likes on Projects (Can be easily extended for comments or other models).
Most of these Related Resources can be accessed individually as well.

* Top Level View : http://127.0.0.1:8000/api/v1/profile/list/

{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 3
},
"objects": [
{
"about_me": "DjangoNaut",
"birth_date": "1991-06-20",
"friends": [
"testuser",
"SomeDude"
],
"gender": 1,
"language": "en",
"location": "India",
"mugshot": "/media/mugshots/d749832b7a.jpg",
"privacy": "registered",
"projects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
},
{
"Likes": 0,
"comment": [],
"desc": "This is my first hello world code",
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-07-04T19:18:23.307241",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
}
],
"user": "aregee",
"website": "http://rahulgaur.info/"
},
{
"about_me": "Profile BIO",
"birth_date": "2013-06-26",
"friends": [
"aregee",
"SomeDude"
],
"gender": 2,
"language": "en",
"location": "Delhi",
"mugshot": null,
"privacy": "registered",
"projects": [
{
"Likes": 3,
"comment": [],
"desc": "This is my first hello world code",
"owner": "testuser",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-06-27T15:31:22.560494",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
},
{
"Likes": 0,
"comment": [],
"desc": "Wired Hack ",
"owner": "testuser",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-07-04T19:37:54.184572",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
}
],
"user": "testuser",
"website": "http://Something.com/"
},
{
"about_me": "Hello I am a dummy User here and I am doing something very amazing",
"birth_date": "2013-07-02",
"friends": [
"aregee",
"testuser"
],
"gender": 1,
"language": "en",
"location": "India",
"mugshot": "/media/mugshots/0ebb9512eb.jpg",
"privacy": "registered",
"projects": [],
"user": "SomeDude",
"website": "http://somedude.com/"
}
]
}

* Individual User Profiles could be further requested as http://127.0.0.1:8000/api/v1/profile/list/2/?format=json
{
"about_me": "Profile BIO",
"birth_date": "2013-06-26",
"friends": [
"aregee",
"SomeDude"
],
"gender": 2,
"language": "en",
"location": "Delhi",
"mugshot": null,
"privacy": "registered",
"projects": [
{
"Likes": 3,
"comment": [],
"desc": "This is my first hello world code",
"owner": "testuser",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-06-27T15:31:22.560494",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
},
{
"Likes": 0,
"comment": [],
"desc": "Wired Hack ",
"owner": "testuser",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-07-04T19:37:54.184572",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
}
],
"user": "testuser",
"website": "http://Something.com/"
}

* Related Resource Projects here can be accessed by http://127.0.0.1:8000/api/v1/projects/?format=json
{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 5
},
"objects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
},
{
"Likes": 3,
"comment": [],
"desc": "This is my first hello world code",
"owner": "testuser",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-06-27T15:31:22.560494",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
},
{
"Likes": 0,
"comment": [],
"desc": "This is my first hello world code",
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-07-04T19:18:23.307241",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
},
{
"Likes": 0,
"comment": [],
"desc": "Wired Hack ",
"owner": "testuser",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-07-04T19:37:54.184572",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
}
]
}

In the above results I have excluded Project ids from the json Response, but similarly each individual project could be accessed and updated by making GET or Post or Put request to http://127.0.0.1:8000/api/v1/projects/<pk>?format=json

* Accessing particular project http://127.0.0.1:8000/api/v1/projects/2/?format=json

{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
}

==Forking==
Lets take a look at how forking works here , though this is not really the best approach but I am doing this for understanding purpose and would figure out the proper solution for this ..
but for now here it is.

* Lets say these are the projects on the Moksaya submitted by the user :
{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 3
},
"objects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"id": 1,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"id": 2,
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
},
{
"Likes": 3,
"comment": [],
"desc": "This is my first hello world code",
"id": 3,
"owner": "testuser",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-06-27T15:31:22.560494",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
}
]
}

* Now I am logged in as aregee , and here is my profile at 127.0.0.1:8000/api/v1/profile/list/1/?format=json

{
"about_me": "DjangoNaut",
"birth_date": "1991-06-20",
"friends": [
"testuser",
"SomeDude"
],
"gender": 1,
"language": "en",
"location": "India",
"mugshot": "/media/mugshots/d749832b7a.jpg",
"privacy": "registered",
"projects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"id": 1,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"id": 2,
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
}
],
"user": "aregee",
"website": "http://rahulgaur.info/"
}

* Now I want to fork the Project with id = 3 created by testuser , so I will make a GET request to 127.0.0.1:8000/api/v1/forking/3/?format=json
{
"Changes": {
"owner": "testuser",
"shared_date": "2013-06-27T15:31:22.560494"
},
"desc": "This is my first hello world code",
"resource_uri": "/api/v1/forking/3/",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-06-27T15:31:22.560494",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
}

The diffs / metadata could be viewed for the changes made , for instance here the response shows the original author of the project and the date it was shared

* Lets take a look at my Profile again at 127.0.0.1:8000/api/v1/profile/list/1/?format=json
{
"about_me": "DjangoNaut",
"birth_date": "1991-06-20",
"friends": [
"testuser",
"SomeDude"
],
"gender": 1,
"language": "en",
"location": "India",
"mugshot": "/media/mugshots/d749832b7a.jpg",
"privacy": "registered",
"projects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"id": 1,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"id": 2,
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
},
{
"Likes": 0,
"comment": [],
"desc": "This is my first hello world code",
"id": 4,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-07-04T20:46:43.062294",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
}
],
"user": "aregee",
"website": "http://rahulgaur.info/"
}

* And the list of projects at 127.0.0.1:8000/api/v1/projects/

{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 4
},
"objects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"id": 1,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"id": 2,
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
},
{
"Likes": 3,
"comment": [],
"desc": "This is my first hello world code",
"id": 3,
"owner": "testuser",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-06-27T15:31:22.560494",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
},
{
"Likes": 0,
"comment": [],
"desc": "This is my first hello world code",
"id": 4,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-07-04T20:46:43.062294",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
}
]
}

Difference among the two Projects can be tracked by Project.objects.get(pk = 4).diff(Project.objects.get(pk = 3)) , its a method provided by the django-forkit app to view changes / differences in the forkable models.
Meta data field needs to bee added to Projects field so that we can save these differences when a project is forked , and every project should contain a link to original creator.

=== TODOS ===

* Add Authentication
* Provide Full CRUD access to authenticated user to the core site functionalities : Like , Comment , UserProfile, Projects etcs
* Improve the forking functionality
* Implement JavaScript Client to consume APIs to get a minimal functional product up and running

Summer of Code/2013/moksaya

2013-09-20T23:56:41Z

Rahul Gaur: /* Progress */

== [http://sanskritdictionary.org/moksaya Moksaya] Project : ==
==== A Dajngo based web app aimed at sharing and collaboration of sugar activities to foster learning and creativity ====

Goal of this project is to implement a Project Sharing site to foster collaboration and sharing of Sugar Activities over the internet.The website upon the completion would also provide REST-API’s , so that the services of the website could be utilised by the Sugar Activities to share the project on the site from within the Sugar Environment.

=== Key Deliverables : ===
Here I have listed the Key features that I am currently working on , however as we go through the course of GSoC new features will be added ,once we have a concrete and stable base infrastructure for the Social Project Sharing site.

* Social Features : Following/Followers , Like , favourites , share , Comments .etc
* Authenticated RESTful API's :Ability to interact with website from various Sugar Activities
* Separate landing pages for different audiences (kids, teachers, parents, etc.)
* Gallery : Ability for users to create portfolio of their projects.

== Repository ==
I am developing this project under the Moksaya branch on my [https://github.com/aregee/moksaya Github].

== REST API v1 Resources ==

==== User Creation ====
{| class="wikitable"
|-
! Resource !! Description
|-
| POST /api/v1/register/ || Makes http POST request with the JSON data to create a new user in the database ,if a user already exist raises HTTP 400 badrequest and returns a Json response with error message "the username already exist" . Returns HTTP 201 for successfully Created User
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X POST --data '{"username" :"user101" , "email" :"user@mail.com" , "password" : "password" }' http://moksaya-rahulgaur.rhcloud.com/api/v1/register/
|-
| Response || HTTP/1.1 201 CREATED Date: Thu, 19 Sep 2013 23:49:52 GMT Server: Apache/2.2.15 (Red Hat) Vary: Accept,Accept-Language,Cookie X-Frame-Options: SAMEORIGIN Content-Language: en-us Location:http://moksaya-rahulgaur.rhcloud.com/api/v1/register/19/
Content-Length: 0
Content-Type: text/html; charset=utf-8
|}

==== Authentication and User Login ====

Requires Username and Password for obtaining the api_keys , and rest of the other resources are accessed with the API Keys.
There are two ways to do it, these are Publicly accessible end points.

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/token/auth/ || Returns the apikey for the requested user, we need to supply the username and password in the request headers .
|-
| Example || curl -k --user "aregee:notebook" http://moksaya-rahulgaur.rhcloud.com/api/v1/token/auth/
|-
| Response || {
"key": "531ffb6152171df4f60b1b09f09dd1b4c5aba997"
}

|-
| POST /api/v1/user/login/ || Another way is to POST the user credentials as a JSON data to this end point and returns User Resource with the API_key . Raises HTTP 401 for unauthorized with error response
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X POST --data '{"username":"user101","password":"notebook" }' http://moksaya-rahulgaur.rhcloud.com/api/v1/user/login/
|-
| Response || HTTP/1.1 200 OK
Date: Fri, 20 Sep 2013 22:16:20 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Content-Type: application/json
Set-Cookie: sessionid=ddb4289b9fe8b2a963bfc540f81559c3; expires=Fri, 04-Oct-2013 22:16:20 GMT; httponly; Max-Age=1209600; Path=/
Transfer-Encoding: chunked

{
"apikey": "03f9a40ddd029b0a773a54f189aaa92d5a07c2d2",
"email": "user@mail.com",
"first_name": "",
"id": 14,
"last_name": "",
"resource_uri": "/api/v1/user/14/",
"username": "user101"
}

|}

==== User Resource ====
Authenticated users can access the User Resource , with the api_key and User Resource supports following authenticated options

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/user/ || Returns the list of all user accounts when accessed with authenticated header but returns requested user's resource when username and api_key supplied in url parameters
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/user/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
| Response || HTTP/1.1 200 OK
Date: Fri, 20 Sep 2013 22:32:23 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Type: application/json
Transfer-Encoding: chunked

{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 1
},
"objects": [
{
"apikey": "feea1175cdb9dde076eb68b5d83857fe2a58a186",
"email": "user@mail.com",
"first_name": "",
"id": 19,
"last_name": "",
"resource_uri": "/api/v1/user/19/",
"username": "akshit"
}
]
}
|-
| GET /api/v1/user/<username>/ || We can also access users with their respective usernames and returns HTTP 401 for resource not found
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/user/aregee/?username=spock\&api_key=d2fe32b15b0b395a5d0e0ea4b7eb1e5d6ea15de7
|-
| Response || HTTP/1.1 200 OK
Date: Fri, 20 Sep 2013 23:05:43 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Type: application/json
Transfer-Encoding: chunked

{
"apikey": "531ffb6152171df4f60b1b09f09dd1b4c5aba997",
"email": "iamaregee@gmail.com",
"first_name": "",
"id": 2,
"last_name": "",
"resource_uri": "/api/v1/user/2/",
"username": "aregee"
}
|-
| DELETE /api/v1/user/<username>/ || Removes the requested <username> from the database .
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X DELETE http://moksaya-rahulgaur.rhcloud.com/api/v1/user/akshit/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
| Response || HTTP/1.1 204 NO CONTENT
Date: Fri, 20 Sep 2013 22:36:22 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Content-Length: 0
Content-Type: text/html; charset=utf-8

|}

==== Profile Resource ====

{| class="wikitable"
|-
! Resource !! Description
|-
| POST /api/v1/profile/ || Making http post to this end point with the json data containing the Profile fields creates a new user profile , which is Related to all the other resources.Returns HTTP 201 response for successfully created user profile , returns HTTP 400 bad request with error response for unsuccessful attempts.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X POST --data '{"user":"/api/v1/user/akshit/" , "about_me" :"Profile Create with CURL"}' http://moksaya-rahulgaur.rhcloud.com/api/v1/profile/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
| GET /api/v1/profile/ || Returns list of all user profiles , throttles twenty results per request.
|-
| GET /api/v1/profile/username/ || Returns ProfileResource for the requested user , returns http 404 if resource is not found.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/profile/akshit/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
| Respone || HTTP/1.1 200 OK
Date: Thu, 19 Sep 2013 23:56:13 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Length: 279
Content-Type: application/json

{
"about_me": "Profile Create with CURL",
"followers": [],
"following": [],
"id": 19,
"language": "en",
"location": "",
"mugshot": null,
"privacy": "registered",
"projects": [],
"resource_uri": "/api/v1/profile/19/",
"user": "akshit"
}
|-
| PUT /api/v1/profile/<username>/ || Updates the Profile Resource field with the supplied JSON data.Currently works with only about_me field but can be extended to include location and mugshot or Avatar fields
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X PUT --data '{"about_me" :"Profile Create & updated with CURL "}' http://moksaya-rahulgaur.rhcloud.com/api/v1/profile/akshit/?username=akshit\&api_key=feea1175cdb9dde076eb68b5d83857fe2a58a186
|-
|}

==== Project Resource ====

{| class="wikitable"
|-
! Resource !! Description
|-
| GET /api/v1/projects/ || Following query returns the list of all the projects submitted by the user.
|-
| GET /api/v1/projects/<id>/ || We can query a particular project with its id. This would return ProjectResource for the requested project id.It also shows related comments and likes on the project.
|-
| Example || curl --dump-header - -H "Content-Type: application/json" -X GET http://moksaya-rahulgaur.rhcloud.com/api/v1/projects/1/?username=spock\&api_key=d2fe32b15b0b395a5d0e0ea4b7eb1e5d6ea15de7

|-

| Response || HTTP/1.1 200 OK
Date: Fri, 20 Sep 2013 23:40:38 GMT
Server: Apache/2.2.15 (Red Hat)
Vary: Accept,Accept-Language,Cookie,Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Language: en-us
Cache-Control: no-cache
Content-Type: application/json
Transfer-Encoding: chunked

{
"Likes": 6,
"comment": [
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/3/",
"text": "This is a Comment :)",
"user": "aregee"
},
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/8/",
"text": "Lets Post another Comment here :D",
"user": "aregee"
},
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/9/",
"text": "But This Kinda Looks Sweet :D",
"user": "aregee"
},
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/29/",
"text": "superb :)",
"user": "nikking1793"
},
{
"entry": "This is My Project",
"resource_uri": "/api/v1/comment/30/",
"text": "superb :)",
"user": "nikking1793"
}
],
"desc": "Hello Project world",
"history": "",
"id": 1,
"resource_uri": "/api/v1/projects/1/",
"screenshot": "/media/projects/lin.jpg",
"shared_date": "2013-09-17T16:44:53.773919",
"src": "/media/projects/try.py",
"title": "This is My Project",
"user": "aregee"
}

|-
| POST /api/v1/projects/ || Making an http POST request to this URI with the Multipart form data in the JSON format creates a new project and Returns HTTP 201 for successfully created projects
|-
| Example || curl -F "user=/api/v1/profile/2/" -F "title=Fiddle with JS" -F "desc=this file documents my PROGRESS with learning JavaScript" -F "src=@projects/objects.js" -F "screenshot=@projects/img_screen.png" http://127.0.0.1:8000/api/v1/projects/?username=aregee\&api_key=531ffb6152171df4f60b1b09f09dd1b4c5aba99
|-
| PATCH /api/v1/projects/<id>/ || Updates the changed field to an existing project in the form of json data.
|-
| Example || curl --dump-header - -H "Content-Type:application/json" -X PATCH --data '{"title":"Gallery Lock ++ " }' http://127.0.0.1:8000/api/v1/projects/1/?username=aregee\&api_key=531ffb6152171df4f60b1b09f09dd1b4c5aba99
|-
| PUT /api/v1/projects/<id>/ || We can also use the HTTP PUT request to update all the fields of an existing project
|-
| DELETE /api/v1/projects/<id>/ || Destroys the current project and the resource related to it : Likes , Comments
|-
|}

==== UI/UX ====
The User interface and user experience of the site is an essential feature , we have to get this part right as this whole project's target audience is Kids so the UI should be simple yet should be attractive to kids and the user experience should be done in a way such that if kids use the site ,they are comfortable with all the functionality being offered by the site and engage on the site.
Here are some of my Design Approach :
<gallery>
File:Moksha_1.png|Landing Page
File:Moksha_2.png|User Profiles
File:Moksha_3.png|Responsive Design
</gallery>

I am planning to stage the site on PaaS platform maybe like OpenShift , however there have been certains glitches with my Openshift account but I will try to work it out or consider some other feasible alternative.
I am doing this because with this approach I would be able to get user feedback from community members side by side with my development efforts and hence I can iterate and improve with their feedbacks.

=== Site Model ===
I have planed to design the RESTful interface to the Moksaya project , and I plan to consume these APIs with a webapp possibly written with [http://backbonejs.org/ Backbone.js]
Initially Moksaya project offers a RESTful interface to the following interrelated models :
*ProfileResource
*ProjectResource
*CommentResource
*LikeResource
*ForkResource

At the Top most level Profile/list contains all the User Profiles along with their Related Resources.
So , a typical user profile contains User info like About , Birthdays etcs then the Related Resources Projects , Friends List , Likes on Projects (Can be easily extended for comments or other models).
Most of these Related Resources can be accessed individually as well.

* Top Level View : http://127.0.0.1:8000/api/v1/profile/list/

{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 3
},
"objects": [
{
"about_me": "DjangoNaut",
"birth_date": "1991-06-20",
"friends": [
"testuser",
"SomeDude"
],
"gender": 1,
"language": "en",
"location": "India",
"mugshot": "/media/mugshots/d749832b7a.jpg",
"privacy": "registered",
"projects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
},
{
"Likes": 0,
"comment": [],
"desc": "This is my first hello world code",
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-07-04T19:18:23.307241",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
}
],
"user": "aregee",
"website": "http://rahulgaur.info/"
},
{
"about_me": "Profile BIO",
"birth_date": "2013-06-26",
"friends": [
"aregee",
"SomeDude"
],
"gender": 2,
"language": "en",
"location": "Delhi",
"mugshot": null,
"privacy": "registered",
"projects": [
{
"Likes": 3,
"comment": [],
"desc": "This is my first hello world code",
"owner": "testuser",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-06-27T15:31:22.560494",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
},
{
"Likes": 0,
"comment": [],
"desc": "Wired Hack ",
"owner": "testuser",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-07-04T19:37:54.184572",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
}
],
"user": "testuser",
"website": "http://Something.com/"
},
{
"about_me": "Hello I am a dummy User here and I am doing something very amazing",
"birth_date": "2013-07-02",
"friends": [
"aregee",
"testuser"
],
"gender": 1,
"language": "en",
"location": "India",
"mugshot": "/media/mugshots/0ebb9512eb.jpg",
"privacy": "registered",
"projects": [],
"user": "SomeDude",
"website": "http://somedude.com/"
}
]
}

* Individual User Profiles could be further requested as http://127.0.0.1:8000/api/v1/profile/list/2/?format=json
{
"about_me": "Profile BIO",
"birth_date": "2013-06-26",
"friends": [
"aregee",
"SomeDude"
],
"gender": 2,
"language": "en",
"location": "Delhi",
"mugshot": null,
"privacy": "registered",
"projects": [
{
"Likes": 3,
"comment": [],
"desc": "This is my first hello world code",
"owner": "testuser",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-06-27T15:31:22.560494",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
},
{
"Likes": 0,
"comment": [],
"desc": "Wired Hack ",
"owner": "testuser",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-07-04T19:37:54.184572",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
}
],
"user": "testuser",
"website": "http://Something.com/"
}

* Related Resource Projects here can be accessed by http://127.0.0.1:8000/api/v1/projects/?format=json
{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 5
},
"objects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
},
{
"Likes": 3,
"comment": [],
"desc": "This is my first hello world code",
"owner": "testuser",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-06-27T15:31:22.560494",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
},
{
"Likes": 0,
"comment": [],
"desc": "This is my first hello world code",
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-07-04T19:18:23.307241",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
},
{
"Likes": 0,
"comment": [],
"desc": "Wired Hack ",
"owner": "testuser",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-07-04T19:37:54.184572",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
}
]
}

In the above results I have excluded Project ids from the json Response, but similarly each individual project could be accessed and updated by making GET or Post or Put request to http://127.0.0.1:8000/api/v1/projects/<pk>?format=json

* Accessing particular project http://127.0.0.1:8000/api/v1/projects/2/?format=json

{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
}

==Forking==
Lets take a look at how forking works here , though this is not really the best approach but I am doing this for understanding purpose and would figure out the proper solution for this ..
but for now here it is.

* Lets say these are the projects on the Moksaya submitted by the user :
{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 3
},
"objects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"id": 1,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"id": 2,
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
},
{
"Likes": 3,
"comment": [],
"desc": "This is my first hello world code",
"id": 3,
"owner": "testuser",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-06-27T15:31:22.560494",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
}
]
}

* Now I am logged in as aregee , and here is my profile at 127.0.0.1:8000/api/v1/profile/list/1/?format=json

{
"about_me": "DjangoNaut",
"birth_date": "1991-06-20",
"friends": [
"testuser",
"SomeDude"
],
"gender": 1,
"language": "en",
"location": "India",
"mugshot": "/media/mugshots/d749832b7a.jpg",
"privacy": "registered",
"projects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"id": 1,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"id": 2,
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
}
],
"user": "aregee",
"website": "http://rahulgaur.info/"
}

* Now I want to fork the Project with id = 3 created by testuser , so I will make a GET request to 127.0.0.1:8000/api/v1/forking/3/?format=json
{
"Changes": {
"owner": "testuser",
"shared_date": "2013-06-27T15:31:22.560494"
},
"desc": "This is my first hello world code",
"resource_uri": "/api/v1/forking/3/",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-06-27T15:31:22.560494",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
}

The diffs / metadata could be viewed for the changes made , for instance here the response shows the original author of the project and the date it was shared

* Lets take a look at my Profile again at 127.0.0.1:8000/api/v1/profile/list/1/?format=json
{
"about_me": "DjangoNaut",
"birth_date": "1991-06-20",
"friends": [
"testuser",
"SomeDude"
],
"gender": 1,
"language": "en",
"location": "India",
"mugshot": "/media/mugshots/d749832b7a.jpg",
"privacy": "registered",
"projects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"id": 1,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"id": 2,
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
},
{
"Likes": 0,
"comment": [],
"desc": "This is my first hello world code",
"id": 4,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-07-04T20:46:43.062294",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
}
],
"user": "aregee",
"website": "http://rahulgaur.info/"
}

* And the list of projects at 127.0.0.1:8000/api/v1/projects/

{
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 4
},
"objects": [
{
"Likes": 3,
"comment": [
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "MAhn this is some awesome shit "
},
{
"entry": "Another story i am covering and i want to test the constrains this time",
"resource_uri": "",
"text": "cool Man comments are returned in APIs"
}
],
"desc": "here is another hack by me and I am doing this right now",
"id": 1,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-01-21_030756.png",
"shared_date": "2013-06-25T18:48:18.205760",
"src": "/media/proejcts/admin.py",
"title": "Another story i am covering and i want to test the constrains this time"
},
{
"Likes": 1,
"comment": [],
"desc": "Wired Hack ",
"id": 2,
"owner": "aregee",
"screenshot": "/media/projects/background.png",
"shared_date": "2013-06-26T05:59:48.445868",
"src": "/media/proejcts/startconky.sh",
"title": "Someting Wong"
},
{
"Likes": 3,
"comment": [],
"desc": "This is my first hello world code",
"id": 3,
"owner": "testuser",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-06-27T15:31:22.560494",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
},
{
"Likes": 0,
"comment": [],
"desc": "This is my first hello world code",
"id": 4,
"owner": "aregee",
"screenshot": "/media/projects/Screenshot_from_2013-02-03_173238.png",
"shared_date": "2013-07-04T20:46:43.062294",
"src": "/media/proejcts/hello.c",
"title": "First Project Upload"
}
]
}

Difference among the two Projects can be tracked by Project.objects.get(pk = 4).diff(Project.objects.get(pk = 3)) , its a method provided by the django-forkit app to view changes / differences in the forkable models.
Meta data field needs to bee added to Projects field so that we can save these differences when a project is forked , and every project should contain a link to original creator.

=== TODOS ===

* Add Authentication
* Provide Full CRUD access to authenticated user to the core site functionalities : Like , Comment , UserProfile, Projects etcs
* Improve the forking functionality
* Implement JavaScript Client to consume APIs to get a minimal functional product up and running

Summer of Code/2013/moksaya

2013-07-05T02:45:17Z

Rahul Gaur: /* Forking */

Summer of Code/2013/moksaya

2013-07-05T02:36:56Z

Rahul Gaur: /* Site Model */

Summer of Code/2013/moksaya

2013-07-05T02:33:56Z

Rahul Gaur: /* Site Model */

Summer of Code/2013/moksaya

2013-07-05T02:16:20Z

Rahul Gaur: /* Site Model */

Summer of Code/2013/moksaya

2013-07-05T02:09:52Z

Rahul Gaur: /* TODOS */

Summer of Code/2013/moksaya

2013-07-05T02:05:45Z

Rahul Gaur: /* Site Model */

Summer of Code/2013

2013-06-16T21:22:41Z

Rahul Gaur:

[[Summer of Code/2013/Application|A draft copy of our application]]

The proposals were moved to http://wiki.sugarlabs.org/go/GSoC/2013/Proposals

= Approved Projects=

__TOC__

== Sugar Core ==

=== Sugar Framework for writing activity in full HTML5 ===

[[File:Sugarhtml5.png|300px]]

The objective is to develop a JavaScript framework allowing to write Sugar activities in full HTML5/JavaScript. The framework will expose to JavaScript an API to call Sugar features:
* Journal/Datastore,
* Collaboration/Telepathy,
* Toolbar handling,
* Sugar look&feel - for example via a CSS style sheet usable on HTML controls
* Access to Sugar settings (buddy name, colors, current language, ...),
* View source.
Like PhoneGap/Cordova, the framework will come with a template to develop and package easily a new HTML5 activity. A basic tutorial will be include too.
The work could be inspired by the work done with Enyo Framework in [http://booki.flossmanuals.net/make-your-own-sugar-activities/_draft/_v/1.0/developing-sugar-activities-using-html5/ 1]. By the way, the resulting framework should be JavaScript framework agnostic (no need for jQuery, Enyo, ...).

''Mentor'': [mailto:lionel@olpc-france.org Lionel Laské]

''Co-Mentor'': Daniel Narvaez

Level: Advanced

Benefits to the Student: A chance to learn from touching almost every corner of an advanced system.

Benefits to the Community: We'll greatly expand the reach of the project by opening the door to JavaScript programmers. Plus it will force us to clean up our APIs.

Student: Suraj KS

Wiki: http://wiki.sugarlabs.org/go/HTML5_activities

=== Project sharing website ===

Create a Project Hosting Site similar to the Scratch website where kids can share the projects they have created using various Sugar Activities. The site should foster collaboration and sharing of projects. The Web Site should be built using a free web framework so that it can be installed at deployment sites. Some features include:

* Ability to engage and connect with friends and classmates using various Social Networking sites/techniques.
* Ability to post projects from various Sugar Activities (ex: Turtle Blocks, Etoys, Memorize, Physics, etc.)
* Separate landing pages for different audiences (kids, teachers, parents, etc.)
* Section to share kid created art from projects
* Ability for users to create galleries (of their own projects, favorite projects, subject specific topics, etc.)
* Ability to have “private classroom spaces”
* Tools to support community management of the site
* Multi-language support

''Contact'': [[User:MrSteve]]

''Co-mentor'': [[User:dogi]]

Level: Advanced

Benefits to the Student: Learn more about web services

Benefits to the Community: We need more mechanisms for sharing ideas and work. This is low-hanging fruit.

Student: [[User:Rahul Gaur ]]

Wiki: http://wiki.sugarlabs.org/go/Summer_of_Code/2013/moksaya

=== Implement help mechanism for activities using Mallard ===

[http://projectmallard.org/ Mallard] is a mark-up language that makes it easy to provide user help. It would be a nice feature to add Mallard-like help to activities, accessed through a mechanism similar to the view source mechanism. We need to sort through two issues: integration into Sugar and integration into our i18n / L10n system.

''Contact'': [[User:Walter]]

''Co-mentor'': [[User:Aneesh Dogra]]

''Co-mentor'': [[User:Francis]]

Student: Kalpa Welivitigoda

Wiki page: http://wiki.sugarlabs.org/go/GSoC/2013/MallardHelp

Level: Advanced

Benefits to the Student: Learn about lots of cool tools.

Benefits to the Community: Most of our help is in the wiki and in English. This will enable us to reach our users more directly and in their first language.

=== Social Sugar ===

Design and Develop GUI components that can help Sugar to reflect user's social interactions from external platforms. A perfect target can be the Group-View that shows user's friends and their shared activities [http://wiki.sugarlabs.org/go/Human_Interface_Guidelines/The_Laptop_Experience/Zoom_Metaphor#Groups], but it _could_ also show social information about these friends, IE social networks or sharing platforms publications. This would also give this zoom-level added value.

Community members are already working on the backend component to support this feature [http://lists.sugarlabs.org/archive/sugar-devel/2013-March/042055.html]. This is also a great opportunity to complement other GSoC-2013 proposals.

''Contact'': [[User:tch]]

Level: Intermediate

Benefits to the Student: (a) Learn about Sugar's core, UI Design and web services and (b) interact with community members and other GSoC participants.

Benefits to the Community: Social interaction is a key element in the learning process, therefore we should promote this.

Student: Akshit Khurana

Wiki: http://wiki.sugarlabs.org/go/Summer_of_Code/2013/Social_Sugar_project

== Sugar Activities ==

=== Python export functionality for Turtle Blocks ===

[[File:TurtleArt.svg]] [[File:Pippy.svg]]

A goal of Turtle Blocks is not just to get children programming, but to launch them out of block world into text-based languages where they can develop more sophisticated programs. While Turtle Blocks is written in Python and can be extended by importing Python modules, it currently exports only in its native block language and in Logo. For this project, we'd want to enable a Python export option so that programmers can take their Turtle projects and extend them into full-fledged Python projects. The hypothesis is that this would lead more children to grow their programming skills beyond simple block programs.

''Contact'': [[User:Walter]]

''Co-mentor'': Tony Forster

Level: Advanced

Benefits to the Student: Lots of good Python hacking involved

Benefits to the Community: We'll have a vehicle for studying whether or not we can bring students of programming from block worlds to text-based programming and debugging.

Student: Marion Zepf

Wiki: [[Summer of Code/2013/Turtle Blocks Python export project]]

=== Add recording to Music Keyboard activity ===

[[File:Music keyboard screenshot.png]]

Music Keyboard activity uses part of TamTamMini code to play sounds. Should be good add the capability of record the played sound.

Requires familiarity with Python.

''Contact'': [[User:Godiard]]

Level: Beginner

Benefits to the Student: Learn about python and music libraries (csound)

Benefits to the Community: More shared spaces for expression is aligned with our pedagogical goals.

'''More information ''' http://wiki.sugarlabs.org/go/Activities/MusicKeyboard

Student: Anna Rudkovskaya

Wiki:

=== ASL Open Video Chat ===

Open Video Chat is an Free/Open Source video conferencing activity for the XO laptop. This project was originally started in March 2010 with funding from the National Technical Institute for the Deaf in Rochester NY.

'''Focus'''

The primary focus of Open Video Chat is to provide streaming video at frame rates that are suitable for communicating with sign language. This ends up being somewhere between 20 and 30 frames per second.

'''Current Features'''
* 20 FPS video
* preview window
* text chat

'''Desired Features'''
*RTP protocol implementation
*faster frame rate (30+ FPS)
*audio
*higher resolution video

IRC
* The contributors of Open Video Chat frequent #rit-foss on freenode

''Contact'': [[User:decause]]

Level: Intermediate/Advanced

Benefits to the Student: Learn about gstreamer video pipelines. Learn about sugar networking stack and services (Telepathy). Learn about Python and Sugar UI.

Benefits to the Community: The Video/Text chat software is nearly complete (90%), it just needs to be ported to latest version of sugar and include new telepathy bindings.

Source Code: [https://github.com/FOSSRIT/Open-Video-chat Github Repository]
Activity Page: [http://activities.sugarlabs.org/en-US/sugar/addon/4305 A.SL.O]

Student: Casey DeLorme

Wiki:

== Infrastructure ==

=== Translation Server ===

Student: Erik Price

Wiki:

Summer of Code/2013/moksaya

2013-06-16T21:18:25Z

Rahul Gaur: Created page with "== [http://sanskritdictionary.org/moksaya Moksaya] Project : == ==== A Dajngo based web app aimed at sharing and collaboration of sugar activities to foster learning and creat..."

File:Moksha 3.png

2013-06-16T20:21:46Z

Rahul Gaur:

File:Moksha 2.png

2013-06-16T20:17:12Z

Rahul Gaur:

File:Moksha 1.png

2013-06-16T20:15:25Z

Rahul Gaur:

User talk:Rahul Gaur

2013-04-29T04:32:54Z

Rahul Gaur: Created page with "<nowiki>Insert non-formatted text here</nowiki> Application for Summer of Code 2013 : Rahul Gaur (Draft ) '''Student Information''' * Name : Rahul Gaur * Email: rahul.nbg@gma..."

<nowiki>Insert non-formatted text here</nowiki>
Application for Summer of Code 2013 : Rahul Gaur
(Draft )
'''Student Information'''
* Name : Rahul Gaur
* Email: rahul.nbg@gmail.com
* Telephone: +91-8057019438
* IRC handle :iamaregee2@irc.freenode.net
* Source control username ::
* GitHub : aregee
* Launchpad: rahul-nbg
* SugarLabs Wiki : Rahul_Gaur
* IM information:
* Gtalk : rahul.nbg
* Skype: iamaregee1
* Twitter:iamaregee
* Primary Language: English
* Home Page :: http://www.rahulgaur.info
* Blog(s):http://www.rahulgaur.info/blog/
* Location : New Delhi/ NCR , India
* Prefered Timings : 15:00 hrs to 23:00 hrs (UTC)
* University : Chaudhary Charan Singh University , Meerut
* Major : Computer Science and Engineering
* Current Year : Third Year
* Expected Graduation date : June 2014
* Degree: Bachelor of Technology
* Experience : I have not been involved with any Open Source project(coding), but most of the work I do is Open Source and it could be found on my github page.I want to get involved with an Open Source project and contribute to it because most of the resources, softwares and the programing skills I have achieved so far is mainly possible because of the Open Source community.If I get this project , it would offer me a possibility to contribute back to the community.

'''Project Sharing WebSite for SugarLabs'''

'''Project Synopsis :'''

Goal of this project is to implement a Project Sharing site to foster collaboration and sharing of Open source projects over the internet.The website upon the completion would also provide REST-API’s , so that the services of the website could be utilised by the Sugar Activities to share the project on the site and it will also provide the third party developers to integrate the services in their own apps.

Over the course of GSOC , there would be lot of additions and removal of unwanted components from the project , which would be based on discussing various ideas with the community.

I have been coding in Python since last three years and I recently started with JavaScript , HTML5 , CSS3 . I plan to put all these together in my project.

I am using Django with bootstrap(twitter) for my Mock Up and it's responsive design , so it would be supported by all modern web browsers and mobile/tablet devices.

I am using Django for backend development and I plan to use Django's built in ORM for Database schema.I also have some experience with Pinax project , but I don't intend to use it rather I plan to use numerous social feature apps in pinax leveraging the ability of pluggable apps offered by Django.

The apps that I could easily integrate with my project are notification , login , authentication , sign up and OAuth authentication app just to name a few provided by the pinax project.

'''Deliverables :'''

* Social Features : Followers , Like , favourites , share .etc
* Authenticated API's :Ability to post projects from various Sugar Activities
* Separate landing pages for different audiences (kids, teachers, parents, etc.)
* Gallery : Ability for users to create portfolio of their projects.
* Multi-language support : Adding support for international Languages

In this project my main efforts will be three major task to complete.Despite that , all three enhance the sharing , collaboration and learning efforts with Sugar.

'''Roadmap:'''
* '''Phase 1 ~'''
:*May 27th ~ June 7th :
My University exams would probably be over by this time , and this is the time I would start working full time on my project.
I am planing to use Django/Python to develop this Website
During this week I would do my research , community bonding , going through the Source Code.
Completing My Proof of Concept/ Mockup .
Discussing my strategy with the community and my mentor .
:*June 10th ~ June 17th:
I would start fleshing out the code from my proof of concept stage to more functional stage .
During this time I would be working on developing the frontend for the site.
I would be using bootstrap with django to achieve this goal.
I aim to setup a basic infrastructure with things like authentication, user profiles , project details and galleries by this time.

* '''Phase 2 ~'''
:*June 18th ~ July 18th :
Authentication / Authorization : As of now , for my proof of concept I am considering OAuth as , I haven't worked much with OAuth , I just have a very superficial knowledge of Open Id and Open Authentication protocols and their working. I have already started learning about OAuth and I hope to be in a better state when I reach this time frame.
However the final implementation would be based on discussing ins and outs of OAuth and other similar alternatives.
I also plan to integrate features like FB connect, Twitter connect and Google connect, so that users can connect and avail the services using their existing id’s.
I am planing to implement Facebook API’s to offer ‘Share’ ‘Like’ ‘Comment’ and similar features for twitter.
These features would enable users to share their projects with friends and family who are not on Sugar Labs (project sharing site) . Thus would enable Sugar Project to reach to a wider audience .
:*July 19th ~ August 1st :
By the time we reach the mid-term evaluation , my goal would be to have a functional authentication and authorization mechanism along with the other basic social networking services up and running by this time.
This is the Time I would start implementing REST-API’s for my project.
I plan to use on of the following frameworks to do so :
Django-REST-Framework - [0]
Django-Tastypie - [1]
I have done quick example apps for both the frameworks which could be found on my Github repos.
I am yet to study the above frameworks more deeply , so the final choice for this would be made after discussing and evaluating both the frameworks for different scenarios.
Making sure that Authorization/Authentication module and APIs play nice with each other .
Do my documentation and testing my work and blogging about the achieved milestones .
Adding Multi Language support.

* '''Phase 3 ~'''
:*August 2nd ~ August 15th :
During this time frame , my main objective will be to write a python wrapper for the REST-API’s offered by the WebSite.
This python client would make it easier for the developers to further integrate the web services offered by the website into their own work.
Integrate Project sharing features into the existing Sugar Activities . This would require better understanding of the Core Sugar Codebase.
I would be doing mostly examples on how to achieve this functionality.
Writing Documentation to help other developers on how to integrate the services with other Sugar Activities.
:*August 15th ~ September 1st :
I have taken some amount of cushion time in the above to account and adjust for any unforeseen circumstances.
If there is any major change we have to make and start certain aspects of project from the scratch , this cushion time would allow for accommodating those changes in the project.
I plan to dedicate this time frame specially towards improving the code quality , fixing bugs improving efficiency testing performance and quality of the code written.
This stage will be followed by writing and improving the documentations for the newly added features and APIs.
Tidying up any lose ends and ensuring that the code is properly organized and documented..
Making sure everything which I did is available on Launchpad/Github and other source repositories.

:*September 1st ~ September 22nd :
By this time I would be reaching the firm pencil down date.
Initially I plan to stage this project on Openshift platform by redhat.
This would allow me to gain real time user feedback on my work.
Even Though the load handling capabilities would be low on Openshift (free account) , but this would give us an idea how the projects performs under production environment..
Perfecting any design requires lot of patience and time, so I plan to dedicate this time frame specifically towards perfecting my project.
Key point to gain traction on any web service is consistency in design , layout , performance and constant user feedback..
I have a limited experience with web development, but what I feel is the real time consuming part is not about the design and layout even though no design is perfect and there is something new to add every time.
What really consume time is finalizing the project , so it could serve it’s actual purpose ie: be useable.
I would be reviewing my code , improving it as per the user feedback in order to provide a better user experience.

Links ~ Below I have provided links to some of my experimental work I am doing for this project:
[0] : https://github.com/aregee/restful
[1]: https://github.com/aregee/restpie
[2] - https://github.com/aregee/sugar-labs_project

My Previous Work :
Most of the work I do is Open Source , here is a link to my GitHub Profile - https://github.com/aregee.
Most of the technologies I plan to use for this project are the ones I have some amount of previous experience.It’s just that I haven’t used them all together ,but my elementary fundas for these technologies is strong .
Here is the link to my first Django app staged on OpenShift :http://resworks-rahulgaur.rhcloud.com
My college doesn’t have an online portal to serve Examination Results online , so I took the opportunity to participate under KRDS - Facebook hackathon couple of months back and developed this app.Over the last two - three months , I am working closely with my college administration and professor on this Application.By the time the next college session starts , I hope to deploy this app on cloud , but College Administration is insisting to deploy app on the college servers only.We are working very dedicatedly on this project and we hope to release this project along with couple of additional modules and currently we are working on adding attendance module to this project .
Recently I did some frontend web development for the college . The Cultural Society of my college was organizing Technical Fest , so for that I designed a website leveraging javascript library impress.js along with HTML5 and CSS3. http://www.scrietscs.org .
I have been coding in python for last three years , and I have been using it for all sorts of purpose which range from writing scripts handle things like deploying code on cloud , exploiting and experimenting something or other with python for android.
I am highly self motivated , pro foss and dedicated learner and If provided an opportunity , I am confident enough that I can complete this project in the above mentioned timeline.
I believe that completing this project will help me to gain some sense of how real world software development takes place and benefit me with the understanding of teamwork plus time management so that when I graduate from the college next year I would have most of the skills needed to begin a career in web development.

Profit for SugarLabs
Facilitate the users of the Sugar Labs with an ability to share their work on a platform which would promote collaborative learning and development of projects.The site would have social networking features and integration with the popular social networking services would help the projects and the Sugar community to reach to a wider audience.
I plan to deploy and develop my project on Openshift and add upstream to github , with a copy of app deployed on OpenShift we can get real time feedback from the users and improve upon the work.I think there must be number of people from New Delhi/NCR area involved with Sugar Labs.We can meetup and initially plan a deployment of Sugar platform at some public school nearby (probably after mid-term evaluation).I can also get some help from IIT-Delhi Linux User group , they are helpful breed of coders :) .
There are times when we do get struck and I agree it could be demotivating and one feels lost without a proper guidance.Best way to overcome such situations is to be composed and documentation plus source code.I use lots of open source technologies everyday and at times I feel the need to customize the code or make some changes to it.Knowing what you want and how to do it is not the key , I feel the key is Documentation and understanding the source code.What I have experienced is that most of the time I know what I have to do , but I just couldn’t figure out what part of code do I need to change.So sticking with the rule of thumb , I would go for documentation and source code of the technology I am using as this gives me brief idea about how the particular function/feature is designed and how it works.
I would be doing a weekly blogs over the weekend covering the hardships and achievements which I have accomplished over the week.Besides this I would be communicating my work over the mailing list and I am also active on the IRC , so this would help me to discuss my problems and share my progress over the course of GSOC.

Miscellaneous:
I would probably fit in a T-Shirt of L (Male) size ;)
As a kid , one of the best learning experience I had has been with the Computers and precisely WEB. Internet and world wide web is what that has fascinated me and nothing else comes even close.The Web and computers has given me/ even whole mankind a power to share the ideas , knowledge , earn a living and do good to society in a million ways.I had my first “wow” moment way back in 5th grade I guess.I had just started with internet and one day while browsing some site on IE , I accidently clicked *view source* and there was whole lot of text on my screen which I could correlate to the webpage I was browsing.Quickly I realized that I could save the source and make changes to the text part to display some text that I want.That’s the moment when I realized that what I want to do in my life.I wanted to create websites .Another such *wow* moment came when I switched to Ubuntu/Linux way back in high school ;-)
Ever Since I joined the college (3 years now ) , I have been actively promoting FOSS and helping kids to get started with Coding/familiarising them with computers.Giving presentations around my neighbourhood to foster better learning skills and evangelising foss technology , be it my college or my school. I try to present a picture that coding is fun , interesting and show kids lots of demonstration of *cool* programs that they could make easily and which does accomplish certain task like writing a script to hide files on their computers/mobiles instead of demonstrating how to generate the Fibbonaci series and calculate the golden ratio :). Once they develop interest in coding and computers , they move to the harder and algorithmic problems.
Here is a link to one such presentation I recently gave at my college : http://aregee.github.io/demo-impress.js/
I am dedicating my full summer time to my GSoC Project , here I would like to sate my schedule.I have my End Semester exams running upto 27th of May , this would be the time when I would be occupied with College and my involvement would be low. I would be in touch over the emails.Besides this I have a preplanned family in the end of June (24th to 28th) which would consume my four days apart from this my goal is to work full time on my Project.

Summer of Code/Student application template

2013-04-29T04:20:31Z

Rahul Gaur: Undo revision 87682 by Rahul Gaur (talk)

<noinclude>{{TOCright}}
[[Category:2010 GSoC applications]]
[[Category:GSoC]]
</noinclude>

Please apply also in [http://socghop.appspot.com melange, google's web app]; if you do not apply there '''before''' [http://socghop.appspot.com/document/show/gsoc_program/google/gsoc2010/timeline April 9], we will not be able to accept your application.

Please keep an eye on your talk page (the "discussion" link above). If you hit "watch" above, you can set up your "prefs" to email you the first time it changes since you last saw it.

====About you====

# What is your name?
# What is your email address?
# What is your Sugar Labs wiki username?
# What is your IRC nickname?
# What is your primary language? (We have mentors who speak multiple languages and can match you with one of them if you'd prefer.)
# Where are you located, and what hours do you tend to work? (We also try to match mentors by general time zone if possible.)
# Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects, or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?

====About your project====

# What is the name of your project?
# Describe your project in 10-20 sentences. What are you making? Who are you making it for, and why do they need it? What technologies (programming languages, etc.) will you be using?
# What is the timeline for development of your project? The Summer of Code work period is 7 weeks long, May 23 - August 10; tell us what you will be working on each week. (As the summer goes on, you and your mentor will adjust your schedule, but it's good to have a plan at the beginning so you have an idea of where you're headed.) Note that you should probably plan to have something "working and 90% done" by the midterm evaluation (July 6-13); the last steps always take longer than you think, and we will consider cancelling projects which are not mostly working by then.
# Convince us, in 5-15 sentences, that you will be able to successfully complete your project in the timeline you have described. This is usually where people describe their past experiences, credentials, prior projects, schoolwork, and that sort of thing, but be creative. Link to prior work or other resources as relevant.

====You and the community====

# If your project is successfully completed, what will its impact be on the Sugar Labs community? Give 3 answers, each 1-3 paragraphs in length. The first one should be yours. The other two should be answers from members of the Sugar Labs community, at least one of whom should be a Sugar Labs GSoC mentor. Provide email contact information for non-GSoC mentors.
# Sugar Labs will be working to set up a small (5-30 unit) Sugar pilot near each student project that is accepted to GSoC so that you can immediately see how your work affects children in a deployment. We will make arrangements to either supply or find all the equipment needed. Do you have any ideas on where you would like your deployment to be, who you would like to be involved, and how we can help you and the community in your area begin it?
# What will you do if you get stuck on your project and your mentor isn't around?
# How do you propose you will be keeping the community informed of your progress and any problems or questions you might have over the course of the project?

====Miscellaneous====
[[Image:New-developer-challenge.png|thumb|right|An example of the kind of screenshot of your first modification to your development environment which you should include in your application. Note that the drop-down menu text has Mel's email address in place of the word "Restart" - your screenshot should contain your email instead.]]
# We want to make sure that you can set up a [[Development Team#Development_systems|development environment]] before the summer starts. Please send us a link to a screenshot of your Sugar development environment with the following modification: when you hover over the XO-person icon in the middle of Home view, the drop-down text should have your email in place of "Restart." See the image on the right for an example. It's normal to need assistance with this, so please visit our IRC channel, #sugar on irc.freenode.net, and ask for help.
# What is your t-shirt size? (Yes, we know Google asks for this already; humor us.)
# Describe a great learning experience you had as a child.
# Is there anything else we should have asked you or anything else that we should know that might make us like you or your project more?

Note: you will post this application on the wiki in the category [[:Category:2010 GSoC applications]]. We encourage you to browse this category and comment on the talk page of other applications. Also, others' comments and your responses on the talk page of your own application are viewed favorably, and, while we don't like repetitive spam, we welcome honest questions and discussion of your project idea on the mailing list(s) (primarily [http://lists.sugarlabs.org/listinfo/sugar-devel sugar-devel] for technical issues and [http://lists.sugarlabs.org/listinfo/iaep It's An Education Project] for educational issues) and/or [[IRC]].

The NeL project has some good general recommendations for [http://dev.ryzom.com/projects/nel/wiki/GSoC2009WritingProposals writing proposals]. We endorse them all; although Sugar is (regrettably) not test driven development (yet - your project could change that!), we encourage GSoC code to include tests.

Summer of Code/Student application template

2013-04-29T04:16:45Z

Rahul Gaur:

<noinclude>{{TOCright}}
[[Category:2013 GSoC applications]]
[[Category:GSoC]]
</noinclude>

====About you====

* What is your name?
Rahul Gaur
* What is your email address?
rahul.nbg@gmail.com
* What is your Sugar Labs wiki username?
Rahul_Gaur
* What is your IRC nickname?
iamaregee2@irc.freenode.net

* What is your primary language?
I speak english and hindi
* Where are you located, and what hours do you tend to work?
I live in New Delhi/NCR and I have flexible work hours and I am online between 15:00 hrs to 23:00 hrs (UTC)
* Have you participated in an open-source project before? If so, please send us URLs to your profile pages for those projects, or some other demonstration of the work that you have done in open-source. If not, why do you want to work on an open-source project this summer?
I have not been involved with any Open Source project, but most of the work I do is Open Source and it could be found on my github page.I want to get involved with an Open Source project and contribute to it because most of the resources, softwares and the programing skills I have achieved so far is mainly possible because of the Open Source community.If I seek GSOC as opportunity to contribute back to the community.

====About your project====

* What is the name of your project?
Project Sharing WebSite for SugarLabs
* Describe your project in 10-20 sentences. What are you making? Who are you making it for, and why do they need it? What technologies (programming languages, etc.) will you be using?

Goal of this project is to implement a Project Sharing site to foster collaboration and sharing of Open source projects over the internet.The website upon the completion would also provide REST-API’s , so that the services of the website could be utilised by the Sugar Activities to share the project on the site and it will also provide the third party developers to integrate the services in their own apps.

Over the course of GSOC , there would be lot of additions and removal of unwanted components from the project , which would be based on discussing various ideas with the community.

I have been coding in Python since last three years and I recently started with JavaScript , HTML5 , CSS3 . I plan to put all these together in my project.

I am using Django with bootstrap(twitter) for my Mock Up and it's responsive design , so it would be supported by all modern web browsers and mobile/tablet devices.

I am using Django for backend development and I plan to use Django's built in ORM for Database schema.I also have some experience with Pinax project , but I don't intend to use it rather I plan to use numerous social feature apps in pinax leveraging the ability of pluggable apps offered by Django.

The apps that I could easily integrate with my project are notification , login , authentication , sign up and OAuth authentication app just to name a few provided by the pinax project.

Deliverables :

*Social Features : Followers , Like , favourites , share .etc
*Authenticated API's :Ability to post projects from various Sugar Activities
*Separate landing pages for different audiences (kids, teachers, parents, etc.)
*Gallery : Ability for users to create portfolio of their projects.
*Multi-language support : Adding support for international Languages

In this project my main efforts will be three major task to complete.Despite that , all three enhance the sharing , collaboration and learning efforts with Sugar.

* What is the timeline for development of your project?

Roadmap:

*Phase 1 ~
*May 27th ~ June 7th :
My University exams would probably be over by this time , and this is the time I would start working full time on my project.
I am planing to use Django/Python to develop this Website
During this week I would do my research , community bonding , going through the Source Code.
Completing My Proof of Concept/ Mockup .
Discussing my strategy with the community and my mentor .
*June 10th ~ June 17th:
I would start fleshing out the code from my proof of concept stage to more functional stage .
During this time I would be working on developing the frontend for the site.
I would be using bootstrap with django to achieve this goal.
I aim to setup a basic infrastructure with things like authentication, user profiles , project details and galleries by this time.

*Phase 2 ~
*June 18th ~ July 18th :
Authentication / Authorization : As of now , for my proof of concept I am considering OAuth as , I haven't worked much with OAuth , I just have a very superficial knowledge of Open Id and Open Authentication protocols and their working. I have already started learning about OAuth and I hope to be in a better state when I reach this time frame.
However the final implementation would be based on discussing ins and outs of OAuth and other similar alternatives.
I also plan to integrate features like FB connect, Twitter connect and Google connect, so that users can connect and avail the services using their existing id’s.
I am planing to implement Facebook API’s to offer ‘Share’ ‘Like’ ‘Comment’ and similar features for twitter.
These features would enable users to share their projects with friends and family who are not on Sugar Labs (project sharing site) . Thus would enable Sugar Project to reach to a wider audience .
*July 19th ~ August 1st :
By the time we reach the mid-term evaluation , my goal would be to have a functional authentication and authorization mechanism along with the other basic social networking services up and running by this time.
This is the Time I would start implementing REST-API’s for my project.
I plan to use on of the following frameworks to do so :
Django-REST-Framework - [0]
Django-Tastypie - [1]
I have done quick example apps for both the frameworks which could be found on my Github repos.
I am yet to study the above frameworks more deeply , so the final choice for this would be made after discussing and evaluating both the frameworks for different scenarios.
Making sure that Authorization/Authentication module and APIs play nice with each other .
Do my documentation and testing my work and blogging about the achieved milestones .
Adding Multi Language support.

*Phase 3 ~
*August 2nd ~ August 15th :
During this time frame , my main objective will be to write a python wrapper for the REST-API’s offered by the WebSite.
This python client would make it easier for the developers to further integrate the web services offered by the website into their own work.
Integrate Project sharing features into the existing Sugar Activities . This would require better understanding of the Core Sugar Codebase.
I would be doing mostly examples on how to achieve this functionality.
Writing Documentation to help other developers on how to integrate the services with other Sugar Activities.
August 15th ~ September 1st :
I have taken some amount of cushion time in the above to account and adjust for any unforeseen circumstances.
If there is any major change we have to make and start certain aspects of project from the scratch , this cushion time would allow for accommodating those changes in the project.
I plan to dedicate this time frame specially towards improving the code quality , fixing bugs improving efficiency testing performance and quality of the code written.
This stage will be followed by writing and improving the documentations for the newly added features and APIs.
Tidying up any lose ends and ensuring that the code is properly organized and documented..
Making sure everything which I did is available on Launchpad/Github and other source repositories.

*September 1st ~ September 22nd :
By this time I would be reaching the firm pencil down date.
Initially I plan to stage this project on Openshift platform by redhat.
This would allow me to gain real time user feedback on my work.
Even Though the load handling capabilities would be low on Openshift (free account) , but this would give us an idea how the projects performs under production environment..
Perfecting any design requires lot of patience and time, so I plan to dedicate this time frame specifically towards perfecting my project.
Key point to gain traction on any web service is consistency in design , layout , performance and constant user feedback..
I have a limited experience with web development, but what I feel is the real time consuming part is not about the design and layout even though no design is perfect and there is something new to add every time.
What really consume time is finalizing the project , so it could serve it’s actual purpose ie: be useable.
I would be reviewing my code , improving it as per the user feedback in order to provide a better user experience.

Links ~ Below I have provided links to some of my experimental work I am doing for this project:
[0] : https://github.com/aregee/restful
[1]: https://github.com/aregee/restpie
[2] - https://github.com/aregee/sugar-labs_project

# Convince us, in 5-15 sentences, that you will be able to successfully complete your project in the timeline you have described.

Most of the work I do is Open Source , here is a link to my GitHub Profile - https://github.com/aregee.
Most of the technologies I plan to use for this project are the ones I have some amount of previous experience.It’s just that I haven’t used them all together ,but my elementary fundas for these technologies is strong .
Here is the link to my first Django app staged on OpenShift :http://resworks-rahulgaur.rhcloud.com
My college doesn’t have an online portal to serve Examination Results online , so I took the opportunity to participate under KRDS - Facebook hackathon couple of months back and developed this app.Over the last two - three months , I am working closely with my college administration and professor on this Application.By the time the next college session starts , I hope to deploy this app on cloud , but College Administration is insisting to deploy app on the college servers only.We are working very dedicatedly on this project and we hope to release this project along with couple of additional modules and currently we are working on adding attendance module to this project .
Recently I did some frontend web development for the college . The Cultural Society of my college was organizing Technical Fest , so for that I designed a website leveraging javascript library impress.js along with HTML5 and CSS3. http://www.scrietscs.org .
I have been coding in python for last three years , and I have been using it for all sorts of purpose which range from writing scripts handle things like deploying code on cloud , exploiting and experimenting something or other with python for android.
I am highly self motivated , pro foss and dedicated learner and If provided an opportunity , I am confident enough that I can complete this project in the above mentioned timeline.
I believe that completing this project will help me to gain some sense of how real world software development takes place and benefit me with the understanding of teamwork plus time management so that when I graduate from the college next year I would have most of the skills needed to begin a career in web development.

====You and the community====

*Profits for Sugar Labs

Facilitate the users of the Sugar Labs with an ability to share their work on a platform which would promote collaborative learning and development of projects.The site would have social networking features and integration with the popular social networking services would help the projects and the Sugar community to reach to a wider audience.
I plan to deploy and develop my project on Openshift and add upstream to github , with a copy of app deployed on OpenShift we can get real time feedback from the users and improve upon the work.I think there must be number of people from New Delhi/NCR area involved with Sugar Labs.We can meetup and initially plan a deployment of Sugar platform at some public school nearby (probably after mid-term evaluation).I can also get some help from IIT-Delhi Linux User group , they are helpful breed of coders :) .
There are times when we do get struck and I agree it could be demotivating and one feels lost without a proper guidance.Best way to overcome such situations is to be composed and documentation plus source code.I use lots of open source technologies everyday and at times I feel the need to customize the code or make some changes to it.Knowing what you want and how to do it is not the key , I feel the key is Documentation and understanding the source code.What I have experienced is that most of the time I know what I have to do , but I just couldn’t figure out what part of code do I need to change.So sticking with the rule of thumb , I would go for documentation and source code of the technology I am using as this gives me brief idea about how the particular function/feature is designed and how it works.
I would be doing a weekly blogs over the weekend covering the hardships and achievements which I have accomplished over the week.Besides this I would be communicating my work over the mailing list and I am also active on the IRC , so this would help me to discuss my problems and share my progress over the course of GSOC.

====Miscellaneous====
*I would probably fit in a T-Shirt of L (Male) size.
*As a kid , one of the best learning experience I had has been with the Computers and precisely WEB. Internet and world wide web is what that has fascinated me and nothing else comes even close.The Web and computers has given me/ even whole mankind a power to share the ideas , knowledge , earn a living and do good to society in a million ways.I had my first “wow” moment way back in 5th grade I guess.I had just started with internet and one day while browsing some site on IE , I accidently clicked *view source* and there was whole lot of text on my screen which I could correlate to the webpage I was browsing.Quickly I realized that I could save the source and make changes to the text part to display some text that I want.That’s the moment when I realized that what I want to do in my life.I wanted to create websites .Another such *wow* moment came when I switched to Ubuntu/Linux way back in high school ;-)
*Ever Since I joined the college (3 years now ) , I have been actively promoting FOSS and helping kids to get started with Coding/familiarising them with computers.Giving presentations around my neighbourhood to foster better learning skills and evangelising foss technology , be it my college or my school. I try to present a picture that coding is fun , interesting and show kids lots of demonstration of *cool* programs that they could make easily and which does accomplish certain task like writing a script to hide files on their computers/mobiles instead of demonstrating how to generate the Fibbonaci series and calculate the golden ratio :). Once they develop interest in coding and computers , they move to the harder and algorithmic problems.
*Here is a link to one such presentation I recently gave at my college : http://aregee.github.io/demo-impress.js/
*I am dedicating my full summer time to my GSoC Project , here I would like to sate my schedule.I have my End Semester exams running upto 27th of May , this would be the time when I would be occupied with College and my involvement would be low. I would be in touch over the emails.Besides this I have a preplanned family in the end of June (24th to 28th) which would consume my four days apart from this my goal is to work full time on my Project.