Joshua : This project is my first software project.

• Learned about the MVC model and REST API MVC helped to organise our code and encapsulate logic, making it easier to collaborate and work on our respective parts
• Learned how to manage sessions using JSON WEB Token Session is still stored in the databse. This allows for a token access to be revoked if neccessary.
• Learned about how "router" work in context of REST API Learned how backend is commonly build upon HTTP protocol and how to design a simple CRUD API for campaigns

• If we were to write another API in PHP, we would use a different router, as Klien support of exception handling is lacking especially for SQL erors
• Image upload feature can be improved as currently the picture needs to be converted to a base 64 string before transmitted

Our implementation of a business logic similar to change.org using vanilla PHP, REST api design and content learned during "Operating System and Networking Module" in SMU.

• SupportMe
• Endpoints
  • 1. Register
    • Request
    • Response
  • 2. Login
    • Request
    • Response
  • 3. Create campaign
    • Request
    • Response
  • 4. Fetch Campaign
    • Request
    • Response - Success 200
    • Response - Fail 204
  • 5. Search Campaign
    • Request
    • Response - Success 200
    • Response - Fail 204
  • 6. Delete Campaign
    • Request
    • Response - Success 200
    • Response - Fail 401
  • 7. Edit Campaign
    • Request
    • Response - Success 200
    • Response - Fail 400
  • 8. Fetch Campaigns by user
    • Request
    • Response - Success 200
    • Response - Fail 204
  • 9. Add Comments
    • Request
    • Response - Success 200
    • Response - Fail 400
  • 10. Edit Comments
    • Request
    • Response - Success 200
    • Response - Fail 400
  • 11. delete Comments
    • Request
    • Response - Success 200
    • Response - Fail 400
  • 12. Get pledge count for a given campaign
    • Request
    • Response - Success 200
    • Response - Fail 400
  • 13. Get list of all pledgers for a given campaign
    • Request
    • Response - Success 200
    • Response - Fail 400
  • 14. Pledge to a given campaign
    • Request
    • Response - Success 200
    • Response - Fail 400
  • 15. Unpledge from a given campaign
    • Request
    • Response - Success 200
    • Response - Fail 400
• Installation
• Database Entity Relationship Schema
• Testing Commands

POST /register

{
  "firstname": "sunset boulevard",
  "lastname": "test",
  "email": "[email protected]",
  "password": 1234
}

{ "message": "Successfully registered" }

POST /login

{
  "email": "[email protected]",
  "password": 1234
}

{
  "message": "Login successful",
  "token": "JWT-TOKEN"
}

POST /campaign/create

{
  "user_id": 1243,
  "campaign_title": "title_here",
  "campaign_description": "description here",
  "campaign_picture": "picture in base64 string"
}

{
  "message": "Campaign successfully created"
}

POST /campaign/id/[:cid]

Authorisation Header Required

{
  "user_id": "",
  "c_title": "",
  "c_description": "",
  "c_picture": "",
  "updatedAt": ""
}

{
  "error": "No Such Campaign"
}

GET /campaign/search/[*:str]

Authorisation Header Required

{
  "user_id": "",
  "c_title": "",
  "c_description": "",
  "c_picture": "",
  "updatedAt": ""
}

{
  "message": "No Campaign Found"
}

GET /campaign/delete/[i:cid]

Authorisation Header Required

{
  "message": "Campaign successfully deleted"
}

{
  "error": "Campaign was not created by user/ is non-existent"
}

POST /campaign/edit/[i:cid]

Authorisation Header Required

{
  "user_id": 1243,
  "campaign_title": "title_here",
  "campaign_description": "description here",
  "campaign_picture": "picture in base64 string"
}

{
  "message": "campaign successfully edited"
}

{
  "error": "Campaign was not created by user/ is non-existent"
}

POST /user/campaigns

Authorisation Header Required from which the user id is extracted

{
  "user_id": "",
  "c_title": "",
  "c_description": "",
  "c_picture": "",
  "updatedAt": ""
}

{
  "message": "No Campaign Found"
}

