Bumped patch version

I've also included a migration file in the tools directory

.github/FUNDING.yml

@@ -0,0 +1,5 @@
+# These are supported funding model platforms
+
+patreon: krgamestudios
+ko_fi: krgamestudios
+custom: ["https://www.paypal.com/donate/?hosted_button_id=73Q82T2ZHV8AA"]

.github/workflows/docker.yml

@@ -26,7 +26,7 @@ jobs:
           docker_image: krgamestudios/news-server
 
       - name: Login to DockerHub
-        uses: docker/login-action@v1 
+        uses: docker/login-action@v1
         with:
           username: ${{ secrets.DOCKER_USERNAME }}
           password: ${{ secrets.DOCKER_PASSWORD }}

Dockerfile

@@ -1,9 +1,9 @@
 
-FROM node:15
+FROM node:16
 WORKDIR "/app"
 COPY package*.json ./
-COPY . /app
 RUN npm install --production
+COPY . /app
 EXPOSE 3100
 USER node
 ENTRYPOINT ["bash", "-c"]

README.md

@@ -2,18 +2,20 @@
 
 An API centric news server. Uses Sequelize and mariaDB by default.
 
+This server is available via docker hub at krgamestudios/news-server.
+
 # Setup
 
 There are multiple ways to run this app - it can run on it's own via `npm start` (for production) or `npm run dev` (for development). it can also run inside docker using `docker-compose up --build` - run `node configure-script.js` to generate docker-compose.yml and startup.sql.
 
