Merge pull request #13 from ph0bos/entitlements-functionality

Implement entitlements controller
ph0bos · Nov 8, 2015 · 082f1da · 082f1da
2 parents 9cda29f + f028999
commit 082f1da
Show file tree

Hide file tree

Showing 4 changed files with 91 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -75,7 +75,7 @@ default:
 
 ```
 
-In the above example the application would be accessible at the following address: `http://0.0.0.0:8000/starter/v1`, with the `/actuator/info` and `/actuator/health` diagmostic endpoints activated.
+In the above example the application would be accessible at the following address: `http://0.0.0.0:8000/starter/v1`, with the `/actuator/info` and `/actuator/health` diagnostic endpoints activated.
 
 ## API
 
@@ -89,4 +89,4 @@ app.use(micro([options]));
 - `discoverable`: `boolean` Register the service with Zookeeper to allow for discovery by other services connecting to the same instance of Zookeeper.
 - `controllersPath`: `String` Path to load controllers. Defaults to `controllers`.
 - `monitorsPath`: `String` Path to load monitors. Defaults to `monitors`.
-- 'partialResponseQuery': `String` The query parameter to use for partial reponse. Defaults to `fields`.
+- `partialResponseQuery`: `String` The query parameter to use for partial reponse. Defaults to `fields`.
diff --git a/controllers/entitlements.js b/controllers/entitlements.js
@@ -0,0 +1,25 @@
+'use strict';
+
+/*
+ * Dependencies
+ */
+var optional     = require('optional');
+var entitlements = optional(process.cwd() + '/config/entitlements.json');
+
+/**
+ * Initialize Entitlements endpoints
+ *
+ * @param app
+ */
+module.exports = function (router) {
+
+  /*
+   * Entitlements Endpoint
+   */
+  router.get('/', function (req, res, next) {
+    if (!entitlements) return res.status(501).send();
+
+    res.cacheControl({ maxAge: 3600 });
+    res.json(entitlements);
+  });
+};
diff --git a/example/config/entitlements.json b/example/config/entitlements.json
@@ -0,0 +1,62 @@
+{
+  "schema": "http://json-schema.org/draft-04/schema#",
+  "id": "/",
+  "type": "object",
+  "properties": {
+    "embargo": {
+      "id": "embargo",
+      "type": "boolean"
+    },
+    "competition": {
+      "id": "competition",
+      "type": "array",
+      "items": {
+        "id": "0",
+        "type": "object",
+        "properties": {
+          "id": {
+            "id": "id",
+            "type": "string",
+            "enum": [
+              "123"
+            ]
+          },
+          "name": {
+            "id": "name",
+            "type": "string",
+            "enum": [
+              "Sports"
+            ]
+          }
+        },
+        "additionalProperties": false
+      }
+    },
+    "channels": {
+      "id": "channels",
+      "type": "array",
+      "items": {
+        "id": "0",
+        "type": "object",
+        "properties": {
+          "id": {
+            "id": "id",
+            "type": "string",
+            "enum": [
+              "12344"
+            ]
+          },
+          "name": {
+            "id": "name",
+            "type": "string",
+            "enum": [
+              "Test"
+            ]
+          }
+        },
+        "additionalProperties": false
+      }
+    }
+  },
+  "additionalProperties": false
+}
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "express-microservice-starter",
-  "version": "0.5.8",
+  "version": "0.5.9",
   "description": "An express-based Node.js API bootstrapping module for microservices.",
   "main": "index.js",
   "scripts": {
@@ -36,6 +36,7 @@
     "express-partial-response": "^0.3.4",
     "ip": "^0.3.2",
     "konfig": "^0.2.1",
+    "optional": "^0.1.3",
     "vitalsigns": "^0.4.3",
     "zoologist": "^0.4.5"
   }