POST /campaign/[i:cid]/add_comment

Authorisation Header Required from which the user id is extracted

{
  "message": "Successfully added comment"
}

{
  "error": ""
}

POST /campaign/edit_comment/[i:coid]

Authorisation Header Required from which the user id is extracted

{
  "message": "Successfully changed comment"
}

{
  "error": ""
}

POST /campaign/delete_comment/[i:cid]

Authorisation Header Required from which the user id is extracted

{
  "message": "Successfully deleted comment"
}

{
  "error": ""
}

POST /campaign/pledge_count/[*:cid]

Authorisation Header Required from which the user id is extracted

{
  "pledge_count": 00
}

{
  "error": ""
}

POST /campaign/pledge_list/[*:cid]

Authorisation Header Required from which the user id is extracted

{
  "pledge_count": 00
}

{
  "error": ""
}

POST /campaign/pledge/[*:cid]

Authorisation Header Required from which the user id is extracted

{
  "message": "Pledge successfully added"
}

{
  "error": ""
}

POST /campaign/unpledge/[*:cid]

Authorisation Header Required from which the user id is extracted

{
  "message": "Pledge deleted"
}

{
  "error": ""
}

1. Clone the repository

git clone https://github.com/neilscallywag/SupportMe.git

2. Make sure you have Composer installed. Move to the directory where you have composer.json with the command prompt and run the following command:

composer install

• Change the inc/config.php's private_key to your own private key and ISSUER to your own issuer.

Note : user_id do not need to be given as it is encoded in JWT

curl -i  -H "User-Agent: Chrome" -d "{ \"email\":\"[email protected]\",\"password\":1234 }" -X POST localhost/login

curl -i -X POST -d "{ \"firstname\":\"sunset boulevard\",\"lastname\":\"test\",\"email\":\"[email protected]\",\"password\":1234 }" localhost/register

curl -H "Authorization: YOUR_ISSUER JWT_TOKEN" -H "User-Agent: Chrome" -d "{\"user_id\":6}" -i -X POST  localhost/campaign/id/1

curl -H "Authorization: YOUR_ISSUER JWT_TOKEN" -H "User-Agent: Chrome" -d "{\"user_id\":6}" -i -X POST  localhost/campaign/search/save%20my

curl -H "Authorization: YOUR_ISSUER JWT_TOKEN" -H "User-Agent: Chrome" -d "{\"user_id\":8, \"campaign_title\":\"Let us eat cake\",\"campaign_description\":\"shit have flight eh\",\"campaign_picture\":\"base 64 string here\"}" -i -X POST  localhost/campaign/create

curl -H "Authorization: YOUR_ISSUER JWT_TOKEN" -H "User-Agent: Chrome" -d "{\"user_id\":8 }" -i -X POST  localhost/user/campaigns

curl -H "Authorization: YOUR_ISSUER JWT_TOKEN" -H "User-Agent: Chrome" -d "{\"user_id\":8 }" -i -X POST  localhost/campaign/comments/1

curl -H "Authorization: YOUR_ISSUER JWT_TOKEN" -H "User-Agent: Chrome" -d "{\"user_id\":8 }" -i -X POST  localhost/campaign/pledge_count/1

#note user id is not provided in the json

curl -H "Authorization: YOUR_ISSUER JWT_TOKEN" -H "User-Agent: Chrome" -d "{\"user_id\":8, \"pledge_reason\": \"i love you\" }" -i -X POST  localhost/campaign/pledge/1

curl -H "Authorization: YOUR_ISSUER JWT_TOKEN" -H "User-Agent: Chrome" -d "{ \"comment_text\": \"i love you\" }" -i -X POST  localhost/campaign/edit_comment/1

curl -H "Authorization: YOUR_ISSUER JWT_TOKEN" -H "User-Agent: Chrome" -d "{\"user_id\":8, \"campaign_title\":\"Let us eat cake\",\"campaign_description\":\"shit have flight eh\",\"campaign_picture\":\"base 64 string here\"}" -i -X POST  localhost/campaign/edit/1