Merge https://github.com/LukeShu/leaguer

11 files changed, 46 insertions, 289 deletions

diff --git a/.gitignore b/.gitignore
index ed193ea..2c03f2a 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,4 +1,4 @@
-*.pdf
-*.html
-*.png
-!stickman.png
+.~lock.*
+*~
+*#
+.#*
\ No newline at end of file
diff --git a/Diagram01.jpg b/Diagram01.jpg
deleted file mode 100644
index 0c85216..0000000
--- a/Diagram01.jpg
+++ /dev/null
diff --git a/Makefile b/Makefile
deleted file mode 100644
index 7a239c4..0000000
--- a/Makefile
+++ /dev/null
@@ -1,17 +0,0 @@
-docs = ProductBacklog ProjectCharter ProjectLeaguerWorkloadBreakup
-
-pdf: $(addsuffix .pdf,$(docs))
-html: $(addsuffix .html,$(docs))
-
-%.pdf: %.md Makefile
-	pandoc -s $< -o $@
-%.html: %.md Makefile
-	pandoc -s $< -o $@
-%.png: %.dot Makefile
-	dot -Tpng < $< > $@
-
-ProductBacklog.pdf: SystemModel.png
-SystemModel.png: stickman.png
-
-clean:
-	rm -f -- *.pdf *.html
diff --git a/ProductBacklog.md b/ProductBacklog.md
deleted file mode 100644
index cb089c6..0000000
--- a/ProductBacklog.md
+++ /dev/null
@@ -1,108 +0,0 @@
----
-title: Team 6 - Leaguer
-author: [ Nathaniel Foy, Guntas Grewal, Tomer Kimia, Andrew Murrell, Luke Shumaker, Davis Webb ]
----
-
-Problem Statement
------------------
-
-In team-based tournament sports, often individual contributions are
-overshadowed by the binary end result: win or lose.  This
-winner-takes-all mentality may unfairly pair players in later stages
-of the tournament based on the team's score rather than their own in
-early stages.
-
-
-Background
-----------
-
-Generally, new team based competitions have been managed
-electronically using archaic methods.  The winning team advances and
-the losing team is defeated.  In the real world there are many
-examples of individual review (as in football) and handicaps (as in
-golf).  Our goal is to create software that allows teams to compete
-and review their peers to more accurately represent modern team
-competitions.  Our domain is online competition management and
-e-sports.  The targeted audience is defined on two levels, on a broad
-level it is for any individual wishing to manage a competitive event,
-on a niche level it is for individuals looking to manage and
-participate in team competitions (like League of Legends).
-
-All existing solutions that we found were limited by the binary
-win/lose.  Several open-souce options exist, which we could possibly
-extend.
-
-The most prominent of these is "XDojo". It has not been modified in
-roughly two years, but has been used for several national
-tournaments.  Unfortunately, the documentation is not in English.
-Because of this, evaluating it for possible adaptation is at the very
-least, a spike.
-
-Another current offering is "OMGT" (Open Manager for Game
-Tournaments).  It seems to be reasonably well developed and stable,
-though the install process is mostly undocumented, and while probably
-not very complex, we haven't figured it out yet.
-
-The third current open source offering looked at was "tournamentmngr",
-which seems to be unstable/incomplete.  It is written in C#, which
-gets in the way of our "easy to install" requirement.
-
-System Model
-------------
-
-![](./SystemModel.png)\ 
-
-Requirements
-------------
-<<<<<<< HEAD
-//
-+---------+-----------------------------------+-----------------------------+
-|         | Functional Requirements           | Non-Functional Requirements |
-+=========+===================================+===================================================================================+
-| Must be | - Tournament Creation             | - As a user and host, I would like the program to be simple and intuitive         |
-| done    | - Tournament Settings Management  | - As a user and host, I would like the program to be fast and memory efficient    |
-|         | - Tournament Registration         | - As a user and host, I would like installation to be as simple as possible       |
-|         | - Tournament Pairings             |                                                                                   |
-|         | - Peer Review System              |                                                                                   |
-|         | - Standings                       |                                                                                   |
-|         | - Server File Backup              |                                                                                   |
-+---------+-----------------------------------+-----------------------------------------------------------------------------------+
-| If time | - Alert System                    | - Interactive Menu          |
-| allows  | - Private Message System          | - Twitch Integration        |
-|         | - Advanced Tournament Search      | - Mobile Access             |
-+---------+-----------------------------------+-----------------------------+
-=======
-
- - Essential functional requirements
-    - As a host, I would like to create a new tournament.
-    - As a host, I would like to set some of the parameters of a
-      tournamet, such as number of players per team, whether
-      spectators ar allowed, and game type.
-    - As a player, I would like to register for a tournament.
-    - As a host, I would like to assign members to team, or have the
-      option to randomly assign teams.
-    - As a player, I would like to rate my peers, and would like to be
-      reviewed by my peers.
-    - As a player, or spectator, I would like to see the standings of
-      all players.
-    - As a host, or a player, I would like my win/rating history to be
-      stored so that I can have the same profile throughout many
-      tournaments.
- - Essential non-functional requirements
-    - As a host, player, or spectator I would like the Project Leaguer
-      interface to be simple and easy to use.
-    - As a host, player, or spectator I would like the Project Leaguer
-      server to be secure and to operate quickly.
- - Non-essential functional requirements
-    - As a host, I would like to be able to send public alerts to
-      players and spectators.
-    - As a player, I would like to be able to exchange private
-      messages with a host.
-    - As a player or spectator I would like access to Advanced 
-      Tournament Search facilities.
- - Non-essential non-functional requirements
-    - As a player or spectator I would like to utilize an Interactive Menu.
-    - As a spectator, I would like to be able to watch matches on "Twitch".
-    - As a player, or a spectator, I would like to be able to access
-      the service on a mobile device.
->>>>>>> 81ad3ea9605516711b798ba759a2dd1c7264d8d1
diff --git a/ProductBacklog.md~ b/ProductBacklog.md~
deleted file mode 100644
index b193d89..0000000
--- a/ProductBacklog.md~
+++ /dev/null
@@ -1,55 +0,0 @@
----
-title: Team 6 - Leaguer
-author: [ Nathaniel Foy, Guntas Grewal, Tomer Kimia, Andrew Murrell, Luke Shumaker, Davis Webb ]
----
-
-Problem Statement
------------------
-
-In team-based tournament sports, often individual contributions are
-overshadowed by the binary end result: win or lose.  This
-winner-takes-all mentality may unfairly pair players in later stages
-of the tournament based on the team's score rather than their own in
-early stages.
-
-
-Background
-----------
-
-Generally, new team based competitions have been managed
-electronically using archaic methods.  The winning team advances and
-the losing team is defeated.  In the real world there are many
-examples of individual review (as in football) and handicaps (as in
-golf).  Our goal is to create software that allows teams to compete
-and review their peers to more accurately represent modern team
-competitions.  Our domain is online competition management and
-e-sports.  The targeted audience is defined on two levels, on a broad
-level it is for any individual wishing to manage a competitive event,
-on a niche level it is for individuals looking to manage and
-participate in team competitions (like League of Legends).
-
-TODO - Luke write about existing software.
-
-System Model
-------------
-
-![](./Diagram01.jpg)\ 
-
-Requirements
-------------
-
-+---------+-----------------------------------+-----------------------------+
-|         | Functional Requirements           | Non-Functional Requirements |
-+=========+===================================+===================================================================================+
-| Must be | - Tournament Creation             | - As a user and host, I would like the program to be simple and intuitive         |
-| done    | - Tournament Settings Management  | - As a user and host, I would like the program to be fast and memory efficient    |
-|         | - Tournament Registration         | - As a user and host, I would like installation to be as simple as possible       |
-|         | - Tournament Pairings             |                                                                                   |
-|         | - Peer Review System              |                                                                                   |
-|         | - Standings                       |                                                                                   |
-|         | - Server File Backup              |                                                                                   |
-+---------+-----------------------------------+-----------------------------------------------------------------------------------+
-| If time | - Alert System                    | - Interactive Menu          |
-| allows  | - Private Message System          | - Twitch Integration        |
-|         | - Advanced Tournament Search      | - Mobile Access             |
-+---------+-----------------------------------+-----------------------------+
diff --git a/ProjectCharter.md b/ProjectCharter.md
deleted file mode 100644
index f88ccd4..0000000
--- a/ProjectCharter.md
+++ /dev/null
@@ -1,26 +0,0 @@
-1. In team-based tournament sports, often individual contributions are
-   overshadowed by the binary end result: win or lose.  This
-   winner-takes-all mentality may unfairly pair players in later
-   stages of the tournament based on the team's score rather than
-   their own in early stages.
-
-2. Project Objectives:
-  * To address issues of fairness in tournament orchestration and
-  * To create a general-purpose open source solution for organizing
-    team-based tournaments where individual performance matters
-    * by implementing an out-of-the-box open source server software
-    * capable of managing pairings, scoring, and statistics for a
-      variety of applicable game types
-    * accessable via an intuitive web interface.
-
-3. Stakeholders - the development team, testers, and a future community of users.
-
-4. A Project Leaguer server provides the user with everything needed
-   to run a tournament: regisration, pairing, scoring, and statistics,
-   right away through a simple web interface.  Project Leaguer also
-   gives its users a unique option for scoring, not available through
-   traditional tournament management techniques: peer review.  By
-   providing a forward facing, web-based interface for tournament
-   participants to score their teammates, Project Leaguer allows
-   individual ability and activity to be recognized within the context
-   of an all-in, win-or-lose multiplayer team game.
diff --git a/ProjectLeaguerWorkloadBreakup.md b/ProjectLeaguerWorkloadBreakup.md
deleted file mode 100644
index 99d9c2e..0000000
--- a/ProjectLeaguerWorkloadBreakup.md
+++ /dev/null
@@ -1,14 +0,0 @@
-How to break up workload:

