Implemented a RESTful API using Spring Boot, JPA, and Postgresql that exposes operations for social media data that resembles the conceptual model of Twitter.
Developed a suitable database schema and wrote Spring services and controllers to handle requests, perform validation and business logic, and to transform data between the API and database models.
Included in this skeleton are 2 json files required to run the test suite for the project. To run the tests you will need postman's newman CLI. To install newman run the command npm install -g newman. Once newman is installed you need to navigate to the folder containing the Twitter Clone Test Suite & Twitter Clone environment json files. Once there you can run the command newman run "Twitter Clone Test Suite.postman_collection.json" -e "Twitter Clone.postman_environment.json". When all tests are passing successfully you will pass 330 assertions and should see something similar to the following in your terminal:
A user of the application. The username must be unique. The joined timestamp should be assigned when the user is first created, and must never be updated.
{ // User
username: 'string',
profile: 'Profile',
joined: 'timestamp'
}A user's profile information. Only the email property is required.
{ // Profile
firstName?: 'string',
lastName?: 'string',
email: 'string',
phone?: 'string'
}A user's credentials. These are mostly used for validation and authentication during operations specific to a user. Passwords are plain text for the sake of academic simplicity, and it should be kept in mind that this is never appropriate in the real world.
{ // Credentials
username: 'string',
password: 'string'
}A hashtag associated with tweets that contain its label. The label property must be unique, but is case-insensitive. The firstUsed timestamp should be assigned on creation, and must never be updated. The lastUsed timestamp should be updated every time a new tweet is tagged with the hashtag.
{ // Hashtag
label: 'string',
firstUsed: 'timestamp',
lastUsed: 'timestamp'
}A tweet posted by a user. The posted timestamp should be assigned when the tweet is first created, and must not be updated.
There are three distinct variations of tweets: simple, repost, and reply.
- A simple tweet has a
contentvalue but noinReplyToorrepostOfvalues - A repost has a
repostOfvalue but nocontentorinReplyTovalues - A reply has
contentandinReplyTovalues, but norepostOfvalue
{ // Tweet
id: 'integer'
author: 'User',
posted: 'timestamp',
content?: 'string',
inReplyTo?: 'Tweet',
repostOf?: 'Tweet'
}The reply context of a tweet. The before property represents the chain of replies that led to the target tweet, and the after property represents the chain of replies that followed the target tweet.
The chains should be in chronological order, and the after chain should include all replies of replies, meaning that all branches of replies must be flattened into a single chronological list to fully satisfy the requirements.
{ // Context
target: 'Tweet',
before: ['Tweet'],
after: ['Tweet']
}Checks whether or not a given hashtag exists.
'boolean'Checks whether or not a given username exists.
'boolean'Checks whether or not a given username is available.
'boolean'Retrieves all active (non-deleted) users as an array.
['User']Creates a new user. If any required fields are missing or the username provided is already taken, an error should be sent in lieu of a response.
If the given credentials match a previously-deleted user, re-activate the deleted user instead of creating a new one.
{
credentials: 'Credentials',
profile: 'Profile'
}'User'Retrieves a user with the given username. If no such user exists or is deleted, an error should be sent in lieu of a response.
'User'Updates the profile of a user with the given username. If no such user exists, the user is deleted, or the provided credentials do not match the user, an error should be sent in lieu of a response. In the case of a successful update, the returned user should contain the updated data.
{
credentials: 'Credentials',
profile: 'Profile'
}'User'"Deletes" a user with the given username. If no such user exists or the provided credentials do not match the user, an error should be sent in lieu of a response. If a user is successfully "deleted", the response should contain the user data prior to deletion.
IMPORTANT: This action should not actually drop any records from the database! Instead, develop a way to keep track of "deleted" users so that if a user is re-activated, all of their tweets and information are restored.
'Credentials''User'Subscribes the user whose credentials are provided by the request body to the user whose username is given in the url. If there is already a following relationship between the two users, no such followable user exists (deleted or never created), or the credentials provided do not match an active user in the database, an error should be sent as a response. If successful, no data is sent.
'Credentials'Unsubscribes the user whose credentials are provided by the request body from the user whose username is given in the url. If there is no preexisting following relationship between the two users, no such followable user exists (deleted or never created), or the credentials provided do not match an active user in the database, an error should be sent as a response. If successful, no data is sent.
'Credentials'Retrieves all (non-deleted) tweets authored by the user with the given username, as well as all (non-deleted) tweets authored by users the given user is following. This includes simple tweets, reposts, and replies. The tweets should appear in reverse-chronological order. If no active user with that username exists (deleted or never created), an error should be sent in lieu of a response.
['Tweet']Retrieves all (non-deleted) tweets authored by the user with the given username. This includes simple tweets, reposts, and replies. The tweets should appear in reverse-chronological order. If no active user with that username exists (deleted or never created), an error should be sent in lieu of a response.
['Tweet']Retrieves all (non-deleted) tweets in which the user with the given username is mentioned. The tweets should appear in reverse-chronological order. If no active user with that username exists, an error should be sent in lieu of a response.
A user is considered "mentioned" by a tweet if the tweet has content and the user's username appears in that content following a @.
['Tweet']Retrieves the followers of the user with the given username. Only active users should be included in the response. If no active user with the given username exists, an error should be sent in lieu of a response.
['User']Retrieves the users followed by the user with the given username. Only active users should be included in the response. If no active user with the given username exists, an error should be sent in lieu of a response.
['User']Retrieves all hashtags tracked by the database.
['Hashtag']Retrieves all (non-deleted) tweets tagged with the given hashtag label. The tweets should appear in reverse-chronological order. If no hashtag with the given label exists, an error should be sent in lieu of a response.
A tweet is considered "tagged" by a hashtag if the tweet has content and the hashtag's label appears in that content following a #
['Tweet']Retrieves all (non-deleted) tweets. The tweets should appear in reverse-chronological order.
['Tweet']Creates a new simple tweet, with the author set to the user identified by the credentials in the request body. If the given credentials do not match an active user in the database, an error should be sent in lieu of a response.
The response should contain the newly-created tweet.
Because this always creates a simple tweet, it must have a content property and may not have inReplyTo or repostOf properties.
IMPORTANT: when a tweet with content is created, the server must process the tweet's content for @{username} mentions and #{hashtag} tags. There is no way to create hashtags or create mentions from the API, so this must be handled automatically!
{
content: 'string',
credentials: 'Credentials'
}'Tweet'Retrieves a tweet with a given id. If no such tweet exists, or the given tweet is deleted, an error should be sent in lieu of a response.
'Tweet'"Deletes" the tweet with the given id. If no such tweet exists or the provided credentials do not match author of the tweet, an error should be sent in lieu of a response. If a tweet is successfully "deleted", the response should contain the tweet data prior to deletion.
IMPORTANT: This action should not actually drop any records from the database! Instead, develop a way to keep track of "deleted" tweets so that even if a tweet is deleted, data with relationships to it (like replies and reposts) are still intact.
'Credentials''Tweet'Creates a "like" relationship between the tweet with the given id and the user whose credentials are provided by the request body. If the tweet is deleted or otherwise doesn't exist, or if the given credentials do not match an active user in the database, an error should be sent. Following successful completion of the operation, no response body is sent.
'Credentials'Creates a reply tweet to the tweet with the given id. The author of the newly-created tweet should match the credentials provided by the request body. If the given tweet is deleted or otherwise doesn't exist, or if the given credentials do not match an active user in the database, an error should be sent in lieu of a response.
Because this creates a reply tweet, content is not optional. Additionally, notice that the inReplyTo property is not provided by the request. The server must create that relationship.
The response should contain the newly-created tweet.
IMPORTANT: when a tweet with content is created, the server must process the tweet's content for @{username} mentions and #{hashtag} tags. There is no way to create hashtags or create mentions from the API, so this must be handled automatically!
{
content: 'string',
credentials: 'Credentials'
}'Tweet'Creates a repost of the tweet with the given id. The author of the repost should match the credentials provided in the request body. If the given tweet is deleted or otherwise doesn't exist, or the given credentials do not match an active user in the database, an error should be sent in lieu of a response.
Because this creates a repost tweet, content is not allowed. Additionally, notice that the repostOf property is not provided by the request. The server must create that relationship.
The response should contain the newly-created tweet.
'Credentials''Tweet'Retrieves the tags associated with the tweet with the given id. If that tweet is deleted or otherwise doesn't exist, an error should be sent in lieu of a response.
IMPORTANT Remember that tags and mentions must be parsed by the server!
['Hashtag']Retrieves the active users who have liked the tweet with the given id. If that tweet is deleted or otherwise doesn't exist, an error should be sent in lieu of a response.
Deleted users should be excluded from the response.
['User']Retrieves the context of the tweet with the given id. If that tweet is deleted or otherwise doesn't exist, an error should be sent in lieu of a response.
IMPORTANT: While deleted tweets should not be included in the before and after properties of the result, transitive replies should. What that means is that if a reply to the target of the context is deleted, but there's another reply to the deleted reply, the deleted reply should be excluded but the other reply should remain.
'Context'Retrieves the direct replies to the tweet with the given id. If that tweet is deleted or otherwise doesn't exist, an error should be sent in lieu of a response.
Deleted replies to the tweet should be excluded from the response.
['Tweet']Retrieves the direct reposts of the tweet with the given id. If that tweet is deleted or otherwise doesn't exist, an error should be sent in lieu of a response.
Deleted reposts of the tweet should be excluded from the response.
['Tweet']Retrieves the users mentioned in the tweet with the given id. If that tweet is deleted or otherwise doesn't exist, an error should be sent in lieu of a response.
Deleted users should be excluded from the response.
IMPORTANT Remember that tags and mentions must be parsed by the server!
['User']