Added browser and node local storage capabilities

.gitignore

@@ -59,3 +59,6 @@ typings/
 
 # next.js build output
 .next
+
+# Make build artifacts
+.build-tmp

.travis.yml

@@ -0,0 +1,13 @@
+language: minimal
+
+services:
+  - docker
+
+install:
+  - make
+
+before_install:
+  - make build
+
+script:
+  - make test

Dockerfile

@@ -0,0 +1,30 @@
+FROM node:12-slim
+
+# Install chrome for puppeteer tests
+# From https://github.com/GoogleChrome/puppeteer/blob/master/docs/troubleshooting.md#running-puppeteer-in-docker
+RUN wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | apt-key add - \
+    && sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list' \
+    && apt-get update \
+    && apt-get install -y google-chrome-unstable fonts-ipafont-gothic fonts-wqy-zenhei fonts-thai-tlwg fonts-kacst fonts-freefont-ttf procps\
+      --no-install-recommends \
+    && rm -rf /var/lib/apt/lists/* \
+    # Add user so we don't need --no-sandbox.
+    # same layer as npm install to keep re-chowned files from using up several hundred MBs more space
+    && groupadd -r test && useradd -r -g test -G audio,video test \
+    && mkdir -p /home/test/Downloads \
+    && chown -R test:test /home/test 
+
+
+WORKDIR /app
+COPY package.json /app
+COPY yarn.lock /app
+COPY webpack.config.js /app
+COPY jest-puppeteer.config.js /app
+RUN yarn install
+
+COPY src /app/src/
+COPY test /app/test/
+RUN chown -R test:test /app
+USER test
+
+ENTRYPOINT ["yarn", "test"]

Makefile

@@ -0,0 +1,22 @@
+test: .build-tmp/build-image src/* test/*
+	docker run --rm -it --cap-add=SYS_ADMIN -v ${PWD}/src:/app/src:ro -v ${PWD}/test:/app/test:ro rgpm:storageIntegrations-test
+
+build: .build-tmp/build-image src/* test/*
+
+install:
+	yarn install --frozen-lockfile
+
+.build-tmp/build-image: Dockerfile package.json yarn.lock webpack.config.js jest-puppeteer.config.js
+	docker build -t rgpm -t rgpm:storageIntegrations-test .
+	mkdir -p .build-tmp
+	@touch $@
+
+clean:
+	rm -rf .build-tmp
+
+clean-docker:
+	docker rmi rgpm:storageIntegrations-test
+
+clean-all: clean clean-docker
+
+.PHONY: build test install clean

README.md

@@ -1 +1,19 @@
-# storage-integrations
+# RGPM
+## Storage Integrations
+
+[![Build Status](https://travis-ci.com/rgpm/storage-integrations.svg?branch=master)](https://travis-ci.com/rgpm/storage-integrations)
+
+This repo is a supporting module for the [RGPM Core](github.com/rgpm/core). 
+
+
+### Current Supported Integrations
+Have you seen this repo? There are no source files!
+
+
+### Planned Integrations
+- Local Browser Storage
+- Google Drive
+- Microsoft OneDrive
+- Dropbox
+- GitHub
+- Keybase

jest-puppeteer.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+    server: {
+      command: 'yarn serve',
+      port: 4444
+    }
+  }

package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@rgpm/storage-integrations",
+  "version": "0.1.2",
+  "description": "Storage Integrations for RGPM Core",
+  "main": "index.js",
+  "repository": "git@github.com:rgpm/storage-integrations.git",
+  "author": "Owen Parkins <oparkins@gmail.com>",
+  "license": "LGPL-3.0-only",
+  "scripts": {
+    "serve": "node test/server.js",
+    "test": "jest"
+  },
+  "dependencies": {
+    "node-localstorage": "^1.3.1"
+  },
+  "devDependencies": {
+    "express": "^4.17.1",
+    "jest": "^24.9.0",
+    "jest-cli": "^24.9.0",
+    "jest-puppeteer": "^4.3.0",
+    "puppeteer": "^1.20.0",
+    "webpack": "^4.41.0",
+    "webpack-dev-middleware": "^3.7.1",
+    "webpack-node-externals": "^1.7.2"
+  },
+  "jest": {
+    "projects": [
+      {
+        "displayName": "RGPM Core Tests",
+        "testMatch": [
+          "**/test/*.test.js"
+        ],
+        "preset": "jest-puppeteer",
+        "globals": {
+          "PATH": "http://localhost:4444"
+        }
+      }
+    ]
+  }
+}

src/browserStorage.js

@@ -0,0 +1,74 @@
+"use strict"
+
+const NotImplementedError = require("./notImplementedError");
+const StorageIntegration = require("./storageIntegration");
+
+/**
+ * Uses localStorage in browsers to store information
+ */
+class BrowserStorage extends StorageIntegration {
+    constructor() {
+        super();
+        this.storage = window.localStorage;
+    }
+
+    /**
+     * Not needed.
+     */
+    authorize() {
+        return true;
+    }
+
+    /**
+     * Not needed.
+     */
+    unauthorize() {
+        return true;
+    }
+
+    /**
+     * Not needed.
+     */
+    createFile(name) {
+        return true;
+    }
+
+    /**
+     * Returns the value from the specified key
+     * @param name The name of key
+     * @returns {String} The value contents
+     */
+    readFile(name) {
+        return this.storage.getItem(name)
+    }   
+
+    /**
+     * Updates the contents of the file
+     * @param {String} name The name of the file
+     * @param {String} content The file contents
+     */
+    updateFile(name, content) {
+        this.storage.setItem(name, content)
+        return true;
+    }
+
+    /**
+     * Removes the file from storage
+     * @param {String} name The name of the file
+     */
+    deleteFile(name) {
+        this.storage.removeItem(name);
+        return true;
+    }
+
+    check() {
+        return true;
+    }
+
+    type() {
+        return "browserStorage";
+    }
+}
+
+module.exports = BrowserStorage;
+

