summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavisLWebb <davislwebb@ymail.com>2014-02-10 21:07:28 -0500
committerDavisLWebb <davislwebb@ymail.com>2014-02-10 21:07:28 -0500
commitf5c80fbaac9f9147b271dc03ed088d678ca2bcac (patch)
tree7bd7c7872c4ec570f051c158a56be2f57f900a2a
parentc2cfe34c6088419dc925e655d1ba66bca418f834 (diff)
parent4945ce02b45dacee020f8919f51fa3dfb23cc194 (diff)
Merge https://github.com/LukeShu/leaguer
-rw-r--r--docs/DesignDocument.md74
1 files changed, 47 insertions, 27 deletions
diff --git a/docs/DesignDocument.md b/docs/DesignDocument.md
index ec874be..a9ae97a 100644
--- a/docs/DesignDocument.md
+++ b/docs/DesignDocument.md
@@ -153,7 +153,9 @@ layouts/application.html (abstract)
logout button that causes a POST to `LoginController#logout()`.
It may contain an alert box of recent alerts submitted by a
tournament host. It contains a searc form that is POSTed to
- `SearchController#show_results`.
+ `SearchController#show_results`. If the user is authorized to
+ publish alerts, it also contains a button that causes the browser
+ to GET `MessagesController#new_alert()`.
common/permission_denied.html
: A generic page for when a user attempts to do something for which
@@ -308,17 +310,24 @@ SearchController
contains the information requested and renders the `search/results` view.
MessagesController
- : TODO
+ : This controller handles inter-user messages. It has a couple
+ methods that respond to GET requests:
- - `new_alert()` TODO: GET
- - `post_alert()` TODO: POST
- - `show_private()` TODO: GET
- - `post_private()` TODO: POST
+ - `new_alert()` Renders the `messages/new_alert` template,
+ assuming the user has permission.
+ - `show_private()` Renders the `messages/private template,
+ assuming the user has permission.
-TournamentsController
- : This controller will have methods:
+ It also has methods that respond to POST requests:
+
+ - `post_alert()` Publishes a new system-wide alert, assuming the
+ user has permission. It then redirects the browser to whichever
+ page it would otherwise be on.
+ - `post_private()` Sends a new private message, assuming the user
+ has permission.
- The following methods respond to GET requests by rendering the
+TournamentsController
+ : The following methods respond to GET requests by rendering the
`tournaments/*` view with the same name:
- `index()`
@@ -341,36 +350,47 @@ TournamentsController
TournamentSettings.
MatchesController
- : TODO
+ : The following methods respond to GET requests by rendering the
+ `matches/*` view with the same name:
- - `index()`: TODO: GET
- - `show()` TODO: GET
- - `edit()` TODO: GET
- - `update()` TODO: POST
+ - `index()`
+ - `show()`
+ - `edit()`
+
+ The following methods respond to POST requests, assuming the user
+ has permission:
+
+ - `update()` Updates the specified `Match` with the POSTed data.
TeamsController
- : TODO
+ : The following methods respond to GET requests by rendering the
+ `teams/*` view with the same name:
+
+ - `index()`
+ - `show()`
+ - `edit()`
+
+ The following methods respond to POST requests, assuming the user
+ has permission:
- - `index()` TODO: GET
- - `show()` TODO: GET
- - `edit()` TODO: GET
- `update()` TODO: POST
UsersController
- : TODO
+ : The following methods respond to GET requests by rendering the
+ `users/*` view with the same name:
+
+ - `index()`
+ - `show()`
+ - `new()`
+ - `edit()`
+
+ The following methods respond to POST requests, assuming the user
+ has permission:
- - `index()` TODO: GET
- - `show()` TODO: GET
- - `new()` TODO: GET
- `create()` TODO: POST
- - `edit()` TODO: GET
- `update()` TODO: POST
- `delete()` TODO: POST
## UML Diagram of Classes
-TODO ā€“ Iā€™m working on this ā€“ see images.pptx ~ Tomer
-
-So am I: ~ Luke
-
![](DesignDocument-classes.pdf)\