Create infrastructure to install and run

Mostly copied from ORES, although we should be extracting into a shared
library.

Author: Adam Wight

.codecov.yml

@@ -0,0 +1,7 @@
+codecov:
+  notify:
+    require_ci_to_pass: no
+
+coverage:
+  status:
+    patch: off

.gitignore

@@ -0,0 +1,3 @@
+*.pyc
+__pycache__
+/*.egg-info

config/00-main.yaml

@@ -16,5 +16,5 @@ actions:
   new_judgement:
     groups: []
   set_judgement_preference:
-    groups: []
+    groups:
       - autoconfirmed

jade/about.py

@@ -0,0 +1,7 @@
+__name__ = "jade"
+__version__ = "0.0.1"
+__author__ = "Aaron Halfaker"
+__author_email__ = "[email protected]"
+__description__ = "Judgment and Dialog Engine"
+__url__ = "https://github.com/wiki-ai/jade"
+__license__ = "MIT"

jade/applications/util.py

@@ -0,0 +1,57 @@
+# TODO: Dedupe with utilities and application framework from ores?
+import glob
+import os.path
+import yamlconf
+import logging
+import logging.config
+import sys
+
+DEFAULT_DIRS = ["config/", "/etc/jade/"]
+DEFAULT_LOGGING_CONFIG = "logging_config.yaml"
+DEFAULT_FORMAT = "%(asctime)s %(levelname)s:%(name)s -- %(message)s"
+
+
+logger = logging.getLogger(__name__)
+
+
+def build_config(config_dirs=DEFAULT_DIRS, **kwargs):
+    # Loads files in alphabetical order based on the bare filename
+    config_file_paths = []
+    for directory in config_dirs:
+        dir_glob = os.path.join(directory, "*.yaml")
+        config_file_paths.extend((os.path.basename(path), path)
+                                 for path in glob.glob(dir_glob))
+    config_file_paths.sort()
+    logger.info("Loading configs from {0}".format(config_file_paths))
+    config = yamlconf.load(*(open(p) for fn, p in config_file_paths))
+
+    return config
+
+
+def configure_logging(verbose=False, debug=False, logging_config=None,
+                      **kwargs):
+    # Load logging config if specified.  If no config file is specified, we
+    # make a half-hearted attempt to find a distributed logging_config.yaml
+    # in the current working directory.
+    if logging_config is None:
+        if os.path.exists(DEFAULT_LOGGING_CONFIG):
+            logging_config = DEFAULT_LOGGING_CONFIG
+
+    if logging_config is not None:
+        with open(logging_config) as f:
+            logging_config = yamlconf.load(f)
+            logging.config.dictConfig(logging_config)
+
+        # Secret sauce: if running from the console, mirror logs there.
+        if sys.stdin.isatty():
+            handler = logging.StreamHandler(stream=sys.stderr)
+            formatter = logging.Formatter(fmt=DEFAULT_FORMAT)
+            handler.setFormatter(formatter)
+            logging.getLogger().addHandler(handler)
+
+    else:
+        # Configure fallback logging.
+        logging.basicConfig(level=logging.INFO, format=DEFAULT_FORMAT)
+
+    if debug:
+        logging.getLogger().setLevel(logging.DEBUG)

jade/applications/wsgi.py

@@ -0,0 +1,52 @@
+import docopt_subcommands as dsc
+from jade.wsgi import server
+
+from .util import build_config, configure_logging
+
+
+@dsc.command()
+def server_command(args):
+    """
+    usage:
+        {program} server (-h | --help)
+        {program} server [--host=<name>] [--port=<num>] [--config-dir=<path>]...
+                         [--processes=<num>] [--debug] [--verbose]
+                         [--logging-config=<path>]
+
+    Runs a WSGI-based web server that hosts JADE.
+
+    Options:
+        -h --help                Print this documentation
+        --host=<name>            The hostname to listen on [default: 0.0.0.0]
+        --port=<num>             The port number to start the server on
+                                 [default: 8080]
+        --config-dir=<path>      The path to a directory containing configuration
+                                 [default: config/]
+        --logging-config=<path>  The path to a logging configuration file
+        --processes=<num>        The number of parallel processes to handle
+                                 [default: 16]
+        --debug                  Print debug logging information
+        --verbose                Print verbose extraction information
+    """
+    host = args['--host']
+    port = int(args['--port'])
+    processes = int(args['--processes'])
+    verbose = args['--verbose']
+    debug = args['--debug']
+
+    run(host, port, processes,
+        verbose=verbose, debug=debug,
+        logging_config=args['--logging-config'],
+        config_dirs=args['--config-dir'])
+
+
+def run(host, port, processes, **kwargs):
+    application = build(**kwargs)
+    application.debug = True
+    application.run(host=host, port=port, processes=processes, debug=True)
+
+
+def build(**kwargs):
+    configure_logging(**kwargs)
+    config = build_config(**kwargs)
+    return server.configure(config)

jade/jade.py

@@ -0,0 +1,21 @@
+"""
+Console access to JADE
+
+Usage:
+    jade [-h | --help]
+    jade server
+
+Available commands:
+    server      Start the web server.
+
+Options:
+    --help      Show this usage message.
+"""
+import docopt_subcommands as dsc
+import sys
+
+from .applications import wsgi
+
+
+def main():
+    dsc.main(program='jade', version='jade v1')

jade/wsgi/preprocessors.py

@@ -0,0 +1,36 @@
+# TODO: dedupe with ores code
+from functools import wraps
+
+from flask import current_app, make_response, request
+
+
+def minifiable(route):
+    @wraps(route)
+    def minifiable_route(*args, **kwargs):
+        # Change the config
+        current_app.config['JSONIFY_PRETTYPRINT_REGULAR'] = \
+            False if request.args.get('format') == 'json' else True
+
+        # Generate a response
+        response = route(*args, **kwargs)
+
+        # Explicitly return to default now that the result is generated
+        current_app.config['JSONIFY_PRETTYPRINT_REGULAR'] = True
+
+        return response
+
+    return minifiable_route
+
+
+def nocache(route):
+    @wraps(route)
+    def nocache_route(*args, **kwargs):
+        response = make_response(route(*args, **kwargs))
+        response.headers['Cache-Control'] = \
+            "no-store, no-cache, max-age=0"
+        response.headers['Pragma'] = 'no-cache'
+        # Unix epoch
+        response.headers['Expires'] = 'Thu, 01 Jan 1970 00:00:00 GMT'
+        return response
+
+    return nocache_route

requirements.txt

@@ -0,0 +1,9 @@
+# Note that cryptography < 1.9 is incompatible with openssl-1.1.0f
+cryptography >= 1.9.0, < 1.9.999
+docopt
+docopt_subcommands
+flask_swaggerui
+Flask >= 0.12.2, < 0.12.999
+jwt
+mwapi
+yamlconf

setup.py

@@ -0,0 +1,62 @@
+import os
+import re
+import sys
+import platform
+from setuptools import find_packages, setup
+
+about_path = os.path.join(os.path.dirname(__file__), "jade/about.py")
+exec(compile(open(about_path).read(), about_path, "exec"))
+
+if sys.version_info <= (3, 0):
+    print("JADE needs Python 3 to run properly. Your version is "
+          + platform.python_version())
+    sys.exit(1)
+
+
+def read(fname):
+    return open(os.path.join(os.path.dirname(__file__), fname)).read()
+
+
+def requirements(fname):
+    """
+    Generator to parse requirements.txt file
+
+    Supports bits of extended pip format (git urls)
+    """
+    with open(fname) as f:
+        for line in f:
+            match = re.search('#egg=(.*)$', line)
+            if match:
+                yield match.groups()[0]
+            else:
+                yield line.strip()
+
+
+setup(
+    python_requires=">=3",
+    name=__name__,  # noqa
+    version=__version__,  # noqa
+    author=__author__,  # noqa
+    author_email=__author_email__,  # noqa
+    description=__description__,  # noqa
+    url=__url__,  # noqa
+    license=__license__,  # noqa
+    entry_points={
+        'console_scripts': [
+            'jade = jade.jade:main',
+        ],
+    },
+    packages=find_packages(),
+    include_package_data=True,
+    long_description=read('README.md'),
+    install_requires=list(requirements("requirements.txt")),
+    classifiers=[
+        "Development Status :: 3 - Alpha",
+        "Programming Language :: Python",
+        "Programming Language :: Python :: 3",
+        "Environment :: Other Environment",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent"
+    ],
+)