wisp-schema 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5234655066185960baf7e6dd335407a08a0972258c9cea6dc41e6373b41290a2
+  data.tar.gz: 66e415f68ff4b5ccd7a640a55ea6997bae70c74fdcd15267da092a7ee50d70c2
+SHA512:
+  metadata.gz: 56ceee9cf9a97d0a9009b7683dffaa8b3ac5039c7a120ca68d7399f19753440a60c4bd4fcee324239012d77e179b08e6a35779ebed50c8d766bb833a5bf1a759
+  data.tar.gz: 29764efd8c35f3418dfa5484f2341c288ba06735d3a51f813455a020ac39dc15c6f6e98a83d6122c55c96a3bc7e682780aa1bba7efcd058e38c1722adc121311

data/lib/wisp-schema.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Wisp
+  VERSION = '0.1.0'
+
+  SCHEMA_PATH = File.expand_path('../wisp.json', __dir__)
+end

data/wisp.json

@@ -0,0 +1,462 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "definitions": {
+    "noun": {
+      "title": "Wisp Noun",
+      "oneOf": [
+        {"$ref": "#/definitions/button"},
+        {"$ref": "#/definitions/field"},
+        {"$ref": "#/definitions/dropdown"},
+        {"$ref": "#/definitions/dropdown_option"},
+        {"$ref": "#/definitions/link"},
+        {"$ref": "#/definitions/icon"},
+        {"$ref": "#/definitions/checkbox"},
+        {"$ref": "#/definitions/header"},
+        {"$ref": "#/definitions/window"},
+        {"$ref": "#/definitions/modal"},
+        {"$ref": "#/definitions/text"},
+        {"$ref": "#/definitions/ui_element"}
+      ]
+    },
+    "button": {
+      "type": "object",
+      "title": "Button",
+      "description": "Button",
+      "properties": {
+        "type": {
+          "enum": ["BUTTON"]
+        },
+        "label": {"title": "Label", "type": "string"}
+      },
+      "required": ["type", "label"]
+    },
+    "field": {
+      "type": "object",
+      "title": "Field",
+      "description": "Text Field",
+      "properties": {
+        "type": {
+          "enum": ["TEXT_FIELD"]
+        },
+        "label": {"title": "Label", "type": "string"}
+      },
+      "required": ["type", "label"]
+    },
+    "dropdown": {
+      "type": "object",
+      "title": "Dropdown",
+      "description": "Dropdown",
+      "properties": {
+        "type": {
+          "enum": ["DROPDOWN"]
+        },
+        "label": {"title": "Label", "type": "string"}
+      },
+      "required": ["type", "label"]
+    },
+    "dropdown_option": {
+      "type": "object",
+      "title": "Dropdown Option",
+      "description": "Option in open dropdown",
+      "properties": {
+        "type": {
+          "enum": ["DROPDOWN_OPTION"]
+        },
+        "label": {"title": "Label", "type": "string"}
+      },
+      "required": ["type", "label"]
+    },
+    "link": {
+      "type": "object",
+      "title": "Link",
+      "description": "Link",
+      "properties": {
+        "type": {
+          "enum": ["LINK"]
+        },
+        "text": {"title": "Text", "type": "string"}
+      },
+      "required": ["type", "text"]
+    },
+    "icon": {
+      "type": "object",
+      "title": "Icon",
+      "description": "Icon",
+      "properties": {
+        "type": {
+          "enum": ["ICON"]
+        },
+        "description": {"title": "Description", "type": "string"}
+      },
+      "required": ["type", "description"]
+    },
+    "checkbox": {
+      "type": "object",
+      "title": "Checkbox",
+      "description": "Checkbox",
+      "properties": {
+        "type": {
+          "enum": ["CHECKBOX"]
+        },
+        "label": {"title": "Label", "type": "string"}
+      },
+      "required": ["type", "label"]
+    },
+    "header": {
+      "type": "object",
+      "title": "Header",
+      "description": "Page Header",
+      "properties": {
+        "type": {
+          "enum": ["HEADER"]
+        },
+        "text": {"title": "Text", "type": "string"}
+      },
+      "required": ["type", "text"]
+    },
+    "window": {
+      "type": "object",
+      "title": "Window",
+      "description": "Any pop-up window",
+      "properties": {
+        "type": {
+          "enum": ["WINDOW"]
+        },
+        "description": {"title": "Description", "type": "string"}
+      },
+      "required": ["type", "description"]
+    },
+    "modal": {
+      "type": "object",
+      "title": "Modal",
+      "description": "In page modal",
+      "properties": {
+        "type": {
+          "enum": ["MODAL"]
+        },
+        "description": {"title": "Description", "type": "string"}
+      },
+      "required": ["type", "description"]
+    },
+    "text": {
+      "type": "object",
+      "title": "Text",
+      "description": "Exactly matched text",
+      "properties": {
+        "type": {
+          "enum": ["TEXT"]
+        },
+        "text": {"title": "Text", "type": "string"}
+      },
+      "required": ["type", "text"]
+    },
+    "ui_element": {
+      "type": "object",
+      "title": "UI Element",
+      "description": "Any other UI Element",
+      "properties": {
+        "type": {
+          "enum": ["UI_ELEMENT"]
+        },
+        "element": {"title": "Element", "type": "string"}
+      },
+      "required": ["type", "element"]
+    },
+    "verb": {
+      "title": "Wisp Verb",
+      "oneOf": [
+        {"$ref": "#/definitions/click"},
+        {"$ref": "#/definitions/fill"},
+        {"$ref": "#/definitions/type"},
+        {"$ref": "#/definitions/send_key"},
+        {"$ref": "#/definitions/hover"},
+        {"$ref": "#/definitions/dropdown_select"},
+        {"$ref": "#/definitions/checkbox_check"},
+        {"$ref": "#/definitions/checkbox_uncheck"},
+        {"$ref": "#/definitions/refresh"},
+        {"$ref": "#/definitions/navigate"},
+        {"$ref": "#/definitions/navigate_new_tab"},
+        {"$ref": "#/definitions/navigate_incognito_tab"},
+        {"$ref": "#/definitions/close_tab"},
+        {"$ref": "#/definitions/scroll"},
+        {"$ref": "#/definitions/drag_and_drop"},
+        {"$ref": "#/definitions/click_and_hold"},
+        {"$ref": "#/definitions/plain_language"},
+        {"$ref": "#/definitions/see"},
+        {"$ref": "#/definitions/disappear"},
+        {"$ref": "#/definitions/loaded"},
+        {"$ref": "#/definitions/plain_language_assertion"}
+      ]
+    },
+    "click": {
+      "type": "object",
+      "title": "Click",
+      "description": "Clicks on the UI element",
+      "properties": {
+        "action": {
+          "enum": ["CLICK"]
+        },
+        "target": {"$ref": "#/definitions/noun"}
+      },
+      "required": ["action", "target"]
+    },
+    "fill": {
+      "type": "object",
+      "title": "Fill",
+      "description": "Fills the text field with specified content",
+      "properties": {
+        "action": {
+          "enum": ["FILL"]
+        },
+        "text": {"title": "Text", "type": "string"},
+        "target": {"$ref": "#/definitions/noun"}
+      },
+      "required": ["action", "target", "text"]
+    },
+    "type": {
+      "type": "object",
+      "title": "Type",
+      "description": "Types in specified text",
+      "properties": {
+        "action": {
+          "enum": ["TYPE"]
+        },
+        "text": {"title": "Text", "type": "string"}
+      },
+      "required": ["action", "text"]
+    },
+    "send_key": {
+      "type": "object",
+      "title": "Send Key",
+      "description": "Sends key combination",
+      "properties": {
+        "action": {
+          "enum": ["SEND_KEY"]
+        },
+        "modifier": {"title": "Modifier", "type": "string"},
+        "key": {"title": "Key", "type": "string"}
+      },
+      "required": ["action", "key"]
+    },
+    "hover": {
+      "type": "object",
+      "title": "Hover",
+      "description": "Hovers over specified element",
+      "properties": {
+        "action": {
+          "enum": ["HOVER"]
+        },
+        "target": {"$ref": "#/definitions/noun"}
+      },
+      "required": ["action", "target"]
+    },
+    "dropdown_select": {
+      "type": "object",
+      "title": "Dropdown Select",
+      "description": "Selects specified item from the dropdown",
+      "properties": {
+        "action": {
+          "enum": ["DROPDOWN_SELECT"]
+        },
+        "target": {"$ref": "#/definitions/noun"},
+        "option": {"title": "Option", "type": "string"}
+      },
+      "required": ["action", "target"]
+    },
+    "checkbox_check": {
+      "type": "object",
+      "title": "Checkbox Check",
+      "description": "Checks specified checkbox",
+      "properties": {
+        "action": {
+          "enum": ["CHECKBOX_CHECK"]
+        },
+        "target": {"$ref": "#/definitions/noun"}
+      },
+      "required": ["action", "target"]
+    },
+    "checkbox_uncheck": {
+      "type": "object",
+      "title": "Checkbox Uncheck",
+      "description": "Unhecks specified checkbox",
+      "properties": {
+        "action": {
+          "enum": ["CHECKBOX_UNCHECK"]
+        },
+        "target": {"$ref": "#/definitions/noun"}
+      },
+      "required": ["action", "target"]
+    },
+    "refresh": {
+      "type": "object",
+      "title": "Refresh",
+      "description": "Refreshes the webpage",
+      "properties": {
+        "action": {
+          "enum": ["REFRESH"]
+        }
+      },
+      "required": ["action"]
+    },
+    "navigate": {
+      "type": "object",
+      "title": "Navigate",
+      "description": "Navigates to specified URL",
+      "properties": {
+        "action": {
+          "enum": ["NAVIGATE"]
+        },
+        "url": {"title": "URL", "type": "string"}
+      },
+      "required": ["action", "url"]
+    },
+    "navigate_new_tab": {
+      "type": "object",
+      "title": "Navigate - New Tab",
+      "description": "Navigates to specified URL in a new tab",
+      "properties": {
+        "action": {
+          "enum": ["NAVIGATE_NEW_TAB"]
+        },
+        "url": {"title": "URL", "type": "string"}
+      },
+      "required": ["action", "url"]
+    },
+    "navigate_incognito_tab": {
+      "type": "object",
+      "title": "Navigate - Incognito Tab",
+      "description": "Navigates to specified URL in a new incognito tab",
+      "properties": {
+        "action": {
+          "enum": ["NAVIGATE_INCOGNITO_TAB"]
+        },
+        "url": {"title": "URL", "type": "string"}
+      },
+      "required": ["action", "url"]
+    },
+    "close_tab": {
+      "type": "object",
+      "title": "Close Tab",
+      "description": "Closes current browser tab",
+      "properties": {
+        "action": {
+          "enum": ["CLOSE_TAB"]
+        }
+      },
+      "required": ["action"]
+    },
+    "scroll": {
+      "type": "object",
+      "title": "Scroll",
+      "description": "Scrolls the page into specified direction until target is reached",
+      "properties": {
+        "action": {
+          "enum": ["SCROLL"]
+        },
+        "target": {"$ref": "#/definitions/noun"},
+        "direction": {"title": "Direction", "type": "string"}
+      },
+      "required": ["action", "direction"]
+    },
+    "drag_and_drop": {
+      "type": "object",
+      "title": "Drag and drop",
+      "description": "Drag and drop",
+      "properties": {
+        "action": {
+          "enum": ["DRAG_AND_DROP"]
+        },
+        "target": {"$ref": "#/definitions/noun"},
+        "object": {"title": "Object", "type": "string"}
+      },
+      "required": ["action", "target", "object"]
+    },
+    "click_and_hold": {
+      "type": "object",
+      "title": "Click and Hold",
+      "description": "Clicks and holds mouse button over object",
+      "properties": {
+        "action": {
+          "enum": ["CLICK_AND_HOLD"]
+        },
+        "target": {"$ref": "#/definitions/noun"},
+        "seconds": {"title": "Seconds", "type": "integer"}
+      },
+      "required": ["action", "target", "seconds"]
+    },
+    "plain_language": {
+      "type": "object",
+      "title": "Plain Language",
+      "description": "Allows to fallback to english",
+      "properties": {
+        "action": {
+          "enum": ["PLAIN_LANGUAGE"]
+        },
+        "instruction": {"title": "Instruction", "type": "string"}
+      },
+      "required": ["action", "instruction"]
+    },
+    "see": {
+      "type": "object",
+      "title": "See",
+      "description": "Checks if element of the UI is visible",
+      "properties": {
+        "assertion": {
+          "enum": ["SEE"]
+        },
+        "object": {"$ref": "#/definitions/noun"}
+      },
+      "required": ["assertion", "object"]
+    },
+    "disappear": {
+      "type": "object",
+      "title": "Disappear",
+      "description": "Checks if element of the UI is no longer visible",
+      "properties": {
+        "assertion": {
+          "enum": ["DISAPPEAR"]
+        },
+        "object": {"$ref": "#/definitions/noun"}
+      },
+      "required": ["assertion", "object"]
+    },
+    "loaded": {
+      "type": "object",
+      "title": "Loaded",
+      "description": "Checks if specified page has loaded",
+      "properties": {
+        "assertion": {
+          "enum": ["LOADED"]
+        },
+        "page": {"title": "Page", "type": "string"}
+      },
+      "required": ["assertion", "page"]
+    },
+    "plain_language_assertion": {
+      "type": "object",
+      "title": "Plain Language Assertion",
+      "description": "Allows to fallback to english",
+      "properties": {
+        "assertion": {
+          "enum": ["PLAIN_LANGUAGE"]
+        },
+        "instruction": {"title": "Instruction", "type": "string"}
+      },
+      "required": ["assertion", "instruction"]
+    }
+  },
+  "type": "object",
+  "title": "Wisp Test",
+  "properties": {
+    "version": {
+      "type": "integer"
+    },
+    "verbs": {
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/verb"
+      }
+    }
+  },
+  "required": ["version", "verbs"]
+}

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: wisp-schema
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jan Grodowski
+- Maciej Siwek
+- Bartosz Kruszczynski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-15 00:00:00.000000000 Z
+dependencies: []
+description: This gem contains Wisp's JSON schema definition
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/wisp-schema.rb
+- wisp.json
+homepage: https://github.com/rainforestapp/wisp
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.8
+signing_key: 
+specification_version: 4
+summary: Wisp's schema
+test_files: []