qube_rails 0.2.0

data/lib/qube_rails/storyboard/missing_record.json

@@ -0,0 +1,141 @@
+{
+  "title": "A missing customer",
+  "note": "add_transaction's ask_missing with one record: the invoice names a customer QuickBooks doesn't have and the app sent no add for it, so the person says whether to create it or use one QuickBooks has. Create it needs nothing more for a customer; Use an existing one shows the search.",
+  "prompt": {
+    "id": "add_transaction / ask_missing",
+    "kind": "decision",
+    "token": "Mc7pR4tKw2NbY9xQ",
+    "message": "Some records this transaction uses aren't in QuickBooks yet. For each one, create it or pick one QuickBooks already has.",
+    "data": {
+      "operation": "invoice",
+      "missing": [
+        {
+          "kind": "customer",
+          "full_name": "Lone Star Supply",
+          "paths": [
+            "customer_ref"
+          ]
+        },
+        {
+          "kind": "item",
+          "full_name": "Vinyl Banner 3x6",
+          "paths": [
+            "invoice_line_add.0.item_ref"
+          ]
+        },
+        {
+          "kind": "item",
+          "full_name": "Hardware Kit",
+          "paths": [
+            "invoice_line_add.1.item_ref"
+          ]
+        }
+      ]
+    },
+    "details": [
+      {
+        "label": "Adding",
+        "value": "Invoice"
+      },
+      {
+        "label": "Number",
+        "value": "1042"
+      },
+      {
+        "label": "For",
+        "value": "Lone Star Supply"
+      }
+    ],
+    "options": [],
+    "choices": [
+      {
+        "id": "proceed",
+        "label": "Add the transaction",
+        "description": null,
+        "detail": null,
+        "fields": [
+          {
+            "name": "records",
+            "type": "rows",
+            "label": "Not in QuickBooks yet",
+            "required": true,
+            "columns": [
+              {
+                "name": "action",
+                "type": "string",
+                "label": "What to do",
+                "required": true,
+                "kind": null,
+                "enum": [
+                  {
+                    "value": "create",
+                    "label": "Create it"
+                  },
+                  {
+                    "value": "use",
+                    "label": "Use an existing one"
+                  }
+                ],
+                "when": null
+              },
+              {
+                "name": "list_id",
+                "type": "record",
+                "label": "Existing record",
+                "required": true,
+                "kind": null,
+                "enum": null,
+                "when": {
+                  "action": [
+                    "use"
+                  ]
+                }
+              }
+            ],
+            "rows": [
+              {
+                "key": "customer_ref",
+                "label": "Lone Star Supply",
+                "detail": "Customer",
+                "columns": [
+                  "action",
+                  "list_id"
+                ],
+                "values": {},
+                "kinds": {
+                  "list_id": "customer"
+                }
+              }
+            ]
+          }
+        ]
+      },
+      {
+        "id": "cancel",
+        "label": "Cancel",
+        "description": "Stop here. Nothing is created.",
+        "detail": null,
+        "fields": []
+      }
+    ]
+  },
+  "search": {
+    "records.list_id": [
+      {
+        "value": "80000001-1700000000",
+        "label": "Riverbend Electric",
+        "detail": "Customer"
+      },
+      {
+        "value": "80000002-1700000000",
+        "label": "Riverbend Supply Co.",
+        "detail": "Customer"
+      },
+      {
+        "value": "80000003-1700000000",
+        "label": "Lone Star Supply",
+        "detail": "Customer"
+      }
+    ]
+  }
+}

data/lib/qube_rails/storyboard/name_clash.json

