Initial commit of framework

app/routing/Middleware.js

@@ -0,0 +1,18 @@
+/*
+ * Global Middleware Definitions
+ * -------------------------------------------------------------
+ * These middleware are applied, in order, before every request that
+ * Flitter handles, regardless of request type. Each middleware class
+ * can be referenced using the middleware's Flitter canonical name.
+ * 
+ * Route-specific middleware should be specified in the corresponding
+ * routes file.
+ */
+const Middleware = [
+
+    // Injects the RequestLocalizationHelper
+    "i18n:Localize",
+
+]
+
+module.exports = exports = Middleware

app/routing/middleware/HomeLogger.middleware.js

@@ -0,0 +1,32 @@
+const { Middleware } = require('libflitter')
+
+/*
+ * HomeLogger Middleware
+ * -------------------------------------------------------------
+ * This is a sample middleware. It simply prints a console message when
+ * the route that it is tied to is accessed. By default, it is called if
+ * the '/' route is accessed. It can be injected in routes globally using
+ * the middlewares service.
+ */
+class HomeLogger extends Middleware {
+    static get services() {
+        return [...super.services, 'output']
+    }
+
+    /*
+     * Run the middleware test.
+     * This method is required by all Flitter middleware.
+     * It should either call the next function in the stack,
+     * or it should handle the response accordingly.
+     */
+    test(req, res, next, args) {
+        this.output.debug('Home was accessed!')
+
+        /*
+         * Call the next function in the stack.
+         */
+        next()
+    }
+}
+
+module.exports = HomeLogger

app/routing/middleware/i18n/Localize.middleware.js

@@ -0,0 +1,7 @@
+const Middleware = require('flitter-i18n/src/middleware/Localize')
+
+class LocalizeMiddleware extends Middleware {
+
+}
+
+module.exports = exports = LocalizeMiddleware

app/routing/middleware/i18n/Scope.middleware.js

@@ -0,0 +1,7 @@
+const Middleware = require('flitter-i18n/src/middleware/Scope')
+
+class ScopeMiddleware extends Middleware {
+
+}
+
+module.exports = exports = ScopeMiddleware

app/routing/middleware/util/Config.middleware.js

@@ -0,0 +1,43 @@
+const { Middleware } = require('libflitter')
+
+/*
+ * Config Middleware
+ * -------------------------------------------------------------
+ * Checks the specified configuration key (and optionally the value).
+ * If the configuration matches the required value, the request can
+ * proceed. Otherwise, a 404 will be returned.
+ *
+ * To use, add the call to your route's middleware:
+ *
+ * ['middleware::util:Config', {key: 'server.ssl.test', value: true}],
+ *
+ * In this case, the request would be allowed to proceed in the case:
+ *  services.configs.get('server.ssl.test') === true
+ *
+ * The 'value' attribute is optional. If none is provided, the request
+ * can proceed if the config value is truthy.
+ */
+class Config extends Middleware {
+    static get services() {
+        return [...super.services, 'configs', 'output']
+    }
+
+    /*
+     * Run the middleware test.
+     */
+    test(req, res, next, args = {}){
+        if ( !args.key ) return res.error(500)
+
+        const config = this.configs.get(args.key)
+
+        if ( !args.value && !config ) {
+            if ( !config && typeof config === 'undefined' )
+                this.output.warn(`util:Config middleware check failed because it tried to access a config that doesn't exist. (${key})`)
+            return res.error(404)
+        }
+        else if ( args.value && args.value !== config ) return res.error(404)
+        else return next()
+    }
+}
+
+module.exports = Config

app/routing/routers/index.routes.js

@@ -0,0 +1,71 @@
+/*
+ * Index Routes
+ * -------------------------------------------------------------
+ * This is a sample routes file. Routes and their handlers should be
+ * defined here, but no logic should occur.
+ */
+const index = {
+
+    /*
+     * Define the prefix applied to each of these routes.
+     * For example, if prefix is '/auth':
+     *      '/' becomes '/auth'
+     *      '/login' becomes '/auth/login'
+     */
+    prefix: '/',
+
+    /*
+     * Define middleware that should be applied to all
+     * routes defined in this file. Middleware should be
+     * included using its non-prefixed canonical name.
+     *
+     * You can pass arguments along to a middleware by
+     * specifying it as an array where the first element
+     * is the canonical name of the middleware and the
+     * second element is the argument passed to the
+     * handler's test() method.
+     */
+    middleware: [
+        // Sets the locale scope
+        ['i18n:Scope', {scope: 'common'}],
+
+        ['HomeLogger', {note: 'arguments can be specified as the second element in this array'}],
+        // 'MiddlewareName', // Or without arguments
+    ],
+
+    /*
+     * Define GET routes.
+     * These routes are registered as GET methods.
+     * Handlers for these routes should be specified as
+     * an array of canonical references to controller methods
+     * or middleware that are applied in order.
+     */
+    get: {
+        // handlers should be a list of either controller:: or middleware:: references
+        // e.g. middleware::HomeLogger
+        // e.g. controller::Home.welcome
+        '/': [
+            'controller::Home.welcome'
+        ],
+
+        // Placeholder for auth dashboard. You'd replace this with
+        // your own route protected by 'middleware::auth:UserOnly'
+        '/dash': [ 'controller::Home.welcome' ],
+    },
+
+    /*
+     * Define POST routes.
+     * These routes are registered as POST methods.
+     * Handlers for these routes should be specified as
+     * an array of canonical references to controller methods
+     * or middleware that are applied in order.
+     */
+    post: {
+
+    },
+
+    // You can include other HTTP verbs here.
+    // Supported ones are: get, post, put, delete, copy, patch
+}
+
+module.exports = exports = index