ldn-inbox-server 1.0.0

package/README.md

@@ -0,0 +1,49 @@
+# ldn-inbox-server
+
+An experimental LDN inbox server for [Event Notification](https://www.eventnotifications.net) messages.
+
+## Install
+
+```
+yarn add ldn-inbox-server
+```
+
+## Example
+
+Create required directories
+
+```
+mkdir config inbox public
+```
+
+Copy an example JSON Schema as `config/offer_schema.json` from this project.
+
+Start the server:
+
+```
+npx ldn-inbox-server start-server --port 8000
+```
+
+Send a demonstration Event Notifications message:
+
+```
+curl -X POST -H 'Content-Type: application/ld+json' --data-binary '@examples/offer.jsonld' http://localhost:8000/inbox/
+```
+
+Start an inbox handler: 
+
+```
+npx ldn-inbox-server handle-inbox ./handler/demo.js
+```
+
+where `./handler/demo.js` contains a `handleInbox` function to process the inbox/
+
+Example handler:
+
+```
+async function handleInbox(path,options) {
+    console.log(path);
+}
+
+module.exports = { handleInbox };
+```

package/bin/inbox-server.js

@@ -0,0 +1,36 @@
+#!/usr/bin/env node
+
+const { program } = require('commander');
+const { inbox_server, handle_inbox } = require('../index.js');
+
+const HOST = 'localhost'
+const PORT = 8000;
+const PUBLIC_PATH = './public';
+const INBOX_PATH = './inbox';
+const JSON_SCHEMA_PATH = './config/offer_schema.json';
+
+program
+  .name('lnd-inbox-server')
+  .version('1.0.0')
+  .description('A demonstration Event Notifications Inbox server');
+
+program
+  .command('start-server')
+  .option('--host <host>','host',HOST)
+  .option('--port <port>','port',PORT)
+  .option('--inbox <inbox>','inbox',INBOX_PATH)
+  .option('--public <public>','public',PUBLIC_PATH)
+  .option('--schema <schema>','json schema',JSON_SCHEMA_PATH)
+  .action( (options) => {
+    inbox_server(options);
+  });
+
+program
+  .command('handle-inbox')
+  .option('--inbox <inbox>','inbox',INBOX_PATH)
+  .argument('<handler>','handler of inbox')
+  .action( async(handler,options) => {
+    await handle_inbox(options['inbox'],handler,options);
+  });
+
+program.parse();

package/config/offer_schema.json

@@ -0,0 +1,40 @@
+{
+    "id": "/EventNotificationsOffer",
+    "type": "object",
+    "properties": {
+      "id": {"type": "string"},
+      "type": {"type": "string"},
+      "actor": {
+        "type": "object",
+        "properties": {
+            "id": {"type": "string"},
+            "type": {"type": "string"},
+            "inbox": {"type": "string"} 
+        },
+        "required": [ "id", "inbox" ]
+      },
+      "object": {
+        "type": "object",
+        "properties": {
+            "id": {"type": "string"}
+        },
+        "oneOf": [
+            {
+                "properties" : {
+                    "type": {"type": "string"}
+                }
+            },
+            {
+                "properties" : {
+                    "type": {
+                        "type": "array",
+                        "items": {"type": "string"}
+                    }
+                }
+            }
+        ],
+        "required": [ "id" ]
+      } 
+    },
+    "required": ["id", "type", "actor", "object"]
+}

package/examples/offer.jsonld

@@ -0,0 +1,17 @@
+{ 
+    "@context": [ 
+      "https://www.w3.org/ns/activitystreams" ,
+      {"schema": "https://schema.org/"}
+    ], 
+    "id": "urn:uuid:6E5FAF88-A7F1-47A4-B087-77345EBFF495",
+    "type": "Offer",
+    "actor": {
+       "id": "https://acme.org/profile/card#us",
+       "inbox": "https://acme.org/inbox/",
+       "type": "Organization"
+    },
+    "object": {
+       "id": "http://acme.org/artifacts/alice/data-set-2022-01-19.zip",
+       "type": [ "Document" , "schema:Dataset" ]
+    }
+ }

package/handler/demo.js

@@ -0,0 +1,22 @@
+const fs = require('fs');
+
+async function handleInbox(path,options) {
+    fs.readdir(path, (err,files) => {
+        files.forEach( (file) => {
+            const fullPath = `${path}/${file}`;
+            if (file.match("^\\..*$")) {
+                // Ignore
+            }
+            else if (file.match("^.*\\.jsond$")) {
+                // Process
+                console.log(`Deleting ${fullPath}...`);
+                fs.unlinkSync(fullPath);
+            }
+            else {
+                fs.unlinkSync(fullPath);
+            }
+        });
+    });
+}
+
+module.exports = { handleInbox };

package/index.js

@@ -0,0 +1,102 @@
+const { start_server } = require('mellon-server');
+const Validator = require('jsonschema').Validator;
+const fs = require('fs');
+const md5 = require('md5');
+
+let INBOX_PATH = './inbox';
+let JSON_SCHEMA = '';
+
+function inbox_server(options) {
+    INBOX = options['inbox'];
+    JSON_SCHEMA = JSON.parse(fs.readFileSync(options['schema'], { encoding: 'utf-8'}));
+    start_server({
+        host: options['host'],
+        port: options['port'],
+        public: options['public'],
+        registry: [
+          { path : 'inbox/.*' , do: doInbox }
+        ]
+    });
+}
+
+async function handle_inbox(path,handler,options) {
+    delete require.cache[handler];
+    const func = require(handler).handleInbox;
+    await func(path,options);
+}
+
+function doInbox(req,res) {
+    if (req.method !== 'POST') {
+        res.writeHead(403);
+        res.end('Forbidden');
+        return;
+    }
+
+    const headers = req.headers;
+
+    if (headers && (
+        headers['content-type'] === 'application/ld+json' ||
+        headers['content-type'] === 'application/json'
+        )
+    ) {
+        // We are ok
+    }
+    else {
+        res.writeHead(400);
+        res.end(`Need a Content-Type 'application/ld+json'`);
+        return;
+    }
+
+    let postData = ''
+    req.on('data', (data) => {
+        postData += data;
+    });
+    req.on('end',() => {
+        if (checkBody(postData)) {
+            const id = storeBody(postData);
+            res.setHeader('Location',`${req.url}${id}`);
+            res.writeHead(201);
+            res.end(`Accepted ${req.url}${id}`);
+        }
+        else {
+            res.writeHead(400);
+            res.end(`Looks like a weird POST to me...`);
+        }
+    });
+}
+
+function storeBody(data) {
+    try {
+        const id = md5(data);
+        const newpath = `${INBOX_PATH}/${id}.jsonld`;
+
+        if (! fs.existsSync(newpath)) {
+            fs.writeFileSync(newpath,data);
+        }
+
+        return `${id}.jsonld`;
+    }
+    catch (e) {
+        return null;
+    }
+}
+
+function checkBody(data) {
+    try {
+        const json = JSON.parse(data);
+        const v = new Validator();
+        const res = v.validate(json,JSON_SCHEMA);
+
+        if (res.errors.length == 0) {
+            return true;
+        }
+        else {
+            return false;
+        }
+    }
+    catch (e) {
+        return false;
+    }
+}
+
+module.exports = { inbox_server , handle_inbox };

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "ldn-inbox-server",
+  "version": "1.0.0",
+  "description": "A demonstration Event Notifications Inbox server",
+  "main": "index.js",
+  "author": "Patrick Hochstenbach <Patrick.Hochstenbach@UGent.be>",
+  "repository": "https://github.com/MellonScholarlyCommunication/ldn-inbox-server",
+  "scripts": {
+    "server": "node bin/inbox-server.js start-server",
+    "demo-post": "curl -X POST -H 'Content-Type: application/ld+json' --data-binary '@examples/offer.jsonld' http://localhost:8000/inbox/",
+    "demo-orch": "npx orch --info --keep --in inbox --out outbox rules/demo.n3",
+    "demo-pol": "npx pol --info --keep --in outbox"
+  },
+  "bin": "./bin/inbox-server.js",
+  "keywords": [
+    "ldn",
+    "event notifications"
+  ],
+  "license": "MIT",
+  "dependencies": {
+    "commander": "^12.0.0",
+    "jsonschema": "^1.4.1",
+    "md5": "^2.3.0",
+    "mellon-server": "^1.0.2",
+    "uuid": "^9.0.1"
+  }
+}

