meadow-endpoints 3.0.6 → 4.0.2

package/{Dockerfile → Dockerfile_LUXURYCode}

@@ -13,6 +13,48 @@ RUN sudo apt install default-mysql-server default-mysql-client -y
 
 RUN echo "Building RETOLD development image..."
 
+RUN echo "...installing vscode extensions..."
+
+# Mocha unit testing in the sidebar
+RUN code-server --install-extension hbenl.vscode-mocha-test-adapter
+RUN code-server --install-extension hbenl.test-adapter-converter
+RUN code-server --install-extension hbenl.vscode-test-explorer
+
+# Magic indentation rainbow
+RUN code-server --install-extension oderwat.indent-rainbow
+RUN code-server --install-extension dbaeumer.vscode-eslint
+
+# Contextual git
+RUN code-server --install-extension eamodio.gitlens
+
+# Other extensions (uncomment them to have them automagic, or run this from a terminal to install in the container):
+
+# SQL Tools
+RUN code-server --install-extension mtxr.sqltools
+RUN code-server --install-extension mtxr.sqltools-driver-mysql
+
+# Microsoft's AI code completion
+# RUN code-server --install-extension  VisualStudioExptTeam.vscodeintellicode
+
+# Live server -- make sure to open up the port on the docker image
+# RUN code-server --install-extension ritwickdey.LiveServer
+
+# Quick link to required modules' documentation
+RUN code-server --install-extension bengreenier.vscode-node-readme
+
+# Switch up fonts
+# RUN code-server --install-extension evan-buss.font-switcher
+
+# Icons
+# RUN code-server --install-extension vscode-icons-team.vscode-icons
+# RUN code-server --install-extension PKief.material-icon-theme
+
+# Hover over CSS colors to see them previewed
+# RUN code-server --install-extension bierner.color-info
+
+# An easy on the eyes color theme
+# RUN code-server --install-extension daylerees.rainglow
+
 RUN echo "...configuring mariadb (mysql) server..."
 RUN sudo sed -i "s|bind-address|#bind-address|g" /etc/mysql/mariadb.conf.d/50-server.cnf
 ADD ./.config/luxury-extras/MySQL/MySQL-Security.sql /home/coder/MySQL-Configure-Security.sql
@@ -20,7 +62,7 @@ ADD ./.config/luxury-extras/MySQL/MySQL-Laden-Entry.sh /usr/bin/MySQL-Laden-Entr
 RUN ( sudo mysqld_safe --skip-grant-tables --skip-networking & ) && sleep 5 &&  mysql -u root < /home/coder/MySQL-Configure-Security.sql
 
 # Import the initial database
-COPY ./.config/luxury-extras/model/sql_create/BookStore-CreateDatabase.mysql.sql /home/coder/MySQL-Create-Databases.sql
+COPY ./test_support/model/sql_create/BookStore-CreateDatabase.mysql.sql /home/coder/MySQL-Create-Databases.sql
 RUN sudo service mariadb restart && sleep 5 && mysql -u root -p"123456789" -e "CREATE DATABASE bookstore;"
 RUN sudo service mariadb restart && sleep 5 && mysql -u root -p"123456789" bookstore < /home/coder/MySQL-Create-Databases.sql
 RUN sudo service mariadb restart && sleep 5 && mysql -u root -p"123456789" -e "CREATE DATABASE FableTest;"

package/README.md

@@ -2,8 +2,6 @@
 
 Automagic REST endpoints for basic CRUD operations on the Retold framework.
 
