TRIP Itinerary Documentation: Database Design, UI, and Testing

This comprehensive document details the development of a trip itinerary application, encompassing various aspects from database design to user interface (UI) and testing methodologies. It begins with a use case diagram illustrating user interactions, followed by actor roles and descriptions. The report then delves into the database structure, presenting entity-relationship diagrams and detailed table designs for users, trips, friends, events, and shared trips. UI design is showcased through various screenshots of the login page, trip views, friend management, and itinerary displays. Furthermore, the report includes class and sequence diagrams to visualize system interactions and data flow. The implementation section highlights external libraries like Alamofire, SwiftyJSON, and Google APIs, along with the application's test plan, which includes unit, integration, and functionality testing with corresponding test cases. The document concludes with implementation details and requirements, providing a holistic view of the application's development lifecycle.

RO CHAN
TRIP ITINERARY
DOCUMENTATION

Table of Contents
LIST OF FIGURES................................................................................................................II
LIST OF TABLES..................................................................................................................II
USE CASE................................................................................................................................1
DIAGRAM...............................................................................................................................1
ACTOR ROLE AND DESCRIPTION..........................................................................................1
DESCRIPTION.........................................................................................................................2
ENTITY RELATIONSHIP DIAGRAM................................................................................8
DATABASE DESIGN..............................................................................................................9
CLASS DIAGRAM................................................................................................................12
SEQUENCE DIAGRAM.......................................................................................................13
USER INTERFACE DESIGN..............................................................................................14
EXTERNAL LIBRARIES....................................................................................................19
TEST PLAN............................................................................................................................20
UNIT TESTING......................................................................................................................20
INTEGRATION TESTING.......................................................................................................20
FUNCTIONALITY TESTING...................................................................................................20
TEST CASES..........................................................................................................................20
IMPLEMENTATION...........................................................................................................24
REQUIREMENTS...................................................................................................................24
CHANGING GOOGLE DEVELOPER SERVICES ACCOUNT....................................................24
i

List of figures
Figure 1: Use case diagram........................................................................................................1
Figure 2: Entity relationship diagram........................................................................................8
Figure 3: Class diagram...........................................................................................................12
Figure 4: Sequence diagram.....................................................................................................13
Figure 5: Login page................................................................................................................14
Figure 6: Trips page.................................................................................................................14
Figure 7: Friends page..............................................................................................................15
Figure 8: Add friend page........................................................................................................15
Figure 9: View trip page..........................................................................................................16
Figure 10: Itinerary..................................................................................................................16
Figure 11: View location page.................................................................................................17
Figure 12: Add plan page.........................................................................................................17
Figure 13: New trip..................................................................................................................17
Figure 14: View event..............................................................................................................18
Figure 15: Edit event................................................................................................................18
Figure 16: Changing Google services account........................................................................24
List of tables
Table 1: User actor.....................................................................................................................1
Table 2: Friend actor..................................................................................................................1
Table 3: Logging in description table........................................................................................2
Table 4: Add friend description.................................................................................................2
Table 5: Add traveller description.............................................................................................3
Table 6: Accept or reject invite description...............................................................................3
Table 7: Add trip description.....................................................................................................4
Table 8: Add event description..................................................................................................5
Table 9: Edit event description..................................................................................................6
Table 10: Delete event description.............................................................................................6
Table 11: User table...................................................................................................................9
Table 12: Trip table....................................................................................................................9
Table 13: Friend table................................................................................................................9
ii

Table 14: Share Trip table........................................................................................................10
Table 15: Event table...............................................................................................................10
Table 16: Test cases.................................................................................................................20
iii

Use case
Diagram
Figure 1: Use case diagram
Actor role and description
Table 1: User actor
Actor Name: User
Description: A person who has registered into the application
Table 2: Friend actor
Actor Name: Friend
Description: Added by a user for sharing trips. A friend can be an existing user or not.
A friend if not registered can register to be a user later and once logged in
they will be able to see their invites.
1

Description
Table 3: Logging in description table
Use case name: Logging in
Use case ID:
Actor: User
Description: User logs into the application
Pre-conditions: Must have a Gmail account
Post-conditions:
Normal Flow:
Side of Action Actor Action System Response
Taps onto the login button,
chooses or inputs an account
then enters their password
Takes user to Google sign in
page and saves users
information when done.
Alternative Flow:
Side of Action Actor Action System Response
Table 4: Add friend description
Use case name: Adding friend
Use case ID:
Actor: User
Description: User adds a new friend
Pre-conditions: Must be logged in
Post-conditions:
Normal Flow:
Side of Action Actor Action System Response
Taps onto the friend button
then the add friend button.
The user then inputs the
friend’s name and email and
clicks on the save button.
Takes user to the add friend
page. Saves the friend
information provided by the
user to firebase
2