-

- * Login/Registration/Verification System

- * SQL Database Design and Access

- * User Interface

- * Officiator Interface/Admin Access

- * Pairings and Statistics

- * Peer Review

- * Secure Saved Server Image (backed up user profiles, database, and statistics)

- * Separate Game Module Plugins

- * General Abstractions

- * Unit Testing and Error Handling

- * Installing and Running Out-of-the-box

- * Icons and Images

diff --git a/SystemModel.dot b/SystemModel.dot
deleted file mode 100644
index ea1836a..0000000
--- a/SystemModel.dot
+++ /dev/null
@@ -1,60 +0,0 @@
-digraph SystemModel {
-	rankdir=LR;
-	peripheries=0;
-
-	/* users */
-	{
-		node [image="stickman.png", labelloc="b", shape="none"];
-		player[label="Player"];
-		host[label="Host"];
-		spectator[label="Spectator"];
-	}
-
-	/* subsystems */
-	/* if you want to rename any of these, it is probably easiest
-	* to leave the ID the same, and just change the label */
-	subgraph clusterSystem {
-		label = "System Boundry";
-		style = filled;
-
-		node [style=solid];
-		peerReview[label="Peer Review"];
-		performance[label="Performance"];
-		standings[label="Standings"];
-		gs[label="Game Score"];
-		search[label="Search"];
-		pm[label="Private Message"];
-		alerts[label="Alerts"];
-		pairings[label="Pairings"];
-		details[label="Tournament Details"];
-		backup[label="Backup"];
-		registration[label="Registration"];
-	}
-
-	/* all the relationships */
-	spectator -> search;
-	standings -> spectator;
-	alerts -> spectator;
-	pairings -> spectator;
-	
-	player -> spectator [arrowhead="onormal"];
-	player -> peerReview;
-	player -> performance;
-	player -> registration;
-	player -> pm;
-	pm -> player;
-
-	host->spectator [arrowhead="onormal"];
-	host->alerts;
-	host->details;
-	host->registration;
-	host -> pm;
-	pm -> host;
-	
-	peerReview -> standings;
-	performance-> standings;
-	gs -> performance;
-	details -> backup;
-	details -> pairings;
-	registration -> pairings;
-}
diff --git a/docs/DesignDocument.md b/docs/DesignDocument.md
index a15c2f7..87599c7 100644
--- a/docs/DesignDocument.md
+++ b/docs/DesignDocument.md
@@ -24,6 +24,20 @@ Davis Webb
 5.1Class Descriptions and Interactions	4
 5.2UML Diagram of Classes	4
 
