Updated docs and improved comments in source

Author: TheF1rstPancake

docs/Makefile

@@ -5,7 +5,7 @@
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 PAPER         =
-BUILDDIR      = _build
+BUILDDIR      = /Users/giovannib/Documents/WePay/support-dashboard/pages/
 
 # User-friendly check for sphinx-build
 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)

docs/architecture.rst

@@ -1,3 +1,5 @@
+.. _kvasirarch:
+
 Kvasir's Architecture
 =========================
 This page details Kvasir's architecture.  It explains in detail why each architecture decision was made.
@@ -40,3 +42,9 @@ In order to achieve this, we came up with this idea of a "middleware component."
 
 This middleware can be provided in any language that the developer chooses, using any structure that they want.  As long as it can receive and send back information in the way that Kvasir expects, the rest is up to the developer.  The information that Kvasir requests may be spread out across three or four tables for one developer, but be completed contained in a single table for another.  This middleware piece allows Kvasir to be apathetic towards a developer's underlying database.  This provides us with the necessary flexibility to be able to provide this as a solution to all company's currently using WePay, not just a handful.
 
+
+Integrating with Kvasir
+----------------------------
+The entire architectural model assumes that this application is running on an company's internal network.  It does not come with any sort of authentication and there are no plans for it.  Similarly to database configurations there are a plethora of authentication systems out there that we cannot provide mechanisms to interact with all of them.
+
+You should launch Kvasir on system that is only accessible to your employees and not the greater Internet.  Otherwise, you will be exposing your database, and all of the information about your end users.

docs/conf.py

@@ -20,14 +20,17 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #sys.path.insert(0, os.path.abspath('.'))
-
+sys.path.insert(0,os.path.abspath('sphinxext'))
+print (sys.path)
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
 #needs_sphinx = '1.0'
 
 primary_domain = "js"
 
+BUILDDIR = "/Users/giovannib/Documents/WePay/support-dashboard/pages"
+
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
@@ -37,6 +40,7 @@
     'sphinx.ext.todo',
     'sphinx.ext.mathjax',
     'sphinx.ext.viewcode',
+    'wepay_docs'
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -116,7 +120,8 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'alabaster'
+#html_theme = 'alabaster'
+html_theme = "sphinx_rtd_theme"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

docs/index.rst

@@ -8,6 +8,14 @@ Welcome to Kvasir's documentation!
 Kvasir (Vas-eer) is a support dashboard built for WePay partner's to use with their customer support teams.  
 It provides most of the essential functionality that a support teams needs to handle the various actions that merchants and payers need.
 
+.. note::
+    This documentation was added to GitLab pages and GitHub pages by following this tutorial:
+        http://lucasbardella.com/blog/2010/02/hosting-your-sphinx-docs-in-github
+
+    Getting it to work for GitLab pages required some changes and help from the following link:
+        https://about.gitlab.com/2016/04/07/gitlab-pages-setup/
+        
+
 Kvasir's Capabilities
 ---------------------
 Kvasir is designed to aid in the completion of many actions that your typical customer support user would have to do after integrating with WePay.
@@ -29,7 +37,7 @@ These actions include:
 
 Tech Stack
 -----------
-Kvasir is comprised of two major components - a back end server running on `NodeJS <http://https://nodejs.org/en/>_` and a set of front-end JavaScript files built on top of `ReactJS <https://facebook.github.io/react/>_` and `Redux <http://redux.js.org/>_`.
+Kvasir is comprised of two major components - a back end server running on `NodeJS <http://https://nodejs.org/en/>`_ and a set of front-end JavaScript files built on top of `ReactJS <https://facebook.github.io/react/>`_ and `Redux <http://redux.js.org/>`_.
 
 You are free to pick and choose what parts of the application you want to use.  ReactJS is designed to be back end agnostic - it doesn't care what technology you use on the back end, as long as it receives the information it needs and in the format that it expects.  You could chose to scrape the NodeJS server and rebuild it in your own language of choice.  The reverse is true as well - if you want to work your support dashboard within an existing infrastructure, then you can throw away the front end component and build your own on top of our NodeJS server.
 
@@ -42,7 +50,7 @@ NodeJS comes with some nice functions that make compiling our front end JavaScri
 
 Installation
 ---------------
-First make sure that you have `NodeJS <https://nodejs.org/en/download/>_` installed on your machine.  Node comes prepackaged with it's package manager `npm <https://www.npmjs.com/>_` which will allow you to download and manage all of the packages and dependencies.
+First make sure that you have `NodeJS <https://nodejs.org/en/download/>`_ installed on your machine.  Node comes prepackaged with it's package manager `npm <https://www.npmjs.com/>`_ which will allow you to download and manage all of the packages and dependencies.
 
 From within the main application directory run:
     >>> npm install
@@ -58,7 +66,7 @@ Contents:
    :maxdepth: 2
 
    architecture
-
+   frontend
 
 
 Indices and tables

