feature/overhaul

.coveragerc

@@ -0,0 +1,5 @@
+[run]
+omit=
+  */site-packages/*
+  */distutils/*
+  */src/tests/*

.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.{py,md}]
+indent_size = 4

.flake8

@@ -0,0 +1,5 @@
+[flake8]
+max-line-length=99
+inline-quotes="
+exclude=
+  src/tests/mockredis

.gitignore

@@ -3,4 +3,8 @@ bin/
 include/
 lib/
 pip-selfcheck.json
-local_settings.py
+local_settings.py
+.DS_Store
+.coverage
+htmlcov
+.env

Pipfile

@@ -0,0 +1,29 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[scripts]
+test = "python -m unittest discover -s src/tests"
+test-coverage = "coverage run -m unittest discover -s src/tests"
+test-report = "coverage report"
+test-report-html = "coverage html"
+lint = "flake8"
+start = "gunicorn src.server:app --reload"
+start-prod = "gunicorn src.server:app"
+
+[packages]
+falcon = "*"
+gunicorn = "*"
+python-mimeparse = "*"
+redis = "*"
+requests = "*"
+six = "*"
+
+[dev-packages]
+flake8 = "*"
+flake8-quotes = "*"
+coverage = "*"
+
+[requires]
+python_version = "3.6"

README.md

@@ -2,24 +2,47 @@
 
 GoonAuth2 is a REST API service that can be used to authorize membership in the Something Is Awful internet forum.
 
+## Requirements
+
+- Pipenv
+- Python3 (v3.6+)
+- Redis (v5.0.0+)
+
 ## Installation
 
-The service is powered by **Python 3** (v3.4.3) and **Redis** (v2.8.4). Python dependencies include **Falcon**, **redis-py**, **requests**, and **gunicorn**. You can install all of these dependencies via the included `requirements.txt`:
+Install dependencies with **Pipenv** via the included **Pipfile**:
+
+```sh
+$> pipenv install
+```
+
+A few environment variables can be set within a **.env** file (placed in the root of this project) to customize functionality:
+
+- `REDIS_URL`
+    - **String** in the following format: `redis://[username]:[password]@[hostname]:6379`
+    - **Default:** "" (will attempt to connect to localhost:6379 without a username or password)
+- `HASH_LIFESPAN_MINS`
+    - **Number** of minutes a hash is good for
+    - **Default:** 5
 
-	virtualenv .
-	pip install -r requirements.txt
+The only things stored in the database are short-lived `key:value` pairs that automatically expire in `HASH_LIFESPAN_MINS * 60` seconds.
 
-There are a couple of values you'll need to update before the server will work. First, update `REDIS_HOST`, `REDIS_PORT`, and `REDIS_DB_NUM` to point to whatever Redis server you want to use. The only things stored in the database are short-lived `key:value` pairs that automatically expire in `HASH_LIFESPAN_MINS * 60` seconds.
+The following values will also need to be set so that the server can access SA profiles:
 
-You'll also want to set values for the following strings: `COOKIE_SESSIONID`, `COOKIE_SESSIONHASH`, `COOKIE_BBUSERID`, and `COOKIE_BBPASSWORD`. I opted to create an accompanying `local_settings.py` file and define them within that, but feel free to specify them as you wish.
+- `COOKIE_SESSIONID`
+- `COOKIE_SESSIONHASH`
+- `COOKIE_BBUSERID`
+- `COOKIE_BBPASSWORD`.
 
 These four values need to be taken from an existing logged-in user's cookies:
 
 ![Something Is Awful Cookies](./docs/somethingisawful_cookies.png)
 
 Once everything is in place, you can start the server using `gunicorn`:
 
-	gunicorn server:app
+```sh
+$> pipenv run start-prod
+```
 
 ## Usage
 
@@ -29,9 +52,11 @@ POST to `/v1/generate_hash/` with a JSON-encoded payload containing a `username`
 
 The returned payload will contain a `hash` key with a random 32-character alphanumeric value:
 
-	{
-		"hash": "hMPAtkx6xIEtVfqqP0X9bvEG8lU4Yypb"
-	}
+```json
+{
+    "hash": "hMPAtkx6xIEtVfqqP0X9bvEG8lU4Yypb"
+}
+```
 
 The hash will expire after **5 minutes** but can easily be re-generated after expiration by re-submitting the above request.
 
@@ -49,6 +74,8 @@ Once the hash is in-place, POST a request to `/v1/validate_user/` with a JSON-en
 
 The returned payload will contain a `validated` key with a `boolean` value of whether or not the hash was detected :
 
-	{
-		"validated": true
-	}
+```json
+{
+    "validated": true
+}
+```