+The purpose of this document is to outlay the desgin, intent, and structure of
+the Project Leaguer tournament organizing software.
+
+Released under an open license, Project Leaguer leverages powerful web
+technologies to provide everything needed to organize an online tournament.
+Whether it's League of Legends, Chess, Poker or more, Project Leaguer provides
+tournament organizers, participants, and spectators with an online
+interface to keep up with the score.
+
+The software itself operates as a stand-alone background application
+accessible and configurable though its web interface.
+
+NOT FINISHED -- JUST COMMITING
+ANDREW COMPLETE THIS.
  
 1 Purpose
 This document describes all components of the Leaguer Tournament management system. Leaguer is a software to be installed and run on a server. TODO. ANDREW COMPLETE THIS.
@@ -73,11 +87,34 @@ TODO – Nathaniel write this.
 5.1 Class Descriptions and Interactions
 
 VIEWS
-Webpage: An abstract HTML file, all entries below are webpages (we represent them as subclasses of the abstract “Webpage” class. All webpages will send HTTP requests to the server. Most of the visual effects and update the display with Javascript methods. Each page will have a link to either the login or the logged in user’s page. 
-Homepage: This page has 3 basic options. Visually simple – two large buttons on a white screen, and a search bar above them. The search bar will allow you to search upcoming or current searchable tournaments. Log in (which will take you to the login page) and “Go to Tournament” in which you enter a tournament title. This interacts with the Homepage Controller.
-Login: Page with form entries for username, password. If user clicks “new user” more forms entries will appear. One for repeating the password, and one for email. This interacts with the Login controller.
-Tournament: A tree-like display of pairs of matches, where each match consists of a pair of teams. All users can click on a match to go to that match’s page.  Host can see a gear on top left corner that represents tournament settings. This will open up more options for the host to change. This interacts with the tournament controller.
-Match: A display of both teams.
+Webpage: An abstract HTML file, all entries below are webpages (we represent them as subclasses of the abstract “Webpage” class. All webpages will send HTTP requests to the server. Most of the visual effects and update the display with Javascript methods. Each page will have a login dialogue which will POST to the login controller or the logged in user’s page. 
+
+Homepage: This page has 3 basic options. Visually simple – two large buttons on a white screen, and a search bar above them. The search bar will cause a POST requeest to the search controller. Log in (which will cause a POST to the login controller) and “Go to Tournament” in which you enter a tournament title. This interacts with the Homepage Controller.
+
+Login: Page with form entries for username, password. If user clicks “new user” more forms entries will appear. One for repeating the password, and one for email. This POST to the Login controller.
+
+newTorunament: A form that interacts with users who are either hosts or becoming hosts. This interacts with tournament controller.
+
+Tournament: A tree-like display of matches, where each match consists of a pair of teams. All users can click on a match to go to that match’s page.  Host can see a gear on top left corner that represents tournament settings, it will GET the edit Tournament view. There will be an end button that will redirect to back to the homepage after posting to the tournament controller. The tournament will POST to the tournament controller.
+
+editTorunament: This view is a list of settings. Some are form entries, and some are checkboxes. More settings will be added later in develpment. This view interacts with the tournament controller.
+
+Match: A display of both teams. Each team's players are clickable which causes a GET for the player's profile HTML. A link above both teams will GET the tournament the match belongs to. This will POST its actions to the Match controller.
+
+Search: A page with a searchbar and a list of searchable tournaments that match the search query. The searchbar causes a POST to the search controller. Each entry is clickable and causes a GET to the enrry's tournament.
+
+UserProfile: A page with the user's information. One can view the player's reviews. If the user is viewing his/her own profile, they can edit it causing a POST to the userProfile controller.
+
+
+CONTROLLERS
+HomepageController: This is the main controller. It has methods showHomepage() which renders the homepage view. It has editSettings() method, that gets the current settings of the entire server, provided that the host is viewing the homepage. 
+
+LoginController: This has doLogin() and doLogout(). Both have access to the HTTP requrest. It will interact with the Users model to validate passwords and usernames.
+
+TournamentController: This controller will have methods: newTorunament(), getTournament(), editTournament(), and endTournament(). All of these methods will interact with the Tournament model, and all of its fields including users matches and TournamentSettings. And all will interact with their tournament view, for example, newTournament() will render newTorunament.
+
+
+
 
 Server: Rails’ Server class handles all HTTP events. Our Server class is the class that is the main program. It instantiates other classes, manages requests from Views, and runs static methods.
 User: A class that represents someone using the Views (HTML, javascript) the user is in competitions and 
diff --git a/docs/Images.pptx b/docs/Images.pptx
index 73f002d..01e8016 100644
--- a/docs/Images.pptx
+++ b/docs/Images.pptx
diff --git a/stickman.png b/stickman.png
deleted file mode 100644
index 00f16fc..0000000
--- a/stickman.png
+++ /dev/null