110swag / docs

Download as
Browse Code ยป

Commit 88d1384790ad4a7ee48acb5137162f48b6b49b78

Authored by mjeng
2 parents ede1fa6077 1f1a665a07
Exists in master

Merges

Showing 3 changed files Inline Diff

DesignUseCases.tex View file @ 88d1384
\documentclass[letterpaper]{scrartcl} % or whatever 1 1 \documentclass[letterpaper]{scrartcl} % or whatever
\usepackage{tgpagella} 2 2 \usepackage{tgpagella}
\setkomafont{disposition}{\normalfont\bfseries} 3 3 \setkomafont{disposition}{\normalfont\bfseries}
%\usepackage[markuppercase]{scrpage2} 4 4 %\usepackage[markuppercase]{scrpage2}
\title{\huge Design Use Cases} 5 5 \title{\huge Design Use Cases}
\date{\today} 6 6 \date{\today}
\author{\Large Students With A Goal (S.W.A.G.)} 7 7 \author{\Large Students With A Goal (S.W.A.G.)}
\usepackage[pass]{geometry} 8 8 \usepackage[pass]{geometry}
\usepackage{hyperref} 9 9 \usepackage{hyperref}
\usepackage{graphicx} 10 10 \usepackage{graphicx}
\usepackage{enumitem} 11 11 \usepackage{enumitem}
\setlist[description]{style=multiline,leftmargin=3cm,font=\normalfont\textbf} 12 12 \setlist[description]{style=multiline,leftmargin=3cm,font=\normalfont\textbf}
\setlistdepth{9} 13 13 \setlistdepth{9}
14 14
\setlist[itemize,1]{label=$\bullet$} 15 15 \setlist[itemize,1]{label=$\bullet$}
\setlist[itemize,2]{label=$\bullet$} 16 16 \setlist[itemize,2]{label=$\bullet$}
\setlist[itemize,3]{label=$\bullet$} 17 17 \setlist[itemize,3]{label=$\bullet$}
\setlist[itemize,4]{label=$\bullet$} 18 18 \setlist[itemize,4]{label=$\bullet$}
\setlist[itemize,5]{label=$\bullet$} 19 19 \setlist[itemize,5]{label=$\bullet$}
\setlist[itemize,6]{label=$\bullet$} 20 20 \setlist[itemize,6]{label=$\bullet$}
\setlist[itemize,7]{label=$\bullet$} 21 21 \setlist[itemize,7]{label=$\bullet$}
\setlist[itemize,8]{label=$\bullet$} 22 22 \setlist[itemize,8]{label=$\bullet$}
\setlist[itemize,9]{label=$\bullet$} 23 23 \setlist[itemize,9]{label=$\bullet$}
\renewlist{itemize}{itemize}{9} 24 24 \renewlist{itemize}{itemize}{9}
\begin{document} 25 25 \begin{document}
\maketitle 26 26 \maketitle
\begin{center} 27 27 \begin{center}
\includegraphics[width=12cm]{../swag_logo.png}\\ 28 28 \includegraphics[width=12cm]{../swag_logo.png}\\
29 29
\begin{tabular}{l r} 30 30 \begin{tabular}{l r}
Melody Jeng & System Architect \\ 31 31 Melody Jeng & System Architect \\
Arno Gau & Senior System Analyst \\ 32 32 Arno Gau & Senior System Analyst \\
Rachel Lee & Software Development Lead \\ 33 33 Rachel Lee & Software Development Lead \\
Laura Hawkins & Project Manager \\ 34 34 Laura Hawkins & Project Manager \\
Rohan Rangray & Algorithms Specialist\\ 35 35 Rohan Rangray & Algorithms Specialist\\
Andrew Buss & Database Specialist \\ 36 36 Andrew Buss & Database Specialist \\
Phuong Tran & Quality Assurance Lead \\ 37 37 Phuong Tran & Quality Assurance Lead \\
Chung Kang Wang & Business Analyst\\ 38 38 Chung Kang Wang & Business Analyst\\
Masud Rahman & User Interface Specialist\\ 39 39 Masud Rahman & User Interface Specialist\\
Kevin Mach & User Interface Specialist\\ 40 40 Kevin Mach & User Interface Specialist\\
\end{tabular} 41 41 \end{tabular}
\end{center} 42 42 \end{center}
\newpage 43 43 \newpage
\tableofcontents 44 44 \tableofcontents
\newpage 45 45 \newpage
46 46
\section{Accounts} 47 47 \section{Accounts}
\subsection{[A1] User Registration} 48 48 \subsection{[A1] User Registration}
\begin{description}[style=multiline,leftmargin=3cm] 49 49 \begin{description}[style=multiline,leftmargin=3cm]
\item[Description]{To create and save decks, the system requires the user 50 50 \item[Description]{To create and save decks, the system requires the user
to create an account prior. The user will be able to create an account 51 51 to create an account prior. The user will be able to create an account
through registering.} 52 52 through registering.}
\item[Desired Outcome]{An account will be created for the user from the 53 53 \item[Desired Outcome]{An account will be created for the user from the
specified username, password, email. The user will be able to log into 54 54 specified username, password, email. The user will be able to log into
the aforementioned account.} 55 55 the aforementioned account.}
\\ 56 56 \\
\item[User Goals]{The user shall have an account to participate in the 57 57 \item[User Goals]{The user shall have an account to participate in the
application's activities.} 58 58 application's activities.}
59 59
\item[Primary Actor]{User (student)} 60 60 \item[Primary Actor]{User (student)}
61 61
\item[Dependency Use Cases]{None} 62 62 \item[Dependency Use Cases]{None}
\\ 63 63 \\
\item[Priority Level]{``Must''} 64 64 \item[Priority Level]{``Must''}
65 65
\item[Status]{Implemented} 66 66 \item[Status]{Implemented}
67 67
\item[Pre-conditions]: None. 68 68 \item[Pre-conditions]: None.
69 69
\item[Post-conditions] 70 70 \item[Post-conditions]
71 71
\begin{itemize} 72 72 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 73 73 \itemsep1pt\parskip0pt\parsep0pt
\item 74 74 \item
{The user has an account registered with the system.} 75 75 {The user has an account registered with the system.}
\end{itemize} 76 76 \end{itemize}
77 77
\item[Trigger]{The user wants to create an account.} 78 78 \item[Trigger]{The user wants to create an account.}
79 79
\item[Workflow] 80 80 \item[Workflow]
81 81
\begin{enumerate} 82 82 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 83 83 \itemsep1pt\parskip0pt\parsep0pt
\item 84 84 \item
{The frontend renders the login form described in login.html.} 85 85 {The frontend renders the login form described in login.html.}
\item 86 86 \item
{The User shall click the sign up toggle.} 87 87 {The User shall click the sign up toggle.}
\item 88 88 \item
{The frontend shall render a registration form and display it to the User.} 89 89 {The frontend shall render a registration form and display it to the User.}
\item 90 90 \item
{The User shal fill in the form.} 91 91 {The User shal fill in the form.}
\item 92 92 \item
{The frontend checks that the provided email is not invalid, and that 93 93 {The frontend checks that the provided email is not invalid, and that
the password is not valid. If anything is not valid, it displays an 94 94 the password is not valid. If anything is not valid, it displays an
error and returns this to the user. } 95 95 error and returns this to the user. }
\item 96 96 \item
{If the form is valid, the frontent POSTs the form in JSON format to the 97 97 {If the form is valid, the frontent POSTs the form in JSON format to the
server API at /api/verify\_email/.} 98 98 server API at /api/verify\_email/.}
\item 99 99 \item
{The backend deserializes and validates the data in /api/register. If it's not valid, it 100 100 {The backend deserializes and validates the data in /api/register. If it's not valid, it
returns an error to the frontend.} 101 101 returns an error to the frontend.}
\item 102 102 \item
{The backend creates a new User object from the provided data, filling 103 103 {The backend creates a new User object from the provided data, filling
in the email and password fields in models.py in model method create\_user.} 104 104 in the email and password fields in models.py in model method create\_user.}
\item 105 105 \item
{The backend saves the User object in models.py.} 106 106 {The backend saves the User object in models.py.}
\item 107 107 \item
{The backend marks the User's email as unverified.} 108 108 {The backend marks the User's email as unverified.}
\item 109 109 \item
{The backend sends an email to the User's address with a link to 110 110 {The backend sends an email to the User's address with a link to
validate the user's email address from models.py in function send\_confirmation\_email.} 111 111 validate the user's email address from models.py in function send\_confirmation\_email.}
\item 112 112 \item
{The backend responds with success and logs the User in on a new 113 113 {The backend responds with success and logs the User in on a new
session for the User. } 114 114 session for the User. }
\item 115 115 \item
{The frontend reports success to the User and stores the sessionid for 116 116 {The frontend reports success to the User and stores the sessionid for
future requests.} 117 117 future requests.}
\end{enumerate} 118 118 \end{enumerate}
119 119
{Verification Workflow:} 120 120 {Verification Workflow:}
121 121
\begin{enumerate} 122 122 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 123 123 \itemsep1pt\parskip0pt\parsep0pt
\item 124 124 \item
{The User receives an email with a link to verify their email. The 125 125 {The User receives an email with a link to verify their email. The
User clicks the link} 126 126 User clicks the link}
\item 127 127 \item
{The frontend in VerifyEmailController submits a POST request to the backend.} 128 128 {The frontend in VerifyEmailController submits a POST request to the backend.}
\item 129 129 \item
{The backend validates the code in views.py in function veryify\_email. If the code is not valid, it returns 130 130 {The backend validates the code in views.py in function veryify\_email. If the code is not valid, it returns
an error to the frontend.} 131 131 an error to the frontend.}
\item 132 132 \item
{The backend marks the user's email as confirmed and saves the User object 133 133 {The backend marks the user's email as confirmed and saves the User object
again in models.py in function confirm\_email. The user's account is now active.} 134 134 again in models.py in function confirm\_email. The user's account is now active.}
\item 135 135 \item
{The frontend's VerifyEmailController.js reports success and logs the User in to the application. } 136 136 {The frontend's VerifyEmailController.js reports success and logs the User in to the application. }
\end{enumerate} 137 137 \end{enumerate}
138 138
\end{description} 139 139 \end{description}
140 140
\newpage 141 141 \newpage
\subsection{[A2] User Login} 142 142 \subsection{[A2] User Login}
143 143
\begin{description} 144 144 \begin{description}
\item[Description]{User is able to login to personal account.} 145 145 \item[Description]{User is able to login to personal account.}
146 146
\item[Desired Outcome]{The user shall be able to provide their username and 147 147 \item[Desired Outcome]{The user shall be able to provide their username and
password to access their courses and flash cards. The user shall gain 148 148 password to access their courses and flash cards. The user shall gain
access to the list of the courses they have added, and be able to review 149 149 access to the list of the courses they have added, and be able to review
the flash cards they have added to their decks.} 150 150 the flash cards they have added to their decks.}
\\ 151 151 \\
\item[User Goals]{The user wants to resume use of the site on another 152 152 \item[User Goals]{The user wants to resume use of the site on another
device, or use the site after logging out.} 153 153 device, or use the site after logging out.}
154 154
\item[Primary Actor]{User (student)} 155 155 \item[Primary Actor]{User (student)}
156 156
\item[Dependency Use Cases]{{[}A1{]} User Registration} 157 157 \item[Dependency Use Cases]{{[}A1{]} User Registration}
\\ 158 158 \\
\item[Priority Level]{``Must''} 159 159 \item[Priority Level]{``Must''}
160 160
\item[Status]{Implemented} 161 161 \item[Status]{Implemented}
162 162
\item[Pre-conditions] 163 163 \item[Pre-conditions]
164 164
\begin{itemize} 165 165 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 166 166 \itemsep1pt\parskip0pt\parsep0pt
\item 167 167 \item
{The User has registered an account.} 168 168 {The User has registered an account.}
{The User knows their email and password.} 169 169 {The User knows their email and password.}
\end{itemize} 170 170 \end{itemize}
171 171
\item[Post-conditions] 172 172 \item[Post-conditions]
173 173
\begin{itemize} 174 174 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 175 175 \itemsep1pt\parskip0pt\parsep0pt
\item 176 176 \item
{The User can navigate the site and see their data.} 177 177 {The User can navigate the site and see their data.}
\end{itemize} 178 178 \end{itemize}
179 179
\item[Trigger]{The User wants to use the application and its core features.} 180 180 \item[Trigger]{The User wants to use the application and its core features.}
181 181
\item[Workflow] 182 182 \item[Workflow]
183 183
\begin{enumerate} 184 184 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 185 185 \itemsep1pt\parskip0pt\parsep0pt
\item 186 186 \item
{The frontend shall render the login form described in login.html and implemented in LoginController.js} 187 187 {The frontend shall render the login form described in login.html and implemented in LoginController.js}
\item 188 188 \item
{The User shall type in their email and password.} 189 189 {The User shall type in their email and password.}
\item 190 190 \item
{The backend shall verify that the User has submitted their email and password in views.py in function login.} 191 191 {The backend shall verify that the User has submitted their email and password in views.py in function login.}
\item 192 192 \item
{The backend shall check that the User is active in views.py in function login.} 193 193 {The backend shall check that the User is active in views.py in function login.}
\item 194 194 \item
{The backend shall log the User in using the Django login feature.} 195 195 {The backend shall log the User in using the Django login feature.}
\item 196 196 \item
{The frontend shall displays the home page for the User.} 197 197 {The frontend shall displays the home page for the User.}
\end{enumerate} 198 198 \end{enumerate}
\end{description} 199 199 \end{description}
\newpage 200 200 \newpage
201 201
\subsection{[A3] Add a Class} 202 202 \subsection{[A3] Add a Class}
\begin{description} 203 203 \begin{description}
\item[Description]{The User shall be able to add a class and access the 204 204 \item[Description]{The User shall be able to add a class and access the
flashcards associated with that class.} 205 205 flashcards associated with that class.}
206 206
\item[Desired Outcome]{The class shall be connected to the student's account 207 207 \item[Desired Outcome]{The class shall be connected to the student's account
and the User shall have the ability to read and publish flashcards 208 208 and the User shall have the ability to read and publish flashcards
for this class.} 209 209 for this class.}
\\ 210 210 \\
\item[User Goals]{The User wants to publish flashcards for this class, and 211 211 \item[User Goals]{The User wants to publish flashcards for this class, and
read the flashcards for this class that are published by other users.} 212 212 read the flashcards for this class that are published by other users.}
213 213
\item[Primary Actor]{User (student)} 214 214 \item[Primary Actor]{User (student)}
215 215
\item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User 216 216 \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
Login} 217 217 Login}
\\ 218 218 \\
\item[Priority Level]{``Must''} 219 219 \item[Priority Level]{``Must''}
220 220
\item[Status]{Implemented} 221 221 \item[Status]{Implemented}
222 222
\item[Pre-conditions] 223 223 \item[Pre-conditions]
224 224
\begin{itemize} 225 225 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 226 226 \itemsep1pt\parskip0pt\parsep0pt
\item 227 227 \item
{The User has registered an account.} 228 228 {The User has registered an account.}
\item 229 229 \item
{The User has successfully logged in to the application.} 230 230 {The User has successfully logged in to the application.}
\end{itemize} 231 231 \end{itemize}
232 232
\item[Post-conditions] 233 233 \item[Post-conditions]
234 234
\begin{itemize} 235 235 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 236 236 \itemsep1pt\parskip0pt\parsep0pt
\item 237 237 \item
{The User can view the flashcards being published for the class and 238 238 {The User can view the flashcards being published for the class and
add them to their deck.} 239 239 add them to their deck.}
\item 240 240 \item
{The User can publish flashcards to be viewed and added by other users 241 241 {The User can publish flashcards to be viewed and added by other users
in the same class.} 242 242 in the same class.}
\end{itemize} 243 243 \end{itemize}
244 244
\item[Trigger]{The User wants to make flashcards and view flashcards for a class.} 245 245 \item[Trigger]{The User wants to make flashcards and view flashcards for a class.}
246 246
\item[Workflow] 247 247 \item[Workflow]
248 248
\begin{enumerate} 249 249 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 250 250 \itemsep1pt\parskip0pt\parsep0pt
\item 251 251 \item
{The User shall click "Add a Class" from the drop down menu in the upper left hand corner.} 252 252 {The User shall click "Add a Class" from the drop down menu in the upper left hand corner.}
\item 253 253 \item
{The frontend shall navigate to the new page described by addclass.html.} 254 254 {The frontend shall navigate to the new page described by addclass.html.}
\item 255 255 \item
{The User shall begin to type the class department code, course title, course number, or instructor in the text box.} 256 256 {The User shall begin to type the class department code, course title, course number, or instructor in the text box.}
\item 257 257 \item
{The frontend in ClassAddController.js shall send a get request to the backend at api/sections/search/.} 258 258 {The frontend in ClassAddController.js shall send a get request to the backend at api/sections/search/.}
\item 259 259 \item
{The backend shall search the database for the classes matching department code, course title, course number, or instructor in models.py in function search.} 260 260 {The backend shall search the database for the classes matching department code, course title, course number, or instructor in models.py in function search.}
\item 261 261 \item
{The frontend shall show the classes that the backend has found.} 262 262 {The frontend shall show the classes that the backend has found.}
\item 263 263 \item
{The User shall select from the classes the one that they want to add.} 264 264 {The User shall select from the classes the one that they want to add.}
\item 265 265 \item
{The frontend shall enable the 'Add Class' button.} 266 266 {The frontend shall enable the 'Add Class' button.}
\item 267 267 \item
{The User shall click 'Add Class' button to the right of the text box.} 268 268 {The User shall click 'Add Class' button to the right of the text box.}
\item 269 269 \item
{The frontend shall send a post request to api/sections/.} 270 270 {The frontend shall send a post request to api/sections/.}
\item 271 271 \item
{The backend shall in views.py in function enroll shall call the method enroll in models.py.} 272 272 {The backend shall in views.py in function enroll shall call the method enroll in models.py.}
\item 273 273 \item
{The backend in models.py in function enroll shall add the class to the User's sections.} 274 274 {The backend in models.py in function enroll shall add the class to the User's sections.}
\item 275 275 \item
{The frontend shall redirect the User to the class's Live Feed using the ClassAddController.js.} 276 276 {The frontend shall redirect the User to the class's Live Feed using the ClassAddController.js.}
\item 277 277 \item
{The frontend shall present the live feed for the class by using feed.html and FeedController.js.} 278 278 {The frontend shall present the live feed for the class by using feed.html and FeedController.js.}
279 279
\end{enumerate} 280 280 \end{enumerate}
281 281
\item[Alternate Workflow: User is whitelisted.\\] 282 282 \item[Alternate Workflow: User is whitelisted.\\]
\begin{enumerate} 283 283 \begin{enumerate}
\setcounter{enumi}{3} 284 284 \setcounter{enumi}{3}
\itemsep1pt\parskip0pt\parsep0pt 285 285 \itemsep1pt\parskip0pt\parsep0pt
\item []{ Precondition: The class has a whitelist, a whitelist is a list of email addresses that can add themselves to the class.\\} 286 286 \item []{ Precondition: The class has a whitelist, a whitelist is a list of email addresses that can add themselves to the class.\\}
\item 287 287 \item
{The User shall select their desired class, which has a whitelist, by clicking on ``Add Class''.} 288 288 {The User shall select their desired class, which has a whitelist, by clicking on ``Add Class''.}
\item 289 289 \item
{The frontend shall submit a POST request to /api/me/sections with 290 290 {The frontend shall submit a POST request to /api/me/sections with
the course ID that the User typed. } 291 291 the course ID that the User typed. }
\item 292 292 \item
{The backend shall check if there is a whitelist for the class that the 293 293 {The backend shall check if there is a whitelist for the class that the
User has selected in models.py at function is\_whitelisted.} 294 294 User has selected in models.py at function is\_whitelisted.}
\item 295 295 \item
{The backend shall check if the user is on the whitelist in models.py 296 296 {The backend shall check if the user is on the whitelist in models.py
in function is\_user\_on\_whitelist.} 297 297 in function is\_user\_on\_whitelist.}
\item 298 298 \item
{The backend shall add the User to the class following steps above.} 299 299 {The backend shall add the User to the class following steps above.}
\item 300 300 \item
{The frontend shall redirect the User to the class's live feed followed the last step in the Workflow above.} 301 301 {The frontend shall redirect the User to the class's live feed followed the last step in the Workflow above.}
\end{enumerate} 302 302 \end{enumerate}
303 303
\item[Alternate Workflow: User is not whitelisted.] 304 304 \item[Alternate Workflow: User is not whitelisted.]
\begin{enumerate} 305 305 \begin{enumerate}
\setcounter{enumi}{7} 306 306 \setcounter{enumi}{7}
\itemsep1pt\parskip0pt\parsep0pt 307 307 \itemsep1pt\parskip0pt\parsep0pt
\item []{ Precondition: The class has a whitelist, a whitelist is a list of email addresses that can add themselves to the class.\\} 308 308 \item []{ Precondition: The class has a whitelist, a whitelist is a list of email addresses that can add themselves to the class.\\}
\item 309 309 \item
{The backend shall will check that the user is in the whitelist in models.py.} 310 310 {The backend shall will check that the user is in the whitelist in models.py.}
\item 311 311 \item
{The frontend shall display that the class is whitelisted and the Add Class button will not be enabled.} 312 312 {The frontend shall display that the class is whitelisted and the Add Class button will not be enabled.}
\end{enumerate} 313 313 \end{enumerate}
314 314
\end{description} 315 315 \end{description}
{} 316 316 {}
317 317
\newpage 318 318 \newpage
319 319
{} 320 320 {}
321 321
\subsection{[A4] Drop a Class} 322 322 \subsection{[A4] Drop a Class}
323 323
\begin{description} 324 324 \begin{description}
\item[Description]{The User can remove themselves from a course he/she is 325 325 \item[Description]{The User can remove themselves from a course he/she is
registered to} 326 326 registered to}
327 327
\item[Desired Outcome]{The User has dropped the class and no longer need 328 328 \item[Desired Outcome]{The User has dropped the class and no longer need
access to the flashcards for said class. This means they can no longer 329 329 access to the flashcards for said class. This means they can no longer
see the flashcards associated to the class that they dropped } 330 330 see the flashcards associated to the class that they dropped }
\\ 331 331 \\
\item[User Goals]{The User shall not have access to a class and the 332 332 \item[User Goals]{The User shall not have access to a class and the
flashcards associated with that class. They will no longer see the class 333 333 flashcards associated with that class. They will no longer see the class
listed in their drop down menu.} 334 334 listed in their drop down menu.}
335 335
\item[Primary Actor]{User (student)} 336 336 \item[Primary Actor]{User (student)}
337 337
\item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User 338 338 \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
Login, {[}A3{]} Add a Class} 339 339 Login, {[}A3{]} Add a Class}
\\ 340 340 \\
\item[Priority Level]{ ``Should''} 341 341 \item[Priority Level]{ ``Should''}
342 342
\item[Status]{Implemented } 343 343 \item[Status]{Implemented }
344 344
\item[Pre-conditions] 345 345 \item[Pre-conditions]
346 346
\begin{itemize} 347 347 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 348 348 \itemsep1pt\parskip0pt\parsep0pt
\item 349 349 \item
{The User has a valid account.} 350 350 {The User has a valid account.}
\item 351 351 \item
{The User is logged in.} 352 352 {The User is logged in.}
\item 353 353 \item
{The User has enrolled in at least one class.} 354 354 {The User has enrolled in at least one class.}
\item 355 355 \item
{The User has navigated to the Settings page.} 356 356 {The User has navigated to the Settings page.}
\end{itemize} 357 357 \end{itemize}
358 358
\item[Post-conditions]{} 359 359 \item[Post-conditions]{}
360 360
\begin{itemize} 361 361 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 362 362 \itemsep1pt\parskip0pt\parsep0pt
\item 363 363 \item
{User shall no longer have access to dropped class, or associated 364 364 {User shall no longer have access to dropped class, or associated
flashcards} 365 365 flashcards}
\end{itemize} 366 366 \end{itemize}
367 367
\item[Trigger]{User no longer wants to see flashcards from that class.} 368 368 \item[Trigger]{User no longer wants to see flashcards from that class.}
369 369
\item[Workflow] 370 370 \item[Workflow]
371 371
\begin{enumerate} 372 372 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 373 373 \itemsep1pt\parskip0pt\parsep0pt
\item 374 374 \item
{The User shall click `Drop' button to the right of the class they wish to drop.} 375 375 {The User shall click `Drop' button to the right of the class they wish to drop.}
\item 376 376 \item
{The frontend shall submit a DELETE request to 377 377 {The frontend shall submit a DELETE request to
/api/me/sections/\textless{}section ID number\textgreater{}.} 378 378 /api/me/sections/\textless{}section ID number\textgreater{}.}
\item 379 379 \item
{The backend shall check that the User is enrolled in the section in models.py in function drop.} 380 380 {The backend shall check that the User is enrolled in the section in models.py in function drop.}
\item 381 381 \item
{The server shall remove the selected class from a user's list of section in models.py in function drop. } 382 382 {The server shall remove the selected class from a user's list of section in models.py in function drop. }
\item 383 383 \item
{The frontend shall remove the class from the list in setting and show toast reading 'Dropped'.} 384 384 {The frontend shall remove the class from the list in setting and show toast reading 'Dropped'.}
\end{enumerate} 385 385 \end{enumerate}
\end{description} 386 386 \end{description}
\newpage 387 387 \newpage
388 388
{} 389 389 {}
390 390
\subsection{[A5] Password change} 391 391 \subsection{[A5] Password change}
392 392
\begin{description} 393 393 \begin{description}
\item[Description]{The User shall be able to change the password for their 394 394 \item[Description]{The User shall be able to change the password for their
account in the account settings. } 395 395 account in the account settings. }
396 396
\item[Desired Outcome]{The User's password shall be changed and the User 397 397 \item[Desired Outcome]{The User's password shall be changed and the User
shall be able to log in with the new password in the future} 398 398 shall be able to log in with the new password in the future}
\\\\ 399 399 \\\\
\item[User Goals]{The User wants to use a different password in the future} 400 400 \item[User Goals]{The User wants to use a different password in the future}
401 401
\item[Primary Actor]{User (student)} 402 402 \item[Primary Actor]{User (student)}
403 403
\item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User 404 404 \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
Login} 405 405 Login}
\\ 406 406 \\
\item[Details]{The User provides their current password and a new password 407 407 \item[Details]{The User provides their current password and a new password
in a form. If the current password is correct, the system updates their 408 408 in a form. If the current password is correct, the system updates their
password to the requested new password.} 409 409 password to the requested new password.}
410 410
\item[Priority Level]{``Must''} 411 411 \item[Priority Level]{``Must''}
412 412
\item[Status]{Implemented} 413 413 \item[Status]{Implemented}
414 414
\item[Pre-conditions] 415 415 \item[Pre-conditions]
416 416
\begin{itemize} 417 417 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 418 418 \itemsep1pt\parskip0pt\parsep0pt
\item 419 419 \item
{The User has registered an account.} 420 420 {The User has registered an account.}
\item 421 421 \item
{The User has logged in.} 422 422 {The User has logged in.}
\item 423 423 \item
{The User knows their current password.} 424 424 {The User knows their current password.}
\item 425 425 \item
{The User has navigated to the Settings page.} 426 426 {The User has navigated to the Settings page.}
\end{itemize} 427 427 \end{itemize}
428 428
\item[Post-conditions] 429 429 \item[Post-conditions]
430 430
\begin{itemize} 431 431 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 432 432 \itemsep1pt\parskip0pt\parsep0pt
\item 433 433 \item
{The User's password is changed} 434 434 {The User's password is changed}
\item 435 435 \item
{The User can log in with the new password} 436 436 {The User can log in with the new password}
\end{itemize} 437 437 \end{itemize}
438 438
\item[Trigger]{The User wants to change their password.} 439 439 \item[Trigger]{The User wants to change their password.}
440 440
\item[Error Handling] 441 441 \item[Error Handling]
\begin{description} 442 442 \begin{description}
\item[\small Missing Fields] \begin{itemize} 443 443 \item[\small Missing Fields] \begin{itemize}
\item The client shall enforce required fields 444 444 \item The client shall enforce required fields
\item The server will return an HTTP Bad Request error to the client. 445 445 \item The server will return an HTTP Bad Request error to the client.
\end{itemize} 446 446 \end{itemize}
\item[\small Incorrect Old Password] \begin{itemize} 447 447 \item[\small Incorrect Old Password] \begin{itemize}
\item The server will return an HTTP Forbidden error to the client. 448 448 \item The server will return an HTTP Forbidden error to the client.
\end{itemize} 449 449 \end{itemize}
\item[\small Blank New Password] \begin{itemize} 450 450 \item[\small Blank New Password] \begin{itemize}
\item The server will return an HTTP Bad Request error to the client. 451 451 \item The server will return an HTTP Bad Request error to the client.
\end{itemize} 452 452 \end{itemize}
\end{description} 453 453 \end{description}
\item[Workflow] 454 454 \item[Workflow]
455 455
\begin{enumerate} 456 456 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 457 457 \itemsep1pt\parskip0pt\parsep0pt
\item 458 458 \item
{The frontend shall render a form that requires the user to enter their 459 459 {The frontend shall render a form that requires the user to enter their
old password and new password from settings.html} 460 460 old password and new password from settings.html}
\item 461 461 \item
{The User shall type in their current password, the desired new 462 462 {The User shall type in their current password, the desired new
password, and retype the desired new password to confirm.} 463 463 password, and retype the desired new password to confirm.}
\item 464 464 \item
{The frontend shall submit the data to the server by sending a PATCH 465 465 {The frontend shall submit the data to the server by sending a PATCH
request to /api/me containing ``old\_password'' and 466 466 request to /api/me containing ``old\_password'' and
``new\_password'' values in SettingsController.js.} 467 467 ``new\_password'' values in SettingsController.js.}
\item (The ) 468 468 \item (The )
\item 469 469 \item
{The backend shall check the user's current password in views.py in function patch under UserDetail.} 470 470 {The backend shall check the user's current password in views.py in function patch under UserDetail.}
\item The backend shall update the user's current password in views.py in function patch under UserDetail. 471 471 \item The backend shall update the user's current password in views.py in function patch under UserDetail.
\item 472 472 \item
{The frontend shall present a toast reading "Password successfully changed" and redirect the User to the Add a Class page.} 473 473 {The frontend shall present a toast reading "Password successfully changed" and redirect the User to the Add a Class page.}
\end{enumerate} 474 474 \end{enumerate}
\end{description} 475 475 \end{description}
{} 476 476 {}
477 477
\newpage 478 478 \newpage
479 479
{} 480 480 {}
481 481
\subsection{[A6] Password reset} 482 482 \subsection{[A6] Password reset}
483 483
\begin{description} 484 484 \begin{description}
\item[Description]{The User shall be able to reset their password without 485 485 \item[Description]{The User shall be able to reset their password without
being logged in.} 486 486 being logged in.}
487 487
\item[Desired Outcome]{The User's password shall be changed to one that 488 488 \item[Desired Outcome]{The User's password shall be changed to one that
they remember.} 489 489 they remember.}
\\ 490 490 \\
\item[User Goals]{The User will be able to log into the site with a new password.} 491 491 \item[User Goals]{The User will be able to log into the site with a new password.}
492 492
\item[Primary Actor]{User (student)} 493 493 \item[Primary Actor]{User (student)}
494 494
\item[Dependency Use Cases]{{[}A1{]} User Registration} 495 495 \item[Dependency Use Cases]{{[}A1{]} User Registration}
\\ 496 496 \\
\item[Details]{The user provides their email in a password reset form. If 497 497 \item[Details]{The user provides their email in a password reset form. If
the address is valid, the site sends a password reset link with a random 498 498 the address is valid, the site sends a password reset link with a random
token to that address. If the address is invalid, the site does not send 499 499 token to that address. If the address is invalid, the site does not send
a link. For security reasons, we do not reveal to the user whether the 500 500 a link. For security reasons, we do not reveal to the user whether the
email address was valid, and we expire the link after 24 hours. When a 501 501 email address was valid, and we expire the link after 24 hours. When a
user visits the link emailed to them, they are able to specify a new 502 502 user visits the link emailed to them, they are able to specify a new
password in a form. When they submit the form, their password is updated 503 503 password in a form. When they submit the form, their password is updated
if the token is correct. } 504 504 if the token is correct. }
505 505
\item[Priority Level]{``Must''} 506 506 \item[Priority Level]{``Must''}
507 507
\item[Status]{Implemented} 508 508 \item[Status]{Implemented}
509 509
\item[Pre-conditions] 510 510 \item[Pre-conditions]
511 511
\begin{itemize} 512 512 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 513 513 \itemsep1pt\parskip0pt\parsep0pt
\item 514 514 \item
{The User has created an account before.} 515 515 {The User has created an account before.}
\item 516 516 \item
{The User knows the email address attached to their account for our application.} 517 517 {The User knows the email address attached to their account for our application.}
\item 518 518 \item
{The User can log into their email account.} 519 519 {The User can log into their email account.}
\end{itemize} 520 520 \end{itemize}
521 521
\item[Post-conditions] 522 522 \item[Post-conditions]
523 523
\begin{itemize} 524 524 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 525 525 \itemsep1pt\parskip0pt\parsep0pt
\item 526 526 \item
{The User's password is changed.} 527 527 {The User's password is changed.}
\item 528 528 \item
{The User can log in with the new password.} 529 529 {The User can log in with the new password.}
\end{itemize} 530 530 \end{itemize}
531 531
\item[Trigger]{The User wants to log into the site but does not know their password.} 532 532 \item[Trigger]{The User wants to log into the site but does not know their password.}
\item[Workflow] 533 533 \item[Workflow]
534 534
\begin{enumerate} 535 535 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 536 536 \itemsep1pt\parskip0pt\parsep0pt
\item 537 537 \item
{The User clicks ``Forgot Password'' text on the login page} 538 538 {The User clicks ``Forgot Password'' text on the login page}
\item 539 539 \item
{The frontend shall render the password reset page from the template requestpasswordreset.html.} 540 540 {The frontend shall render the password reset page from the template requestpasswordreset.html.}
\item 541 541 \item
{The User shall type in their email address for their account and click the "Reset" button.} 542 542 {The User shall type in their email address for their account and click the "Reset" button.}
\item 543 543 \item
{The frontend shall send a POST request to /api/request\_password\_reset/ from RequestResetController.js.} 544 544 {The frontend shall send a POST request to /api/request\_password\_reset/ from RequestResetController.js.}
\item 545 545 \item
{The backend shall check if an account exists with the email entered by 546 546 {The backend shall check if an account exists with the email entered by
the User in views.py in function request\_password\_reset.} 547 547 the User in views.py in function request\_password\_reset.}
\item 548 548 \item
{The backend shal send an email to the User with a link to the password reset page in models.py in function 549 549 {The backend shal send an email to the User with a link to the password reset page in models.py in function
request\_password\_reset.} 550 550 request\_password\_reset.}
\item 551 551 \item
{The User will navigate to their email account, open the email, and click the link.} 552 552 {The User will navigate to their email account, open the email, and click the link.}
\item 553 553 \item
{The frontend shall render the password reset page from the template resetpassword.html.} 554 554 {The frontend shall render the password reset page from the template resetpassword.html.}
\item 555 555 \item
{The User shall type in their new password and re-type it to confirm it.} 556 556 {The User shall type in their new password and re-type it to confirm it.}
\item 557 557 \item
{The frontend shall check if the new password is long enough and if the confirmed password is the same as 558 558 {The frontend shall check if the new password is long enough and if the confirmed password is the same as
the new password in ResetPasswordController.js.} 559 559 the new password in ResetPasswordController.js.}
\item 560 560 \item
{The frontend shall send a POST request to /api/reset\_password from ResetPasswordController.js.} 561 561 {The frontend shall send a POST request to /api/reset\_password from ResetPasswordController.js.}
\item 562 562 \item
{The backend shall change the user's password in views.py in function reset\_password.} 563 563 {The backend shall change the user's password in views.py in function reset\_password.}
\item 564 564 \item
{The frontend shall redirect the User to the login page. } 565 565 {The frontend shall redirect the User to the login page. }
\item 566 566 \item
{The User shall use their new password to login to the application.} 567 567 {The User shall use their new password to login to the application.}
\end{enumerate} 568 568 \end{enumerate}
\end{description} 569 569 \end{description}
\newpage 570 570 \newpage
571 571
{} 572 572 {}
573 573
\subsection{[A7] Limit Student Access to Courses} 574 574 \subsection{[A7] Limit Student Access to Courses}
575 575
\begin{description} 576 576 \begin{description}
\item[Description]{The instructor shall be able to limit access to the 577 577 \item[Description]{The instructor shall be able to limit access to the
courses that he is in charge of by whitelisting only those students that 578 578 courses that he is in charge of by whitelisting only those students that
are actually in the class.} 579 579 are actually in the class.}
580 580
\item[Desired Outcome]{The class will have limited access and only those 581 581 \item[Desired Outcome]{The class will have limited access and only those
users who are whitelisted may enroll in the class.} 582 582 users who are whitelisted may enroll in the class.}
\\ 583 583 \\
\item[User Goals]{The instructor wants to limit access to his class so only 584 584 \item[User Goals]{The instructor wants to limit access to his class so only
the students who are actually in his class participate, and nobody 585 585 the students who are actually in his class participate, and nobody
else.} 586 586 else.}
587 587
{Primary Actor: }{User (instructor)} 588 588 \item[Primary Actor]{Instructor}
589 589
\item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User 590 590 \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
Login} 591 591 Login}
\\ 592 592 \\
\item[Priority Level]{``Should''} 593 593 \item[Priority Level]{``Should''}
594 594
\item[Status]{Implemented} 595 595 \item[Status]{Implemented}
596 596
\item[Pre-conditions] 597 597 \item[Pre-conditions]
598 598
\begin{itemize} 599 599 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 600 600 \itemsep1pt\parskip0pt\parsep0pt
\item 601 601 \item
{User has valid instructor's account} 602 602 {User has valid instructor's account}
\end{itemize} 603 603 \end{itemize}
604 604
\item[Post-conditions] 605 605 \item[Post-conditions]
606 606
\begin{itemize} 607 607 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 608 608 \itemsep1pt\parskip0pt\parsep0pt
\item 609 609 \item
{Only those users who were whitelisted may add the class.} 610 610 {Only those users who were whitelisted may add the class.}
\end{itemize} 611 611 \end{itemize}
612 612
\item[Trigger]{The course instructor wants to limit the students who 613 613 \item[Trigger]{The course instructor wants to limit the students who
can add his class on our application.} 614 614 can add his class on our application.}
615 615
\item[Workflow] 616 616 \item[Workflow]
617 617
\begin{enumerate} 618 618 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 619 619 \itemsep1pt\parskip0pt\parsep0pt
\item 620 620 \item
{The instructor emails the administrators from his UCSD email address 621 621 {The instructor emails the administrators from his UCSD email address
and requests to limit access to his course. He provides a list of 622 622 and requests to limit access to his course. He provides a list of
emails of the students that are to be whitelisted.} 623 623 emails of the students that are to be whitelisted.}
\item 624 624 \item
{The administrators visit a custom admin page, select the course, and 625 625 {The administrators visit a custom admin page, select the course, and
paste the list of emails. They submit the page directly (no separate 626 626 paste the list of emails. They submit the page directly (no separate
frontend here) to the server.} 627 627 frontend here) to the server.}
\item 628 628 \item
{The backend shall create a WhitelistedAddress for each provided email, 629 629 {The backend shall create a WhitelistedAddress for each provided email,
attaching it to the section taught by the instructor.} 630 630 attaching it to the section taught by the instructor.}
\item 631 631 \item
{The backend shall add any existing users whose email addresses appear 632 632 {The backend shall add any existing users whose email addresses appear
in the whitelist to the class. } 633 633 in the whitelist to the class. }
\end{enumerate} 634 634 \end{enumerate}
\end{description} 635 635 \end{description}
\newpage 636 636 \newpage
637 637
\subsection{[A8] User Logout} 638 638 \subsection{[A8] User Logout}
639 639
\begin{description} 640 640 \begin{description}
\item[Description]{The User shall be able to log out of his/her account on 641 641 \item[Description]{The User shall be able to log out of his/her account on
the site.} 642 642 the site.}
643 643
\item[Desired Outcome]{The User's information and data will no longer be 644 644 \item[Desired Outcome]{The User's information and data will no longer be
accessible after logging out. } 645 645 accessible after logging out. }
\\ 646 646 \\
\item[User Goals]{The User is done with his/her session of using the 647 647 \item[User Goals]{The User is done with his/her session of using the
website, and wants to make sure others cannot access the data in his/her 648 648 website, and wants to make sure others cannot access the data in his/her
account.} 649 649 account.}
650 650
\item[Primary Actor]{User (student)} 651 651 \item[Primary Actor]{User (student)}
652 652
\item[Dependency Use Cases] None 653 653 \item[Dependency Use Cases] None
\\ 654 654 \\
\item[Priority Level]{``Must''} 655 655 \item[Priority Level]{``Must''}
656 656
\item[Status]{Implemented} 657 657 \item[Status]{Implemented}
658 658
\item[Pre-conditions]{The user is logged into their account} 659 659 \item[Pre-conditions]{The user is logged into their account}
660 660
\item[Post-conditions]{}{The user's data can no longer be accessed.} 661 661 \item[Post-conditions]{}{The user's data can no longer be accessed.}
662 662
\item[Trigger]{The User no longer wants to be logged into the application.} 663 663 \item[Trigger]{The User no longer wants to be logged into the application.}
664 664
\item[Workflow] 665 665 \item[Workflow]
666 666
\begin{enumerate} 667 667 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 668 668 \itemsep1pt\parskip0pt\parsep0pt
\item 669 669 \item
{The User clicks the 'Logout' button in the upper right hand corner.} 670 670 {The User clicks the 'Logout' button in the upper right hand corner.}
\item 671 671 \item
{The backend shall log the User out using the Django logout feature.} 672 672 {The backend shall log the User out using the Django logout feature.}
\item 673 673 \item
{The frontend renders the application login page using login.html.} 674 674 {The frontend renders the application login page using login.html.}
\end{enumerate} 675 675 \end{enumerate}
676 676
\end{description} 677 677 \end{description}
678 678
\newpage 679 679 \newpage
680 680
681 681
682 682
\subsection{[A9] Contact Admin} 683 683 \subsection{[A9] Contact Admin}
684 684
\begin{description} 685 685 \begin{description}
\item[Description]{The User shall be able to contact the admin.} 686 686 \item[Description]{The User shall be able to contact the admin.}
687 687
\item[Desired Outcome]{The User shall send a message to the admin; the 688 688 \item[Desired Outcome]{The User shall send a message to the admin; the
admin shall receive the message.} 689 689 admin shall receive the message.}
690 690
{User Goals:}{The User sends a message to the admin.} 691 691 {User Goals:}{The User sends a message to the admin.}
692 692
\item[Primary Actor]{User} 693 693 \item[Primary Actor]{User}
694 694
\item[Dependency Use Cases]{None} 695 695 \item[Dependency Use Cases]{None}
\\ 696 696 \\
\item[Priority Level]{``Must''} 697 697 \item[Priority Level]{``Must''}
698 698
\item[Status]{Implemented} 699 699 \item[Status]{Implemented}
700 700
\item[Pre-conditions]{The User has an account registered and is logged in.} 701 701 \item[Pre-conditions]{The User has an account registered and is logged in.}
702 702
\item[Post-conditions]{The admin receives the user's message.} 703 703 \item[Post-conditions]{The admin receives the user's message.}
704 704
\item[Trigger]{The User wants to contact the adiminstators of the site with 705 705 \item[Trigger]{The User wants to contact the adiminstators of the site with
bug reports, questions, or praise. } 706 706 bug reports, questions, or praise. }
707 707
\item[Workflow] 708 708 \item[Workflow]
709 709
\begin{enumerate} 710 710 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 711 711 \itemsep1pt\parskip0pt\parsep0pt
\item 712 712 \item
{The User shall click the '?' button in the right half of the navbar.} 713 713 {The User shall click the '?' button in the right half of the navbar.}
\item 714 714 \item
{The frontend shall render the page using the help.html template.} 715 715 {The frontend shall render the page using the help.html template.}
\item 716 716 \item
{The User shall scroll to the bottom of the page.} 717 717 {The User shall scroll to the bottom of the page.}
\item 718 718 \item
{The User shall click the text reading "Send Us an Email!"} 719 719 {The User shall click the text reading "Send Us an Email!"}
\item 720 720 \item
{The frontend shall open Microsoft Outlook or a similar application using the HelpController.js.} 721 721 {The frontend shall open Microsoft Outlook or a similar application using the HelpController.js.}
\item 722 722 \item
{The User shall see our email address in the recipients text box.} 723 723 {The User shall see our email address in the recipients text box.}
\end{enumerate} 724 724 \end{enumerate}
\end{description} 725 725 \end{description}
\newpage 726 726 \newpage
727 727
{} 728 728 {}
\section{Flashcards} 729 729 \section{Flashcards}
\subsection{[F1] Push Flashcard} 730 730 \subsection{[F1] Push Flashcard}
731 731
\begin{description} 732 732 \begin{description}
\item[Description]{The User shall be able to create a flashcard with their 733 733 \item[Description]{The User shall be able to create a flashcard with their
input. } 734 734 input. }
735 735
\item[Desired Outcome]{The User shall have the flashcard added to their own 736 736 \item[Desired Outcome]{The User shall have the flashcard added to their own
deck and the Live Feed. } 737 737 deck and the Live Feed. }
\\ 738 738 \\
\item[User Goals]{The User will see their flashcard in their deck and the 739 739 \item[User Goals]{The User will see their flashcard in their deck and the
flashcard will be shared with others. } 740 740 flashcard will be shared with others. }
741 741
\item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User 742 742 \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
Login, {[}A3{]} Add a Class} 743 743 Login, {[}A3{]} Add a Class}
\\ 744 744 \\
\item[Pre-conditions] 745 745 \item[Pre-conditions]
746 746
\begin{itemize} 747 747 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 748 748 \itemsep1pt\parskip0pt\parsep0pt
\item 749 749 \item
{The User has an account.} 750 750 {The User has an account.}
\item 751 751 \item
{The User has added at least one class.} 752 752 {The User has added at least one class.}
\item 753 753 \item
{The User has navigated to the live feed for a class.} 754 754 {The User has navigated to the live feed for a class.}
\end{itemize} 755 755 \end{itemize}
756 756
\item[Post-conditions] 757 757 \item[Post-conditions]
758 758
\begin{itemize} 759 759 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 760 760 \itemsep1pt\parskip0pt\parsep0pt
\item 761 761 \item
{The User has flashcard added to their deck.} 762 762 {The User has flashcard added to their deck.}
\item 763 763 \item
{The Flashcard is shown in the Live Feed.} 764 764 {The Flashcard is shown in the Live Feed.}
\item 765 765 \item
{Other users can add this flashcard to their decks.} 766 766 {Other users can add this flashcard to their decks.}
\end{itemize} 767 767 \end{itemize}
768 768
\item[Trigger]{The User wants to make a flashcard to study.} 769 769 \item[Trigger]{The User wants to make a flashcard to study.}
770 770
\item[Workflow] 771 771 \item[Workflow]
772 772
\begin{enumerate} 773 773 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 774 774 \itemsep1pt\parskip0pt\parsep0pt
\item 775 775 \item
{The User is at the live feed for the class from feed.html.} 776 776 {The User is at the live feed for the class from feed.html.}
\item 777 777 \item
{The User shall click on the '+' button at the bottom right of the screen.} 778 778 {The User shall click on the '+' button at the bottom right of the screen.}
\item 779 779 \item
{The frontend shall present a modal for inputting the flashcard text to the User.} 780 780 {The frontend shall present a modal for inputting the flashcard text to the User.}
\item 781 781 \item
{The User shall type in the content of their flashcard.} 782 782 {The User shall type in the content of their flashcard.}
\item 783 783 \item
{The User shall highlight keywords in the flashcard text.} 784 784 {The User shall highlight keywords in the flashcard text.}
\item 785 785 \item
{The User shall click on the `Contribute' button.} 786 786 {The User shall click on the `Contribute' button.}
\item {The frontend shallsubmit the flashcard text, 787 787 \item {The frontend shall generate a POST request consisting of the flashcard text,
blanks, and material date, in JSON form as a POST request.} 788 788 blanks, and material date, in JSON form in FeedController.js and send it to /api/flashcards/.}
\item 789 789 \item
{The backend shall obtain the flashcard information by deserializing 790 790 {The backend shall obtain the flashcard information by deserializing
the JSON in the POST request in views.py.} 791 791 the JSON in the POST request in views.py.}
\item 792 792 \item
{The backend shall create a new record for this flashcard in the 793 793 {The backend shall create a new record for this flashcard in the
Flashcards table in the database in models.py.} 794 794 Flashcards table in the database in models.py.}
\item 795 795 \item
{The frontend shall publish the newly created card to the live feed of 796 796 {The frontend shall publish the newly created card to the live feed of
the class using FeedController.js.} 797 797 the class using FeedController.js.}
\end{enumerate} 798 798 \end{enumerate}
\end{description} 799 799 \end{description}
\newpage 800 800 \newpage
{} 801 801 {}
802 802
\subsection{[F2] Edit Flashcard} 803 803 \subsection{[F2] Edit Flashcard}
804 804
\begin{description} 805 805 \begin{description}
\item[Description]{The User shall be able to duplicate the flashcard authored by a different user and make changes to it.} 806 806 \item[Description]{The User shall be able to duplicate the flashcard authored by a different user and make changes to it.}
807 807
\item[Desired Outcome]{The new flashcard is edited and saved appropriately.} 808 808 \item[Desired Outcome]{The new flashcard is edited and saved appropriately.}
\\ 809 809 \\
\item[User Goals]{To create a flashcard similar to an existing flashcard but with minor changes.} 810 810 \item[User Goals]{To create a flashcard similar to an existing flashcard but with minor changes.}
811 811
\item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User 812 812 \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard, {[}F3{]} Pull 813 813 Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard, {[}F3{]} Pull
Flashcard} 814 814 Flashcard}
815 815
\item[Pre-conditions] 816 816 \item[Pre-conditions]
817 817
\begin{itemize} 818 818 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 819 819 \itemsep1pt\parskip0pt\parsep0pt
\item 820 820 \item
{The flashcard to be edited is visible in the user's feed view or deck view.} 821 821 {The flashcard to be edited is visible in the user's feed view or deck view.}
\item 822 822 \item
{The user is currently in the feed view or the deck view of the course the card to be edited belongs to.} 823 823 {The user is currently in the feed view or the deck view of the course the card to be edited belongs to.}
\end{itemize} 824 824 \end{itemize}
825 825
\item[Post-conditions] 826 826 \item[Post-conditions]
827 827
\begin{itemize} 828 828 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 829 829 \itemsep1pt\parskip0pt\parsep0pt
\item 830 830 \item
{A duplicate flashcard with some differences is created.} 831 831 {A duplicate flashcard with some differences is created.}
\end{itemize} 832 832 \end{itemize}
833 833
\item[Trigger] {The User wants to duplicate a card and make some changes to it and thus create a new flashcard.} 834 834 \item[Trigger] {The User wants to duplicate a card and make some changes to it and thus create a new flashcard.}
\item[Workflow] 835 835 \item[Workflow]
836 836
\begin{enumerate} 837 837 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 838 838 \itemsep1pt\parskip0pt\parsep0pt
\item{The user shall hover over the card to be edited and and click on the 839 839 \item{The user shall hover over the card to be edited and and click on the
pencil button that appears on the bottom left of the card.} 840 840 pencil button that appears on the bottom left of the card.}
\item 841 841 \item
{The frontend shall produce an editable dialog box containing the flashcard 842 842 {The frontend shall produce an editable dialog box containing the flashcard
text } 843 843 text }
\item 844 844 \item
{The user shall make desired changes} 845 845 {The user shall make desired changes}
\item 846 846 \item
{The user shall click `Save Changes'} 847 847 {The user shall click `Save Changes'}
\item 848 848 \item
{The client shall generate a POST request for a new flashcard and send 849 849 {The client shall generate a PATCH request for a new flashcard in CardGridController.js
it to the server at /api/flashcards/} 850 850 and send it to the server at /api/flashcards/}
\item 851 851 \item
{If the user changed only the blanks of the cards, the server shall 852 852 {If the user changed only the blanks of the cards, the server shall
create a new FlashcardMask object and update the appropriate 853 853 create a new FlashcardMask object and update the appropriate
UserFlashcard object with a reference to it.} 854 854 UserFlashcard object with a reference to it.}
\item 855 855 \item
{If the user changed the text of the card, the server will instead:} 856 856 {If the user changed the text of the card, the server will instead:}
\end{enumerate} 857
858 857
\begin{enumerate} 859 858 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 860 859 \itemsep1pt\parskip0pt\parsep0pt
\item 861 860 \item
{create a new flashcard for the section} 862 861 {Create a new flashcard for the section}
\item 863 862 \item
{push it to the feed} 864 863 {Push it to the feed}
\item 865 864 \item
{add it to the user's deck} 866 865 {Add it to the user's deck}
\item 867 866 \item
{hide the old card from the user} 868 867 {Hide the old card from the user}
\item 869 868 \item
{and return the new card to the user} 870 869 {Return the new card to the user}
\end{enumerate} 871 870 \end{enumerate}
871 \end{enumerate}
\end{description} 872 872 \end{description}
{} 873 873 {}
874 874
\newpage 875 875 \newpage
876 876
{} 877 877 {}
878 878
\subsection{[F3] Pull Flashcard} 879 879 \subsection{[F3] Pull Flashcard}
\begin{description} 880 880 \begin{description}
\item[Description]{The User shall be able to add flash cards to their own 881 881 \item[Description]{The User shall be able to add flash cards to their own
deck from the Live Feed. } 882 882 deck from the Live Feed. }
883 883
\item[Desired Outcome]{The User shall have the flashcard added to their own 884 884 \item[Desired Outcome]{The User shall have the flashcard added to their own
deck } 885 885 deck }
\\ 886 886 \\
\item[User Goals]{The user will be able to review that flashcard. } 887 887 \item[User Goals]{The user will be able to review that flashcard. }
888 888
\item[Primary Actor]{User (student)} 889 889 \item[Primary Actor]{User (student)}
890 890
\item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User 891 891 \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashard} 892 892 Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashard}
\\ 893 893 \\
\item[Priority Level]{``Must'' } 894 894 \item[Priority Level]{``Must'' }
895 895
\item[Status]{Implemented} 896 896 \item[Status]{Implemented}
897 897
\item[Pre-conditions] 898 898 \item[Pre-conditions]
899 899
\begin{itemize} 900 900 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 901 901 \itemsep1pt\parskip0pt\parsep0pt
\item 902 902 \item
{A flashcard has been created and is in the Live Feed for a class. } 903 903 {A flashcard has been created and is in the Live Feed for a class. }
\item 904 904 \item
{The User is currently viewing the Live Feed for that class.} 905 905 {The User is currently viewing the Live Feed for that class.}
\end{itemize} 906 906 \end{itemize}
907 907
\item[Post-conditions] 908 908 \item[Post-conditions]
909 909
\begin{itemize} 910 910 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 911 911 \itemsep1pt\parskip0pt\parsep0pt
\item 912 912 \item
{User shall have that flashcard added to their deck.} 913 913 {User shall have that flashcard added to their deck.}
\item 914 914 \item
{User can review this flashcard later.} 915 915 {User can review this flashcard later.}
\end{itemize} 916 916 \end{itemize}
917 917
\item[Trigger]{The User wants to save a flashcard for review later.} 918 918 \item[Trigger]{The User wants to save a flashcard for review later.}
919 919
\item[Workflow] 920 920 \item[Workflow]
921 921
\begin{enumerate} 922 922 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 923 923 \itemsep1pt\parskip0pt\parsep0pt
\item 924 924 \item
{User shall click on the ``Pull Flashcard'' button on a Flashcard in 925 925 {The user shall hover over the flashcard he wants to add to his deck and click on the '+'
the Feed.} 926 926 icon that appears in the center of the card.}
\item 927 927 \item
{The frontend shall } 928 928 {The frontend shall make the pulled Flashcard appear in the user's deck.}
\item 929 929 \item
{The Client shall make the pulled Flashcard appear in the User's Deck 930 930 {The frontend shall generate a POST request in FlashcardFactory.js and send it to
on the sidebar.} 931
\item 932
{The Client shall submit a POST request to 933
/api/flashcards/\textless{}flashcard id\textgreater{}/pull} 934 931 /api/flashcards/\textless{}flashcard id\textgreater{}/pull}
\item 935 932 \item
{The server shall create a UserFlashcard object to represent that the 936 933 {The server shall call the FlashcardViewSet.pull to handle the POST request sent by the frontend.}
user's deck contains the card.} 937 934 \item
935 {The FlashcardViewSet.pull method should call the user.pull method in models.py with the flashcard object
936 to be pulled as an argument}
937 \item
938 {The user.pull method shall create a UserFlashcard object associated with the request's user and the
939 passed in flashcard object and save it in the database.}
\item 938 940 \item
{The server shall notify connected clients about the new card rating, 939 941 {The server shall notify connected clients about the new card rating,
if any} 940 942 if any}
\item 941 943 \item
{Connected clients will take the new rating into account when next 942 944 {Connected clients will take the new rating into account when next
rearranging the feed.} 943 945 rearranging the feed.}
\end{enumerate} 944 946 \end{enumerate}
\end{description} 945 947 \end{description}
\newpage 946 948 \newpage
947 949
{} 948 950 {}
949 951
\subsection{[F4] Flag Inappropriate Cards} 950 952 \subsection{[F4] Flag Inappropriate Cards}
951 953
\begin{description} 952 954 \begin{description}
\item[Description]{Cards may be flagged indicating inappropriate content} 953 955 \item[Description]{Cards may be flagged indicating inappropriate content}
954 956
\item[Desired Outcome]{The flashcard's inappropriateness variable is 955 957 \item[Desired Outcome]{The flashcard's inappropriateness variable is
adjusted.} 956 958 adjusted.}
\\ 957 959 \\
\item[User Goals]{To note if a card should not belong in the class and 958 960 \item[User Goals]{To note if a card should not belong in the class and
should not be displayed in the feed.} 959 961 should not be displayed in the feed.}
960 962
\item[Primary Actor]{User (Student)} 961 963 \item[Primary Actor]{User (Student)}
962 964
\item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User 963 965 \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard} 964 966 Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard}
\\ 965 967 \\
\item[Priority Level]{``Should''} 966 968 \item[Priority Level]{``Should''}
967 969
\item[Status]{Implemented} 968 970 \item[Status]{Implemented}
969 971
\item[Pre-conditions] 970 972 \item[Pre-conditions]
971 973
\begin{itemize} 972 974 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 973 975 \itemsep1pt\parskip0pt\parsep0pt
\item 974 976 \item
{User is enrolled in a class} 975 977 {User is enrolled in a class}
\end{itemize} 976 978 \end{itemize}
977 979
\begin{itemize} 978 980 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 979 981 \itemsep1pt\parskip0pt\parsep0pt
\item 980 982 \item
{Flashcard is created.} 981 983 {Flashcard is created.}
\item 982 984 \item
{Flashcard is viewable in feed.} 983 985 {Flashcard is viewable in feed.}
\item 984 986 \item
{The User has clicked the red button on the flashcard which is the "Hide Card" button.} 985 987 {The User has clicked the red button on the flashcard which is the "Hide Card" button.}
\end{itemize} 986 988 \end{itemize}
987 989
\item[Post-conditions] 988 990 \item[Post-conditions]
989 991
\begin{itemize} 990 992 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 991 993 \itemsep1pt\parskip0pt\parsep0pt
\item 992 994 \item
{Flashcard is hidden from user.} 993 995 {Flashcard is hidden from user.}
\item 994 996 \item
{Flashcard internal variable is adjusted.} 995 997 {Flashcard internal variable is adjusted.}
\end{itemize} 996 998 \end{itemize}
997 999
\item[Trigger]{The User does not like the particular flashcard.} 998 1000 \item[Trigger]{The User does not like the particular flashcard.}
999 1001
\item[Workflow] 1000 1002 \item[Workflow]
1001 1003
\begin{enumerate} 1002 1004 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1003 1005 \itemsep1pt\parskip0pt\parsep0pt
\item { 1004 1006 \item {
The frontend displays a toast that offers the User the report text.} 1005 1007 The frontend displays a toast that offers the User the report text.}
\item 1006 1008 \item
{The User clicks the ``Report'' text on the flashcard.} 1007 1009 {The User clicks the ``Report'' text on the flashcard.}
\item 1008 1010 \item
{The frontend shall hide the flashcard from the User.} 1009 1011 {The frontend shall hide the flashcard from the User.}
\item 1010 1012 \item
{The backend shall check if the User already hid the flashcard in views.py function report.} 1011 1013 {The backend shall check if the User already hid the flashcard in views.py function report.}
\item 1012 1014 \item
{The backend shall hide the flashcard in models.py in class FlashcardHide. } 1013 1015 {The backend shall hide the flashcard in models.py in class FlashcardHide. }
\end{enumerate} 1014 1016 \end{enumerate}
\end{description} 1015 1017 \end{description}
{} 1016 1018 {}
1017 1019
{} 1018 1020 {}
1019 1021
\newpage 1020 1022 \newpage
1021 1023
{} 1022 1024 {}
1023 1025
\subsection{[F5] Filter Flashcards - Deferred} 1024 1026 \subsection{[F5] Filter Flashcards - Deferred}
1025 1027
\begin{description} 1026 1028 \begin{description}
\item[Description]{The User is able to filter for flashcards by date.} 1027 1029 \item[Description]{The User is able to filter for flashcards by date.}
1028 1030
\item[Desired Outcome]{The User shall see flashcards based on the filter 1029 1031 \item[Desired Outcome]{The User shall see flashcards based on the filter
options.} 1030 1032 options.}
1031 1033
{User Goals:}{The User can find what he/she is specifically looking 1032 1034 {User Goals:}{The User can find what he/she is specifically looking
for.} 1033 1035 for.}
1034 1036
\item[Primary Actor]{User (student)} 1035 1037 \item[Primary Actor]{User (student)}
1036 1038
\item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User 1037 1039 \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard, {[}F3{]} Pull 1038 1040 Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard, {[}F3{]} Pull
Flashcard} 1039 1041 Flashcard}
\\ 1040 1042 \\
\item[Priority Level]{''Should''} 1041 1043 \item[Priority Level]{''Should''}
1042 1044
\item[Status]{Not Implemented } 1043 1045 \item[Status]{Not Implemented }
1044 1046
\item[Pre-conditions] 1045 1047 \item[Pre-conditions]
1046 1048
\begin{itemize} 1047 1049 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1048 1050 \itemsep1pt\parskip0pt\parsep0pt
\item 1049 1051 \item
{User has added the class.} 1050 1052 {User has added the class.}
\item 1051 1053 \item
{Flashcards exist in the course.} 1052 1054 {Flashcards exist in the course.}
\item 1053 1055 \item
{The User has navigated to the study page.} 1054 1056 {The User has navigated to the study page.}
\end{itemize} 1055 1057 \end{itemize}
1056 1058
\item[Post-conditions]{} 1057 1059 \item[Post-conditions]{}
1058 1060
\begin{itemize} 1059 1061 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1060 1062 \itemsep1pt\parskip0pt\parsep0pt
\item 1061 1063 \item
{User only sees specific flashcards} 1062 1064 {User only sees specific flashcards}
\end{itemize} 1063 1065 \end{itemize}
1064 1066
\item[Trigger]{The User wants to only see cards for a specific date range.} 1065 1067 \item[Trigger]{The User wants to only see cards for a specific date range.}
1066 1068
\item[Workflow] 1067 1069 \item[Workflow]
1068 1070
\begin{enumerate} 1069 1071 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1070 1072 \itemsep1pt\parskip0pt\parsep0pt
\item 1071 1073 \item
{The frontend shall render the page described in study.html.} 1072 1074 {The frontend shall render the page described in study.html.}
\item 1073 1075 \item
{The User fills in the date fields.} 1074 1076 {The User fills in the date fields.}
\item 1075 1077 \item
{The frontend checks the date fields before making the POST request to /api/study.} 1076 1078 {The frontend checks the date fields before making the POST request to /api/study.}
\item 1077 1079 \item
{The system follows the Study workflow, displaying only cards made within a certain date time.} 1078 1080 {The system follows the Study workflow, displaying only cards made within a certain date time.}
1079 1081
\end{enumerate} 1080 1082 \end{enumerate}
\end{description} 1081 1083 \end{description}
{} 1082 1084 {}
1083 1085
\newpage 1084 1086 \newpage
1085 1087
{} 1086 1088 {}
1087 1089
\subsection{[F6] Blank Out Words in Flashcard} 1088 1090 \subsection{[F6] Blank Out Words in Flashcard}
1089 1091
\begin{description} 1090 1092 \begin{description}
\item[Description]{The User shall be able to blank out keywords in any 1091 1093 \item[Description]{The User shall be able to blank out keywords in any
flashcard in his deck. } 1092 1094 flashcard in his deck. }
1093 1095
\item[Desired Outcome]{The blanked out words in the flashcard notify the 1094 1096 \item[Desired Outcome]{The blanked out words in the flashcard notify the
System that they are keywords. } 1095 1097 System that they are keywords. }
\\ 1096 1098 \\
\item[User Goals]{The User shall mark some words as keywords so the System 1097 1099 \item[User Goals]{The User shall mark some words as keywords so the System
may later quiz theirself by blanking out the keywords and having the 1098 1100 may later quiz theirself by blanking out the keywords and having the
User guess what they are.} 1099 1101 User guess what they are.}
1100 1102
{Primary Actor: }{User (student)} 1101 1103 {Primary Actor: }{User (student)}
1102 1104
\item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User 1103 1105 \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard} 1104 1106 Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard}
\\ 1105 1107 \\
\item[Priority Level]{``Must''} 1106 1108 \item[Priority Level]{``Must''}
1107 1109
\item[Status]{Implemented.} 1108 1110 \item[Status]{Implemented.}
1109 1111
\item[Pre-conditions] 1110 1112 \item[Pre-conditions]
1111 1113
\begin{itemize} 1112 1114 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1113 1115 \itemsep1pt\parskip0pt\parsep0pt
\item 1114 1116 \item
{The User has an account and is logged in.} 1115 1117 {The User has an account and is logged in.}
\item 1116 1118 \item
{The User shall be on the Live Feed for the class.} 1117 1119 {The User shall be on the Live Feed for the class.}
\item 1118 1120 \item
{The User has clicked the 'c' hotkey or the 'plus' button to start making a card.} 1119 1121 {The User has clicked the 'c' hotkey or the 'plus' button to start making a card.}
\item 1120 1122 \item
{The User shall type in information relevant to their class.} 1121 1123 {The User shall type in information relevant to their class.}
\end{itemize} 1122 1124 \end{itemize}
1123 1125
{Post-conditions: } 1124 1126 {Post-conditions: }
1125 1127
\begin{itemize} 1126 1128 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1127 1129 \itemsep1pt\parskip0pt\parsep0pt
\item 1128 1130 \item
{The blanked out words in the flashcard are marked as keywords.} 1129 1131 {The blanked out words in the flashcard are marked as keywords.}
\item 1130 1132 \item
{The System shall blank out the keywords and let the User guess what 1131 1133 {The System shall blank out the keywords and let the User guess what
they are when it presents the flashcard to the User for reviewing.} 1132 1134 they are when it presents the flashcard to the User for reviewing.}
\end{itemize} 1133 1135 \end{itemize}
1134 1136
\item[Trigger]{The User wants to make a flashcard and be quizzed on parts of the flashcard while they study.} 1135 1137 \item[Trigger]{The User wants to make a flashcard and be quizzed on parts of the flashcard while they study.}
1136 1138
\item[Workflow] 1137 1139 \item[Workflow]
1138 1140
\begin{enumerate} 1139 1141 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1140 1142 \itemsep1pt\parskip0pt\parsep0pt
\item 1141 1143 \item
{The User shall highlight the words that he wishes to blank out.} 1142 1144 {The User shall highlight the words that he wishes to blank out.}
\item 1143 1145 \item
{The User shall click the 'Contribute' button.} 1144 1146 {The User shall click the 'Contribute' button.}
\item 1145 1147 \item
{The backend shall mark those words by updating the field mask for 1146 1148 {The backend shall mark those words by updating the field mask for
that userflashcard object in views.py in function create. } 1147 1149 that userflashcard object in views.py in function create. }
\item 1148 1150 \item
{The backend shall save those in models.py.} 1149 1151 {The backend shall save those in models.py.}
\item 1150 1152 \item
{The frontend shall change the color of the text that was blanked out in flashcard.html.} 1151 1153 {The frontend shall change the color of the text that was blanked out in flashcard.html.}
\end{enumerate} 1152 1154 \end{enumerate}
1153 1155
{Alternative Workflows:} 1154 1156 {Alternative Workflows:}
1155 1157
\begin{enumerate} 1156 1158 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1157 1159 \itemsep1pt\parskip0pt\parsep0pt
\item 1158 1160 \item
{Precondition: The User has clicked the edit flashcard button instead of creating a new card.} 1159 1161 {Precondition: The User has clicked the edit flashcard button instead of creating a new card.}
\item 1160 1162 \item
{The User shall highlight selection text and click either ctrl-b or 'Blank Selected Text'.} 1161 1163 {The User shall highlight selection text and click either ctrl-b or 'Blank Selected Text'.}
\item 1162 1164 \item
{The backend shall mark those words by updating the field mask for 1163 1165 {The backend shall mark those words by updating the field mask for
that userflashcard object in views.py in function create. } 1164 1166 that userflashcard object in views.py in function create. }
\item 1165 1167 \item
{The backend shall save those in models.py.} 1166 1168 {The backend shall save those in models.py.}
\item 1167 1169 \item
{The frontend shall change the color of the text that was blanked out in flashcard.html.} 1168 1170 {The frontend shall change the color of the text that was blanked out in flashcard.html.}
1169 1171
\end{enumerate} 1170 1172 \end{enumerate}
\end{description} 1171 1173 \end{description}
{} 1172 1174 {}
1173 1175
\newpage 1174 1176 \newpage
1175 1177
{} 1176 1178 {}
1177 1179
\subsection{[F7] Fix Flashcard} 1178 1180 \subsection{[F7] Fix Flashcard}
1179 1181
\begin{description} 1180 1182 \begin{description}
\item[Description]{The User shall be able to alter a flashcard he/she made 1181 1183 \item[Description]{The User shall be able to alter a flashcard he/she made
originally and not have to make a new copy of it.} 1182 1184 originally and not have to make a new copy of it.}
1183 1185
\item[Desired Outcome]{The User shall alter one flashcard and that 1184 1186 \item[Desired Outcome]{The User shall alter one flashcard and that
alteration will be shown to all users of that flashcard} 1185 1187 alteration will be shown to all users of that flashcard}
\\ 1186 1188 \\
\item[User Goals]{The user shall make the flashcard say something different 1187 1189 \item[User Goals]{The user shall make the flashcard say something different
than it did originally.} 1188 1190 than it did originally.}
1189 1191
\item[Primary Actor]{User (student) } 1190 1192 \item[Primary Actor]{User (student) }
1191 1193
\item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User 1192 1194 \item[Dependency Use Cases]{{[}A1{]} User Registration, {[}A2{]} User
Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard} 1193 1195 Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard}
\\ 1194 1196 \\
\item[Priority Level]{Must} 1195 1197 \item[Priority Level]{Must}
1196 1198
\item[Status]{Not Implemented} 1197 1199 \item[Status]{Not Implemented}
1198 1200
\item[Pre-conditions] 1199 1201 \item[Pre-conditions]
1200 1202
\begin{itemize} 1201 1203 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1202 1204 \itemsep1pt\parskip0pt\parsep0pt
\item 1203 1205 \item
{User has created the flashcard} 1204 1206 {User has created the flashcard}
\end{itemize} 1205 1207 \end{itemize}
1206 1208
\item[Post-conditions]{} 1207 1209 \item[Post-conditions]{}
1208 1210
\begin{itemize} 1209 1211 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1210 1212 \itemsep1pt\parskip0pt\parsep0pt
\item 1211 1213 \item
{The user shall see their alteration for that flashcard} 1212 1214 {The user shall see their alteration for that flashcard}
\item 1213 1215 \item
{Other users will be notified of the alteration} 1214 1216 {Other users will be notified of the alteration}
\end{itemize} 1215 1217 \end{itemize}
1216 1218
\item[Trigger]{User (creator of original card) has clicked on the button 1217 1219 \item[Trigger]{User (creator of original card) has clicked on the button
``Edit''} 1218 1220 ``Edit''}
1219 1221
\item[Workflow] 1220 1222 \item[Workflow]
1221 1223
\begin{enumerate} 1222 1224 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1223 1225 \itemsep1pt\parskip0pt\parsep0pt
\item 1224 1226 \item
{User shall select one of the Flashcards they authored.} 1225 1227 {User shall select one of the Flashcards they authored.}
\item 1226 1228 \item
{User shall select ``Edit'' button on the flashcard.} 1227 1229 {User shall select ``Edit'' button on the flashcard.}
\item 1228 1230 \item
{Client shall display an ``Edit Flashcard'' view.} 1229 1231 {Client shall display an ``Edit Flashcard'' view.}
\item 1230 1232 \item
{The Flashcard will display editable fields/areas.} 1231 1233 {The Flashcard will display editable fields/areas.}
\item 1232 1234 \item
{The User shall input any changes to the Flashcard.} 1233 1235 {The User shall input any changes to the Flashcard.}
\item 1234 1236 \item
{The User shall select the ``Done Editing'' button.} 1235 1237 {The User shall select the ``Done Editing'' button.}
\item 1236 1238 \item
{The Client shall close the ``Edit Flashcard'' view.} 1237 1239 {The Client shall close the ``Edit Flashcard'' view.}
\item 1238 1240 \item
{The server shall update the Flashcard's content.} 1239 1241 {The server shall update the Flashcard's content.}
\item 1240 1242 \item
{Client shall notify users with the Flashcard that the Flashcard has 1241 1243 {Client shall notify users with the Flashcard that the Flashcard has
been edited, allowing the other users to keep or to discard the 1242 1244 been edited, allowing the other users to keep or to discard the
changes.} 1243 1245 changes.}
\end{enumerate} 1244 1246 \end{enumerate}
\end{description} 1245 1247 \end{description}
{} 1246 1248 {}
1247 1249
{} 1248 1250 {}
1249 1251
{} 1250 1252 {}
1251 1253
\newpage 1252 1254 \newpage
1253 1255
{} 1254 1256 {}
1255 1257
\subsection{[F8] Hide Cards} 1256 1258 \subsection{[F8] Hide Cards}
1257 1259
\begin{description} 1258 1260 \begin{description}
\item[Description]{The user shall be able to hide cards from feed} 1259 1261 \item[Description]{The user shall be able to hide cards from feed}
1260 1262
\item[Desired Outcome]{The card is no longer visible to the user} 1261 1263 \item[Desired Outcome]{The card is no longer visible to the user}
\\ 1262 1264 \\
\item[User Goals]{The card has been looked at and should be hidden to 1263 1265 \item[User Goals]{The card has been looked at and should be hidden to
reduce screen clutter} 1264 1266 reduce screen clutter}
1265 1267
{Primary Actor: }{User (Student)} 1266 1268 {Primary Actor: }{User (Student)}
1267 1269
\item[Dependency Use Cases]{}{}{{[}A1{]} User Registration, {[}A2{]} User 1268 1270 \item[Dependency Use Cases]{}{}{{[}A1{]} User Registration, {[}A2{]} User
Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard} 1269 1271 Login, {[}A3{]} Add a Class, {[}F1{]} Push Flashcard}
\\ 1270 1272 \\
\item[Priority Level]{``Should''} 1271 1273 \item[Priority Level]{``Should''}
1272 1274
{Status:}{Implemented} 1273 1275 {Status:}{Implemented}
1274 1276
\item[Pre-conditions]{Flashcard is created, flashcard is viewable by user.} 1275 1277 \item[Pre-conditions]{Flashcard is created, flashcard is viewable by user.}
1276 1278
\item[Post-conditions]{Flashcard is not viewable by user} 1277 1279 \item[Post-conditions]{Flashcard is not viewable by user}
1278 1280
\item[Trigger]{The User no longer wants to see a card in their feed and deck.} 1279 1281 \item[Trigger]{The User no longer wants to see a card in their feed and deck.}
1280 1282
\item[Workflow] 1281 1283 \item[Workflow]
1282 1284
\begin{enumerate} 1283 1285 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1284 1286 \itemsep1pt\parskip0pt\parsep0pt
\item 1285 1287 \item
{The User chooses a class from the drop down menu.} 1286 1288 {The User chooses a class from the drop down menu.}
\item 1287 1289 \item
{The frontend renders the Live Feed for the selected class from feed.html.} 1288 1290 {The frontend renders the Live Feed for the selected class from feed.html.}
\item 1289 1291 \item
{The User sees a card they want to hide.} 1290 1292 {The User sees a card they want to hide.}
\item 1291 1293 \item
{The User shall press the ``Hide Flashcard'' button on the card to be 1292 1294 {The User shall press the ``Hide Flashcard'' button on the card to be
hidden.} 1293 1295 hidden.}
\item 1294 1296 \item
{The frontend shall make a request to the backend from FeedController.js.} 1295 1297 {The frontend shall make a request to the backend from FeedController.js.}
\item 1296 1298 \item
{The backend shall check if the User has already hidden that card in views.py.} 1297 1299 {The backend shall check if the User has already hidden that card in views.py.}
\item 1298 1300 \item
{The backend shall change the falshcard to hidden in the models.py.} 1299 1301 {The backend shall change the falshcard to hidden in the models.py.}
\item 1300 1302 \item
{The frontend shall no longer show that card when the feed is rendered.} 1301 1303 {The frontend shall no longer show that card when the feed is rendered.}
\end{enumerate} 1302 1304 \end{enumerate}
1303 1305
\end{description} 1304 1306 \end{description}
1305 1307
\newpage 1306 1308 \newpage
1307 1309
{} 1308 1310 {}
1309 1311
\subsection{[F9] View a Feed} 1310 1312 \subsection{[F9] View a Feed}
1311 1313
\begin{description} 1312 1314 \begin{description}
\item[Description]{The User shall be able to view Live Feeds for different 1313 1315 \item[Description]{The User shall be able to view Live Feeds for different
classes} 1314 1316 classes}
1315 1317
\item[Desired Outcome]{The system shall only show the user Live Feeds for 1316 1318 \item[Desired Outcome]{The system shall only show the user Live Feeds for
specific classes. } 1317 1319 specific classes. }
\\ 1318 1320 \\
\item[User Goals]{The User will see only one Live Feed at a time. } 1319 1321 \item[User Goals]{The User will see only one Live Feed at a time. }
1320 1322
\item[Dependency Use Cases]{}{}{{[}A1{]} User Registration, {[}A2{]} User 1321 1323 \item[Dependency Use Cases]{}{}{{[}A1{]} User Registration, {[}A2{]} User
Login, {[}A3{]} Add a Class} 1322 1324 Login, {[}A3{]} Add a Class}
\\ 1323 1325 \\
\item[Priority Level]{``Must''} 1324 1326 \item[Priority Level]{``Must''}
1325 1327
{Status:}{Implemented} 1326 1328 {Status:}{Implemented}
1327 1329
\item[Pre-conditions]{User has added a class.} 1328 1330 \item[Pre-conditions]{User has added a class.}
1329 1331
\item[Post-conditions]{User shall see the Live Feed for that class} 1330 1332 \item[Post-conditions]{User shall see the Live Feed for that class}
1331 1333
\item[Trigger]{User shall select a class} 1332 1334 \item[Trigger]{User shall select a class}
1333 1335
\item[Workflow] 1334 1336 \item[Workflow]
1335 1337
\begin{enumerate} 1336 1338 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1337 1339 \itemsep1pt\parskip0pt\parsep0pt
\item 1338 1340 \item
{The User logs into their account.} 1339 1341 {The User logs into their account.}
\item 1340 1342 \item
{The System verifies the User's credentials and saves their session.} 1341 1343 {The System verifies the User's credentials and saves their session.}
\item 1342 1344 \item
{The User is at their dashboard.} 1343 1345 {The User is at their dashboard.}
\item 1344 1346 \item
{The Client shows the User's dashboard.} 1345 1347 {The Client shows the User's dashboard.}
\item 1346 1348 \item
{The User selects a class from their dashboard.} 1347 1349 {The User selects a class from their dashboard.}
\item 1348 1350 \item
{The Client displays the Live Feed for the class.} 1349 1351 {The Client displays the Live Feed for the class.}
\end{enumerate} 1350 1352 \end{enumerate}
1351 1353
\end{description} 1352 1354 \end{description}
\newpage 1353 1355 \newpage
1354 1356
{} 1355 1357 {}
\section{Decks} 1356 1358 \section{Decks}
\subsection{[-D2-] Making a deck - Removed} 1357 1359 \subsection{[-D2-] Making a deck - Removed}
1358 1360
\begin{description} 1359 1361 \begin{description}
\item[Description]{Upon selecting the right course, the student has the 1360 1362 \item[Description]{Upon selecting the right course, the student has the
power to make a deck by either selecting existing flashcard or adding a 1361 1363 power to make a deck by either selecting existing flashcard or adding a
new flashcard.} 1362 1364 new flashcard.}
1363 1365
\item[Desired Outcome]{The user can keep track of cards that s/he wants.} 1364 1366 \item[Desired Outcome]{The user can keep track of cards that s/he wants.}
\\ 1365 1367 \\
\item[User Goals]{The user has a personal deck ready for review later.} 1366 1368 \item[User Goals]{The user has a personal deck ready for review later.}
1367 1369
\item[Primary Actor]{User (student)} 1368 1370 \item[Primary Actor]{User (student)}
1369 1371
\item[Dependency Use Cases]{Add a class {[}A3{]}, Add Flashcards to Deck 1370 1372 \item[Dependency Use Cases]{Add a class {[}A3{]}, Add Flashcards to Deck
{[}F1{]}, Make a Flashcard {[}F3{]}} 1371 1373 {[}F1{]}, Make a Flashcard {[}F3{]}}
\\ 1372 1374 \\
\item[Priority Level]{``Must''} 1373 1375 \item[Priority Level]{``Must''}
1374 1376
\item[Status]{In Progress} 1375 1377 \item[Status]{In Progress}
1376 1378
\item[Pre-conditions] 1377 1379 \item[Pre-conditions]
1378 1380
\begin{itemize} 1379 1381 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1380 1382 \itemsep1pt\parskip0pt\parsep0pt
\item 1381 1383 \item
{The user has an account with the application. } 1382 1384 {The user has an account with the application. }
\item 1383 1385 \item
{The user has been added to the desired class.} 1384 1386 {The user has been added to the desired class.}
\end{itemize} 1385 1387 \end{itemize}
1386 1388
\item[Post-conditions] 1387 1389 \item[Post-conditions]
1388 1390
\begin{itemize} 1389 1391 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1390 1392 \itemsep1pt\parskip0pt\parsep0pt
\item 1391 1393 \item
{Desired cards are added to user's deck to the specific class } 1392 1394 {Desired cards are added to user's deck to the specific class }
\item 1393 1395 \item
{User's deck is added to the database.} 1394 1396 {User's deck is added to the database.}
\end{itemize} 1395 1397 \end{itemize}
1396 1398
\item[Trigger]{User has selected a card from the pool. User submitted a 1397 1399 \item[Trigger]{User has selected a card from the pool. User submitted a
new flashcard after ``Make New Flashcard''.} 1398 1400 new flashcard after ``Make New Flashcard''.}
1399 1401
\item[Workflow] 1400 1402 \item[Workflow]
1401 1403
\begin{enumerate} 1402 1404 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1403 1405 \itemsep1pt\parskip0pt\parsep0pt
\item 1404 1406 \item
{User is at their dashboard.} 1405 1407 {User is at their dashboard.}
\item 1406 1408 \item
{User selects the class of interest that they had no activity in yet.} 1407 1409 {User selects the class of interest that they had no activity in yet.}
\item 1408 1410 \item
{Client displays the Live Feed for the class.} 1409 1411 {Client displays the Live Feed for the class.}
\item 1410 1412 \item
{User presses ``Pull Flashcard'' button on a Flashcard that they want 1411 1413 {User presses ``Pull Flashcard'' button on a Flashcard that they want
in their Deck.} 1412 1414 in their Deck.}
\item 1413 1415 \item
{The server creates a Deck for the User for the Class of interest.} 1414 1416 {The server creates a Deck for the User for the Class of interest.}
\item 1415 1417 \item
{The server adds the Flashcard to the User's Deck.} 1416 1418 {The server adds the Flashcard to the User's Deck.}
\item 1417 1419 \item
{The Client makes the Flashcard disappear from the Live Feed.} 1418 1420 {The Client makes the Flashcard disappear from the Live Feed.}
\item 1419 1421 \item
{The Client displays the Flashcard in the User's Deck in the sidebar.} 1420 1422 {The Client displays the Flashcard in the User's Deck in the sidebar.}
\end{enumerate} 1421 1423 \end{enumerate}
1422 1424
{Alternate Workflow:} 1423 1425 {Alternate Workflow:}
1424 1426
\begin{enumerate} 1425 1427 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1426 1428 \itemsep1pt\parskip0pt\parsep0pt
\item 1427 1429 \item
{User is at their dashboard.} 1428 1430 {User is at their dashboard.}
\item 1429 1431 \item
{User selects the class of interest that they had no activity in yet.} 1430 1432 {User selects the class of interest that they had no activity in yet.}
\item 1431 1433 \item
{Client displays the Live Feed for the class.} 1432 1434 {Client displays the Live Feed for the class.}
\item 1433 1435 \item
{The User adds a Flashcard into the Class.} 1434 1436 {The User adds a Flashcard into the Class.}
\item 1435 1437 \item
{The server creates a Deck for the User for the Class of interest.} 1436 1438 {The server creates a Deck for the User for the Class of interest.}
\item 1437 1439 \item
{The server adds the new Flashcard to the User's Deck.} 1438 1440 {The server adds the new Flashcard to the User's Deck.}
\item 1439 1441 \item
{The Client makes the Flashcard disappear from the Live Feed.} 1440 1442 {The Client makes the Flashcard disappear from the Live Feed.}
\item 1441 1443 \item
{The Client displays the Flashcard in the User's Deck in the sidebar.} 1442 1444 {The Client displays the Flashcard in the User's Deck in the sidebar.}
\end{enumerate} 1443 1445 \end{enumerate}
\end{description} 1444 1446 \end{description}
\newpage 1445 1447 \newpage
1446 1448
{} 1447 1449 {}
1448 1450
\subsection{[D1] Remove a card from a deck} 1449 1451 \subsection{[D1] Remove a card from a deck}
1450 1452
\begin{description} 1451 1453 \begin{description}
\item[Description]{The user can remove flashcards from their deck.} 1452 1454 \item[Description]{The user can remove flashcards from their deck.}
1453 1455
\item[Desired Outcome]{The user will not be notified about that card. } 1454 1456 \item[Desired Outcome]{The user will not be notified about that card. }
\\ 1455 1457 \\
\item[User Goals]{To only review cards that the user wants to review. } 1456 1458 \item[User Goals]{To only review cards that the user wants to review. }
1457 1459
\item[Primary Actor]{User (student)} 1458 1460 \item[Primary Actor]{User (student)}
1459 1461
\item[Dependency Use Cases]{Add a class {[}A3{]}, Add Flashcards to Deck 1460 1462 \item[Dependency Use Cases]{Add a class {[}A3{]}, Add Flashcards to Deck
{[}F1{]}, Make a Flashcard {[}F3{]}} 1461 1463 {[}F1{]}, Make a Flashcard {[}F3{]}}
\\ 1462 1464 \\
\item[Priority Level]{``Must''} 1463 1465 \item[Priority Level]{``Must''}
1464 1466
\item[Status]{Implemented} 1465 1467 \item[Status]{Implemented}
1466 1468
\item[Pre-conditions] 1467 1469 \item[Pre-conditions]
1468 1470
\begin{itemize} 1469 1471 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1470 1472 \itemsep1pt\parskip0pt\parsep0pt
\item 1471 1473 \item
{The User has an account with the application} 1472 1474 {The User has an account with the application}
\item 1473 1475 \item
{The User is logged in} 1474 1476 {The User is logged in}
\end{itemize} 1475 1477 \end{itemize}
1476 1478
\item[Post-conditions] 1477 1479 \item[Post-conditions]
1478 1480
\begin{itemize} 1479 1481 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1480 1482 \itemsep1pt\parskip0pt\parsep0pt
\item 1481 1483 \item
{Desired cards are hidden to the user.} 1482 1484 {Desired cards are hidden to the user.}
\end{itemize} 1483 1485 \end{itemize}
1484 1486
\item[Trigger]{User has selected a card to be hidden.} 1485 1487 \item[Trigger]{User has selected a card to be hidden.}
1486 1488
\item[Workflow] 1487 1489 \item[Workflow]
1488 1490
\begin{enumerate} 1489 1491 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1490 1492 \itemsep1pt\parskip0pt\parsep0pt
\item 1491 1493 \item
{The Client shows the user the dashboard.} 1492 1494 {The Client shows the user the dashboard.}
\item 1493 1495 \item
{The User shall select the appropriate class.} 1494 1496 {The User shall select the appropriate class.}
\item 1495 1497 \item
{The System checks if the class is in session.} 1496 1498 {The System checks if the class is in session.}
\item 1497 1499 \item
{The User shall select deck view.} 1498 1500 {The User shall select deck view.}
\item 1499 1501 \item
{The Client shall route the user to the deck view.} 1500 1502 {The Client shall route the user to the deck view.}
\item 1501 1503 \item
{The User clicks a flashcard's remove button.} 1502 1504 {The User clicks a flashcard's remove button.}
\item 1503 1505 \item
{The Client shall send a DELETE request to the server}{}{at 1504 1506 {The Client shall send a DELETE request to the server}{}{at
/api/flashcard/\textless{}flashcard ID\textgreater{}/remove} 1505 1507 /api/flashcard/\textless{}flashcard ID\textgreater{}/remove}
\item 1506 1508 \item
{The Server removes the flashcard from the User's Deck.} 1507 1509 {The Server removes the flashcard from the User's Deck.}
\item 1508 1510 \item
{The Server updates the flashcard's position in the Live Feed.} 1509 1511 {The Server updates the flashcard's position in the Live Feed.}
\item 1510 1512 \item
{The Client updates the User's Deck.} 1511 1513 {The Client updates the User's Deck.}
\end{enumerate} 1512 1514 \end{enumerate}
1513 1515
{} 1514 1516 {}
1515 1517
{Alternate Workflow:} 1516 1518 {Alternate Workflow:}
1517 1519
\begin{enumerate} 1518 1520 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1519 1521 \itemsep1pt\parskip0pt\parsep0pt
\item 1520 1522 \item
{The Client shows the user the dashboard.} 1521 1523 {The Client shows the user the dashboard.}
\item 1522 1524 \item
{The User shall select the appropriate class.} 1523 1525 {The User shall select the appropriate class.}
\item 1524 1526 \item
{The System checks if the class is }{not}{in session.} 1525 1527 {The System checks if the class is }{not}{in session.}
\item 1526 1528 \item
{The Client shall the user to the deck view.} 1527 1529 {The Client shall the user to the deck view.}
\item 1528 1530 \item
{The User clicks a flashcard's remove button.} 1529 1531 {The User clicks a flashcard's remove button.}
\item 1530 1532 \item
{The Client shall send a DELETE request to the server}{}{at 1531 1533 {The Client shall send a DELETE request to the server}{}{at
/api/flashcard/\textless{}flashcard ID\textgreater{}/remove} 1532 1534 /api/flashcard/\textless{}flashcard ID\textgreater{}/remove}
\item 1533 1535 \item
{The Server removes the flashcard from the User's Deck.} 1534 1536 {The Server removes the flashcard from the User's Deck.}
\item 1535 1537 \item
{The Server updates the flashcard's position in the Live Feed.} 1536 1538 {The Server updates the flashcard's position in the Live Feed.}
\item 1537 1539 \item
{The Client updates the User's Deck.} 1538 1540 {The Client updates the User's Deck.}
\end{enumerate} 1539 1541 \end{enumerate}
\end{description} 1540 1542 \end{description}
1541 1543
\subsection{[-D2-] Shuffling deck - Removed} 1542 1544 \subsection{[-D2-] Shuffling deck - Removed}
1543 1545
\begin{description} 1544 1546 \begin{description}
\item[Description]{User is able to shuffle his/her deck as a way to study 1545 1547 \item[Description]{User is able to shuffle his/her deck as a way to study
the flashcards} 1546 1548 the flashcards}
1547 1549
\item[Desired Outcome]{When taking a quiz, the user will notice that 1548 1550 \item[Desired Outcome]{When taking a quiz, the user will notice that
flashcards appear in random order} 1549 1551 flashcards appear in random order}
1550 1552
{User Goals:}{Improve quiz taking skills and knowledge consumption} 1551 1553 {User Goals:}{Improve quiz taking skills and knowledge consumption}
1552 1554
\item[Primary Actor]{User (student)} 1553 1555 \item[Primary Actor]{User (student)}
1554 1556
\item[Dependency Use Cases]{Deck has been created {[}D2{]}} 1555 1557 \item[Dependency Use Cases]{Deck has been created {[}D2{]}}
\\ 1556 1558 \\
\item[Priority Level]{}{''Won't''} 1557 1559 \item[Priority Level]{}{''Won't''}
1558 1560
\item[Status]{Implemented } 1559 1561 \item[Status]{Implemented }
1560 1562
\item[Pre-conditions] 1561 1563 \item[Pre-conditions]
1562 1564
\begin{itemize} 1563 1565 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1564 1566 \itemsep1pt\parskip0pt\parsep0pt
\item 1565 1567 \item
{User must have registered for course } 1566 1568 {User must have registered for course }
\end{itemize} 1567 1569 \end{itemize}
1568 1570
\begin{itemize} 1569 1571 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1570 1572 \itemsep1pt\parskip0pt\parsep0pt
\item 1571 1573 \item
{User must have added cards to deck} 1572 1574 {User must have added cards to deck}
\end{itemize} 1573 1575 \end{itemize}
1574 1576
\item[Post-conditions]{} 1575 1577 \item[Post-conditions]{}
TestCases.tex View file @ 88d1384
\documentclass[letterpaper]{scrartcl} % or whatever 1 1 \documentclass[letterpaper]{scrartcl} % or whatever
\usepackage{tgpagella} 2 2 \usepackage{tgpagella}
\setkomafont{disposition}{\normalfont\bfseries} 3 3 \setkomafont{disposition}{\normalfont\bfseries}
%\usepackage[markuppercase]{scrpage2} 4 4 %\usepackage[markuppercase]{scrpage2}
\title{\huge System Test Plan} 5 5 \title{\huge System Test Plan}
\date{\today} 6 6 \date{\today}
\author{\Large Students With A Goal (S.W.A.G.)} 7 7 \author{\Large Students With A Goal (S.W.A.G.)}
\usepackage[pass]{geometry} 8 8 \usepackage[pass]{geometry}
\usepackage{hyperref} 9 9 \usepackage{hyperref}
\usepackage{graphicx} 10 10 \usepackage{graphicx}
\usepackage{enumitem} 11 11 \usepackage{enumitem}
\setlist[description]{style=multiline,leftmargin=3cm,font=\normalfont\textbf} 12 12 \setlist[description]{style=multiline,leftmargin=3cm,font=\normalfont\textbf}
\setlistdepth{9} 13 13 \setlistdepth{9}
14 14
\setlist[itemize,1]{label=$\bullet$} 15 15 \setlist[itemize,1]{label=$\bullet$}
\setlist[itemize,2]{label=$\bullet$} 16 16 \setlist[itemize,2]{label=$\bullet$}
\setlist[itemize,3]{label=$\bullet$} 17 17 \setlist[itemize,3]{label=$\bullet$}
\setlist[itemize,4]{label=$\bullet$} 18 18 \setlist[itemize,4]{label=$\bullet$}
\setlist[itemize,5]{label=$\bullet$} 19 19 \setlist[itemize,5]{label=$\bullet$}
\setlist[itemize,6]{label=$\bullet$} 20 20 \setlist[itemize,6]{label=$\bullet$}
\setlist[itemize,7]{label=$\bullet$} 21 21 \setlist[itemize,7]{label=$\bullet$}
\setlist[itemize,8]{label=$\bullet$} 22 22 \setlist[itemize,8]{label=$\bullet$}
\setlist[itemize,9]{label=$\bullet$} 23 23 \setlist[itemize,9]{label=$\bullet$}
\renewlist{itemize}{itemize}{9} 24 24 \renewlist{itemize}{itemize}{9}
\begin{document} 25 25 \begin{document}
\maketitle 26 26 \maketitle
\begin{center} 27 27 \begin{center}
\includegraphics[width=12cm]{../swag_logo.png}\\ 28 28 \includegraphics[width=12cm]{../swag_logo.png}\\
29 29
\begin{tabular}{l r} 30 30 \begin{tabular}{l r}
Melody Jeng & System Architect \\ 31 31 Melody Jeng & System Architect \\
Arno Gau & Senior System Analyst \\ 32 32 Arno Gau & Senior System Analyst \\
Rachel Lee & Software Development Lead \\ 33 33 Rachel Lee & Software Development Lead \\
Laura Hawkins & Project Manager \\ 34 34 Laura Hawkins & Project Manager \\
Rohan Rangray & Algorithms Specialist\\ 35 35 Rohan Rangray & Algorithms Specialist\\
Andrew Buss & Database Specialist \\ 36 36 Andrew Buss & Database Specialist \\
Nam Phuong Tran & Quality Assurance Lead \\ 37 37 Nam Phuong Tran & Quality Assurance Lead \\
Chung Kang Wang & Business Analyst\\ 38 38 Chung Kang Wang & Business Analyst\\
Masud Rahman & User Interface Specialist\\ 39 39 Masud Rahman & User Interface Specialist\\
Kevin Mach & User Interface Specialist\\ 40 40 Kevin Mach & User Interface Specialist\\
\end{tabular} 41 41 \end{tabular}
\end{center} 42 42 \end{center}
\newpage 43 43 \newpage
\tableofcontents 44 44 \tableofcontents
\newpage 45 45 \newpage
46 46
\section{Testing Notes} 47 47 \section{Testing Notes}
\subsection{Testing Accounts} 48 48 \subsection{Testing Accounts}
UserX\\ 49 49 UserX\\
- email: userx@flashy.cards\\ 50 50 - email: UserX@flashy.cards\\
- password: mynameisuserx 51 51 - password: mynameisuserx
\\ 52 52 \\
UserY\\ 53 53 UserY\\
- email: usery@flashy.cards\\ 54 54 - email: UserY@flashy.cards\\
- password: mynameisusery 55 55 - password: mynameisusery
56 56
\subsection{Fixtures} 57 57 \subsection{Fixtures}
Fixtures are provided to reset the database to a known state before running each test case. This isolates the effects of each test case and simplifies resolution of preconditions. Each test case specifies a test fixture which may be applied by running the command \texttt{scripts/apply-test-fixture.sh <fixture name>} in the root of the backend directory. Once a fixture has been applied, reload the page, log back in (if required by the test case) and continue running the test case. 58 58 Fixtures are provided to reset the database to a known state before running each test case. This isolates the effects of each test case and simplifies resolution of preconditions. Each test case specifies a test fixture which may be applied by running the command \texttt{scripts/apply-test-fixture.sh <fixture name>} in the root of the backend directory. Once a fixture has been applied, reload the page, log back in (if required by the test case) and continue running the test case.
\subsection{Testing Multiple Users} 59 59 \subsection{Testing Multiple Users}
Some test cases relating to real-time functionality require two users simultaneously logged into the the application. This requires two separate browser sessions. Refer to browser documentation for this. 60 60 Some test cases relating to real-time functionality require two users simultaneously logged into the the application. This requires two separate browser sessions. Refer to browser documentation for this.
\subsection{Supported Browser} 61 61 \subsection{Supported Browser}
Flashy officially supports Chrome version 42 on Windows and Linux. Frontend functionality may be degraded on other browsers. 62 62 Flashy officially supports Chrome version 42 on Windows and Linux. Frontend functionality may be degraded on other browsers.
63 63
\subsection{Sent Emails in Development} 64 64 \subsection{Sent Emails in Development}
As noted in the backend README, when run as a local development server for testing, Flashy does not actually send email except in a production environment. Sending email requires an AWS SES key that we do not want to bundle with our application's source. Instead they are printed out to the server console. When any reference is made to an email being sent, check the console. Example: 65 65 As noted in the backend README, when run as a local development server for testing, Flashy does not actually send email except in a production environment. Sending email requires an AWS SES key that we do not want to bundle with our application's source. Instead they are printed out to the server console. When any reference is made to an email being sent, check the console. Example:
66 66
\includegraphics[width=4in]{../doc_screenshots/console_backend.png} 67 67 \includegraphics[width=4in]{../doc_screenshots/console_backend.png}
68 68
\newpage 69 69 \newpage
70 70
71 71
\section{Accounts} 72 72 \section{Accounts}
73 73
\subsection{[A1] User Registration} 74 74 \subsection{[A1] User Registration}
\begin{description}[style=multiline,leftmargin=3cm] 75 75 \begin{description}[style=multiline,leftmargin=3cm]
76 76
\item[Description:]{This test case outlines the presentation layer step 77 77 \item[Description:]{This test case outlines the presentation layer step
process of a user registering for an account with our application.} 78 78 process of a user registering for an account with our application.}
79 79
\item[Desired Outcome:]{An account will be created for the User from the 80 80 \item[Desired Outcome:]{An account will be created for the User from the
specified username, password, email. The User will be able to log into 81 81 specified username, password, email. The User will be able to log into
the aforementioned account.} 82 82 the aforementioned account.}
83 83
\item[User Goals:]{The User shall have an account to participate in the 84 84 \item[User Goals:]{The User shall have an account to participate in the
website's activities.} 85 85 website's activities.}
86 86
\item[Dependency Use Cases:]{None} 87 87 \item[Dependency Use Cases:]{None}
\\ 88 88 \\
89 89
\item[Priority Level:]{``Must''} 90 90 \item[Priority Level:]{``Must''}
91 91
\item[Status:]{Implemented} 92 92 \item[Status:]{Implemented}
93 93
\item[Preconditions:] 94 94 \item[Preconditions:]
\begin{itemize} 95 95 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 96 96 \itemsep1pt\parskip0pt\parsep0pt
\item 97 97 \item
{None} 98 98 {None}
\end{itemize} 99 99 \end{itemize}
100 100
\item[Postconditions:] 101 101 \item[Postconditions:]
\begin{itemize} 102 102 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 103 103 \itemsep1pt\parskip0pt\parsep0pt
\item 104 104 \item
{The User has an account registered with the system.} 105 105 {The User has an account registered with the system.}
\end{itemize} 106 106 \end{itemize}
107 107
\item[Trigger:]{UserX wants to start creating flashcards for a class.} 108 108 \item[Trigger:]{UserX wants to start creating flashcards for a class.}
109 109
\item[Workflow:] 110 110 \item[Workflow:]
\begin{enumerate} 111 111 \begin{enumerate}
\item 112 112 \item
{UserX shall click the ``Sign Up'' button.} 113 113 {UserX shall click the ``Sign Up'' button.}
\item 114 114 \item
{The System shall display a registration form.} 115 115 {The System shall display a registration form.}
\item 116 116 \item
{UserX shall fill in the form with email \mbox{UserX@flashy.cards} and password 117 117 {UserX shall fill in the form with email \mbox{UserX@flashy.cards} and password
\mbox{``mynameisuserx''}.} 118 118 \mbox{``mynameisuserx''}.}
\item 119 119 \item
{The System shall successfully receive the correct credentials and send an 120 120 {The System shall successfully receive the correct credentials and send an
email to the User's address with a link to validate the User's email address 121 121 email to the User's address with a link to validate the User's email address
and displays the Add Class page to the User.} 122 122 and displays the Add Class page to the User.}
\item 123 123 \item
{The System shall display a toast ``Please verify your email address! RESEND 124 124 {The System shall display a toast ``Please verify your email address! RESEND
VERIFICATION EMAIL''.} 125 125 VERIFICATION EMAIL''.}
\item 126 126 \item
{UserX receives an email with a link to verify their email. The 127 127 {UserX receives an email with a link to verify their email. The
User clicks the link (see Testing Notes).} 128 128 User clicks the link (see Testing Notes).}
\item 129 129 \item
{The System shall mark UserX's email as valid.} 130 130 {The System shall mark UserX's email as valid.}
\item 131 131 \item
{UserX shall click ``Logout'' (power button) in the top left corner.} 132 132 {UserX shall click ``Logout'' (power button) in the top left corner.}
\item 133 133 \item
{The System shall present UserX Login screen.} 134 134 {The System shall present UserX Login screen.}
\item 135 135 \item
{UserX shall once again login with \mbox{``UserX@flashy.cards''} and \mbox{``mynameisuserx''}.} 136 136 {UserX shall once again login with \mbox{``UserX@flashy.cards''} and \mbox{``mynameisuserx''}.}
\end{enumerate} 137 137 \end{enumerate}
138 138
\item [Expected Result:]{UserX shall see Add Class page without a toast asking 139 139 \item [Expected Result:]{UserX shall see Add Class page without a toast asking
UserX to verify their email.} 140 140 UserX to verify their email.}
141 141
\end{description} 142 142 \end{description}
\newpage 143 143 \newpage
144 144
{} 145 145 {}
146 146
\subsection{[A2] User Login} 147 147 \subsection{[A2] User Login}
148 148
\begin{description} 149 149 \begin{description}
\item[Description:]{This test case outlines the presentation layering step 150 150 \item[Description:]{This test case outlines the presentation layering step
process of a user logging into the application.} 151 151 process of a user logging into the application.}
152 152
\item[Desired Outcome:]{The User shall be able to provide their email address and 153 153 \item[Desired Outcome:]{The User shall be able to provide their email address and
password to access their courses and flash cards. The User shall gain 154 154 password to access their courses and flash cards. The User shall gain
access to the list of the courses they have added, and be able to review 155 155 access to the list of the courses they have added, and be able to review
the flashcards they have added to their decks.} 156 156 the flashcards they have added to their decks.}
157 157
\item[User Goals:]{The User wants to resume use of the site on another 158 158 \item[User Goals:]{The User wants to resume use of the site on another
device, or use the site after logging out.} 159 159 device, or use the site after logging out.}
160 160
\item[Dependency Use Cases:]{[A1] User Registration} 161 161 \item[Dependency Use Cases:]{[A1] User Registration}
\\ 162 162 \\
163 163
\item[Priority Level:]{``Must''} 164 164 \item[Priority Level:]{``Must''}
165 165
\item[Status:]{Implemented} 166 166 \item[Status:]{Implemented}
167 167
\item[Preconditions:] 168 168 \item[Preconditions:]
\begin{itemize} 169 169 \begin{itemize}
\item 170 170 \item
{The User has created an account before with email \mbox{``UserX@flashy.cards''} with 171 171 {The User has created an account before with email \mbox{``UserX@flashy.cards''} with
password \mbox{``mynameisuserx''}.} 172 172 password \mbox{``mynameisuserx''}.}
\end{itemize} 173 173 \end{itemize}
174 174
\item[Postconditions:] 175 175 \item[Postconditions:]
\begin{itemize} 176 176 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 177 177 \itemsep1pt\parskip0pt\parsep0pt
\item 178 178 \item
{The user can navigate the site and see their data.} 179 179 {The user can navigate the site and see their data.}
\end{itemize} 180 180 \end{itemize}
181 181
\item[Trigger:]{UserX wants to view, add, or create cards for a class or classes.} 182 182 \item[Trigger:]{UserX wants to view, add, or create cards for a class or classes.}
183 183
\item[Workflow:] 184 184 \item[Workflow:]
\begin{enumerate} 185 185 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 186 186 \itemsep1pt\parskip0pt\parsep0pt
\item 187 187 \item
{UserX shall enter their email \mbox{``UserX@flashy.cards''} and password 188 188 {UserX shall enter their email \mbox{``UserX@flashy.cards''} and password
\mbox{``mynameisuserx''}.} 189 189 \mbox{``mynameisuserx''}.}
\item 190 190 \item
{The System shall authenticate UserX's email and password and checks if UserX is active.} 191 191 {The System shall authenticate UserX's email and password and checks if UserX is active.}
\item 192 192 \item
{The System shall receive the credentials and display the ``Add Class'' page to the User.} 193 193 {The System shall receive the credentials and display the ``Add Class'' page to the User.}
\end{enumerate} 194 194 \end{enumerate}
\item [Expected Result:] 195 195 \item [Expected Result:]
{The User is brought to the page ``Add Class''.}\\ 196 196 {The User is brought to the page ``Add Class''.}\\
197 197
\item [Alternate Workflow A:] 198 198 \item [Alternate Workflow A:]
\begin{enumerate} 199 199 \begin{enumerate}
\item 200 200 \item
{UserX accidentally puts in the credentials \mbox{``UserX@flashy.cards''}, 201 201 {UserX accidentally puts in the credentials \mbox{``UserX@flashy.cards''},
\mbox{``hahahaha''} and clicks the ``Login'' button.} 202 202 \mbox{``hahahaha''} and clicks the ``Login'' button.}
\item 203 203 \item
{The System shows UserX the site login page with a message reading 204 204 {The System shows UserX the site login page with a message reading
``Invalid username or password!!''.} 205 205 ``Invalid username or password!!''.}
\end {enumerate} 206 206 \end {enumerate}
207 207
\item [Expected Result:] 208 208 \item [Expected Result:]
{The User is not able to login.} \\ 209 209 {The User is not able to login.} \\
210 210
\item [Alternate Workflow B:] 211 211 \item [Alternate Workflow B:]
\begin{enumerate} 212 212 \begin{enumerate}
\item 213 213 \item
{UserX accidentally puts in the credentials \mbox{``NotUserX@flashy.cards''}, 214 214 {UserX accidentally puts in the credentials \mbox{``NotUserX@flashy.cards''},
\mbox{``mynameisuserx''} and clicks the ``Login'' button.} 215 215 \mbox{``mynameisuserx''} and clicks the ``Login'' button.}
\item 216 216 \item
{The System shows UserX the site login page with a message reading 217 217 {The System shows UserX the site login page with a message reading
``Invalid username or password!!''.} 218 218 ``Invalid username or password!!''.}
\end {enumerate} 219 219 \end {enumerate}
220 220
\item [Expected Result:] 221 221 \item [Expected Result:]
{The User is not able to login.} \\ 222 222 {The User is not able to login.} \\
223 223
\item [Alternate Workflow C:] 224 224 \item [Alternate Workflow C:]
\begin{enumerate} 225 225 \begin{enumerate}
\item 226 226 \item
{UserX accidentally puts in the credentials \mbox{``theflash@flashy.cards''}, 227 227 {UserX accidentally puts in the credentials \mbox{``theflash@flashy.cards''},
\mbox{``MyNameIsUserX''} and clicks the ``Login'' button.} 228 228 \mbox{``MyNameIsUserX''} and clicks the ``Login'' button.}
\item 229 229 \item
{The System shows UserX the site login page with a message reading 230 230 {The System shows UserX the site login page with a message reading
``Invalid username or password!!''.} 231 231 ``Invalid username or password!!''.}
\end {enumerate} 232 232 \end {enumerate}
233 233
\item [Expected Result:] 234 234 \item [Expected Result:]
{The User is not able to login.} \\ 235 235 {The User is not able to login.} \\
236 236
\end{description} 237 237 \end{description}
\newpage 238 238 \newpage
239 239
{} 240 240 {}
241 241
\subsection{[A3] Add a Class} 242 242 \subsection{[A3] Add a Class}
\begin{description} 243 243 \begin{description}
\item[Description:]{This test case outlines the presentation layer step 244 244 \item[Description:]{This test case outlines the presentation layer step
process of a user adding a class.} 245 245 process of a user adding a class.}
246 246
\item[Desired Outcome:]{The class shall be linked with the student's account 247 247 \item[Desired Outcome:]{The class shall be linked with the student's account
and the student shall have the ability to read and publish flashcards 248 248 and the student shall have the ability to read and publish flashcards
for this class.} 249 249 for this class.}
250 250
\item[User Goals:]{The User wants to publish flashcards for this class and 251 251 \item[User Goals:]{The User wants to publish flashcards for this class and
read the flashcards for this class that are published by other users.} 252 252 read the flashcards for this class that are published by other users.}
253 253
\item[Dependency Use Cases:]{[A1] User Registration, [A2] User Login} 254 254 \item[Dependency Use Cases:]{[A1] User Registration, [A2] User Login}
\\ 255 255 \\
256 256
\item[Priority Level:]{``Must''} 257 257 \item[Priority Level:]{``Must''}
258 258
\item[Status:]{Implemented} 259 259 \item[Status:]{Implemented}
260 260
\item[Preconditions:] 261 261 \item[Preconditions:]
\begin{itemize} 262 262 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 263 263 \itemsep1pt\parskip0pt\parsep0pt
\item 264 264 \item
{The User is logged in as UserX.} 265 265 {The User is logged in as UserX.}
\item 266 266 \item
{The User is whitelisted for class TEST 101.} 267 267 {The User is whitelisted for class TEST 101.}
\item 268 268 \item
{The User is not whitelisted for class TEST 102.} 269 269 {The User is not whitelisted for class TEST 102.}
\item 270 270 \item
{The class TEST 103 has no whitelist.} 271 271 {The class TEST 103 has no whitelist.}
\end{itemize} 272 272 \end{itemize}
273 273
\item[Postconditions:] 274 274 \item[Postconditions:]
\begin{itemize} 275 275 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 276 276 \itemsep1pt\parskip0pt\parsep0pt
\item 277 277 \item
{The User can read the flashcards being published for the class and 278 278 {The User can read the flashcards being published for the class and
add them to their deck.} 279 279 add them to their deck.}
\item 280 280 \item
{The User can publish flashcards to be viewed and added by other users 281 281 {The User can publish flashcards to be viewed and added by other users
in the same class.} 282 282 in the same class.}
\end{itemize} 283 283 \end{itemize}
284 284
\item[Trigger:]{UserX wants to view the Live Feed and have a flashcard deck for a class.} 285 285 \item[Trigger:]{UserX wants to view the Live Feed and have a flashcard deck for a class.}
286 286
\item[Workflow:] 287 287 \item[Workflow:]
\begin{enumerate} 288 288 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 289 289 \itemsep1pt\parskip0pt\parsep0pt
\item 290 290 \item
{UserX shall click ``Add Class'' on the classes dropdown from the navigation bar.} 291 291 {UserX shall click ``Add Class'' on the classes dropdown from the navigation bar.}
\item 292 292 \item
{The System shall show the user ``Add Class'' page.} 293 293 {The System shall show the user ``Add Class'' page.}
\item 294 294 \item
{UserX shall begin to type ``TEST 101''.} 295 295 {UserX shall begin to type ``TEST 101''.}
\item 296 296 \item
{The System shall show suggestions as a user types.} 297 297 {The System shall show suggestions as a user types.}
\item 298 298 \item
{The System shall check if there is a whitelist for each class in the suggestions.} 299 299 {The System shall check if there is a whitelist for each class in the suggestions.}
\item 300 300 \item
{The System shall ensure that UserX is on the whitelist for each section.} 301 301 {The System shall ensure that UserX is on the whitelist for each section.}
\item 302 302 \item
{UserX shall click on ``TEST 101'', which should not have a lock icon.} 303 303 {UserX shall click on ``TEST 101'', which should not have a lock icon.}
\item 304 304 \item
{UserX shall click on the ``Add'' button.} 305 305 {UserX shall click on the ``Add'' button.}
\item 306 306 \item
{The System shall add UserX to the specified class TEST 101.} 307 307 {The System shall add UserX to the specified class TEST 101.}
\end{enumerate} 308 308 \end{enumerate}
309 309
\item[Expected Result:] {UserX has added the section and sees the Live Feed 310 310 \item[Expected Result:] {UserX has added the section and sees the Live Feed
for TEST 101.} 311 311 for TEST 101.}
312 312
\item[Alternate Workflow A:] 313 313 \item[Alternate Workflow A:]
\begin{enumerate} 314 314 \begin{enumerate}
\setcounter{enumi}{3} 315 315 \setcounter{enumi}{3}
\itemsep1pt\parskip0pt\parsep0pt 316 316 \itemsep1pt\parskip0pt\parsep0pt
\item 317 317 \item
{UserX shall begin to type ``TEST 102''.} 318 318 {UserX shall begin to type ``TEST 102''.}
\item 319 319 \item
{The System shall show suggestions as a user types.} 320 320 {The System shall show suggestions as a user types.}
\item 321 321 \item
{The System shall check if there is a whitelist for each class in the suggestions.} 322 322 {The System shall check if there is a whitelist for each class in the suggestions.}
\item 323 323 \item
{The System shall see that UserX is not on the whitelist.} 324 324 {The System shall see that UserX is not on the whitelist.}
\item 325 325 \item
{UserX shall see a lock icon in the suggestions for TEST 102.} 326 326 {UserX shall see a lock icon in the suggestions for TEST 102.}
\item 327 327 \item
{UserX shall click on ``TEST 102'', which has a lock icon.} 328 328 {UserX shall click on ``TEST 102'', which has a lock icon.}
\item 329 329 \item
{The System shall disable the ``Add'' button.} 330 330 {The System shall disable the ``Add'' button.}
\end{enumerate} 331 331 \end{enumerate}
332 332
\item[Expected Result:] {UserX cannot add the specified TEST 102 and cannot 333 333 \item[Expected Result:] {UserX cannot add the specified TEST 102 and cannot
view contents related to this class.} 334 334 view contents related to this class.}
335 335
\item[Alternate Workflow B:] 336 336 \item[Alternate Workflow B:]
\begin{enumerate} 337 337 \begin{enumerate}
\setcounter{enumi}{3} 338 338 \setcounter{enumi}{3}
\itemsep1pt\parskip0pt\parsep0pt 339 339 \itemsep1pt\parskip0pt\parsep0pt
\item 340 340 \item
{UserX shall begin to type ``TEST 103''.} 341 341 {UserX shall begin to type ``TEST 103''.}
\item 342 342 \item
{The System shall show suggestions as a user types.} 343 343 {The System shall show suggestions as UserX types.}
\item 344 344 \item
{The System shall check if there is a whitelist for each class in the suggestions.} 345 345 {The System shall check if there is a whitelist for each class in the suggestions.}
\item 346 346 \item
{The System shall see there is no whitelist for TEST 103.} 347 347 {The System shall see there is no whitelist for TEST 103.}
\item 348 348 \item
{UserX shall click on ``TEST 103'', which should not have a lock icon.} 349 349 {UserX shall click on ``TEST 103'', which should not have a lock icon.}
\item 350 350 \item
{UserX shall click on the ``Add'' button.} 351 351 {UserX shall click on the ``Add'' button.}
\item 352 352 \item
{The System shall add UserX to TEST 103.} 353 353 {The System shall add UserX to TEST 103.}
\end{enumerate} 354 354 \end{enumerate}
355 355
\item[Expected Result:] {UserX has added the section and sees the Live Feed 356 356 \item[Expected Result:] {UserX has added the section and sees the Live Feed
for TEST 103.} 357 357 for TEST 103.}
\end{description} 358 358 \end{description}
\newpage 359 359 \newpage
360 360
{} 361 361 {}
362 362
\subsection{[A4] Drop a Class} 363 363 \subsection{[A4] Drop a Class}
364 364
\begin{description} 365 365 \begin{description}
\item[Description:]{This test case outlines the presentation layer step process of a user dropping a class.} 366 366 \item[Description:]{This test case outlines the presentation layer step process of a user dropping a class.}
367 367
\item[Desired Outcome:]{The User has dropped the class and no longer needs 368 368 \item[Desired Outcome:]{The User has dropped the class and no longer needs
access to the flashcards for the dropped class. They can no longer 369 369 access to the flashcards for the dropped class. They can no longer
see the flashcards associated to the class that they dropped.} 370 370 see the flashcards associated to the class that they dropped.}
371 371
\item[User Goals:]{The User shall not have access to a class and the 372 372 \item[User Goals:]{The User shall not have access to a class and the
flashcards associated with that class. They will no longer see the class 373 373 flashcards associated with that class. They will no longer see the class
listed in their list of ``Enrolled Classes''.} 374 374 listed in their list of ``Enrolled Classes''.}
375 375
\item[Dependency Use Cases:]{[A1] User Registration, [A2] User Login, [A3] Add a Class} 376 376 \item[Dependency Use Cases:]{[A1] User Registration, [A2] User Login, [A3] Add a Class}
\\ 377 377 \\
378 378
\item[Priority Level:]{``Should''} 379 379 \item[Priority Level:]{``Should''}
380 380
\item[Status:]{Implemented} 381 381 \item[Status:]{Implemented}
382 382
\item[Preconditions:] 383 383 \item[Preconditions:]
\begin{itemize} 384 384 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 385 385 \itemsep1pt\parskip0pt\parsep0pt
\item 386 386 \item
{User is logged in as UserX.} 387 387 {The User is logged in as UserX.}
\item 388 388 \item
{User has enrolled in TEST 101.} 389 389 {The User has enrolled in TEST 101.}
\item 390 390 \item
{User is at Settings page.} 391 391 {The User is at Settings page.}
\end{itemize} 392 392 \end{itemize}
393 393
\item[Postconditions:] 394 394 \item[Postconditions:]
\begin{itemize} 395 395 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 396 396 \itemsep1pt\parskip0pt\parsep0pt
\item 397 397 \item
{User shall no longer have access to TEST 101, or associated flashcards.} 398 398 {The User shall no longer have access to TEST 101, or associated flashcards.}
\end{itemize} 399 399 \end{itemize}
400 400
\item[Trigger:]{UserX wants to stop seeing the class's Live Feed and remove 401 401 \item[Trigger:]{UserX wants to stop seeing the class's Live Feed and remove
all of their flashcards.} 402 402 all of their flashcards.}
403 403
\item[Workflow:] 404 404 \item[Workflow:]
\begin{enumerate} 405 405 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 406 406 \itemsep1pt\parskip0pt\parsep0pt
\item 407 407 \item
{UserX shall click ``X'' icon next to TEST 101 in ``Enrolled Classes'' table.} 408 408 {UserX shall click ``X'' icon next to TEST 101 in ``Enrolled Classes'' table.}
\item 409 409 \item
{The System shall remove UserX from TEST 101.} 410 410 {The System shall remove UserX from TEST 101.}
\item 411 411 \item
{The System shall display a toast indicating that a class has been dropped.} 412 412 {The System shall display a toast indicating that a class has been dropped.}
\end{enumerate} 413 413 \end{enumerate}
414 414
\item[Expected Result:] {UserX no longer has access to any content related to TEST 101.} 415 415 \item[Expected Result:] {UserX no longer has access to any content related to TEST 101.}
\end{description} 416 416 \end{description}
\newpage 417 417 \newpage
418 418
{} 419 419 {}
420 420
\subsection{[A5] Password Change} 421 421 \subsection{[A5] Password Change}
422 422
\begin{description} 423 423 \begin{description}
\item[Description:]{The User shall be able to change the password for their 424 424 \item[Description:]{The User shall be able to change the password for their
account in the account settings. This requires that they are logged in.} 425 425 account in the account settings. This requires that they are logged in.}
426 426
\item[Desired Outcome:]{The User's password shall be changed and the user 427 427 \item[Desired Outcome:]{The User's password shall be changed and the user
shall be able to log in with the new password in the future.} 428 428 shall be able to log in with the new password in the future.}
429 429
\item[User Goals:]{The User wants to use a different password in the future.} 430 430 \item[User Goals:]{The User wants to use a different password in the future.}
431 431
\item[Dependency Use Cases:]{[A1] User Registration, [A2] User Login} 432 432 \item[Dependency Use Cases:]{[A1] User Registration, [A2] User Login}
\\ 433 433 \\
434 434
\item[Priority Level:]{``Must''} 435 435 \item[Priority Level:]{``Must''}
436 436
\item[Status:]{Implemented} 437 437 \item[Status:]{Implemented}
438 438
\item[Preconditions:] 439 439 \item[Preconditions:]
\begin{itemize} 440 440 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 441 441 \itemsep1pt\parskip0pt\parsep0pt
\item 442 442 \item
{The User is logged in as UserX.} 443 443 {The User is logged in as UserX.}
\item 444 444 \item
{The User knows the current password \mbox{``mynameisuserx''}.} 445 445 {The User knows the current password \mbox{``mynameisuserx''}.}
\item 446 446 \item
{The User is at the Settings page.} 447 447 {The User is at the Settings page.}
\end{itemize} 448 448 \end{itemize}
449 449
\item[Postconditions:] 450 450 \item[Postconditions:]
\begin{itemize} 451 451 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 452 452 \itemsep1pt\parskip0pt\parsep0pt
\item 453 453 \item
{The User's password is changed} 454 454 {The User's password is changed}
\item 455 455 \item
{The User can log in with the new password} 456 456 {The User can log in with the new password}
\end{itemize} 457 457 \end{itemize}
458 458
\item[Trigger:]{UserX is dissatisfied with their current password and wishes 459 459 \item[Trigger:]{UserX is dissatisfied with their current password and wishes
to change it.} 460 460 to change it.}
461 461
\item[Workflow:] 462 462 \item[Workflow:]
\begin{enumerate} 463 463 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 464 464 \itemsep1pt\parskip0pt\parsep0pt
\item 465 465 \item
{UserX shall enter their current password \mbox{``mynameisuserx''} and the desired 466 466 {UserX shall enter their current password \mbox{``mynameisuserx''} and the desired
new password \mbox{``newPassword''} (twice) in the ``Change Password'' form.} 467 467 new password \mbox{``newPassword''} (twice) in the ``Change Password'' form.}
\item 468 468 \item
{UserX shall click the ``Submit'' button.} 469 469 {UserX shall click the ``Submit'' button.}
\item 470 470 \item
{The System shall check UserX's current password.} 471 471 {The System shall check UserX's current password.}
\item 472 472 \item
{The System shall update the UserX's current password \mbox{``mynameisuserx''} 473 473 {The System shall update the UserX's current password \mbox{``mynameisuserx''}
to the new password \mbox{``newPassword''}.} 474 474 to the new password \mbox{``newPassword''}.}
\end{enumerate} 475 475 \end{enumerate}
476 476
\item[Expected Result:] {User's password is changed from \mbox{``mynameisuserx''} 477 477 \item[Expected Result:] {User's password is changed from \mbox{``mynameisuserx''}
to \mbox{``newPassword''}.} 478 478 to \mbox{``newPassword''}.}
479 479
\item[Alternate Workflow A:] 480 480 \item[Alternate Workflow A:]
\begin{enumerate} 481 481 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 482 482 \itemsep1pt\parskip0pt\parsep0pt
\item 483 483 \item
{UserX shall enter an incorrect current password \mbox{``MyNameIsUserX''} and the desired 484 484 {UserX shall enter an incorrect current password \mbox{``MyNameIsUserX''} and the desired
new password \mbox{``newPassword''} (twice) in the ``Change Password'' form.} 485 485 new password \mbox{``newPassword''} (twice) in the ``Change Password'' form.}
\item 486 486 \item
{UserX shall click the ``Submit'' button.} 487 487 {UserX shall click the ``Submit'' button.}
\item 488 488 \item
{The System shall ensure validity of new password.} 489 489 {The System shall ensure validity of new password.}
\item 490 490 \item
{The System shall check UserX's current password.} 491 491 {The System shall check UserX's current password.}
\end{enumerate} 492 492 \end{enumerate}
493 493
\item[Expected Result:] {The System shall display a toast ``Your old password is not correct''.} 494 494 \item[Expected Result:] {The System shall display a toast ``Your old password is not correct''.}
495 495
\item[Workflow:] 496 496 \item[Workflow:]
\begin{enumerate} 497 497 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 498 498 \itemsep1pt\parskip0pt\parsep0pt
\item 499 499 \item
{UserX shall enter their current password \mbox{``mynameisuserx''} and the desired 500 500 {UserX shall enter their current password \mbox{``mynameisuserx''} and the desired
new password \mbox{``newPass''} (twice) in the ``Change Password'' form.} 501 501 new password \mbox{``newPass''} (twice) in the ``Change Password'' form.}
\item 502 502 \item
{UserX shall click the ``Submit'' button.} 503 503 {UserX shall click the ``Submit'' button.}
\item 504 504 \item
{The System shall ensure validity of new password.} 505 505 {The System shall ensure validity of new password.}
\end{enumerate} 506 506 \end{enumerate}
507 507
\item[Expected Result:] {The System shall display error text ``New password 508 508 \item[Expected Result:] {The System shall display error text ``New password
must be at least 8 characters.''} 509 509 must be at least 8 characters.''}
510 510
\end{description} 511 511 \end{description}
\newpage 512 512 \newpage
513 513
{} 514 514 {}
515 515
\subsection{[A6] Password Reset} 516 516 \subsection{[A6] Password Reset}
517 517
\begin{description} 518 518 \begin{description}
\item[Description:]{This test case outlines the presentation step layering process of 519 519 \item[Description:]{This test case outlines the presentation step layering process of
a user requesting a password reset without logging in.} 520 520 a user requesting a password reset without logging in.}
521 521
\item[Desired Outcome:]{The User's password shall be changed to one that 522 522 \item[Desired Outcome:]{The User's password shall be changed to one that
they remember.} 523 523 they remember.}
\\ 524 524 \\
525 525
\item[User Goals:]{The User does not know their current password but wants 526 526 \item[User Goals:]{The User does not know their current password but wants
to log into the site.} 527 527 to log into the site.}
528 528
\item[Dependency Use Cases:]{[A1] User Registration} 529 529 \item[Dependency Use Cases:]{[A1] User Registration}
\\ 530 530 \\
531 531
\item[Priority Level:]{``Must''} 532 532 \item[Priority Level:]{``Must''}
533 533
\item[Status]{Implemented} 534 534 \item[Status]{Implemented}
535 535
\item[Preconditions:] 536 536 \item[Preconditions:]
\begin{itemize} 537 537 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 538 538 \itemsep1pt\parskip0pt\parsep0pt
\item 539 539 \item
{Account for UserX has been created.} 540 540 {Account for UserX has been created.}
\end{itemize} 541 541 \end{itemize}
542 542
\item[Postconditions:] 543 543 \item[Postconditions:]
\begin{itemize} 544 544 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 545 545 \itemsep1pt\parskip0pt\parsep0pt
\item 546 546 \item
{UserX's password is changed.} 547 547 {UserX's password is changed.}
\item 548 548 \item
{UserX can log in with the new password.} 549 549 {UserX can log in with the new password.}
\end{itemize} 550 550 \end{itemize}
551 551
\item[Trigger:]{UserX forgot their password and wants to access the site.} 552 552 \item[Trigger:]{UserX forgot their password and wants to access the site.}
553 553
\item[Workflow:] 554 554 \item[Workflow:]
\begin{enumerate} 555 555 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 556 556 \itemsep1pt\parskip0pt\parsep0pt
\item 557 557 \item
{UserX shall click the ``Forgot Password'' hyperlink.} 558 558 {UserX shall click the ``Forgot Password'' hyperlink.}
\item 559 559 \item
{The System shall prompt the user for their current email.} 560 560 {The System shall prompt the user for their current email.}
\item 561 561 \item
{UserX shall submit their email \mbox{``UserX@flashy.cards''}.} 562 562 {UserX shall submit their email \mbox{``UserX@flashy.cards''}.}
\item 563 563 \item
{The System shall check if an account exists with the email entered by UserX.} 564 564 {The System shall check if an account exists with the email entered by UserX.}
\item 565 565 \item
{The System shall create a new password reset token for UserX.} 566 566 {The System shall create a new password reset token for UserX.}
\item 567 567 \item
{The System shall send an email to UserX with a link containing the token and the 568 568 {The System shall send an email to UserX with a link containing the token and the
user's ID.} 569 569 user's ID.}
\item 570 570 \item
{UserX shall click the link in the email to visit /app/password\_reset.} 571 571 {UserX shall click the link in the email to visit /app/password\_reset.}
\item 572 572 \item
{The System shall render a form that will prompt the user for a new password.} 573 573 {The System shall render a form that will prompt the user for a new password.}
\item 574 574 \item
{UserX shall provide a new password, \mbox{``newPassword''}, in the form.} 575 575 {UserX shall provide a new password, \mbox{``newPassword''}, in the form.}
\item 576 576 \item
{The System shall change the password associated with the user's email.} 577 577 {The System shall change the password associated with the user's email.}
\item 578 578 \item
{UserX shall navigate back to the login page and enter \mbox{``UserX@flashy.cards''} 579 579 {UserX shall navigate back to the login page and enter \mbox{``UserX@flashy.cards''}
with the old password \mbox{``mynameisuserx''}.} 580 580 with the old password \mbox{``mynameisuserx''}.}
\item 581 581 \item
{The System shall display ``Invalid username or password!''} 582 582 {The System shall display ``Invalid username or password!''}
\item 583 583 \item
{UserX shall login as \mbox{``UserX@flashy.cards''} with the password \mbox{``newPassword''}.} 584 584 {UserX shall login as \mbox{``UserX@flashy.cards''} with the password \mbox{``newPassword''}.}
\end{enumerate} 585 585 \end{enumerate}
586 586
\item[Expected Result:] {UserX shall be logged in.} 587 587 \item[Expected Result:] {UserX shall be logged in.}
588 588
\item[Alternate Workflow:] 589 589 \item[Alternate Workflow:]
\begin{enumerate} 590 590 \begin{enumerate}
\setcounter{enumi}{4} 591 591 \setcounter{enumi}{4}
\itemsep1pt\parskip0pt\parsep0pt 592 592 \itemsep1pt\parskip0pt\parsep0pt
\item 593 593 \item
{If no such account exists, the System shall display an error message 594 594 {If no such account exists, the System shall display an error message
``Enter a valid email!'' to UserX.} 595 595 ``Enter a valid email!'' to UserX.}
\end{enumerate} 596 596 \end{enumerate}
597 597
\item[Expected Result:] {UserX's password will not be reset.} 598 598 \item[Expected Result:] {UserX's password will not be reset.}
\end{description} 599 599 \end{description}
\newpage 600 600 \newpage
601 601
{} 602 602 {}
603 603
\subsection{[A7] Student Prevented From Accessing A Restricted Course} 604 604 \subsection{[A7] Student Prevented From Accessing A Restricted Course}
605 605
\begin{description} 606 606 \begin{description}
\item[Description:]{The User shall not be able to access a restricted course.} 607 607 \item[Description:]{The User shall not be able to access a restricted course.}
608 608
\item[Desired Outcome:]{The class will have limited access and only those 609 609 \item[Desired Outcome:]{The class will have limited access and only those
users who are whitelisted may enroll in the class.} 610 610 users who are whitelisted may enroll in the class.}
611 611
\item[User Goals:]{The instructor wants to limit access to his class so only 612 612 \item[User Goals:]{The instructor wants to limit access to his class so only
the students who are actually in his class participate, and nobody 613 613 the students who are actually in his class participate, and nobody
else.} 614 614 else.}
615 615
\item[Dependency Use Cases:]{[A1] User Registration, [A2] User Login} 616 616 \item[Dependency Use Cases:]{[A1] User Registration, [A2] User Login}
\\ 617 617 \\
618 618
\item[Priority Level:]{``Should''} 619 619 \item[Priority Level:]{``Should''}
620 620
\item[Status:]{Deferred (see Add a Class)} 621 621 \item[Status:]{Deferred (see Add a Class)}
622 622
\item[Preconditions:] 623 623 \item[Preconditions:]
\begin{itemize} 624 624 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 625 625 \itemsep1pt\parskip0pt\parsep0pt
\item 626 626 \item
{UserX has valid instructor's account} 627 627 {UserX has valid instructor's account}
\end{itemize} 628 628 \end{itemize}
629 629
\item[Postconditions:] 630 630 \item[Postconditions:]
\begin{itemize} 631 631 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 632 632 \itemsep1pt\parskip0pt\parsep0pt
\item 633 633 \item
{Only those users who were whitelisted may add the class.} 634 634 {Only those users who were whitelisted may add the class.}
\end{itemize} 635 635 \end{itemize}
636 636
\item[Trigger:]{The instructor emails the administrator and requests to 637 637 \item[Trigger:]{The instructor emails the administrator and requests to
limit access to his class.} 638 638 limit access to his class.}
639 639
\item[Workflow:] 640 640 \item[Workflow:]
\begin{enumerate} 641 641 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 642 642 \itemsep1pt\parskip0pt\parsep0pt
\item 643 643 \item
{The instructor, ``INSTR1'', shall email the administrators from his UCSD email address 644 644 {The instructor, ``INSTR1'', shall email the administrators from his UCSD email address
and requests to limit access to his course.} 645 645 and requests to limit access to his course.}
\item 646 646 \item
{ INSTR1 shall provide a list of 647 647 { INSTR1 shall provide a list of
emails of the students that are to be whitelisted.} 648 648 emails of the students that are to be whitelisted.}
\item 649 649 \item
{The administrators shall visit a custom admin page, select the course, and 650 650 {The administrators shall visit a custom admin page, select the course, and
paste the list of emails.} 651 651 paste the list of emails.}
\item 652 652 \item
{The administrators shall submit the page directly to the System.} 653 653 {The administrators shall submit the page directly to the System.}
\item 654 654 \item
{The System shall create a WhitelistedAddress for each provided email, 655 655 {The System shall create a WhitelistedAddress for each provided email,
attaching it to the section taught by INST1.} 656 656 attaching it to the section taught by INST1.}
\item 657 657 \item
{The System shall add any existing users whose email addresses appear 658 658 {The System shall add any existing users whose email addresses appear
in the whitelist to the class. } 659 659 in the whitelist to the class. }
\end{enumerate} 660 660 \end{enumerate}
661 661
\item[Expected Result:] {A whitelist is added to a section.} 662 662 \item[Expected Result:] {A whitelist is added to a section.}
\end{description} 663 663 \end{description}
\newpage 664 664 \newpage
665 665
{} 666 666 {}
667 667
\subsection{[A8] User Logout} 668 668 \subsection{[A8] User Logout}
669 669
\begin{description} 670 670 \begin{description}
\item[Description:]{This test case outlines the presentation layering step process 671 671 \item[Description:]{This test case outlines the presentation layering step process
of a user logging out from their account.} 672 672 of a user logging out from their account.}
673 673
\item[Desired Outcome:]{The User's information and data will no longer be 674 674 \item[Desired Outcome:]{The User's information and data will no longer be
accessible after logging out. } 675 675 accessible after logging out. }
676 676
\item[User Goals:]{The User is done with their session of using the 677 677 \item[User Goals:]{The User is done with their session of using the
website, and wants to make sure others cannot access the data in their 678 678 website, and wants to make sure others cannot access the data in their
account.} 679 679 account.}
680 680
\item[Dependency Use Cases:] {[A1] User Registration, [A2] User Login} 681 681 \item[Dependency Use Cases:] {[A1] User Registration, [A2] User Login}
\\ 682 682 \\
683 683
\item[Priority Level:]{``Must''} 684 684 \item[Priority Level:]{``Must''}
685 685
\item[Status:]{Implemented} 686 686 \item[Status:]{Implemented}
687 687
\item[Preconditions:] 688 688 \item[Preconditions:]
\begin{itemize} 689 689 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 690 690 \itemsep1pt\parskip0pt\parsep0pt
\item 691 691 \item
{The user is logged in as UserX.} 692 692 {The user is logged in as UserX.}
\end{itemize} 693 693 \end{itemize}
694 694
\item[Postconditions:] 695 695 \item[Postconditions:]
\begin{itemize} 696 696 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 697 697 \itemsep1pt\parskip0pt\parsep0pt
\item 698 698 \item
{The user's data can no longer be accessed.} 699 699 {The user's data can no longer be accessed.}
\end{itemize} 700 700 \end{itemize}
701 701
\item[Trigger:] {UserX does not currently want access to the site and does 702 702 \item[Trigger:] {UserX does not currently want access to the site and does
not want others tampering with their account.} 703 703 not want others tampering with their account.}
704 704
\item[Workflow:] 705 705 \item[Workflow:]
\begin{enumerate} 706 706 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 707 707 \itemsep1pt\parskip0pt\parsep0pt
\item 708 708 \item
{UserX shall click ``Logout'' (power button) in the top right.} 709 709 {UserX shall click ``Logout'' (power button) in the top right.}
\item 710 710 \item
{The System shall log out UserX.} 711 711 {The System shall log out UserX.}
\item 712 712 \item
{The System shall redirect UserX to the login page.} 713 713 {The System shall redirect UserX to the login page.}
\end{enumerate} 714 714 \end{enumerate}
715 715
\item[Expected Result:] {UserX is logged out and on the login page.} 716 716 \item[Expected Result:] {UserX is logged out and on the login page.}
\end{description} 717 717 \end{description}
\newpage 718 718 \newpage
719 719
{} 720 720 {}
721 721
\subsection{[A9] Contact Admin} 722 722 \subsection{[A9] Contact Admin}
723 723
\begin{description} 724 724 \begin{description}
\item[Description]{The User shall be able to contact the admin.} 725 725 \item[Description]{The User shall be able to contact the admin.}
726 726
\item[Desired Outcome]{The User shall send a message to the admin; the 727 727 \item[Desired Outcome]{The User shall send a message to the admin; the
admin shall receive the message.} 728 728 admin shall receive the message.}
729 729
\item[User Goals:]{The User sends a message to the admin.} 730 730 \item[User Goals:]{The User sends a message to the admin.}
731 731
\item[Dependency Use Cases]{None} 732 732 \item[Dependency Use Cases]{None}
\\ 733 733 \\
734 734
\item[Priority Level]{``Must''} 735 735 \item[Priority Level]{``Must''}
736 736
\item[Status]{Not Implemented and Deferred} 737 737 \item[Status]{Not Implemented and Deferred}
738 738
\item[Pre-conditions]{None.} 739 739 \item[Pre-conditions]{None.}
740 740
\item[Post-conditions]{The admin receives the user's message.} 741 741 \item[Post-conditions]{The admin receives the user's message.}
742 742
\item[Trigger]{UserX wants to contact the administrators of our application.} 743 743 \item[Trigger]{UserX wants to contact the administrators of our application.}
744 744
\item[Workflow] 745 745 \item[Workflow]
\begin{enumerate} 746 746 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 747 747 \itemsep1pt\parskip0pt\parsep0pt
\item 748 748 \item
{The System shall display the admin email address on every page in the 749 749 {The System shall display the admin email address on every page in the
application.} 750 750 application.}
\end{enumerate} 751 751 \end{enumerate}
752 752
\item[Expected Result:] {The admin's email address can be seen by UserX on every page.} 753 753 \item[Expected Result:] {The admin's email address can be seen by UserX on every page.}
\end{description} 754 754 \end{description}
\newpage 755 755 \newpage
756 756
{} 757 757 {}
758 758
\subsection{[A10] Configure Account Notifications} 759 759 \subsection{[A10] Configure Account Notifications}
\begin{description} 760 760 \begin{description}
\item[Description]{This test case outlines the presentation layering step process of a user configuring notification settings.} 761 761 \item[Description]{This test case outlines the presentation layering step process of a user configuring notification settings.}
762 762
\item[Desired Outcome]{The User shall only receive notifications at the 763 763 \item[Desired Outcome]{The User shall only receive notifications at the
times that were specified.} 764 764 times that were specified.}
\\ 765 765 \\
766 766
\item[User Goals]{The User shall not be bothered needlessly or at 767 767 \item[User Goals]{The User shall not be bothered needlessly or at
inconvenient times.} 768 768 inconvenient times.}
769 769
\item[Dependency Use Cases:]{[A1] User Registration, [A2] User Login} 770 770 \item[Dependency Use Cases:]{[A1] User Registration, [A2] User Login}
\\ 771 771 \\
772 772
\item[Priority Level]{``Must''} 773 773 \item[Priority Level]{``Must''}
774 774
\item[Status]{Deferred} 775 775 \item[Status]{Deferred}
776 776
\item[Preconditions:] 777 777 \item[Preconditions:]
\begin{itemize} 778 778 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 779 779 \itemsep1pt\parskip0pt\parsep0pt
\item 780 780 \item
{The User is logged in as UserX.} 781 781 {The User is logged in as UserX.}
\end{itemize} 782 782 \end{itemize}
783 783
\item[Postconditions:] 784 784 \item[Postconditions:]
\begin{itemize} 785 785 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 786 786 \itemsep1pt\parskip0pt\parsep0pt
\item 787 787 \item
{User only receive notifications at specified times} 788 788 {User only receive notifications at specified times}
\end{itemize} 789 789 \end{itemize}
790 790
\item[Trigger]{UserX wants to change their notification settings} 791 791 \item[Trigger]{UserX wants to change their notification settings}
792 792
\item[Workflow] 793 793 \item[Workflow]
\begin{enumerate} 794 794 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 795 795 \itemsep1pt\parskip0pt\parsep0pt
\item 796 796 \item
{UserX shall select ``Settings'' (gear) from the top right.} 797 797 {UserX shall select ``Settings'' (gear) from the top right.}
\item 798 798 \item
{The System shall display a settings screen.} 799 799 {The System shall display a settings screen.}
\item 800 800 \item
{UserX shall change the notification timing to 1 min.} 801 801 {UserX shall change the notification timing to 1 min.}
\item 802 802 \item
{UserX shall click ``Save Settings'' button.} 803 803 {UserX shall click ``Save Settings'' button.}
\item 804 804 \item
{The System shall display a message confirming the settings are saved.} 805 805 {The System shall display a message confirming the settings are saved.}
\item 806 806 \item
{The System shall save notification settings to the user's attributes.} 807 807 {The System shall save notification settings to the user's attributes.}
\end{enumerate} 808 808 \end{enumerate}
809 809
\item[Expected Result:]{UserX shall be notified at least as slow as 1 min.} 810 810 \item[Expected Result:]{UserX shall be notified at least as slow as 1 min.}
\end{description} 811 811 \end{description}
\newpage 812 812 \newpage
813 813
{} 814 814 {}
815 815
\section{Flashcards} 816 816 \section{Flashcards}
\subsection{[F1] Push Flashcard} 817 817 \subsection{[F1] Push Flashcard}
818 818
\begin{description} 819 819 \begin{description}
\item[Description:]{This test case outlines the presentation layer step 820 820 \item[Description:]{This test case outlines the presentation layer step
process of a User contributing a flashcard to the live feed and to their deck.} 821 821 process of a User contributing a flashcard to the live feed and to their deck.}
822 822
\item[Desired Outcome:]{The User shall have the flashcard added to their own deck 823 823 \item[Desired Outcome:]{The User shall have the flashcard added to their own deck
and the live feed.} 824 824 and the live feed.}
\\ 825 825 \\
826 826
\item[User Goals:]{The User will see their flashcard in their deck and the 827 827 \item[User Goals:]{The User will see their flashcard in their deck and the
flashcard will be shared with others.} 828 828 flashcard will be shared with others.}
829 829
\item[Dependency Use Cases:]{[A1] User Registration, [A2] User Login, [A3] Add a Class} 830 830 \item[Dependency Use Cases:]{[A1] User Registration, [A2] User Login, [A3] Add a Class}
\\ 831 831 \\
832 832
\item[Priority Level:]{``Must''} 833 833 \item[Priority Level:]{``Must''}
834 834
\item[Status:]{Implemented} 835 835 \item[Status:]{Implemented}
836 836
\item[Preconditions:] 837 837 \item[Preconditions:]
\begin{itemize} 838 838 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 839 839 \itemsep1pt\parskip0pt\parsep0pt
\item 840 840 \item
{The User is logged as UserX.} 841 841 {The User is logged as UserX.}
\item 842 842 \item
{The User is logged in a different browser session as UserY (see Testing Notes).} 843 843 {The User is logged in a different browser session as UserY (see Testing Notes).}
\item 844 844 \item
{UserX and UserY have added the class TEST 101.} 845 845 {UserX and UserY have added the class TEST 101.}
\item 846 846 \item
{UserX and UserY are on the live feed for TEST 101.} 847 847 {UserX and UserY are on the live feed for TEST 101.}
\end{itemize} 848 848 \end{itemize}
849 849
\item[Postconditions:] 850 850 \item[Postconditions:]
\begin{itemize} 851 851 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 852 852 \itemsep1pt\parskip0pt\parsep0pt
\item 853 853 \item
{UserX has flashcard added to their deck.} 854 854 {UserX has flashcard added to their deck.}
\item 855 855 \item
{The Flashcard is shown in the live feed.} 856 856 {The Flashcard is shown in the live feed.}
\item 857 857 \item
{UserY and other users can add this flashcard to their decks.} 858 858 {UserY and other users can add this flashcard to their decks.}
\end{itemize} 859 859 \end{itemize}
860 860
\item[Trigger:]{UserX wants to contribute a flashcard to the class TEST 101.} 861 861 \item[Trigger:]{UserX wants to contribute a flashcard to the class TEST 101.}
862 862
\item[Workflow:] 863 863 \item[Workflow:]
\begin{enumerate} 864 864 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 865 865 \itemsep1pt\parskip0pt\parsep0pt
\item {UserX has clicked the circular plus button (``Compose'' button) in 866 866 \item {UserX has clicked the circular plus button (``Compose'' button) in
the lower right corner of the live feed.} 867 867 the lower right corner of the live feed.}
\item 868 868 \item
{The System shall present a modal with a text box.} 869 869 {The System shall present a modal with a text box.}
\item 870 870 \item
{UserX shall select the input field of the modal and type ``The rain in Spain stays mainly in the plain''.} 871 871 {UserX shall select the input field of the modal and type ``The rain in Spain stays mainly in the plain''.}
\item 872 872 \item
{UserX shall select the ``Contribute'' button in the modal.} 873 873 {UserX shall select the ``Contribute'' button in the modal.}
\item 874 874 \item
{The System shall add the new card containing the text ``The rain in Spain stays mainly in 875 875 {The System shall add the new card containing the text ``The rain in Spain stays mainly in
the plain'' to the feed of each user enrolled in ``TEST 101''.} 876 876 the plain'' to the feed of each user enrolled in ``TEST 101''.}
\item 877 877 \item
{UserY shall see the card appear in their feed within a minute (See Notes).} 878 878 {UserY shall see the card appear in their feed within a minute (See Notes).}
\item 879 879 \item
{The System shall hide the modal from UserX.} 880 880 {The System shall hide the modal from UserX.}
\item 881 881 \item
{The flashcard shall be included in the UserX's deck.(c.f. Note about simultaneous browser session).} 882 882 {The flashcard shall be included in the UserX's deck.(c.f. Note about simultaneous browser session).}
\end{enumerate} 883 883 \end{enumerate}
884 884
\item[Expected Result:] {UserX will have the new flashcard in their deck. 885 885 \item[Expected Result:] {UserX will have the new flashcard in their deck.
For UserX, the new flashcard will have a checkmark, indicating that the card 886 886 For UserX, the new flashcard will have a checkmark, indicating that the card
is in their deck and a pencil icon on top right to indicate UserX as 887 887 is in their deck and a pencil icon on top right to indicate UserX as
the author of the flashcard. The new flashcard will show up on UserY's 888 888 the author of the flashcard. The new flashcard will show up on UserY's
live feed on class TEST 101 without checkmark and pencil icon.} 889 889 live feed on class TEST 101 without checkmark and pencil icon.}
890 890
\item[Alternative Workflow:] 891 891 \item[Alternative Workflow:]
\begin{enumerate} 892 892 \begin{enumerate}
\setcounter{enumi}{3} 893 893 \setcounter{enumi}{3}
\itemsep1pt\parskip0pt\parsep0pt 894 894 \itemsep1pt\parskip0pt\parsep0pt
\item 895 895 \item
{UserX shall user their cursor to select the word Spain in the text box, then click the ``Blank Word'' button.} 896 896 {UserX shall user their cursor to select the word Spain in the text box, then click the ``Blank Word'' button.}
\item 897 897 \item
{The System shall bold the word Spain.} 898 898 {The System shall bold the word Spain.}
\item 899 899 \item
{UserX shall use the cursor to select the word ``plain'' in the text box, then click the ``Blank Word'' button.} 900 900 {UserX shall use the cursor to select the word ``plain'' in the text box, then click the ``Blank Word'' button.}
\item 901 901 \item
{The System shall bold the word plain.} 902 902 {The System shall bold the word plain.}
\item 903 903 \item
{UserX shall click the ``Contribute'' button in the modal.} 904 904 {UserX shall click the ``Contribute'' button in the modal.}
\item 905 905 \item
{The System shall add the new flashcard containing the text ``The rain in \textbf{Spain} stays mainly in the \textbf{plain}'' to the feed of each user enrolled in TEST.} 906 906 {The System shall add the new flashcard containing the text ``The rain in \textbf{Spain} stays mainly in the \textbf{plain}'' to the feed of each user enrolled in TEST.}
\item 907 907 \item
{UserY shall view the live feed and within a minute see the new flashcard appear with ``Spain'' and ``plain'' bolded.} 908 908 {UserY shall view the live feed and within a minute see the new flashcard appear with ``Spain'' and ``plain'' bolded.}
\end{enumerate} 909 909 \end{enumerate}
910 910
\item[Expected Result:] { 911 911 \item[Expected Result:] {
UserX will have the new flashcard with the words ``Spain'' and ``plain'' bolded in their deck. 912 912 UserX will have the new flashcard with the words ``Spain'' and ``plain'' bolded in their deck.
For UserX, the new flashcard will have a checkmark, 913 913 For UserX, the new flashcard will have a checkmark,
indicating that the card is in their deck and a pencil icon on 914 914 indicating that the card is in their deck and a pencil icon on
top right to indicate UserX as the author of the flashcard. 915 915 top right to indicate UserX as the author of the flashcard.
The new flashcard will show up on UserY's live feed on class TEST 101 916 916 The new flashcard will show up on UserY's live feed on class TEST 101
without checkmark and pencil icon.} 917 917 without checkmark and pencil icon.}
918 918
\item[Alternate Workflow:] 919 919 \item[Alternate Workflow:]
\begin{enumerate} 920 920 \begin{enumerate}
\setcounter{enumi}{2} 921 921 \setcounter{enumi}{2}
\itemsep1pt\parskip0pt\parsep0pt 922 922 \itemsep1pt\parskip0pt\parsep0pt
\item 923 923 \item
{UserX shall select the input field of the modal and type five blank spaces.} 924 924 {UserX shall select the input field of the modal and type five blank spaces.}
\item 925 925 \item
{UserX shall click the ``Contribute'' button in the dialog.} 926 926 {UserX shall click the ``Contribute'' button in the dialog.}
\end{enumerate} 927 927 \end{enumerate}
928 928
\item[Expected Result:] {Blank flashcard will not be added to UserX's deck or to the live feed of TEST 101.} 929 929 \item[Expected Result:] {Blank flashcard will not be added to UserX's deck or to the live feed of TEST 101.}
930 930
\item[Alternate Workflow:] 931 931 \item[Alternate Workflow:]
\begin{enumerate} 932 932 \begin{enumerate}
\setcounter{enumi}{2} 933 933 \setcounter{enumi}{2}
\itemsep1pt\parskip0pt\parsep0pt 934 934 \itemsep1pt\parskip0pt\parsep0pt
\item 935 935 \item
{UserX shall select the input field and type ``Test''.} 936 936 {UserX shall select the input field and type ``Test''.}
\item 937 937 \item
{UserX shall click the ``Contribute'' button in the dialog.} 938 938 {UserX shall click the ``Contribute'' button in the dialog.}
\end{enumerate} 939 939 \end{enumerate}
940 940
\item[Expected Result:] 941 941 \item[Expected Result:]
{ Flashcard with input not meeting the length restriction will not be added to 942 942 { Flashcard with input not meeting the length restriction will not be added to
UserX's deck or to the live feed of TEST 101.} 943 943 UserX's deck or to the live feed of TEST 101.}
944 944
\end{description} 945 945 \end{description}
\newpage 946 946 \newpage
947 947
{} 948 948 {}
949 949
\subsection{[F2] Edit Flashcard} 950 950 \subsection{[F2] Edit Flashcard}
951 951
\begin{description} 952 952 \begin{description}
\item[Description:]{This test case outlines the presentation layering step process of a user editting a flashcard.} 953 953 \item[Description:]{This test case outlines the presentation layering step process of a user editting a flashcard.}
954 954
\item[Desired Outcome:]{Flashcard is edited and saved appropriately} 955 955 \item[Desired Outcome:]{Flashcard is edited and saved appropriately}
\\ 956 956 \\
957 957
\item[User Goals:]{The User shall be able to change the text and the blanked words on a flashcard.} 958 958 \item[User Goals:]{The User shall be able to change the text and the blanked words on a flashcard.}
959 959
\item[Dependency Use Cases:]{[A1] User Registration, [A2] User 960 960 \item[Dependency Use Cases:]{[A1] User Registration, [A2] User
Login, [A3] Add a Class, [F1] Push Flashcard, [F3] Pull Flashcard} 961 961 Login, [A3] Add a Class, [F1] Push Flashcard, [F3] Pull Flashcard}
962 962
\item[Priority Level:]{``Should''} 963 963 \item[Priority Level:]{``Should''}
964 964
\item[Status:]{Implemented} 965 965 \item[Status:]{Implemented}
966 966
\item[Preconditions:] 967 967 \item[Preconditions:]
\begin{itemize} 968 968 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 969 969 \itemsep1pt\parskip0pt\parsep0pt
\item 970 970 \item
{The User is logged in as UserX.} 971 971 {The User is logged in as UserX.}
\item 972 972 \item
{The User is logged in a different browser session as UserY.} 973 973 {The User is logged in a different browser session as UserY.}
\item 974 974 \item
{User has added the class TEST 101.} 975 975 {User has added the class TEST 101.}
\item 976 976 \item
{TEST 101 contains the flashcard ``This is made for \textbf{edit}'' 977 977 {TEST 101 contains the flashcard ``This is made for edit''
, which was made by other user and is not in UserX's deck.} 978 978 , which was made by other user and is not in UserX's deck.}
\item 979 979 \item
{UserX has the flashcard ``I have made an error'', which was created by UserX, in their deck.} 980 980 {UserX has the flashcard ``I have made an \textbf{error}'',
981 which was created by UserX, and was pulled by UserY.}
982 \item
983 {UserX is at the live feed of TEST 101.}
\end{itemize} 981 984 \end{itemize}
982 985
\item[Postconditions:] 983 986 \item[Postconditions:]
\begin{itemize} 984 987 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 985 988 \itemsep1pt\parskip0pt\parsep0pt
\item 986 989 \item
{The selected flashcard is edited} 987 990 {The selected flashcards are edited.}
\end{itemize} 988 991 \end{itemize}
989 992
\item[Trigger:]{The User wants to edit a card.} 990 993 \item[Trigger:]{The User wants to edit existing flashcards.}
991 994
\item[Workflow:] 992 995 \item[Workflow:]
\begin{enumerate} 993 996 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 994 997 \itemsep1pt\parskip0pt\parsep0pt
\item 995 998 \item
{UserX shall hover the cursor over the flashcard ``this is made for \textbf{edit}''.} 996 999 {UserX shall hover the cursor over the flashcard
1000 ``this is made for edit''.}
\item 997 1001 \item
{UserX shall click the edit button on bottom left of the hovered flashcard. The blue edit button looks like a pencil slanted writing on a paper.} 998 1002 {UserX shall click the blue pencil edit icon on
1003 the bottom left of the hovered flashcard.}
\item 999 1004 \item
{The System shall present a modal that contains the text of the selected flashcard.} 1000 1005 {The System shall present a modal that contains the
1006 ``this is made for edit'' of the selected flashcard.}
\item 1001 1007 \item
{UserX shall be able to change the text to ``Edit has been made''.} 1002 1008 {UserX shall select the entire text.}
\item 1003 1009 \item
{UserX shall click ``Save Changes''.} 1004 1010 {UserX shall change the text to ``Edit has been made''.}
\item 1005 1011 \item
1012 {UserX shall click 'SAVE CHANGES'}
1013 \item
{The System shall hide the modal from UserX.} 1006 1014 {The System shall hide the modal from UserX.}
\end{enumerate} 1007 1015 \end{enumerate}
1008 1016
\item[Expected Results:]{The selected flashcard's text shall be changed to ``Edit has been made''.} 1009 1017 \item[Expected Results:]{UserX shall see a new flashcard with the
1018 text ``Edit has been made'' added to the top of the feed and the new
1019 flashcard will be added to UserX's deck.
1020 The flashcard with the text ``this is made for edit''
1021 will be hidden from UserX.}
1010 1022
\item[Alternative Workflow A:] 1011 1023 \item[Alternate Workflow A:]
\begin{enumerate} 1012 1024 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1013 1025 \itemsep1pt\parskip0pt\parsep0pt
\item 1014 1026 \item
{UserX shall move the cursor over the flash card ``this is made for edit2''.} 1015 1027 {UserX shall move the cursor over the flash card
1028 ``I have made an \textbf{error}''.}
\item 1016 1029 \item
{UserX shall click the edit button on bottom left of the selected flashcard.} 1017 1030 {UserX shall click the blue pencil edit icon on
1031 the bottom left of the hovered flashcard.}
\item 1018 1032 \item
{The System shall present a modal that contains the text of the selected flashcard.} 1019 1033 {The System shall present a modal that contains the text
1034 ``I have made an \textbf{error}'' of the selected flashcard.}
\item 1020 1035 \item
{UserX shall be able to change the bolded text from ``edit2'' to ``fun'' by highlighting the words and click blank words.} 1021 1036 {UserX shall select the bolded text ``\textbf{error}''}
\item 1022 1037 \item
1038 {UserX shall select }
1039 \item
{UserX shall click ``Save Changes''.} 1023 1040 {UserX shall click ``Save Changes''.}
\item 1024 1041 \item
{The System shall hide the modal from UserX.} 1025 1042 {The System shall hide the modal from UserX.}
\item 1026 1043 \item
{The selected flashcard's blanked words shall be changed to ``fun''.} 1027 1044 {The selected flashcard's blanked words shall be
1045 changed to ``fun''.}
\end{enumerate} 1028 1046 \end{enumerate}
1029 1047
\item[Expected Result:]{The selected flashcard's blanked words shall be changed to ``fun''.} 1030 1048 \item[Expected Result:]{The selected flashcard's blanked words shall be changed to ``fun''.}
1031 1049
1050 \item[Alternate Workflow B:]
1051 \begin{enumerate}
1052 \itemsep1pt\parskip0pt\parsep0pt
1053 \item
1054 {UserX shall hover the cursor over the flashcard
1055 ``Edit has been made''.}
1056 \item
1057 {UserX shall click the blue pencil edit icon on
1058 the bottom left of the hovered flashcard.}
1059 \item
1060 {The System shall present a modal that contains the
1061 ``Edit has been made'' of the selected flashcard.}
1062 \item
1063 {UserX shall select the entire text.}
1064 \item
1065 {UserX shall change the text to blanks.}
1066 \item
1067 {UserX shall click 'SAVE CHANGES' (button may not change
1068 color).}
1069 \item
1070 {The System shall hide the modal from UserX.}
1071 \end{enumerate}
1072
1073 \item[Expected Result:]{UserX shall see a new flashcard with the
1074 text ``Edit has been made'' added to the top of the feed and the new
1075 flashcard will be added to UserX's deck.
1076 The flashcard with the text ``this is made for edit''
1077 will be hidden from UserX.}
\item[Alternative Workflow B:] 1032 1078 \item[Alternative Workflow B:]
1033 1079
\begin{enumerate} 1034 1080 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1035 1081 \itemsep1pt\parskip0pt\parsep0pt
\item 1036 1082 \item
{UserX shall move the cursor over the flash card ``this is made for edit3''.} 1037 1083 {UserX shall move the cursor over the flash card ``this is made for edit3''.}
\item 1038 1084 \item
{UserX shall click the edit button on bottom left of the selected flashcard.} 1039 1085 {UserX shall click the edit button on bottom left of the selected flashcard.}
\item 1040 1086 \item
{The System shall present a modal that contains the text of the selected flashcard.} 1041 1087 {The System shall present a modal that contains the text of the selected flashcard.}
\item 1042 1088 \item
{UserX shall be able the study date to 6/12.} 1043 1089 {UserX shall be able the study date to 6/12.}
\item 1044 1090 \item
{UserX shall click 'Save'} 1045 1091 {UserX shall click 'Save'}
\item 1046 1092 \item
{The System shall hide the modal from UserX.} 1047 1093 {The System shall hide the modal from UserX.}
\end{enumerate} 1048 1094 \end{enumerate}
1049 1095
\item[Expected Result:]{The selected flashcard's study date shall be changed to 6/12.} 1050 1096 \item[Expected Result:]{The selected flashcard's study date shall be changed to 6/12.}
\end{description} 1051 1097 \end{description}
\newpage 1052 1098 \newpage
1053 1099
{} 1054 1100 {}
1055 1101
\subsection{[F3] Pull Flashcard} 1056 1102 \subsection{[F3] Pull Flashcard}
\begin{description} 1057 1103 \begin{description}
\item[Description:]{This test case outlines the presentation layering step 1058 1104 \item[Description:]{This test case outlines the presentation layering step
process of a user pulling a flashcard.} 1059 1105 process of a user pulling a flashcard.}
1060 1106
\item[Desired Outcome:]{The User shall have the flashcard added to their deck.} 1061 1107 \item[Desired Outcome:]{The User shall have the flashcard added to their deck.}
\\ 1062 1108 \\
1063 1109
\item[User Goals:]{The User will be able to review that flashcard.} 1064 1110 \item[User Goals:]{The User will be able to review that flashcard.}
1065 1111
\item[Dependency Use Cases:]{[A1] User Registration, [A2] User 1066 1112 \item[Dependency Use Cases:]{[A1] User Registration, [A2] User
Login, [A3] Add a Class, [F1] Push Flashard} 1067 1113 Login, [A3] Add a Class, [F1] Push Flashard}
1068 1114
\item[Priority Level:]{``Must'' } 1069 1115 \item[Priority Level:]{``Must'' }
1070 1116
\item[Status:]{Implemented} 1071 1117 \item[Status:]{Implemented}
1072 1118
\item[Preconditions:] 1073 1119 \item[Preconditions:]
\begin{itemize} 1074 1120 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1075 1121 \itemsep1pt\parskip0pt\parsep0pt
\item 1076 1122 \item
{The User is logged in as UserX.} 1077 1123 {The User is logged in as UserX.}
\item 1078 1124 \item
{User has registered for class TEST 101.} 1079 1125 {User has registered for class TEST 101.}
\item 1080 1126 \item
{User is at live feed for TEST 101.} 1081 1127 {User is at live feed for TEST 101.}
\item 1082 1128 \item
{That flashcard with the text ``Pull me'' is in the Live Feed of class TEST 101.} 1083 1129 {That flashcard with the text ``Pull me'' is in the Live Feed of class TEST 101.}
\end{itemize} 1084 1130 \end{itemize}
1085 1131
\item[Postconditions:] 1086 1132 \item[Postconditions:]
\begin{itemize} 1087 1133 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1088 1134 \itemsep1pt\parskip0pt\parsep0pt
\item 1089 1135 \item
{UserX shall have that flashcard with the text ``Pull me'' added to their deck} 1090 1136 {UserX shall have that flashcard with the text ``Pull me'' added to their deck}
\item 1091 1137 \item
{UserX shall be able to review this flashcard later} 1092 1138 {UserX shall be able to review this flashcard later}
\end{itemize} 1093 1139 \end{itemize}
1094 1140
\item[Trigger:]{UserX wants to add a flashcard to their deck to study it.} 1095 1141 \item[Trigger:]{UserX wants to add a flashcard to their deck to study it.}
1096 1142
\item[Workflow:] 1097 1143 \item[Workflow:]
1098 1144
\begin{enumerate} 1099 1145 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1100 1146 \itemsep1pt\parskip0pt\parsep0pt
\item 1101 1147 \item
{UserX shall choose the flashcard with the text ``Pull me'' from the 1102 1148 {UserX shall choose the flashcard with the text ``Pull me'' from the
class TEST 101 feed and hover their cursor over it.} 1103 1149 class TEST 101 feed and hover their cursor over it.}
\item 1104 1150 \item
{The System shall present buttons on mouseover.} 1105 1151 {The System shall present buttons on mouseover.}
\item 1106 1152 \item
{UserX shall click on the large plus that appears over the flashcard with the text ``Pull me''.} 1107 1153 {UserX shall click on the large plus that appears over the flashcard with the text ``Pull me''.}
\item 1108 1154 \item
{The System shall add the flashcard into UserX's deck. 1109 1155 {The System shall add the flashcard into UserX's deck.
A checkmark shall appear on top right corner of the flashcard.} 1110 1156 A checkmark shall appear on top right corner of the flashcard.}
\item 1111 1157 \item
{UserX shall click the ``Deck'' icon on the top left to enter their 1112 1158 {UserX shall click the ``Deck'' icon on the top left to enter their
deck.} 1113 1159 deck.}
\item 1114 1160 \item
{UserX shall check that the card with the text ``Pull me'' has been added to their class 1115 1161 {UserX shall check that the card with the text ``Pull me'' has been added to their class
TEST 101 deck.} 1116 1162 TEST 101 deck.}
\end{enumerate} 1117 1163 \end{enumerate}
1118 1164
\item[Expected Result:] {The flashcard with the text ``Pull me'' is in the class 1119 1165 \item[Expected Result:] {The flashcard with the text ``Pull me'' is in the class
TEST 101 deck. If UserX hovers the cursor over the flashcard at the live feed of 1120 1166 TEST 101 deck. If UserX hovers the cursor over the flashcard at the live feed of
TEST 101, the original placement of the large plus button has been changed to large minus button.} 1121 1167 TEST 101, the original placement of the large plus button has been changed to large minus button.}
\end{description} 1122 1168 \end{description}
\newpage 1123 1169 \newpage
1124 1170
{} 1125 1171 {}
1126 1172
\subsection{[F4] Flag Inappropriate Cards} 1127 1173 \subsection{[F4] Flag Inappropriate Cards}
1128 1174
\begin{description} 1129 1175 \begin{description}
\item[Description:]{This test case outlines the presentation layering step 1130 1176 \item[Description:]{This test case outlines the presentation layering step
process of a user flagging a card they have deemed inappropriate.} 1131 1177 process of a user flagging a card they have deemed inappropriate.}
1132 1178
\item[Desired Outcome:]{The flashcard's inappropriateness variable is 1133 1179 \item[Desired Outcome:]{The flashcard's inappropriateness variable is
adjusted.} 1134 1180 adjusted.}
\\ 1135 1181 \\
1136 1182
\item[User Goals:]{To note if a card should not belong in the class and 1137 1183 \item[User Goals:]{To note if a card should not belong in the class and
should not be displayed in the feed.} 1138 1184 should not be displayed in the feed.}
1139 1185
\item[Dependency Use Cases:]{[A1] User Registration, [A2] User 1140 1186 \item[Dependency Use Cases:]{[A1] User Registration, [A2] User
Login, [A3] Add a Class, [F1] Push Flashcard} 1141 1187 Login, [A3] Add a Class, [F1] Push Flashcard}
1142 1188
\item[Priority Level:]{``Should''} 1143 1189 \item[Priority Level:]{``Should''}
1144 1190
\item[Status:]{Implemented} 1145 1191 \item[Status:]{Implemented}
1146 1192
\item[Preconditions:] 1147 1193 \item[Preconditions:]
\begin{itemize} 1148 1194 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1149 1195 \itemsep1pt\parskip0pt\parsep0pt
\item 1150 1196 \item
{UserX has registered for a class TEST 101.} 1151 1197 {UserX has registered for a class TEST 101.}
\item 1152 1198 \item
{UserX is in the live feed for class TEST 101.} 1153 1199 {UserX is in the live feed for class TEST 101.}
\item 1154 1200 \item
{Flashcard with text ``TESTY FLASHY'' has been created for TEST 101.} 1155 1201 {Flashcard with text ``TESTY FLASHY'' has been created for TEST 101.}
\item 1156 1202 \item
{That flashcard ``TESTY FLASHY'' is in the Live Feed for TEST 101.} 1157 1203 {That flashcard ``TESTY FLASHY'' is in the Live Feed for TEST 101.}
\end{itemize} 1158 1204 \end{itemize}
1159 1205
\item[Postconditions:] 1160 1206 \item[Postconditions:]
\begin{itemize} 1161 1207 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1162 1208 \itemsep1pt\parskip0pt\parsep0pt
\item 1163 1209 \item
{User shall have that flashcard added to their deck} 1164 1210 {User shall have that flashcard added to their deck}
\item 1165 1211 \item
{User can review this flashcard later} 1166 1212 {User can review this flashcard later}
\end{itemize} 1167 1213 \end{itemize}
1168 1214
\item[Trigger:]{UserX wants to mark a card innapropriate.} 1169 1215 \item[Trigger:]{UserX wants to mark a card innapropriate.}
1170 1216
\item[Workflow:] 1171 1217 \item[Workflow:]
\begin{enumerate} 1172 1218 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1173 1219 \itemsep1pt\parskip0pt\parsep0pt
\item 1174 1220 \item
{UserX shall choose the flashcard with the text ``TESTY FLASHY'' from the 1175 1221 {UserX shall choose the flashcard with the text ``TESTY FLASHY'' from the
feed and hover their cursor over it.} 1176 1222 feed and hover their cursor over it.}
\item 1177 1223 \item
{The System shall present buttons on mouseover.} 1178 1224 {The System shall present buttons on mouseover.}
\item 1179 1225 \item
{UserX shall click on the crossed out eye icon (Hide) that appears on the card.} 1180 1226 {UserX shall click on the crossed out eye icon (Hide) that appears on the card.}
\item 1181 1227 \item
{The System shall hide the card from UserX and display a toast, ``Card hidden! If the card was spammy or abusive you may also REPORT''.} 1182 1228 {The System shall hide the card from UserX and display a toast, ``Card hidden! If the card was spammy or abusive you may also REPORT''.}
\item 1183 1229 \item
{UserX shall click the REPORT.} 1184 1230 {UserX shall click the REPORT.}
\end{enumerate} 1185 1231 \end{enumerate}
1186 1232
\item[Expected Result:] {The System shall display a toast, ``Report successful: thanks for letting us know!''} 1187 1233 \item[Expected Result:] {The System shall display a toast, ``Report successful: thanks for letting us know!''}
\end{description} 1188 1234 \end{description}
\newpage 1189 1235 \newpage
1190 1236
{} 1191 1237 {}
1192 1238
\subsection{[F5] Filter Flashcards} 1193 1239 \subsection{[F5] Filter Flashcards}
1194 1240
\begin{description} 1195 1241 \begin{description}
\item[Description:]{This test case outlines the presentation layer process 1196 1242 \item[Description:]{This test case outlines the presentation layer process
of a user filtering existing flashcards to view only a specified subset.} 1197 1243 of a user filtering existing flashcards to view only a specified subset.}
1198 1244
\item[Desired Outcome:]{The User shall see flashcards based on the filter 1199 1245 \item[Desired Outcome:]{The User shall see flashcards based on the filter
options.} 1200 1246 options.}
1201 1247
\item[User Goals:]{The User can find what they are specifically looking 1202 1248 \item[User Goals:]{The User can find what they are specifically looking
for} 1203 1249 for}
1204 1250
\item[Dependency Use Cases:]{[A1] User Registration, [A2] User 1205 1251 \item[Dependency Use Cases:]{[A1] User Registration, [A2] User
Login, [A3] Add a Class, [F1] Push Flashcard, [F3] Pull 1206 1252 Login, [A3] Add a Class, [F1] Push Flashcard, [F3] Pull
Flashcard} 1207 1253 Flashcard}
1208 1254
\item[Priority Level:]{``Should''} 1209 1255 \item[Priority Level:]{``Should''}
1210 1256
\item[Status:]{Implemented} 1211 1257 \item[Status:]{Implemented}
1212 1258
\item[Preconditions:] 1213 1259 \item[Preconditions:]
\begin{itemize} 1214 1260 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1215 1261 \itemsep1pt\parskip0pt\parsep0pt
\item 1216 1262 \item
{User is logged in as UserX.} 1217 1263 {User is logged in as UserX.}
\item 1218 1264 \item
{UserX has registered for the class TEST 101.} 1219 1265 {UserX has registered for the class TEST 101.}
\item 1220 1266 \item
{There exist flashcards in TEST 101 with the text ``apple'' and ``banana'' 1221 1267 {There exist flashcards in TEST 101 with the text ``apple'' and ``banana''
for each week in the quarter.} 1222 1268 for each week in the quarter.}
\item 1223 1269 \item
{There exist flashcards in TEST 101 with the text ``orange'' that are hidden 1224 1270 {There exist flashcards in TEST 101 with the text ``orange'' that are hidden
for each week in the quarter.} 1225 1271 for each week in the quarter.}
\item 1226 1272 \item
{UserX is at Card List View for the class.} 1227 1273 {UserX is at Card List View for the class.}
\end{itemize} 1228 1274 \end{itemize}
1229 1275
\item[Postconditions:] 1230 1276 \item[Postconditions:]
\begin{itemize} 1231 1277 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1232 1278 \itemsep1pt\parskip0pt\parsep0pt
\item 1233 1279 \item
{User only sees flashcards pertaining to selected dates.} 1234 1280 {User only sees flashcards pertaining to selected dates.}
\end{itemize} 1235 1281 \end{itemize}
1236 1282
\item[Trigger:]{User is looking for specific flashcards.} 1237 1283 \item[Trigger:]{User is looking for specific flashcards.}
1238 1284
\item[Workflow:] 1239 1285 \item[Workflow:]
\begin{enumerate} 1240 1286 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1241 1287 \itemsep1pt\parskip0pt\parsep0pt
\item 1242 1288 \item
{UserX shall deselect ``Week Nine'' from top.} 1243 1289 {UserX shall deselect ``Week Nine'' from top.}
\item 1244 1290 \item
{The System shall hide all cards from Week 9.} 1245 1291 {The System shall hide all cards from Week 9.}
\item 1246 1292 \item
{UserX shall search for ``app'' in the search bar in the top right.} 1247 1293 {UserX shall search for ``app'' in the search bar in the top right.}
\item 1248 1294 \item
{The System shall display only cards including text ``app''.} 1249 1295 {The System shall display only cards including text ``app''.}
\item 1250 1296 \item
{UserX shall click ``Show Hidden'' button in the top left and clear 1251 1297 {UserX shall click ``Show Hidden'' button in the top left and clear
the text in the search box.} 1252 1298 the text in the search box.}
\item 1253 1299 \item
{The System shall display all cards, excluding those from Week 9.} 1254 1300 {The System shall display all cards, excluding those from Week 9.}
\end{enumerate} 1255 1301 \end{enumerate}
1256 1302
\item[Expected Result:] {UserX shall see 9 cards with text ``apple'', 9 cards with text ``banana'', and 9 cards with text ``orange'', distributed evenly among weeks.} 1257 1303 \item[Expected Result:] {UserX shall see 9 cards with text ``apple'', 9 cards with text ``banana'', and 9 cards with text ``orange'', distributed evenly among weeks.}
\end{description} 1258 1304 \end{description}
\newpage 1259 1305 \newpage
1260 1306
{} 1261 1307 {}
1262 1308
\subsection{[F6] Blank Out Words in Flashcard} 1263 1309 \subsection{[F6] Blank Out Words in Flashcard}
1264 1310
\begin{description} 1265 1311 \begin{description}
\item[Description:]{This test case outlines the presentation layer process 1266 1312 \item[Description:]{This test case outlines the presentation layer process
of the User to create keywords in a card they are pushing.} 1267 1313 of the User to create keywords in a card they are pushing.}
1268 1314
\item[Desired Outcome:]{The blanked out words (visually bolded) in the 1269 1315 \item[Desired Outcome:]{The blanked out words (visually bolded) in the
flashcard notify the System that they are keywords.} 1270 1316 flashcard notify the System that they are keywords.}
1271 1317
\item[User Goals:]{The User shall mark some words as keywords so the System 1272 1318 \item[User Goals:]{The User shall mark some words as keywords so the System
may later quiz the User by blanking out one keyword at a time and having the 1273 1319 may later quiz the User by blanking out one keyword at a time and having the
User enter what they think the keyword is.} 1274 1320 User enter what they think the keyword is.}
1275 1321
\item[Dependency Use Cases:]{[A1] User Registration, [A2] User 1276 1322 \item[Dependency Use Cases:]{[A1] User Registration, [A2] User
Login, [A3] Add a Class, [F1] Push Flashcard} 1277 1323 Login, [A3] Add a Class, [F1] Push Flashcard}
1278 1324
\item[Priority Level:]{``Must''} 1279 1325 \item[Priority Level:]{``Must''}
1280 1326
\item[Status:]{Implemented} 1281 1327 \item[Status:]{Implemented}
1282 1328
\item[Preconditions:] 1283 1329 \item[Preconditions:]
\begin{itemize} 1284 1330 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1285 1331 \itemsep1pt\parskip0pt\parsep0pt
\item 1286 1332 \item
\item 1287 1333 \item
{The User is logged in as UserX.} 1288 1334 {The User is logged in as UserX.}
\item 1289 1335 \item
{The User has added the class TEST 101.} 1290 1336 {The User has added the class TEST 101.}
\item 1291 1337 \item
{The User is at the Feed View for the class TEST 101.} 1292 1338 {The User is at the Feed View for the class TEST 101.}
\end{itemize} 1293 1339 \end{itemize}
1294 1340
\item[Postconditions:] 1295 1341 \item[Postconditions:]
\begin{itemize} 1296 1342 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1297 1343 \itemsep1pt\parskip0pt\parsep0pt
\item 1298 1344 \item
{The blanked out words (keyword) ``Spain'' in the flashcard are marked with underline.} 1299 1345 {The blanked out words (keyword) ``Spain'' in the flashcard are marked with underline.}
\end{itemize} 1300 1346 \end{itemize}
1301 1347
\item[Trigger:] {The User wants their newly pushed card to have the keyword ``Spain''.} 1302 1348 \item[Trigger:] {The User wants their newly pushed card to have the keyword ``Spain''.}
1303 1349
\item[Workflow:] 1304 1350 \item[Workflow:]
\begin{enumerate} 1305 1351 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1306 1352 \itemsep1pt\parskip0pt\parsep0pt
\item 1307 1353 \item
{UserX shall click the Compose button (+ circle on bottom right) of Feed.} 1308 1354 {UserX shall click the Compose button (+ circle on bottom right) of Feed.}
\item 1309 1355 \item
{The System shall bring up the composition flashcard modal.} 1310 1356 {The System shall bring up the composition flashcard modal.}
\item 1311 1357 \item
{UserX shall type text ``The rain in Spain stays mainly in the plain'' 1312 1358 {UserX shall type text ``The rain in Spain stays mainly in the plain''
into the composition modal, replacing ``Write a flashcard''.} 1313 1359 into the composition modal, replacing ``Write a flashcard''.}
\item 1314 1360 \item
{UserX shall highlight the word ``Spain''.} 1315 1361 {UserX shall highlight the word ``Spain''.}
\item {UserX shall press Blank Selected Text button.} 1316 1362 \item {UserX shall press Blank Selected Text button.}
\item {UserX shall press Contribute button to push the flashcard.} 1317 1363 \item {UserX shall press Contribute button to push the flashcard.}
\item 1318 1364 \item
{The System will save the blanked out word in the Flashcard Mask of the 1319 1365 {The System will save the blanked out word in the Flashcard Mask of the
newly pushed flashcard.} 1320 1366 newly pushed flashcard.}
\item {The Feed shall display the new card with the keyword underlined.} 1321 1367 \item {The Feed shall display the new card with the keyword underlined.}
\end{enumerate} 1322 1368 \end{enumerate}
1323 1369
\item[Expected Result:] {The System shall show ``Spain'' underlined and bolded 1324 1370 \item[Expected Result:] {The System shall show ``Spain'' underlined and bolded
in the flashcard. The flashcard is visible in the Feed and Deck of class TEST 101.} 1325 1371 in the flashcard. The flashcard is visible in the Feed and Deck of class TEST 101.}
\end{description} 1326 1372 \end{description}
\newpage 1327 1373 \newpage
1328 1374
{} 1329 1375 {}
1330 1376
\subsection{[F7] Fix Flashcard} 1331 1377 \subsection{[F7] Fix Flashcard}
1332 1378
\begin{description} 1333 1379 \begin{description}
\item[Description:]{This Test Case outlines the presentation layer process 1334 1380 \item[Description:]{This Test Case outlines the presentation layer process
for the User to alter (``fix'') a flashcard they made originally and not have 1335 1381 for the User to alter (``fix'') a flashcard they made originally and not have
to make a new copy of it. It is only a ``fix'' if no other users have the 1336 1382 to make a new copy of it. It is only a ``fix'' if no other users have the
flashcard in their Decks AND the User is the author.} 1337 1383 flashcard in their Decks AND the User is the author.}
1338 1384
\item[Desired Outcome:]{The User shall change one of their flashcard's text 1339 1385 \item[Desired Outcome:]{The User shall change one of their flashcard's text
and that alteration will be visible to all users in the Feed.} 1340 1386 and that alteration will be visible to all users in the Feed.}
1341 1387
\item[User Goals:]{The User shall make their own authored flashcard say 1342 1388 \item[User Goals:]{The User shall make their own authored flashcard say
something different than it did originally.} 1343 1389 something different than it did originally.}
1344 1390
\item[Dependency Use Cases:]{[A1] User Registration, [A2] User 1345 1391 \item[Dependency Use Cases:]{[A1] User Registration, [A2] User
Login, [A3] Add a Class, [F1] Push Flashcard} 1346 1392 Login, [A3] Add a Class, [F1] Push Flashcard}
1347 1393
\item[Priority Level:]{``Must''} 1348 1394 \item[Priority Level:]{``Must''}
1349 1395
\item[Status:]{Implemented} 1350 1396 \item[Status:]{Implemented}
1351 1397
\item[Preconditions:] 1352 1398 \item[Preconditions:]
\begin{itemize} 1353 1399 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1354 1400 \itemsep1pt\parskip0pt\parsep0pt
\item 1355 1401 \item
{The User is logged in as UserX.} 1356 1402 {The User is logged in as UserX.}
\item {The User is logged in a separate browser as UserY.} 1357 1403 \item {The User is logged in a separate browser as UserY.}
\item 1358 1404 \item
{UserX and UserY has enrolled in the class TEST 101.} 1359 1405 {UserX and UserY has enrolled in the class TEST 101.}
\item 1360 1406 \item
{UserX is at the Deck View for the class TEST 101.} 1361 1407 {UserX is at the Deck View for the class TEST 101.}
\item {UserY is at the Feed View for the class TEST 101.} 1362 1408 \item {UserY is at the Feed View for the class TEST 101.}
\item 1363 1409 \item
{The User has contributed and pushed a flashcard to the TEST 101 Feed, which is 1364 1410 {The User has contributed and pushed a flashcard to the TEST 101 Feed, which is
also in their Deck with text 1365 1411 also in their Deck with text
``My card is currently broken''; this flashcard is for fixing.} 1366 1412 ``My card is currently broken''; this flashcard is for fixing.}
\end{itemize} 1367 1413 \end{itemize}
1368 1414
\item[Postconditions:] 1369 1415 \item[Postconditions:]
\begin{itemize} 1370 1416 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1371 1417 \itemsep1pt\parskip0pt\parsep0pt
\item 1372 1418 \item
{The authoring User shall see their alteration for that flashcard in their 1373 1419 {The authoring User shall see their alteration for that flashcard in their
Feed and Deck for TEST 101.} 1374 1420 Feed and Deck for TEST 101.}
\item {Other users shall see the fixed flashcard in the Feed for TEST 101 if they 1375 1421 \item {Other users shall see the fixed flashcard in the Feed for TEST 101 if they
refresh the app.} 1376 1422 refresh the app.}
\end{itemize} 1377 1423 \end{itemize}
1378 1424
\item[Trigger:] {UserX realizes that a card they created previously does 1379 1425 \item[Trigger:] {UserX realizes that a card they created previously does
not say what they currently desire and wishes to change it.} 1380 1426 not say what they currently desire and wishes to change it.}
1381 1427
\item[Workflow:] 1382 1428 \item[Workflow:]
\begin{enumerate} 1383 1429 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1384 1430 \itemsep1pt\parskip0pt\parsep0pt
\item 1385 1431 \item
{UserX shall hover the Flashcard they created with text ``My card is currently 1386 1432 {UserX shall hover the Flashcard they created with text ``My card is currently
broken''.} 1387 1433 broken''.}
\item 1388 1434 \item
{UserX shall select the bottom-left blue Edit Card pencil button on the flashcard.} 1389 1435 {UserX shall select the bottom-left blue Edit Card pencil button on the flashcard.}
\item 1390 1436 \item
{The System shall bring up the flashcard Edit modal.} 1391 1437 {The System shall bring up the flashcard Edit modal.}
\item 1392 1438 \item
{UserX shall highlight the text ``broken''.} 1393 1439 {UserX shall highlight the text ``broken''.}
\item {UserX shall change the highlighted word into ``fixed'' so that the text 1394 1440 \item {UserX shall change the highlighted word into ``fixed'' so that the text
reads ``My card is currently fixed''.} 1395 1441 reads ``My card is currently fixed''.}
\item 1396 1442 \item
{UserX shall press the Save Changes button.} 1397 1443 {UserX shall press the Save Changes button.}
\item 1398 1444 \item
{The System shall update the flashcard's text content.} 1399 1445 {The System shall update the flashcard's text content.}
\item 1400 1446 \item
{The System shall close the edit flashcard modal.} 1401 1447 {The System shall close the edit flashcard modal.}
\item {The Client shall show the flashcard in the UserX's TEST 101 Deck with the 1402 1448 \item {The Client shall show the flashcard in the UserX's TEST 101 Deck with the
fixed text.} 1403 1449 fixed text.}
1404 1450
\item {UserY refreshes the TEST 101 Feed view and sees the flashcard ``My card is 1405 1451 \item {UserY refreshes the TEST 101 Feed view and sees the flashcard ``My card is
currently fixed''.} 1406 1452 currently fixed''.}
\end{enumerate} 1407 1453 \end{enumerate}
1408 1454
\item[Expected Results:]{The Client shall show the fixed flashcard 1409 1455 \item[Expected Results:]{The Client shall show the fixed flashcard
in UserX's TEST 101 class Deck with the new text:``My card is currently fixed''. 1410 1456 in UserX's TEST 101 class Deck with the new text:``My card is currently fixed''.
The Client shall show the fixed flashcard in UserY's TEST 101 Feed view as well, 1411 1457 The Client shall show the fixed flashcard in UserY's TEST 101 Feed view as well,
after page refresh.} 1412 1458 after page refresh.}
\end{description} 1413 1459 \end{description}
\newpage 1414 1460 \newpage
1415 1461
{} 1416 1462 {}
1417 1463
\subsection{[F8] Hide cards from feed} 1418 1464 \subsection{[F8] Hide cards from feed}
1419 1465
\begin{description} 1420 1466 \begin{description}
\item[Description:]{This test case outlines the presentation layer process 1421 1467 \item[Description:]{This test case outlines the presentation layer process
for the User shall be able to hide cards from their own view, on 1422 1468 for the User shall be able to hide cards from their own view, on
the Feed and Deck.} 1423 1469 the Feed and Deck.}
1424 1470
\item[Desired Outcome:]{The System marks the flashcard as hidden from the 1425 1471 \item[Desired Outcome:]{The System marks the flashcard as hidden from the
User so that the User cannot see the flashcard in the Feed or Deck.} 1426 1472 User so that the User cannot see the flashcard in the Feed or Deck.}
1427 1473
\item[User Goals:]{The flashcard is no longer visible to the User in the Feed or 1428 1474 \item[User Goals:]{The flashcard is no longer visible to the User in the Feed or
Deck views.} 1429 1475 Deck views.}
1430 1476
\item[Dependency Use Cases:]{[A1] User Registration, [A2] User 1431 1477 \item[Dependency Use Cases:]{[A1] User Registration, [A2] User
Login, [A3] Add a Class, [F1] Push Flashcard} 1432 1478 Login, [A3] Add a Class, [F1] Push Flashcard}
1433 1479
\item[Priority Level:]{``Should''} 1434 1480 \item[Priority Level:]{``Should''}
1435 1481
\item[Status:]{Implemented} 1436 1482 \item[Status:]{Implemented}
1437 1483
\item[Preconditions:] 1438 1484 \item[Preconditions:]
\begin{itemize} 1439 1485 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1440 1486 \itemsep1pt\parskip0pt\parsep0pt
\item 1441 1487 \item
{The User is logged in as UserX.} 1442 1488 {The User is logged in as UserX.}
\item 1443 1489 \item
{The User has enrolled in the class TEST 101.} 1444 1490 {The User has enrolled in the class TEST 101.}
\item 1445 1491 \item
{The User is at the Feed View or Deck View (alternate workflow) 1446 1492 {The User is at the Feed View or Deck View (alternate workflow)
for the class TEST 101.} 1447 1493 for the class TEST 101.}
\item 1448 1494 \item
{The User has composed and contributed a flashcard to the Feed with text 1449 1495 {The User has composed and contributed a flashcard to the Feed with text
``The rain in Spain stays mainly in the plain''.} 1450 1496 ``The rain in Spain stays mainly in the plain''.}
\end{itemize} 1451 1497 \end{itemize}
1452 1498
\item[Postconditions:] 1453 1499 \item[Postconditions:]
\begin{itemize} 1454 1500 \begin{itemize}
\itemsep1pt\parskip0pt\parsep0pt 1455 1501 \itemsep1pt\parskip0pt\parsep0pt
\item{Flashcard is not viewable by user in the Feed or Deck views in TEST 101.} 1456 1502 \item{Flashcard is not viewable by user in the Feed or Deck views in TEST 101.}
\end{itemize} 1457 1503 \end{itemize}
1458 1504
\item[Workflow:] 1459 1505 \item[Workflow:]
\begin{enumerate} 1460 1506 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1461 1507 \itemsep1pt\parskip0pt\parsep0pt
\item {UserX has navigated to the Feed View of TEST 101.} 1462 1508 \item {UserX has navigated to the Feed View of TEST 101.}
\item 1463 1509 \item
{UserX hovers the flashcard they added with the text ``The rain in Spain stays 1464 1510 {UserX hovers the flashcard they added with the text ``The rain in Spain stays
mainly in the plain''.} 1465 1511 mainly in the plain''.}
1466 1512
\item {UserX presses Hide button, which is the red crossed-out eye.} 1467 1513 \item {UserX presses Hide button, which is the red crossed-out eye.}
1468 1514
\item {The System shall hide the card.} 1469 1515 \item {The System shall hide the card.}
\item {The Client shall remove the card from view for UserX.} 1470 1516 \item {The Client shall remove the card from view for UserX.}
\item {A toast is shown on the client that allows the User to report the card.} 1471 1517 \item {A toast is shown on the client that allows the User to report the card.}
\item {The card is not shown on the Feed or Deck.} 1472 1518 \item {The card is not shown on the Feed or Deck.}
\end{enumerate} 1473 1519 \end{enumerate}
1474 1520
\item[Expected Result:]{The Client shows the Feed without the flashcard of text 1475 1521 \item[Expected Result:]{The Client shows the Feed without the flashcard of text
``The rain in Spain stays mainly in the plain''. A toast that allows UserX to 1476 1522 ``The rain in Spain stays mainly in the plain''. A toast that allows UserX to
report the card shows up temporarily.} 1477 1523 report the card shows up temporarily.}
1478 1524
\item[Alternate Workflow:] 1479 1525 \item[Alternate Workflow:]
1480 1526
\begin{enumerate} 1481 1527 \begin{enumerate}
\itemsep1pt\parskip0pt\parsep0pt 1482 1528 \itemsep1pt\parskip0pt\parsep0pt
\item {UserX has navigated to the Deck View of TEST 101.} 1483 1529 \item {UserX has navigated to the Deck View of TEST 101.}
\item 1484 1530 \item
{UserX hovers the flashcard they added with the text ``The rain in Spain stays 1485 1531 {UserX hovers the flashcard they added with the text ``The rain in Spain stays
mainly in the plain''.} 1486 1532 mainly in the plain''.}
1487 1533
\item {UserX presses hide button, which is the red crossed-out eye.} 1488 1534 \item {UserX presses hide button, which is the red crossed-out eye.}
1489 1535
\item {The System shall hide the card.} 1490 1536 \item {The System shall hide the card.}
\item {A toast is shown on the client that allows the User to report the card.} 1491 1537 \item {A toast is shown on the client that allows the User to report the card.}
\item {The card is not shown on the Feed or Deck.} 1492 1538 \item {The card is not shown on the Feed or Deck.}
\end{enumerate} 1493 1539 \end{enumerate}
1494 1540
1495 1541
\item[Expected Result:]{The Client shows the Deck without the flashcard of text 1496 1542 \item[Expected Result:]{The Client shows the Deck without the flashcard of text
``The rain in Spain stays mainly in the plain''. A toast that allows UserX to 1497 1543 ``The rain in Spain stays mainly in the plain''. A toast that allows UserX to
report the card shows up temporarily.} 1498 1544 report the card shows up temporarily.}
\end{description} 1499 1545 \end{description}
\newpage 1500 1546 \newpage
1501 1547
{} 1502 1548 {}
1503 1549
\subsection{[F9] View a Feed} 1504 1550 \subsection{[F9] View a Feed}
1505 1551
\begin{description} 1506 1552 \begin{description}
\item[Description:]{This Test Case outlines the presentation layer process 1507 1553 \item[Description:]{This test case outlines the presentation
process of a user viewing a class feed of flashcards.} 1508 1554 layer process process of a user viewing a class Feed.}
1509 1555
\item[Desired Outcome:]{The System shall show the user the Feed for their 1510 1556 \item[Desired Outcome:]{The System shall show the user the
class.} 1511 1557 Feed for their class.}
\\ 1512 1558 \\
1513 1559
\item[User Goals:]{The User will see the Feed for the class User selected.} 1514 1560 \item[User Goals:]{The User will see the Feed for the class User selected.}
1515 1561
UserStories.tex View file @ 88d1384
\documentclass[letterpaper]{scrartcl} % or whatever 1 1 \documentclass[letterpaper]{scrartcl} % or whatever
\usepackage{tgpagella} 2 2 \usepackage{tgpagella}
\setkomafont{disposition}{\normalfont\bfseries} 3 3 \setkomafont{disposition}{\normalfont\bfseries}
%\usepackage[markuppercase]{scrpage2} 4 4 %\usepackage[markuppercase]{scrpage2}
\title{\huge System Test Plan} 5 5 \title{\huge User Stories}
\date{\today} 6 6 \date{\today}
\author{\Large Students With A Goal (S.W.A.G.)} 7 7 \author{\Large Students With A Goal (S.W.A.G.)}
\usepackage[pass]{geometry} 8 8 \usepackage[pass]{geometry}
\usepackage{hyperref} 9 9 \usepackage{hyperref}
\usepackage{graphicx} 10 10 \usepackage{graphicx}
\usepackage{enumitem} 11 11 \usepackage{enumitem}
\setlist[description]{style=multiline,leftmargin=3cm,font=\normalfont\textbf} 12 12 \setlist[description]{style=multiline,leftmargin=3cm,font=\normalfont\textbf}
\setlistdepth{9} 13 13 \setlistdepth{9}
14 14
\setlist[itemize,1]{label=$\bullet$} 15 15 \setlist[itemize,1]{label=$\bullet$}
\setlist[itemize,2]{label=$\bullet$} 16 16 \setlist[itemize,2]{label=$\bullet$}
\setlist[itemize,3]{label=$\bullet$} 17 17 \setlist[itemize,3]{label=$\bullet$}
\setlist[itemize,4]{label=$\bullet$} 18 18 \setlist[itemize,4]{label=$\bullet$}
\setlist[itemize,5]{label=$\bullet$} 19 19 \setlist[itemize,5]{label=$\bullet$}
\setlist[itemize,6]{label=$\bullet$} 20 20 \setlist[itemize,6]{label=$\bullet$}
\setlist[itemize,7]{label=$\bullet$} 21 21 \setlist[itemize,7]{label=$\bullet$}
\setlist[itemize,8]{label=$\bullet$} 22 22 \setlist[itemize,8]{label=$\bullet$}
\setlist[itemize,9]{label=$\bullet$} 23 23 \setlist[itemize,9]{label=$\bullet$}
\renewlist{itemize}{itemize}{9} 24 24 \renewlist{itemize}{itemize}{9}
\begin{document} 25 25 \begin{document}
\maketitle 26 26 \maketitle
\begin{center} 27 27 \begin{center}
\includegraphics[width=12cm]{../swag_logo.png}\\ 28 28 \includegraphics[width=12cm]{../swag_logo.png}\\
29 29
\begin{tabular}{l r} 30 30 \begin{tabular}{l r}
Melody Jeng & System Architect \\ 31 31 Melody Jeng & System Architect \\
Arno Gau & Senior System Analyst \\ 32 32 Arno Gau & Senior System Analyst \\
Rachel Lee & Software Development Lead \\ 33 33 Rachel Lee & Software Development Lead \\
Laura Hawkins & Project Manager \\ 34 34 Laura Hawkins & Project Manager \\
Rohan Rangray & Algorithms Specialist\\ 35 35 Rohan Rangray & Algorithms Specialist\\
Andrew Buss & Database Specialist \\ 36 36 Andrew Buss & Database Specialist \\
Phuong Tran & Quality Assurance Lead \\ 37 37 Phuong Tran & Quality Assurance Lead \\
Chung Kang Wang & Business Analyst\\ 38 38 Chung Kang Wang & Business Analyst\\
Masud Rahman & User Interface Specialist\\ 39 39 Masud Rahman & User Interface Specialist\\
Kevin Mach & User Interface Specialist\\ 40 40 Kevin Mach & User Interface Specialist\\
\end{tabular} 41 41 \end{tabular}
\end{center} 42 42 \end{center}
\newpage 43 43 \newpage
\textbf{\LARGE{These User Stories supercede the the User Stories listed on the post it notes on the CSE Software Tools 44 44 \textbf{\LARGE{These User Stories supercede the the User Stories listed on the post it notes on the CSE Software Tools
Site. We were not able to remove those User Stories. Please use these as the User Stories. }} 45 45 Site. We were not able to remove those User Stories. Please use these as the User Stories. }}
\tableofcontents 46 46 \tableofcontents
47 \newpage
\section{ Account } 47 48 \section{ Account }
As a student, I want to be able to log in to the account I signed up with. 48 49 \begin {enumerate}
As a student, I want to be able to change my password for my account. 49 50 \item {As a student, I want to be able to log in to the account I signed up with.}
As a student, I want to be able to recover my password when I forget it 50 51 \item {As a student, I want to be able to change my password for my account.}
As a student, I want to configure my notifications. 51 52 \item {As a student, I want to be able to recover my password when I forget it.}
As a student, I want to be able to logout my account. 52 53 \item {As a student, I want to configure my notifications.}
As a first time user, I want to be able build my deck without going through registration process in class. 53 54 \item {As a student, I want to be able to logout my account. }
As an instructor, I want to limit access to the cards for my course 54 55 \item {As a first time user, I want to be able build my deck without going through registration process in class.}
As an instructor, I want to invite students to the class group I created 55 56 \item {As an instructor, I want to limit access to the cards for my course.}
As a student I want to receive notifications without installing an app 56 57 \item {As an instructor, I want to invite students to the class group I created.}
As a student I want to be able to delete my account 57 58 \item {As a student I want to receive notifications without installing an app.}
59 \item {As a student I want to be able to delete my account.}
60 \end{enumerate}
61 \newpage
\section{ Flashcards } 58 62 \section{ Flashcards }
As a student, I want to pick flashcards 59 63 \begin{enumerate}
As a student, I want to be able to make my own flashcard 60 64 \item As a student, I want to pick flashcards.
As a student, I want to remove cards from my deck 61 65 \item As a student, I want to be able to make my own flashcard.
As a student, I don't want to see low-quality cards. 62 66 \item As a student, I want to remove cards from my deck.
As a student, I want to edit my card. 63 67 \item As a student, I don't want to see low-quality cards.
As a student, I want to make flashcards quickly 64 68 \item As a student, I want to edit my card.
As a student, I want to flag abusive flash cards. 65 69 \item As a student, I want to make flashcards quickly
As a student I want to see other cards at the time they are added to the feed 66 70 \item As a student, I want to flag abusive flash cards.
As a student, I want to be able to hide unwanted cards from my live feed 67 71 \item As a student I want to see other cards at the time they are added to the feed.
72 \item As a student, I want to be able to hide unwanted cards from my live feed.
73 \end{enumerate}
74 \newpage
\section{ Decks} 68 75 \section{ Decks}
As a student, I want to be able to make my own deck 69 76 \begin {enumerate}
As a student, I want to be able to separate the live feed for each class 70 77 \item As a student, I want to be able to make my own deck.
As a student, I want to add myself to a class 71 78 \item As a student, I want to be able to separate the live feed for each class.
As a student, I want to my deck to be private 72 79 \item As a student, I want to add myself to a class.
As a student, I want to be able to shuffle my deck. 73 80 \item As a student, I want to my deck to be private.
As a student, I want to be able to remove courses that I was registered to. 74 81 \item As a student, I want to be able to shuffle my deck.
82 \item As a student, I want to be able to remove courses that I was registered to.
83 \end{enumerate}
84 \newpage
\section{Study} 75 85 \section{Study}
As a student, I want to be able to study my deck. 76 86 \begin{enumerate}
As a student, I want to have the app remind me when to review my cards 77 87 \item As a student, I want to be able to study my deck.
As a student, I want to be able to blank out words to make cards. 78 88 \item As a student, I want to have the app remind me when to review my cards.
As a student I want to review cards without waiting for a notification 79 89 \item As a student, I want to be able to blank out words to make cards.
As a student I want to view cards in my deck in the order they were created 80 90 \item As a student I want to review cards without waiting for a notification.
As a student, I want to be able to search/sort/filter for flashcards by date, class, tag, keywords 81 91 \item As a student I want to view cards in my deck in the order they were created.
As a student, I want to be able to scroll infinitely 82 92 \item As a student, I want to be able to search/sort/filter for flashcards by date, class, tag, keywords.
As a student I want to use the keyboard to interact with the app 83 93 \item As a student, I want to be able to scroll infinitely.
94 \item As a student I want to use the keyboard to interact with the app.
95 \end{enumerate}
\newpage 84 96 \newpage
\end{document} 85 97 \end{document}
86 98