Alternative Flow:
Side of Action Actor Action System Response
Table 5: Add traveller description
Use case name: Adding traveler to trip
Use case ID:
Actor: User
Description: User invites a friend to join trip
Pre-conditions: Must be logged in. Must have added a friend.
Post-conditions: Friend has to register on the application if not yet registered
Normal Flow:
Side of Action Actor Action System Response
Taps on trip to view the
details. Clicks on the add
traveler button then clicks
on the friend to be added to
the trip.
Takes user to the add
traveler button. Sends invite
to the chosen friend then
takes user back to the view
trip page while showing the
status of the invite.
Alternative Flow:
Side of Action Actor Action System Response
Table 6: Accept or reject invite description
Use case name: Accept or reject invite
Use case ID:
Actor: Friend or user
Description: Friend accepts user’s invite
Pre-conditions: Must be logged in
Post-conditions: Cost of trip calculated to include all those going to trip
Normal Flow:
Side of Action Actor Action System Response
3

Friend registers and logs
into the application. Clicks
on the invites button. Tap
the accept button to accept
invite or the reject button to
refuse.
Uses Google API to verify
user and add them to users
table. Takes user to the
invites page. Changes status
of invite depending on the
user’s choice.
Alternative Flow:
Side of Action Actor Action System Response
User logs into the
application. Clicks on the
invites button. Tap the
accept button to accept
invite or the reject button to
refuse.
Uses Google API to verify
user credentials. Takes user
to the invites page. Changes
status of invite depending on
the user’s choice.
Table 7: Add trip description
Use case name: Add trip
Use case ID:
Actor: User
Description: User adds a new trip
Pre-conditions: Must be logged in
Post-conditions:
Normal Flow:
Side of Action Actor Action System Response
Taps onto the add trip button
and enters the required
information and clicks on
the save button.
Saves trip and takes user
back to the trips page.
Alternative Flow:
Side of Action Actor Action System Response
Use case name: Delete Trip
4

Use case ID:
Actor: User
Description: User deletes a trip
Pre-conditions: Must be logged in. Must have added a trip.
Post-conditions: Trip status changed to deleted
Normal Flow:
Side of Action Actor Action System Response
Taps onto a trip from the
list. Click on the delete
button.
Takes user to view trip page
and process delete trip
request.
Alternative Flow:
Side of Action Actor Action System Response
Table 8: Add event description
Use case name: Add event
Use case ID:
Actor: User, Friend
Description: An event is added to a trip
Pre-conditions: Must be logged in.
Must be organizer of a trip or have accepted invite.
Post-conditions:
Normal Flow:
Side of Action Actor Action System Response
Navigates to itinerary page.
Click on the add button and
provide all the necessary
information then click on the
save button.
Takes user to the add event
page, saves event details and
returns user to the itinerary
page.
Alternative Flow:
Side of Action Actor Action System Response
5

Table 9: Edit event description
Use case name: Edit event
Use case ID:
Actor: User, Friend
Description: An event’s details are modified
Pre-conditions: Must be logged in.
Must be organizer of a trip or have accepted invite.
Post-conditions:
Normal Flow:
Side of Action Actor Action System Response
Navigates to itinerary page.
Clicks on the event to be
modified from the list. Click
on the edit button and
modify the details then tap
on the save button
Takes user to the edit even
page and saves the new
event details.
Alternative Flow:
Side of Action Actor Action System Response
Table 10: Delete event description
Use case name: Delete event
Use case ID:
Actor: User, Friend
Description: An event is deleted from the itinerary
Pre-conditions: Must be logged in.
Must be organizer of a trip or have accepted invite.
Post-conditions:
Normal Flow:
Side of Action Actor Action System Response
6

Navigates to the view event
page and clicks on the trash
can icon.
Takes user to view event
page and removes event
from the database.
Alternative Flow:
Side of Action Actor Action System Response
7

Entity relationship diagram
An entity relationship diagram is a diagram that shows all the entities present in a system and
how they relate to each other in terms of the data stored and shared in the system.
Figure 2: Entity relationship diagram
8