-[![Coverage Status](https://coveralls.io/repos/stevenvelozo/meadow-endpoints/badge.svg?branch=master)](https://coveralls.io/r/stevenvelozo/meadow-endpoints?branch=master) [![Build Status](https://travis-ci.org/stevenvelozo/meadow-endpoints.svg?branch=master)](https://travis-ci.org/stevenvelozo/meadow-endpoints) [![Dependency Status](https://david-dm.org/stevenvelozo/meadow-endpoints.svg)](https://david-dm.org/stevenvelozo/meadow-endpoints) [![devDependency Status](https://david-dm.org/stevenvelozo/meadow-endpoints/dev-status.svg)](https://david-dm.org/stevenvelozo/meadow-endpoints#info=devDependencies)
-
 This library generates REST endpoints in a consistent manner.  Endpoints have the following features:
 
 * Authentication
@@ -20,22 +18,12 @@ To best use this library, it should be in conjunction with [stricture](https://g
 ### Docker Development Environment
 
 1. Run this command to build this image:
-```
-docker build ./ -t retold/meadow-endpoints:local
-```
-
-alternatively you can use npm to run this
 
 ```
 npm run docker-dev-build-image
 ```
 
-2. Run this command to build the local container:
-```
-docker run -it --name meadow-endpoints-dev -p 127.0.0.1:12343:8080 -v "$PWD/.config:/home/coder/.config"  -v "$PWD:/home/coder/meadow-endpoints" -u "$(id -u):$(id -g)" -e "DOCKER_USER=$USER" retold/meadow-endpoints:local
-```
-
-alternatively you can use npm to run this
+2. Run this command to create and run the local container:
 
 ```
 npm run docker-dev-run
@@ -45,4 +33,50 @@ npm run docker-dev-run
 
 4. The password is "retold"
 
-5. Right now you (may) need to delete the `node_modules` folders and regenerate it for Linux.
+5. Right now you (may) need to delete the `node_modules` folders and regenerate it for Linux, depending on your OS.
+
+
+
+## Pattern Description to Expand
+
+```
+const libMeadowEndpointsControllerBase = require('meadow-endpoints').ControllerBase;
+
+class MySpecialLogController inherits libMeadowEndpointsControllerBase.LogControllerBase
+{
+	constructor(pMeadowEndpoints, pOptions)
+	{
+		super(pMeadowEndpoints, pOptions);
+	}
+
+	// Overload info to do something special
+	info(pLogText, ...pLogObjects)
+	{
+		super(pLogText, ...pLogObjects);
+		console.log('### THIS CONTROLLER DO MAGIC STUFF WITH'+pLogText);
+	}
+}
+
+class MyMeadowEndpointsController
+{
+	constructor(pMeadowEndpoints, pOptions)
+	{
+		super(pMeadowEndpoints, pOptions);
+
+		this._LogController = new mySpecialLogController(pMeadowEndpoints, pOptions);
+
+		this.initializeDefaultUnsetControllers(pMeadowEndpoints, pControllerOptions);
+	}
+}
+
+module.exports = MyMeadowEndpointsController;
+```
+
+```
+let libMySpecialController = require('TheCodeAbove.js');
+
+let tmpMeadow = new Meadow('INITIALIZE THE DAL');
+
+let tmpMeadowEndpoints = new MeadowEndpoints(tmpMeadow, { Controller: libMySpecialController });
+
+```

package/debug/Animal.json

@@ -0,0 +1,62 @@
+{
+	"Scope": "Animal",
+
+	"DefaultIdentifier": "IDAnimal",
+
+	"Schema": [
+		{ "Column": "IDAnimal",        "Type":"AutoIdentity" },
+		{ "Column": "GUIDAnimal",      "Type":"AutoGUID" },
+		{ "Column": "CreateDate",      "Type":"CreateDate" },
+		{ "Column": "CreatingIDUser",  "Type":"CreateIDUser" },
+		{ "Column": "UpdateDate",      "Type":"UpdateDate" },
+		{ "Column": "UpdatingIDUser",  "Type":"UpdateIDUser" },
+		{ "Column": "Deleted",         "Type":"Deleted" },
+		{ "Column": "DeletingIDUser",  "Type":"DeleteIDUser" },
+		{ "Column": "DeleteDate",      "Type":"DeleteDate" },
+		{ "Column": "Name",  "Type":"String" },
+		{ "Column": "Type",  "Type":"String" },
+        { "Column": "IDCustomer",  "Type":"Number" }
+	],
+
+	"DefaultObject": {
+		"IDAnimal": null,
+		"GUIDAnimal": "",
+
+		"CreateDate": false,
+		"CreatingIDUser": 0,
+		"UpdateDate": false,
+		"UpdatingIDUser": 0,
+		"Deleted": 0,
+		"DeleteDate": false,
+		"DeletingIDUser": 0,
+
+		"Name": "Unknown",
+		"Type": "Unclassified",
+        "IDCustomer": 0
+	},
+
+	"JsonSchema": {
+		"title": "Animal",
+		"description": "A creature that lives in a meadow.",
+		"type": "object",
+		"properties": {
+			"IDAnimal": {
+				"description": "The unique identifier for an animal",
+				"type": "integer"
+			},
+			"Name": {
+				"description": "The animal's name",
+				"type": "string"
+			},
+			"Type": {
+				"description": "The type of the animal",
+				"type": "string"
+			},
+            "IDCustomer": {
+				"description": "The customer ID of the record",
+				"type": "number"
+			}
+		},
+		"required": ["IDAnimal", "Name", "CreatingIDUser"]
+	}
+}

package/debug/Harness-Configuration.json

@@ -0,0 +1,31 @@
+{
+	"Product": "MeadowEndpointsHarness",
+	"ProductVersion": "1.0.0",
+
+	"UUID":
+		{
+			"DataCenter": 0,
+			"Worker": 0
+		},
+	"LogStreams":
+		[
+			{
+				"streamtype": "simpleflatfile",
+				"path": "./BookStore-Run.log"
+			}
+		],
+
+	"APIServerPort": 8086,
+
+	"UnauthorizedRequestDelay": 100,
+
+	"MySQL":
+		{
+			"Server": "127.0.0.1",
+			"Port": 3306,
+			"User": "root",
+			"Password": "123456789",
+			"Database": "FableTest",
+			"ConnectionPoolLimit": 20
+		}
+}

package/debug/Harness.js

@@ -6,112 +6,11 @@
 * @author      Steven Velozo <steven@velozo.com>
 */
 
-var libSuperTest = require('supertest');
-
-var libMySQL = require('mysql2');
-
-////////// Code can go here for easy debugging //////////
-var _HarnessBehavior = () =>
-{
-	var tmpRecords = [
-		{GUIDAnimal:'0xHAXXXX', Name:'Jason', Type:'Triceratops'},
-		{Name:'Rover',Type:'Car'},
-		{GUIDAnimal:'0xDavison', Type:'Frog'}
-	];
-	_MockSessionValidUser.UserRoleIndex = 2;
-	libSuperTest('http://localhost:8080/')
-	.put('1.0/FableTest/Upserts')
-	.send(tmpRecords)
-	.end(
-		function(pError, pResponse)
-		{
-			// Expect response to be the record we just created.
-			var tmpResult = JSON.parse(pResponse.text);
-			console.log(JSON.stringify(tmpResult,null,4));
-		}
-	);
-
-};
-
-var tmpFableSettings = 	(
-{
-	Product: 'MockOratorAlternate',
-	ProductVersion: '0.0.0',
-
-	"UnauthorizedRequestDelay": 1000,
-
-	APIServerPort: 8080,
-
-	MySQL:
-		{
-			// This is queued up for Travis defaults.
-			Server: "localhost",
-			Port: 3306,
-			User: "root",
-			Password: "",
-			Database: "FableTest",
-			ConnectionPoolLimit: 20
-		}
-});
-
-var libFable = require('fable').new(tmpFableSettings);
-tmpFableSettings = libFable.settings;
-
-var _MockSessionValidUser = (
+//const libImporter = require('../test_support/bookstore-import-books.js');
+//const libServer = require('../test_support/bookstore-serve-meadow-endpoint-apis.js'); 
+const libServer = require('../test_support/bookstore-serve-meadow-endpoint-apis-IPC.js'); 
+let _Orator = libServer(
+	()=>
 	{
-		SessionID: '0000-VALID',
-		UserID: 37,
-		UserRole: 'User',
-		UserRoleIndex: 1,
-		LoggedIn: true,
-		DeviceID: 'TEST-HARNESS'
-	});
-var ValidAuthentication = function(pRequest, pResponse, fNext)
-{
-	pRequest.UserSession = _MockSessionValidUser;
-	fNext();
-}
-
-var _Meadow;
-var _MeadowEndpoints;
-
-var _AnimalSchema = require('./test/Animal.json');
-
-// Now that we have some test data, wire up the endpoints!
-
-// Load up a Meadow (pointing at the Animal database)
-_Meadow = require('meadow')
-				.new(libFable, 'FableTest')
-				.setProvider('MySQL')
-				.setSchema(_AnimalSchema.Schema)
-				.setJsonSchema(_AnimalSchema.JsonSchema)
-				.setDefaultIdentifier(_AnimalSchema.DefaultIdentifier)
-				.setDefault(_AnimalSchema.DefaultObject)
-				.setAuthorizer(_AnimalSchema.Authorization);
-
-// Instantiate the endpoints
-_MeadowEndpoints = require('./source/Meadow-Endpoints.js').new(_Meadow);
-var _Orator = require('orator').new(tmpFableSettings);
-_Orator.enabledModules.CORS = true;
-_Orator.enabledModules.FullResponse = true;
-_Orator.enabledModules.Body = false;
-
-var _SQLConnectionPool = libMySQL.createPool
-(
-	{
-		connectionLimit: tmpFableSettings.MySQL.ConnectionPoolLimit,
-		host: tmpFableSettings.MySQL.Server,
-		port: tmpFableSettings.MySQL.Port,
-		user: tmpFableSettings.MySQL.User,
-		password: tmpFableSettings.MySQL.Password,
-		database: tmpFableSettings.MySQL.Database
-	}
-);
-
-// Start the web server
-// Wire up an "always logged in" user in the request chain, so session is set right.
-_Orator.webServer.use(ValidAuthentication);
-// Wire the endpoints up
-_MeadowEndpoints.connectRoutes(_Orator.webServer);
-
-_Orator.startWebServer(_HarnessBehavior);
+		console.log('Service is started!');
+	});

package/debug/KillHarness.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+# This script is to kill the Harness, which can be annoying to do from the
+# command line in the docker container when you are running remote
+# debugging *or* the visual studio code debugger has gotten into a wonky
+# state.
+
+# Kill every process with Harness.js in it that isn't piping through grep...
+
+kill $(ps aux | grep 'Harness.js' | grep -v 'grep' | awk '{print $2}')