package/public/index.html

@@ -0,0 +1,52 @@
+<html>
+    <head>
+        <link
+        rel="stylesheet"
+        href="https://cdn.jsdelivr.net/npm/@picocss/pico@2/css/pico.min.css"
+        />
+        <title>LDN Inbox Server</title>
+    </head>
+    <body>
+        <main class="container">
+            <h1>LDN Inbox Server</h1>
+
+            <h2>API</h2>
+
+            <h3>/inbox/</h3>
+
+            <article>
+                An <a href="https://www.eventnotifications.net">Event Notifications</a>
+                LDN Inbox accepting Event Notification Offers.
+
+                <p>
+                    <h4>Example</h4>
+                    <pre>
+curl -X POST -H 'Content-Type: application/ld+json' --data-binary '@examples/offer.jsonld' http://localhost:8000/inbox/
+                    </pre>
+
+                    where <tt>offer.jsonld</tt>:
+
+                    <pre>
+{ 
+    "@context": [ 
+        "https://www.w3.org/ns/activitystreams" ,
+        {"schema": "https://schema.org/"}
+    ], 
+    "id": "urn:uuid:6E5FAF88-A7F1-47A4-B087-77345EBFF495",
+    "type": "Offer",
+    "actor": {
+        "id": "https://acme.org/profile/card#us",
+        "inbox": "https://acme.org/inbox/",
+        "type": "Organization"
+    },
+    "object": {
+        "id": "http://acme.org/artifacts/alice/data-set-2022-01-19.zip",
+        "type": [ "Document" , "schema:Dataset" ]
+    }
+}
+                    </pre>
+                </p>
+            </article>
+          </main>
+    </body>
+</html>