This is the backend API repository for TurLink. TurLink is a link shortener app for the Turing community.
Frontend Repository
AI Microservice
- clone this repo
- run
bundle install - run
rails db:{drop,create,migrate,seed} - for the test suite, run
bundle exec rspec - to use endpoints in development enivronment, run
rails sand usehttp://localhost:3000as your base url
-
ensure you have docker installed on your local machine
-
run
chmod +x docker_start.shto make script executable -
run
./docker_start.sh- builds docker images
- starts containers
- creates database
- runs migrations
- seeds database
-
application should now be live at
http://localhost:3001 -
to stop the application run
docker-compose down -
Rails container:
docker-compose exec web bash -
Rails console:
docker-compose run web rails c
- POST
/api/v1/users- Description: Creates a new user account.
- Request Body:
{ "email": "user@example.com", "password": "password123", "password_confirmation": "password123" } - Successful Response (201 Created):
{ "data": { "id": "1", "type": "user", "attributes": { "email": "user@example.com", "links": [] } } } - Error Response (422 Unprocessable Entity):
{ "errors": [ { "status": "422", "message": "Email has already been taken" } ] }
- POST
/api/v1/sessions- Description: Authenticates a user and creates a session.
- Request Body:
{ "email": "user@example.com", "password": "password123" } - Successful Response (200 OK):
{ "data": { "id": "1", "type": "user", "attributes": { "email": "user@example.com", "links": [ { "id": 1, "original": "testlink.com", "short": "tur.link/4a7c204baeacaf2c", "user_id": 1, "created_at": "2024-08-23T15:51:38.866Z", "updated_at": "2024-08-23T15:51:38.866Z" }, { "id": 2, "original": "testlink.com", "short": "tur.link/67c758fc", "user_id": 1, "created_at": "2024-08-23T15:53:08.573Z", "updated_at": "2024-08-23T15:53:08.573Z" }, ] } } } - Error Response (401 Unauthorized):
{ "errors": [ { "message": "Invalid email or password" } ] }
- POST
/api/v1/users/:id/links?link={original link}- Description: Creates a shortened link associated with an exisiting user
- Example Request: POST
https://turlink-be-53ba7254a7c1.herokuapp.com/api/v1/users/1/links?link=testlink.com - Successful Response (200 OK):
{ "data": { "id": "1", "type": "link", "attributes": { "original": "testlink.com", "short": "tur.link/4a7c204baeacaf2c", "user_id": 1 } } } - Error Response (422 Unprocessable Entity) -- when original link isn't entered:
{ "errors": [ { "status": "unprocessable_entity", "message": "Original can't be blank" } ] } - Error Response (404 Not Found) -- when user_id is not valid:
{ "errors": [ { "status": "unprocessable_entity", "message": "User must exist" } ] }
- GET
/api/v1/users/:id/links- Description: Gets an index of all links for a user
- Example Request: GET
https://turlink-be-53ba7254a7c1.herokuapp.com/api/v1/users/1/links - Successful Response (200 OK):
{ "data": { "id": "1", "type": "user", "attributes": { "email": "user@example.com", "links": [ { "id": 1, "original": "testlink.com", "short": "tur.link/4a7c204baeacaf2c", "user_id": 1, "created_at": "2024-08-23T15:51:38.866Z", "updated_at": "2024-08-23T15:51:38.866Z" }, { "id": 2, "original": "testlink.com", "short": "tur.link/67c758fc", "user_id": 1, "created_at": "2024-08-23T15:53:08.573Z", "updated_at": "2024-08-23T15:53:08.573Z" }, ] } } } - Error Response (404 Not Found) -- when user_id is not valid:
{ "errors": [ { "message": "Record not found" } ] }
- GET
/api/v1/links?short={shortened link}- Description: Gets full link object when given shortened link
- Example Request: GET
https://turlink-be-53ba7254a7c1.herokuapp.com/api/v1/links?short=tur.link/4a7c204baeacaf2c - Successful Response (200 OK):
{ "data": { "id": "1", "type": "link", "attributes": { "original": "testlink.com", "short": "tur.link/4a7c204baeacaf2c", "user_id": 1, "click_count": 1, "last_click": "2024-08-28T12:34:56.789Z", "private": false } } } - Error Response (404 Not Found) -- when shortened link is not entered or does not exist:
{ "errors": [ { "message": "Record not found" } ] }
- Click Tracking
- Each time a shortened link is accessed via the GET
/api/v1/links?short={shortened link}endpoint:- The
click_countfor that link is automatically incremented. - The
last_clicktimestamp is updated to the current time.
- The
- Each time a shortened link is accessed via the GET
- GET
/api/v1/tags- Description: Gets all tags from database
- Example Request: GET
https://turlink-be-53ba7254a7c1.herokuapp.com/api/v1/tags - Successful Response (200 OK):
{ "data": [ { "id": "1", "type": "tag", "attributes": { "name": "javascript" } }, { "id": "2", "type": "tag", "attributes": { "name": "react" } }, { "id": "3", "type": "tag", "attributes": { "name": "ruby" } }, ... ] }
- POST
/api/v1/tags?link={link_id}&tag={tag_id}OR/api/v1/tags?link={link_id}&newTag={user created tag}- Description: Adds a tag to a link, or creates a new tag and adds it to a link
- Example Request for adding an existing tag: POST
https://turlink-be-53ba7254a7c1.herokuapp.com/api/v1/tags?link=1&tag=1 - Successful Response (200 OK):
{ "data": { "id": "1", "type": "link", "attributes": { "original": "testlink.com", "short": "tur.link/4a7c204baeacaf2c", "user_id": 1, "tags": [ { "id": 1, "name": "javascript", "created_at": "2024-08-27T01:19:47.421Z", "updated_at": "2024-08-27T01:19:47.421Z" } ] } } } - Example Request for creating and adding a new tag: POST
https://turlink-be-53ba7254a7c1.herokuapp.com/api/v1/tags?link=1&newTag=miscellaneous - Successful Response (200 OK):
{ "data": { "id": "1", "type": "link", "attributes": { "original": "testlink.com", "short": "tur.link/4a7c204baeacaf2c", "user_id": 1, "tags": [ { "id": 173, "name": "miscellaneous", "created_at": "2024-08-27T01:19:47.421Z", "updated_at": "2024-08-27T01:19:47.421Z" } ] } } } - Error Response (404 Not Found) -- when tag or link doesn't exist or isn't passed as a param:
{ "errors": [ { "message": "Link or Tag not found" } ] }
- DELETE
/api/v1/tags/{tag_id}?link={link_id}- Description: Removes a tag from a link
- Example Request: DELETE
https://turlink-be-53ba7254a7c1.herokuapp.com/api/v1/tags/1?link=1 - Successful Response (200 OK):
{ "data": { "id": "1", "type": "link", "attributes": { "original": "testlink.com", "short": "tur.link/4a7c204baeacaf2c", "user_id": 1, "tags": [] } } } - Error Response (404 Not Found) -- when tag or link doesn't exist or isn't passed as a param:
{ "errors": [ { "message": "Link or Tag not found" } ] }
- GET
/api/v1/tags?link={link_id}- Description: Get all tags for a given link
- Example Request: GET
https://turlink-be-53ba7254a7c1.herokuapp.com/api/v1/tags?link=1 - Successful Response (200 OK):
{ "data": { "id": "1", "type": "link", "attributes": { "original": "testlink.com", "short": "tur.link/4a7c204baeacaf2c", "user_id": 1, "tags": [ { "id": 1, "name": "javascript", "created_at": "2024-08-27T01:19:47.421Z", "updated_at": "2024-08-27T01:19:47.421Z" } ] } } } - Error Response (404 Not Found) -- when link doesn't exist:
{ "errors": [ { "message": "Link or Tag not found" } ] }
- GET
/api/v1/top_links- Description: Returns the top 5 links based on click count.
- Optional Query Parameter:
tagto filter by a specific tag. - Example Request: GET
https://turlink-be-53ba7254a7c1.herokuapp.com/api/v1/top_links - Example Request with Tag Filter: GET
https://turlink-be-53ba7254a7c1.herokuapp.com/api/v1/top_links?tag=javascript - Example Request with Multiple Tag Filter: GET
https://turlink-be-53ba7254a7c1.herokuapp.com/api/v1/top_links?tag=javascript,ruby - Successful Response (200 OK):
{ "data": [ { "id": "1", "type": "link", "attributes": { "original": "https://example1.com", "short": "tur.link/abc123", "user_id": 1, "click_count": 100, "last_click": "2024-08-28T12:34:56.789Z", "tags": [ { "id": 1, "name": "javascript" } ], "private": false, "summary": "Summary not available" } }, { "id": "2", "type": "link", "attributes": { "original": "https://example2.com", "short": "tur.link/def456", "user_id": 2, "click_count": 75, "last_click": "2024-08-27T10:11:12.345Z", "tags": [ { "id": 2, "name": "ruby" } ], "private": false, "summary": "Summary not available" } }, // ... (3 more link objects) ] }
- GET
/api/v1/summary?link={short link}- Description: Retrieves a summary of the content at the given link.
- Example Request: GET
https://turlink-be-53ba7254a7c1.herokuapp.com/api/v1/summary?link=tur.link/96559226 - Successful Response (200 OK):
{ "data": { "id": "6", "type": "link", "attributes": { "original": "https://mod4.turing.edu/lessons/cs/arrays_stacks_queues.html", "short": "tur.link/96559226", "user_id": 1, "tags": [], "click_count": 0, "last_click": null, "private": false, "summary": "1. The document outlines the curriculum for Module 4 at the Turing School of Software and Design, focusing on data structures such as Arrays, Stacks, and Queues. It includes learning goals and key topics of discussion.\n\n2. It provides detailed explanations of each data structure: Arrays, Stacks (Last-In-First-Out), and Queues (First-In-First-Out), including their background, memory usage, implementation, usage, and their pros and cons.\n\n3. Students are encouraged to practice their knowledge of these data structures through various examples and a workshop challenge, reinforcing their understanding of how these data structures operate within programming languages." } }
-
PATCH
/api/v1/users/:user_id/links/:id/update_privacy- Description: Updates the privacy setting of a specific link for a user.
- Request Parameters:
user_id: The ID of the user who owns the linkid: The ID of the link to update
- Request Body:
{ "private": "true" // or "false" to make the link public } - Example Request: PATCH
https://turlink-be-53ba7254a7c1.herokuapp.com/api/v1/users/1/links/1/update_privacy - Successful Response (200 OK):
{ "message": "Privacy setting updated successfully" } - Error Responses:
- 403 Forbidden (If the user doesn't own the link):
{ "error": "Unauthorized to update this link" } - 404 Not Found (If the user or link doesn't exist):
{ "error": "User or Link not found" } - 422 Unprocessable Entity (If the update fails):
{ "error": "Failed to update privacy setting" }
- 403 Forbidden (If the user doesn't own the link):
-
Notes:
- Private links are only accessible by their owners.
- Private links are excluded from the top links listing.
- Attempting to access a private link without proper authorization will result in a 404 Not Found error.