@@ -0,0 +1,59 @@
+{
+  "title": "A name clash",
+  "note": "ensure's ask_use: the name is already in QuickBooks. Use that record, add this one under another name, or cancel.",
+  "prompt": {
+    "id": "ensure / ask_use",
+    "kind": "decision",
+    "token": "Wg5qU7vAs3PhB5dD",
+    "message": "\"Riverbend Electric\" is already in QuickBooks. Use that record, add this one under another name, or cancel.",
+    "data": {
+      "kind": "customer",
+      "name": "Riverbend Electric",
+      "existing": {
+        "list": "customer"
+      }
+    },
+    "details": [
+      {
+        "label": "Customer",
+        "value": "Riverbend Electric"
+      },
+      {
+        "label": "Held by",
+        "value": "Customer"
+      }
+    ],
+    "options": [],
+    "choices": [
+      {
+        "id": "use_existing",
+        "label": "Use the existing record",
+        "description": "Carry on with the record QuickBooks already has. Nothing new is created.",
+        "detail": null,
+        "fields": []
+      },
+      {
+        "id": "rename",
+        "label": "Add it under another name",
+        "description": "Try the add again under a name you choose.",
+        "detail": null,
+        "fields": [
+          {
+            "name": "name",
+            "type": "string",
+            "label": "New name",
+            "required": true
+          }
+        ]
+      },
+      {
+        "id": "cancel",
+        "label": "Cancel",
+        "description": "Stop here. Nothing is created.",
+        "detail": null,
+        "fields": []
+      }
+    ]
+  },
+  "search": {}
+}

data/lib/qube_rails/storyboard/near_match.json

@@ -0,0 +1,77 @@
+{
+  "title": "A near match",
+  "note": "resolve's ask: QuickBooks has no record with exactly that name. The similar ones are choices (detail says why), then a search for another one, none of these, or cancel. With an add from the caller, \"None of these\" says the record is added as new (adds: true); without one it reads just \"None of these\".",
+  "prompt": {
+    "choices": [
+      {
+        "description": null,
+        "detail": "similar name · ap@riverbend.example · 512-555-0142",
+        "fields": [],
+        "id": "use:1",
+        "label": "Riverbend Electric"
+      },
+      {
+        "description": null,
+        "detail": null,
+        "fields": [
+          {
+            "kind": "customer",
+            "label": "Search for a different one",
+            "name": "list_id",
+            "required": true,
+            "type": "record"
+          }
+        ],
+        "id": "use",
+        "label": "Use this one"
+      },
+      {
+        "description": null,
+        "detail": null,
+        "fields": [],
+        "id": "none",
+        "label": "None of these: add \"Riverbend\" as new"
+      },
+      {
+        "description": null,
+        "detail": null,
+        "fields": [],
+        "id": "cancel",
+        "label": "Cancel"
+      }
+    ],
+    "data": {
+      "name": "Riverbend"
+    },
+    "details": [
+      {
+        "label": "Customer",
+        "value": "Riverbend"
+      }
+    ],
+    "id": "resolve / ask",
+    "kind": "decision",
+    "message": "No record has exactly that name. Pick the one you meant, say none of these is it, or cancel.",
+    "options": [],
+    "token": "Vq3kT9xRb2LmW8sZ"
+  },
+  "search": {
+    "list_id": [
+      {
+        "value": "80000001-1700000000",
+        "label": "Riverbend Electric",
+        "detail": "Customer · Riverbend Electric LLC · ap@riverbend.example · 512-555-0142 · Austin 78701"
+      },
+      {
+        "value": "80000002-1700000000",
+        "label": "Riverbend Supply Co.",
+        "detail": "Customer"
+      },
+      {
+        "value": "80000003-1700000000",
+        "label": "Lone Star Supply",
+        "detail": "Customer"
+      }
+    ]
+  }
+}

data/lib/qube_rails/storyboard/number_boolean.json

@@ -0,0 +1,54 @@
+{
+  "title": "Number and yes/no fields",
+  "note": "A number field posts what was typed and is sent as a number; a boolean is a checkbox, sent as true or false. No shipped template asks these; a chart of your own can.",
+  "prompt": {
+    "id": "adjust / ask_quantity",
+    "kind": "decision",
+    "token": "Vf4pT6uZr2NgA4cC",
+    "message": "QuickBooks shows fewer on hand than this adjustment takes. Say how many to take, or cancel.",
+    "data": {
+      "on_hand": 3
+    },
+    "details": [
+      {
+        "label": "Item",
+        "value": "Vinyl Banner 3x6"
+      },
+      {
+        "label": "On hand",
+        "value": "3"
+      }
+    ],
+    "options": [],
+    "choices": [
+      {
+        "id": "adjust",
+        "label": "Adjust",
+        "description": null,
+        "detail": null,
+        "fields": [
+          {
+            "name": "quantity",
+            "type": "number",
+            "label": "Quantity",
+            "required": true
+          },
+          {
+            "name": "allow_negative",
+            "type": "boolean",
+            "label": "Allow a negative quantity on hand",
+            "required": false
+          }
+        ]
+      },
+      {
+        "id": "cancel",
+        "label": "Cancel",
+        "description": null,
+        "detail": null,
+        "fields": []
+      }
+    ]
+  },
+  "search": {}
+}