docs/make.bat

@@ -73,7 +73,8 @@ if errorlevel 9009 (
 
 
 if "%1" == "html" (
-	%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
+	touch *.rst
+    %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
 	if errorlevel 1 exit /b 1
 	echo.
 	echo.Build finished. The HTML pages are in %BUILDDIR%/html.

reducers/accounts.js

@@ -52,7 +52,7 @@ function account(state = [], action) {
         case INVALIDATE_ACCOUNT:
         case RECEIVE_ACCOUNT:
         case REQUEST_ACCOUNT:
-            return Object.assign({}, state, account_base(state, action))
+            return Object.assign([], state, account_base(state, action))
         case CLEAR_ACCOUNTS:
             return {}
         default:

server.js

@@ -5,11 +5,13 @@ var config = require('./webpack.config')
 var bodyParser = require('body-parser')
 var request = require("request")
 
-
+// library for securely handeling hashed cookie objects
 var cookieSession = require("cookie-session")
 
+// WePay library
 var WePay = require("wepay").WEPAY;
 
+// express library for defining routes
 var express = require("express");
 
 // load app configuration settings
@@ -58,22 +60,14 @@ function sendResponse(package, res) {
     }
 }
 
-function getDataFromMiddleware(resource, data, callback) {
-    var uri = app_config.middleware_uri+"/"+resource;
-
-    return request.post(
-        {
-            "url":uri, 
-            "json":data,
-            headers: {
-                "Authorization":app_config.middleware_secret
-            }
-        }, 
-        callback
-    );
-}
-
-
+/**
+ * Request data from the given wepay_endpoint, using the specified access_token and package.  This function will immediately send the response back to the client
+ *
+ * @param res               -   Express response object
+ * @param wepay_endpoint    -   the WePay API endpoint we want to hit
+ * @param access_token      -   the access token we want to use with the request.  NOTE: for certain endpoints, this can be *null*
+ * @param package           -   the package of data we want to send along with request.  This can be an empty object depending on the endpoint
+ */
 function getWePayData(res, wepay_endpoint, access_token, package) {
 
     var wepay_settings = {}
@@ -99,6 +93,45 @@ function getWePayData(res, wepay_endpoint, access_token, package) {
     }
 }
 
+/*
+ * Given a resource, and package of data, send a request to the middleware.
+ * Once the request is complete, it will call the callback function provided.
+ *
+ * Refer to the middleware specification for more details about what resources are available and what each resource expects in it's data package
+ *
+ * @params resource - the resource that we want to search on the partner's database.  This should be user, account, or payer
+ * @params data     - the package we use to query information about the provided resource
+ * @params callback - a callback function to execute after the middleware returns information.  Typically this is `parseMiddlewareResponse`
+ */
+function getDataFromMiddleware(resource, data, callback) {
+    var uri = app_config.middleware_uri+"/"+resource;
+
+    return request.post(
+        {
+            "url":uri, 
+            "json":data,
+            headers: {
+                "Authorization":app_config.middleware_secret
+            }
+        }, 
+        callback
+    );
+}
+
+/*
+ * Parse the response from the middleware and decide what to do with it.
+ * If the middleware sends an error, raise that error back to the client
+ * If a wepay_endpoint is provided, then use the information provided by the client and request information from the provided endpoint with the wepay_package
+ * If no wepay_endpoint is provided, then just send the results from the middleware back to the client
+ *
+ * @params req            -   Expresses Request object
+ * @params res            -   Express Response object
+ * @params error          -   A JSON structure with error information (empty if no error occured)
+ * @params response       -   A detailed response object
+ * @params body           -   A JSON structure with returned data
+ * @params wepay_endpoint -   The wepay_endpoint to hit after receiving a response from the middleware
+ * @params wepay_package  -   The package to send to the wepay_endpoint
+ */
 function parseMiddlewareResponse(req, res, error, response, body, wepay_endpoint, wepay_package) {
     if (body.error) {
         // send error
@@ -256,6 +289,11 @@ app.post("/refund", function(req, res) {
     }
 })
 
+/**
+ * Get reserve information from the WePay API.
+ * Requires an access token and an account_id
+ *
+ */
 app.post("/reserve", function(req, res) {
     if(!req.session.access_token) {
         console.log("ERROR: do not have an access token to work with");
@@ -265,6 +303,9 @@ app.post("/reserve", function(req, res) {
     }
 });
 
+/**
+ * Given a payer's unique identifying information (such as their email), get a list of all of their checkouts from the middleware
+ */
 app.post("/payer", function(req, res) {    
     // get the email from the search
     var email = req.body.email;
@@ -278,6 +319,9 @@ app.post("/payer", function(req, res) {
     );
 })
 
+/*
+ * Given a credit_card_id (tokenized card) get more information about the card from the v2/credit_card WePay API endpoint
+ */
 app.post("/credit_card", function(req, res){
     var credit_card_id = parseInt(req.body.credit_card_id);