src/nodeStorage.js

@@ -0,0 +1,75 @@
+"use strict"
+
+const NotImplementedError = require("./notImplementedError");
+const StorageIntegration = require("./storageIntegration");
+
+/**
+ * Uses a localStorage module to store information on the server (for node)
+ */
+class NodeStorage extends StorageIntegration {
+    constructor() {
+        super();
+        const LocalStorage = require('node-localstorage').LocalStorage;
+        this.storage = new LocalStorage('./rgpm.data');
+    }
+
+    /**
+     * Not needed.
+     */
+    authorize() {
+        return true;
+    }
+
+    /**
+     * Not needed.
+     */
+    unauthorize() {
+        return true;
+    }
+
+    /**
+     * Not needed.
+     */
+    createFile(name) {
+        return true;
+    }
+
+    /**
+     * Returns the value from the specified key
+     * @param name The name of key
+     * @returns {String} The value contents
+     */
+    readFile(name) {
+        return this.storage.getItem(name)
+    }   
+
+    /**
+     * Updates the contents of the file
+     * @param {String} name The name of the file
+     * @param {String} content The file contents
+     */
+    updateFile(name, content) {
+        this.storage.setItem(name, content)
+        return true;
+    }
+
+    /**
+     * Removes the file from storage
+     * @param {String} name The name of the file
+     */
+    deleteFile(name) {
+        this.storage.removeItem(name);
+        return true;
+    }
+
+    check() {
+        return true;
+    }
+
+    type() {
+        return "nodeStorage";
+    }
+}
+
+module.exports = NodeStorage;
+

src/notImplementedError.js

@@ -0,0 +1,11 @@
+"use strict"
+
+class NotImplementedError extends Error {
+    constructor(message) {
+        super();
+        this.name = "NotImplementedError";
+        this.message = message;
+    }
+}
+
+module.exports = NotImplementedError;

src/storageFactory.js

@@ -0,0 +1,35 @@
+"use strict"
+
+const NotImplementedError = require("./notImplementedError");
+
+
+class StorageFactory {
+    static getLocalStorage() {
+        /* Browser */
+        try {
+            /* Use crypto to reliability determine if browser or not*/
+            if (crypto.subtle !== undefined) {
+                const BrowserStorage = require("./browserStorage");
+                return new BrowserStorage();
+            }
+        } catch (e) { 
+            if (!(e instanceof NotImplementedError) && !(e instanceof ReferenceError)) {
+                throw e;
+            }
+        }
+
+        /* Node */
+        try {
+            require('crypto');
+            const NodeStorage = require("./nodeStorage");
+            return new NodeStorage();
+        } catch (e) {
+            if (!(e instanceof NotImplementedError)) {
+                throw e;
+            }
+        }
+        throw new NotImplementedError("Local Storage for NodeJS not ready");
+    }
+}
+
+module.exports = StorageFactory;

src/storageIntegration.js

@@ -0,0 +1,40 @@
+"use strict"
+
+const NotImplementedError = require("./notImplementedError");
+
+class StorageIntegration {
+    authorize() {
+        throw new NotImplementedError("StorageIntegration: authorize: not implemented");
+    }
+
+    unauthorize() {
+        throw new NotImplementedError("StorageIntegration: unauthorize: not implemented");
+    }
+
+    createFile() {
+        throw new NotImplementedError("StorageIntegration: createFile: not implemented");
+    }
+
+    readFile() {
+        throw new NotImplementedError("StorageIntegration: readFile: not implemented");
+    }   
+
+    updateFile() {
+        throw new NotImplementedError("StorageIntegration: updateFile: not implemented");
+    }
+
+    deleteFile() {
+        throw new NotImplementedError("StorageIntegration: deleteFile: not implemented");
+    }
+
+    check() {
+        throw new NotImplementedError("StorageIntegration: check: not implemented");
+    }
+
+    type() {
+        throw new NotImplementedError("StorageIntegration: check: not implemented");
+    }
+}
+
+module.exports = StorageIntegration;
+

test/browserStorage.test.js

@@ -0,0 +1,8 @@
+describe("BrowserStorage", () => {
+    it("should be a class", () => {
+        const BrowserStorage = require("../src/browserStorage");
+        expect(typeof BrowserStorage).toBe("function");
+        // Classes are not callable; functions are
+        expect(BrowserStorage).toThrow(TypeError);
+    });
+});