data/lib/qube_rails/storyboard/record_search.json

@@ -0,0 +1,90 @@
+{
+  "title": "A pick from the records there are",
+  "note": "resolve's ask_pick: nothing has that name and nothing may be created for it (an account here), so the person picks one: the first active records as rows, then a search over every record of the kind. The search box asks your app's search route and fills a hidden input with the pick's ListID.",
+  "prompt": {
+    "id": "resolve / ask_pick",
+    "kind": "decision",
+    "token": "Sb4kQ2rTn8LmV1xZ",
+    "message": "QuickBooks has nothing named \"Consulting Income\". Pick the one to use instead, or cancel.",
+    "data": {
+      "name": "Consulting Income",
+      "kind": "account"
+    },
+    "details": [
+      {
+        "label": "Account",
+        "value": "Consulting Income"
+      }
+    ],
+    "options": [],
+    "choices": [
+      {
+        "id": "use:1",
+        "label": "Sales",
+        "description": null,
+        "detail": null,
+        "fields": []
+      },
+      {
+        "id": "use:2",
+        "label": "Sales:Signs",
+        "description": null,
+        "detail": null,
+        "fields": []
+      },
+      {
+        "id": "use:3",
+        "label": "Service Income",
+        "description": null,
+        "detail": null,
+        "fields": []
+      },
+      {
+        "id": "use",
+        "label": "Use this one",
+        "description": null,
+        "detail": null,
+        "fields": [
+          {
+            "name": "list_id",
+            "type": "record",
+            "kind": "account",
+            "label": "Search for the one to use",
+            "required": true
+          }
+        ]
+      },
+      {
+        "id": "cancel",
+        "label": "Cancel",
+        "description": null,
+        "detail": null,
+        "fields": []
+      }
+    ]
+  },
+  "search": {
+    "list_id": [
+      {
+        "value": "8000000A-1700000000",
+        "label": "Sales",
+        "detail": "Account"
+      },
+      {
+        "value": "8000000B-1700000000",
+        "label": "Sales:Signs",
+        "detail": "Account"
+      },
+      {
+        "value": "8000000C-1700000000",
+        "label": "Service Income",
+        "detail": "Account"
+      },
+      {
+        "value": "8000000D-1700000000",
+        "label": "Consulting Fees",
+        "detail": "Account"
+      }
+    ]
+  }
+}

data/lib/qube_rails/storyboard/refusal.json

@@ -0,0 +1,53 @@
+{
+  "title": "An answer QuBe Sync refused (422)",
+  "note": "The question again, with why QuBe Sync couldn't take the answer (its errors.detail), from flash[:qube_rails_error].",
+  "error": "That answer couldn't be used: a new name is required.",
+  "prompt": {
+    "id": "ensure / ask_rename",
+    "kind": "decision",
+    "token": "Zk8tX1yDv6SmE8gG",
+    "message": "\"Riverbend Electric\" already belongs to a record of another list (Vendor), and QuickBooks keeps names unique across customers, vendors, employees and other names, and across every type of item. Add this one under another name, or cancel.",
+    "data": {
+      "kind": "customer",
+      "name": "Riverbend Electric",
+      "existing": {
+        "list": "vendor"
+      }
+    },
+    "details": [
+      {
+        "label": "Customer",
+        "value": "Riverbend Electric"
+      },
+      {
+        "label": "Held by",
+        "value": "Vendor"
+      }
+    ],
+    "options": [],
+    "choices": [
+      {
+        "id": "rename",
+        "label": "Add it under another name",
+        "description": null,
+        "detail": null,
+        "fields": [
+          {
+            "name": "name",
+            "type": "string",
+            "label": "New name",
+            "required": true
+          }
+        ]
+      },
+      {
+        "id": "cancel",
+        "label": "Cancel",
+        "description": "Stop here. Nothing is created.",
+        "detail": null,
+        "fields": []
+      }
+    ]
+  },
+  "search": {}
+}