Prototype rules engine back end

.gitignore

@@ -0,0 +1,3 @@
+__pycache__
+node_modules
+*.pyc

README.md

@@ -1,5 +1,19 @@
 # opm-faces
 
+## Report
+Our final report and recommendations may be found on [18F's Google Drive](https://drive.google.com/open?id=0B8u6AetkKiTUM0RIVEZZbkI2WTQ).
+
+## Magic Rules!
+As part of our engagement, we created a very basic prototype business rules calculator to demonstrate
+a few of the concepts and patterns that were included in our recommendations:
+ - Store rules as data, not as code
+ - Choose a single, consolidated place for calculations to be executed
+ - Loosen up coupling between the calculation engine and any front end components to allow for component switch out
+
+To run Magic Rules, just clone this repository to your local machine navigate to `/magic_rules` and execute
+`magic.py`. The various data types ("prototypes", "calculations", and "rules") are written to `/magic_rules/datastore`
+when created via the web interface. Magic Rules also has a simple read/write API that is documented in `/api/`.
+
 ## Contributing
 
 See [CONTRIBUTING](CONTRIBUTING.md) for additional information.

magic_rules/api/api.md

@@ -0,0 +1,69 @@
+## /api
+### Request structure
+Method(s): GET
+
+*No payload or parameters required.*
+
+### Call
+```
+curl -X GET http://127.0.0.1:5000/api
+```
+### Response
+```
+{
+  "endpoints": [
+    {
+      "actions": [
+        {
+          "method": "GET",
+          "route": "./read"
+        },
+        {
+          "method": "POST",
+          "route": "./write"
+        }
+      ],
+      "route": "/prototypes"
+    },
+    {
+      "actions": [
+        {
+          "method": "GET",
+          "route": "./read"
+        },
+        {
+          "method": "POST",
+          "route": "./write"
+        }
+      ],
+      "route": "/calculations"
+    },
+    {
+      "actions": [
+        {
+          "method": "GET",
+          "route": "./read"
+        },
+        {
+          "method": "POST",
+          "route": "./write"
+        }
+      ],
+      "route": "/rules"
+    },
+    {
+      "actions": [
+        {
+          "method": "GET",
+          "route": "./read"
+        },
+        {
+          "method": "POST",
+          "route": "./write"
+        }
+      ],
+      "route": "/data"
+    }
+  ]
+}
+```

magic_rules/api/sections/calculations.md

@@ -0,0 +1,58 @@
+## /api/calculations/read
+### Request structure
+Method(s): GET
+*No payload or parameters required.*
+### Call
+```
+curl -X GET http://127.0.0.1:5000/api/calculations/read
+```
+### Response
+```
+{
+  "double_height": {
+    "data": "2*__height__",
+    "name": "double_height",
+    "type": "calc"
+  }
+}
+```
+## /api/calculations/write
+### Request structure
+Method(s): POST
+```
+    {
+        "object": "",
+        "name": "",
+        "contingent": "",
+        "static_value_0": "",
+        "attribute_value_0": "",
+        "operator_value_0": "",
+        "static_value_1": "",
+        "attribute_value_1": "",
+        "operator_value_1": "",
+        "static_value_2": "",
+        "attribute_value_2": "",
+        "operator_value_2": "",
+        "attribute_value_3": "",
+        "static_value_3": "",
+        "operator_value_3": "",
+        "static_value_4": "",
+        "attribute_value_4": "",
+        "operator_value_4": "",
+        "static_value_5": "",
+        "attribute_value_5": "",
+        ...
+    }
+```
+### Call
+```
+curl -H "Content-Type: application/json" -X POST -d '{"name":"double_height", "object":"animal", "contingent": "TRUE", "static_value_0":"2", "attribute_value_0":"", "operator_value_0":"*","static_value_1":"", "attribute_value_1":"__height__"}' http://127.0.0.1:5000/api/calculations/write
+```
+### Response
+```
+{
+  "data": "2*__height__",
+  "name": "double_height",
+  "type": "calc"
+}
+```

magic_rules/api/sections/data.md

@@ -0,0 +1,47 @@
+## /api/rules/read
+### Request structure
+Method(s): GET
+*No payload or parameters required.*
+### Call
+```
+curl -X GET http://127.0.0.1:5000/api/data/read
+```
+### Response
+```
+[
+  {
+    "height": "4",
+    "rules": [
+      "test_tall"
+    ],
+    "test_tall": "8",
+    "type": "animal"
+  }
+]
+```
+
+## /api/data/write
+### Request structure
+Method(s): POST
+```
+    {
+        "type": "",
+        ... # Any attributes available from the prototype.
+
+    }
+```
+### Call
+```
+curl -H "Content-Type: application/json" -X POST -d '{"type":"animal","height":"4"}' http://127.0.0.1:5000/api/data/write
+```
+### Response
+```
+{
+  "height": "4",
+  "rules": [
+    "test_tall"
+  ],
+  "test_tall": "8",
+  "type": "animal"
+}
+```

magic_rules/api/sections/prototypes.md

@@ -0,0 +1,48 @@
+## /api/prototypes/read
+### Request structure
+Method(s): GET
+*No payload or parameters required.*
+### Call
+```
+curl -X GET http://127.0.0.1:5000/api/prototypes/read
+```
+### Response
+```
+{
+  "animal": {
+    "height": null,
+    "rules": [
+      "test_tall"
+    ],
+    "type": "animal"
+  }
+}
+```
+## /api/prototypes/write
+### Request structure
+Method(s): POST
+```
+{
+    "name": "",
+    "attribute_0": "",
+    "attribute_1": "",
+    "attribute_2": "",
+    "attribute_3": "",
+    "attribute_4": "",
+    ...
+}
+```
+### Call
+```
+curl -H "Content-Type: application/json" -X POST -d '{"name":"animal","attribute_0":"height"}' http://127.0.0.1:5000/api/prototypes/write
+```
+### Response
+```
+{
+  "animal": {
+    "height": null,
+    "rules": [],
+    "type": "animal"
+  }
+}
+```

magic_rules/api/sections/rules.md

@@ -0,0 +1,56 @@
+## /api/rules/read
+### Request structure
+Method(s): GET
+*No payload or parameters required.*
+### Call
+```
+curl -X GET http://127.0.0.1:5000/api/rules/read
+```
+### Response
+```
+{
+  "test_tall": {
+    "attribute": "height",
+    "compare_value": "5",
+    "concur": "_double_height",
+    "name": "test_tall",
+    "not_concur": "tall enough already",
+    "operator": "<=",
+    "type": "logic"
+  }
+}
+```
+## /api/rules/write
+### Request structure
+Method(s): POST
+```
+{
+    "name": "",
+    "object": "",
+    "operator": ""
+    "attribute": "",
+    "compare_value": "",
+    "concur_static": "",
+    "concur_calc": "",
+    "not_concur_calc": "",
+    "not_concur_static": "",
+}
+```
+### Call
+```
+curl -H "Content-Type: application/json" -X POST -d '{"name":"test_tall", "object":"animal", "operator":"<=", "attribute":"height", "compare_value":"5", "concur_static":"", "concur_calc":"_double_height", "not_concur_static":"tall enough already", "not_concur_calc":""}' http://127.0.0.1:5000/api/rules/write
+```
+### Response
+```
+{
+  "test_tall": {
+    "attribute": "height",
+    "compare_value": "5",
+    "concur": "_double_height",
+    "name": "test_tall",
+    "not_concur": "tall enough already",
+    "operator": "<=",
+    "type": "logic"
+  }
+}
+```

magic_rules/datastore.py

@@ -0,0 +1,29 @@
+#! /usr/bin/env python3
+import json
+
+class MagicDB:
+    def __init__(self, filename):
+        self.filename = filename
+        self.data = self.read()
+
+    def read(self):
+        with open(self.filename, 'r') as infile:
+            return json.loads(infile.read())
+
+    def write(self, to_write):
+        with open(self.filename, 'w') as outfile:
+            outfile.write(json.dumps(to_write, indent=4))
+
+    def all(self):
+        return self.data
+
+    def single(self, key):
+        return self.data[key]
+
+    def update(self, data, key):
+        self.data[key] = data
+        self.write(self.data)
+
+    def add(self, data):
+        self.data.append(data)
+        self.write(self.data)

magic_rules/datastore/calculations.json

@@ -0,0 +1 @@
+{}

magic_rules/datastore/data.json

@@ -0,0 +1 @@
+[]

magic_rules/datastore/objects.json

@@ -0,0 +1 @@
+{}

magic_rules/datastore/rules.json

@@ -0,0 +1 @@
+{}