-To generate an authorization token, use [auth-server](https://github.com/krgamestudios/auth-server). A public-facing development auth-server is available here (tokens are 10 minutes):
+To generate an authorization token, use [auth-server](https://github.com/krgamestudios/auth-server). A public-facing development auth-server is available here (tokens are valid for 10 minutes):
 
 ```
-POST https://dev-auth.eggtrainer.com/auth/login HTTP/1.1
+POST https://dev-auth.krgamestudios.com/auth/login HTTP/1.1
 Content-Type: application/json
 
 {
-	"email": "kayneruse@gmail.com",
+	"email": "example@example.com",
 	"password": "helloworld"
 }
 ```
@@ -25,19 +27,28 @@ Content-Type: application/json
 //NOTE: you can add a "limit" query parameter to change the default limit
 GET /news?limit=10
 
-//get latest news, up to a default limit, or specify the index "id"
+
+###
+
+
+//DOCS: get latest news, up to a default limit, or specify the index "id"
 GET /news/:id
 
-//get the news starting from the beginning, up to a default limit, or specify the index "id"
+
+###
+
+
+//DOCS: get the news starting from the beginning, up to a default limit, or specify the index "id"
 GET /news/archive/:id
 
-//result (if only a single article is specified, returns just that article rather than an array):
+//DOCS: result (if only a single article is specified, returns just that article rather than an array):
 [
 	{
 		"index": index,			//absolute index of the result
 		"title": title,			//title of the article
 		"author": author,		//author of the aricle
 		"body": body,			//body of the article
+		"rendered": rendered	//body rendered as HTML
 		"edits": edits			//number of times this article has been edited
 		"createdAt": createdAt	//time created
 		"updatedAt": updatedAt	//time updated
@@ -45,13 +56,21 @@ GET /news/archive/:id
 	...
 ]
 
-//get the latest metadata, up to a default limit, or specify the index "id"
+
+###
+
+
+//DOCS: get the latest metadata, up to a default limit, or specify the index "id"
 GET /news/metadata/:id
 
-//get the metadata starting from the beginning, up to a default limit, or specify the index "id"
+
+###
+
+
+//DOCS: get the metadata starting from the beginning, up to a default limit, or specify the index "id"
 GET /news/archive/metadata/:id
 
-//result (if only a single article is specified, returns just that article rather than an array):
+//DOCS: result (if only a single article is specified, returns just that article rather than an array):
 [
 	{
 		"index": index,			//absolute index of the result
@@ -64,38 +83,51 @@ GET /news/archive/metadata/:id
 	...
 ]
 
-//send a formatted JSON object, returns new index on success, or error on failure
+
+###
+
+
+//DOCS: send a formatted JSON object, returns new index on success, or error on failure
 POST /news
 Authorization: Bearer XXX
 
-//arguments:
 {
 	"title": title		//title of the article
 	"author": author	//author of the article
 	"body": body		//body of the article
 }
 
-//result (status 200 on success, otherwise an error status):
+//DOCS: result (status 200 on success, otherwise an error status):
 {
 	"index": index		//new index of the article
 }
 
-//similar to `POST /news`, but allows overwriting an existing article
+
+###
+
+
+//DOCS: similar to `POST /news`, but allows overwriting an existing article
 PATCH /news/:id
 Authorization: Bearer XXX
 
-//arguments:
 {
 	"title": title		//title of the article, optional
 	"author": author	//author of the article, optional
 	"body": body		//body of the article, optional
 }
 
-result: status 200 on success, otherwise an error status
+//DOCS: result: status 200 on success, otherwise an error status
 
-//remove an article from the news feed
+
+###
+
+
+//DOCS: remove an article from the news feed
 DELETE /news/:id
 Authorization: Bearer XXX
 
-//result: status 200 on success, otherwise an error status
+//DOCS: result: status 200 on success, otherwise an error status
+
+
+###
 ```

configure-script.js

@@ -33,7 +33,7 @@ const question = (prompt, def = null) => {
 	const appPort = await question('App Port', '3100');
 
 	const appDBUser = await question('DB User', appName);
-	const appDBPass = await question('DB Pass', uuid());
+	const appDBPass = await question('DB Pass', 'venusaur');
 	const dbRootPass = await question('DB Root Pass');
 
 	const appSecretAccess = await question('Access Token Secret', uuid(32));
@@ -109,7 +109,7 @@ networks:
 `;
 
 	const dockerfile = `
-FROM node:15
+FROM node:16
 WORKDIR "/app"
 COPY package*.json ./
 RUN npm install --production

package.json

@@ -1,6 +1,6 @@
 {
   "name": "news-server",
-  "version": "1.2.2",
+  "version": "1.4.5",
   "description": "An API centric news server. Uses Sequelize and mariaDB by default.",
   "main": "server/server.js",
   "scripts": {
@@ -24,6 +24,7 @@
     "express": "^4.17.1",
     "jsonwebtoken": "^8.5.1",
     "mariadb": "^2.5.4",
+    "markdown-it": "^12.3.0",
     "sequelize": "^6.6.5"
   },
   "devDependencies": {

server/database/models/articles.js

@@ -25,6 +25,11 @@ const articles = sequelize.define('articles', {
 		defaultValue: ''
 	},
 
+	rendered: {
+		type: Sequelize.TEXT,
+		defaultValue: ''
+	},
+
 	edits: {
 		type: Sequelize.INTEGER(11),
 		defaultValue: 0

server/database/models/revisions.js

@@ -1,9 +1,15 @@
 const Sequelize = require('sequelize');
 const sequelize = require('..');
 
-const articles = require('./articles');
-
 const revisions = sequelize.define('revisions', {
+	index: {
+		type: Sequelize.INTEGER(11),
+		allowNull: false,
+		autoIncrement: true,
+		primaryKey: true,
+		unique: true
+	},
+
 	title: {
 		type: Sequelize.TEXT,
 		defaultValue: ''
@@ -17,12 +23,20 @@ const revisions = sequelize.define('revisions', {
 	body: {
 		type: Sequelize.TEXT,
 		defaultValue: ''
+	},
+
+	rendered: {
+		type: Sequelize.TEXT,
+		defaultValue: ''
+	},
+
+	originalIndex: {
+		type: Sequelize.INTEGER(11),
+		default: null
 	}
 });
 
 //relationships
-articles.hasOne(revisions, { as: 'original' });
-
 sequelize.sync();
 
 module.exports = revisions;

server/news/edit.js

@@ -1,5 +1,6 @@
 const { Op } = require('sequelize');
 const { articles, revisions } = require('../database/models');
+const markdownIt = require('markdown-it')({ html: true });
 
 const route = async (req, res) => {
 	//get the existing record
@@ -20,6 +21,7 @@ const route = async (req, res) => {
 		title: record.title,
 		author: record.author,
 		body: record.body,
+		rendered: record.rendered,
 		originalIndex: record.index
 	});
 
@@ -28,6 +30,7 @@ const route = async (req, res) => {
 		title: req.body.title || record.title,
 		author: req.body.author || record.author,
 		body: req.body.body || record.body,
+		rendered: markdownIt.render(req.body.body) || record.rendered,
 		edits: record.edits + 1
 	}, {
 		where: {

server/news/index.js

@@ -23,7 +23,7 @@ router.get('/archive/metadata/:id(\\d+)', query(true, true));
 //use middleware to authenticate the rest of the routes
 router.use(authToken);
 router.use((req, res, next) => {
-	if (req.user.admin) {
+	if (req.user.mod) {
 		next();
 	} else {
 		res.status(403).end();

server/news/publish.js

@@ -1,4 +1,5 @@
 const { articles } = require('../database/models');
+const markdownIt = require('markdown-it')({ html: true });
 
 const route = async (req, res) => {
 	//check for missing data
@@ -18,7 +19,8 @@ const route = async (req, res) => {
 	const [instance, created] = await articles.upsert({
 		title: req.body.title,
 		author: req.body.author,
-		body: req.body.body
+		body: req.body.body,
+		rendered: markdownIt.render(req.body.body),
 	});
 
 	if (!created) {

server/news/query.js

@@ -7,7 +7,7 @@ const query = (ascending, metadataOnly) => async (req, res) => {
 	if (req.params.id && typeof(parseInt(req.params.id)) === 'number') {
 		const result = await articles.findOne({
 			attributes: [
-				'index', 'title', 'author', 'edits', 'createdAt', 'updatedAt', ...(!metadataOnly ? ['body'] : [])
+				'index', 'title', 'author', 'edits', 'createdAt', 'updatedAt', ...(!metadataOnly ? ['body', 'rendered'] : [])
 			],
 			where: {
 				index: {
@@ -24,7 +24,7 @@ const query = (ascending, metadataOnly) => async (req, res) => {
 	else {
 		const result = await articles.findAndCountAll({
 			attributes: [
-				'index', 'title', 'author', 'edits', 'createdAt', 'updatedAt', ...(!metadataOnly ? ['body'] : [])
+				'index', 'title', 'author', 'edits', 'createdAt', 'updatedAt', ...(!metadataOnly ? ['body', 'rendered'] : [])
 			],
 			order: [
 				['index', ascending ? 'ASC' : 'DESC']

server/news/remove.js

@@ -20,6 +20,7 @@ const route = async (req, res) => {
 		title: record.title,
 		author: record.author,
 		body: record.body,
+		rendered: record.rendered,
 		originalIndex: record.index
 	});
 

server/server.js

@@ -26,4 +26,48 @@ app.get('*', (req, res) => {
 server.listen(process.env.WEB_PORT || 3100, async (err) => {
 	await database.sync();
 	console.log(`listening to localhost:${process.env.WEB_PORT || 3100}`);
+
+	//COMPATABILITY: parse the unrendered data from the database
+	const markdownIt = require('markdown-it')();
+	const { articles, revisions } = require('./database/models');
+
+	const missingArticles = await articles.findAll({
+		where: {
+			rendered: ''
+		}
+	});
+
+	const missingRevisions = await revisions.findAll({
+		where: {
+			rendered: ''
+		}
+	});
+
+	await Promise.all(
+		missingArticles.map(async ma => {
+			ma.update({
+				rendered: markdownIt.render(ma.body)
+			}, {
+				where: {
+					index: ma.index
+				}
+			});
+		})
+	)
+		.then(result => {if (result.length > 0) console.log('Rendered articles in HTML'); })
+	;
+
+	await Promise.all(
+		missingRevisions.map(async mr => {
+			mr.update({
+				rendered: markdownIt.render(mr.body)
+			}, {
+				where: {
+					index: mr.index
+				}
+			});
+		})
+	)
+	.then(result => {if (result.length > 0) console.log('Rendered revisions in HTML'); })
+	;
 });

test/dev-news-requests.rest

@@ -1,23 +1,34 @@
 #Query
-GET https://dev-news.eggtrainer.com/news HTTP/1.1
+GET https://dev-news.krgamestudios.com/news HTTP/1.1
+
+###
+
+#Login
+POST https://dev-auth.krgamestudios.com/auth/login HTTP/1.1
+Content-Type: application/json
+
+{
+	"email": "example@example.com",
+	"password": "helloworld"
+}
 
 ###
 
 #Publish
-POST https://dev-news.eggtrainer.com/news HTTP/1.1
+POST https://dev-news.krgamestudios.com/news HTTP/1.1
 Content-Type: application/json
 Authorization: Bearer
 
 {
 	"title": "Hello World",
-	"author": "Kayne Ruse",
+	"author": "Anonymous",
 	"body": "Lorem ipsum."
 }
 
 ###
 
 #Edit
-PATCH https://dev-news.eggtrainer.com/news/1 HTTP/1.1
+PATCH https://dev-news.krgamestudios.com/news/1 HTTP/1.1
 Content-Type: application/json
 Authorization: Bearer
 
@@ -28,6 +39,6 @@ Authorization: Bearer
 ###
 
 #Delete
-DELETE https://dev-news.eggtrainer.com/news/1 HTTP/1.1
+DELETE https://dev-news.krgamestudios.com/news/1 HTTP/1.1
 Content-Type: application/json
 Authorization: Bearer

test/localhost-requests.rest

@@ -0,0 +1,44 @@
+#Query
+GET http://localhost:3100/news HTTP/1.1
+
+###
+
+#Login
+POST https://dev-auth.krgamestudios.com/auth/login HTTP/1.1
+Content-Type: application/json
+
+{
+	"email": "example@example.com",
+	"password": "helloworld"
+}
+
+###
+
+#Publish
+POST http://localhost:3100/news HTTP/1.1
+Content-Type: application/json
+Authorization: Bearer
+
+{
+	"title": "Hello World",
+	"author": "Anonymous",
+	"body": "Lorem ipsum."
+}
+
+###
+
+#Edit
+PATCH http://localhost:3100/news/1 HTTP/1.1
+Content-Type: application/json
+Authorization: Bearer
+
+{
+	"title": "Goodnight World"
+}
+
+###
+
+#Delete
+DELETE http://localhost:3100/news/1 HTTP/1.1
+Content-Type: application/json
+Authorization: Bearer

test/requests.rest

@@ -1,54 +0,0 @@
-#Login to the auth-server
-POST http://127.0.0.1:3200/auth/login HTTP/1.1
-Content-Type: application/json
-
-{
-	"email": "kayneruse@gmail.com",
-	"password": "helloworld"
-}
-
-###
-
-#Refresh from the auth-server
-POST http://127.0.0.1:3200/auth/token HTTP/1.1
-Content-Type: application/json
-
-{
-	"token": ""
-}
-
-###
-
-#Query
-GET http://127.0.0.1:3100/news HTTP/1.1
-
-###
-
-#Publish
-POST http://127.0.0.1:3100/news HTTP/1.1
-Content-Type: application/json
-Authorization: Bearer
-
-{
-	"title": "Hello World",
-	"author": "Kayne Ruse",
-	"body": "Lorem ipsum dolor sit amet..."
-}
-
-###
-
-#Edit
-PATCH http://127.0.0.1:3100/news/5 HTTP/1.1
-Content-Type: application/json
-Authorization: Bearer
-
-{
-	"title": "Goodnight World"
-}
-
-###
-
-#Delete
-DELETE http://127.0.0.1:3100/news/4 HTTP/1.1
-Content-Type: application/json
-Authorization: Bearer

tools/debug-startup.sql

@@ -0,0 +1,4 @@
+#use this while debugging
+CREATE DATABASE IF NOT EXISTS news;
+CREATE USER IF NOT EXISTS 'news'@'%' IDENTIFIED BY 'venusaur';
+GRANT ALL PRIVILEGES ON news.* TO 'news'@'%';

tools/migrations/version-1.3.0.sql

@@ -0,0 +1,6 @@
+use news;
+ALTER TABLE revisions CHANGE COLUMN id `index` INTEGER(11) UNIQUE NOT NULL AUTO_INCREMENT;
+
+ALTER TABLE revisions DROP FOREIGN KEY revisions_ibfk_1;
+
+ALTER TABLE revisions CHANGE COLUMN originalIndex originalIndex INTEGER(11);

tools/migrations/version-1.4.0.sql

@@ -0,0 +1,4 @@
+ALTER TABLE articles ADD COLUMN rendered TEXT DEFAULT "" AFTER body;
+
+ALTER TABLE revisions ADD COLUMN rendered TEXT DEFAULT "" AFTER body;
+