fix(mulesoft/exporter): status vars, perf, style, format

.ameba.yml

@@ -0,0 +1,57 @@
+Excluded:
+  - repositories/**/*.cr
+
+# NOTE: These should all be reviewed on an individual basis to see if their
+#       complexity can be reasonably reduced.
+Metrics/CyclomaticComplexity:
+  Description: Disallows methods with a cyclomatic complexity higher than `MaxComplexity`
+  MaxComplexity: 10
+  Excluded:
+  - drivers/helvar/net.cr
+  - drivers/mulesoft/booking_api.cr
+  - drivers/samsung/displays/mdc_protocol.cr
+  - drivers/cisco/dna_spaces.cr
+  - drivers/cisco/meraki/dashboard.cr
+  - drivers/cisco/switch/snooping_catalyst.cr
+  - drivers/gantner/relaxx/protocol_json.cr
+  - drivers/place/bookings.cr
+  - drivers/place/area_management.cr
+  - drivers/place/smtp.cr
+  - drivers/hitachi/projector/cp_tw_series_basic.cr
+  - drivers/panasonic/projector/nt_control.cr
+  - drivers/lumens/dc193.cr
+  Enabled: false
+  Severity: Convention
+
+Lint/UselessAssign:
+  Description: Disallows useless variable assignments
+  # NOTE: Not enabled due to the extremely large hit count.
+  #       Discussion with driver authors on whether this pattern is intended.
+  Enabled: false
+  Severity: Warning
+
+Style/VerboseBlock:
+  Description: Identifies usage of collapsible single expression blocks.
+  ExcludeCallsWithBlock: false
+  ExcludeMultipleLineBlocks: true
+  ExcludeOperators: false
+  ExcludePrefixOperators: false
+  ExcludeSetters: true
+  Enabled: false
+  Severity: Convention
+
+Style/VariableNames:
+  Description: Enforces variable names to be in underscored case
+  # NOTE: Not enabled due to the extremely large hit count.
+  #       Discussion with driver authors on whether this pattern is intended.
+  Enabled: false
+  Severity: Convention
+
+# NOTE: These appear to be triggered by assignment in case expressions, could be an ameba bug
+Lint/ShadowingOuterLocalVar:
+  Description: Disallows the usage of the same name as outer local variables for block
+    or proc arguments.
+  Excluded:
+  - drivers/cisco/switch/snooping_catalyst.cr
+  Enabled: true
+  Severity: Warning

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,33 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: 'Bug: A concise description of the behaviour'
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+
+Steps to reproduce the behaviour or a minimal code snippet that demonstrates the behaviour.
+
+**Expected behaviour**
+
+A clear and concise description of what you expected to happen.
+
+**Screenshots or a paste of terminal output**
+
+If applicable, add screenshots to help explain your problem.
+
+**Versions (please complete the following information):**
+
+- Output of `$ crystal version`
+- Driver version [e.g. 3.x] 
+
+**Additional context**
+
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/driver_migration.md

@@ -0,0 +1,20 @@
+---
+name: Driver Migration
+about: Migrate existing Ruby Engine Driver to Crystal
+title: 'Driver Migration: Migrate existing Ruby driver'
+labels: driver
+assignees: ''
+
+---
+
+**Driver to be Migrated**
+
+Information about the driver to be migrated.
+
+**Link to Existing Driver**
+
+Link to existing Driver on Ruby Drivers Repo.
+
+**Additional context**
+
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/driver_request.md

@@ -0,0 +1,32 @@
+---
+name: Driver Request
+about: Request a new driver to be created
+title: 'Driver Request: Information required to create a new driver'
+labels: driver
+assignees: ''
+
+---
+
+**Driver Type**
+
+Logic/Device/SSH/Websocket
+
+**Manufacturer**
+
+Manufacturer of device, software or service
+
+**Model/Service**
+
+Model or Service
+
+**Link to or Attach Device API or Protocol**
+
+If applicable, add screenshots to help explain your problem.
+
+**Describe any desired functionality**
+
+- Control all aspects of device
+
+**Additional context**
+
+Add any other context about the driver request here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,24 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: 'RFC: Concise description of desired feature'
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+
+Add any other context or screenshots about the feature request here.

.github/workflows/ci.yml

@@ -0,0 +1,44 @@
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+  schedule:
+    - cron: "0 6 * * 1"
+
+jobs:
+  style:
+    runs-on: ubuntu-latest
+    container:
+      image: crystallang/crystal
+    steps:
+      - uses: actions/checkout@v2
+      - name: Format
+        run: crystal tool format --check
+      - name: Lint
+        uses: crystal-ameba/github-action@v0.2.12
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        crystal:
+          - latest
+          - nightly
+          - 1.0.0
+    steps:
+      - uses: actions/checkout@v2
+      - name: Build drivers image
+        run: docker-compose build drivers
+        env:
+          CRYSTAL_VERSION: ${{ matrix.crystal }}
+      - name: Run docker-compose environment
+        run: docker-compose up -d
+      - name: Spec
+        run: docker exec placeos-drivers crystal spec -v --error-trace
+      - name: Driver Report
+        run: docker exec placeos-drivers /src/bin/report

.gitignore

@@ -4,3 +4,7 @@ lib
 .shards
 app
 *.dwarf
+repositories/*
+bin
+.DS_Store
+*.rdb

.vscode/launch.json

@@ -0,0 +1,16 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Debug",
+      "type": "gdb",
+      "request": "launch",
+      "target": "./bin/test-harness",
+      "cwd": "${workspaceRoot}",
+      "preLaunchTask": "Compile",
+      "setupCommands": [
+        { "text": "-gdb-set follow-fork-mode child" }
+      ]
+    }
+  ]
+}

.vscode/tasks.json

@@ -0,0 +1,10 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "Compile",
+      "command": "shards build --debug drivers",
+      "type": "shell"
+    }
+  ]
+}

Dockerfile

@@ -0,0 +1,34 @@
+ARG crystal_version=1.0.0
+FROM crystallang/crystal:${crystal_version}-alpine
+WORKDIR /src
+
+# Install the latest version of LibSSH2 and the GDB debugger
+RUN apk add --no-cache \
+    ca-certificates \
+    gdb \
+    iputils \
+    libssh2 libssh2-dev libssh2-static \
+    tzdata \
+    yaml-static
+
+# Add trusted CAs for communicating with external services
+RUN update-ca-certificates
+
+RUN mkdir -p /src/bin/drivers
+
+COPY shard.yml /src/shard.yml
+COPY shard.override.yml /src/shard.override.yml
+COPY shard.lock /src/shard.lock
+
+RUN shards install --production --ignore-crystal-version
+
+COPY src /src/src
+COPY spec /src/spec
+
+# Build App
+RUN shards build --error-trace --release --production --ignore-crystal-version
+
+# Run the app binding on port 8080
+EXPOSE 8080
+ENTRYPOINT ["/src/bin/test-harness"]
+CMD ["/src/bin/test-harness", "-b", "0.0.0.0", "-p", "8080"]

README.md

@@ -1,41 +1,15 @@
-# Spider-Gazelle Application Template
+# PlaceOS Drivers
 
-[![Build Status](https://travis-ci.org/spider-gazelle/spider-gazelle.svg?branch=master)](https://travis-ci.org/spider-gazelle/spider-gazelle)
+[![CI](https://github.com/PlaceOS/drivers/actions/workflows/ci.yml/badge.svg)](https://github.com/PlaceOS/drivers/actions/workflows/ci.yml)
 
-Clone this repository to start building your own spider-gazelle based application
+Manage and test [PlaceOS](https://place.technology) drivers.
 
-## Documentation
+## Development
 
-* [Action Controller](https://github.com/spider-gazelle/action-controller) base class for building [Controllers](http://guides.rubyonrails.org/action_controller_overview.html)
-* [Active Model](https://github.com/spider-gazelle/active-model) base class for building [ORMs](https://en.wikipedia.org/wiki/Object-relational_mapping)
-* [Habitat](https://github.com/luckyframework/habitat) configuration and settings for Crystal projects
-* [router.cr](https://github.com/tbrand/router.cr) base request handling
-* [Radix](https://github.com/luislavena/radix) Radix Tree implementation for request routing
-* [HTTP::Server](https://crystal-lang.org/api/latest/HTTP/Server.html) built-in Crystal Lang HTTP server
-  * Request
-  * Response
-  * Cookies
-  * Headers
-  * Params etc
+To spin up the test harness, clone the repository and run...
 
+```bash
+$ docker-compose up -d
+```
 
-Spider-Gazelle builds on the amazing performance of **router.cr** [here](https://github.com/tbrand/which_is_the_fastest).:rocket:
-
-
-## Testing
-
-`crystal spec`
-
-* to run in development mode `crystal ./src/app.cr`
-
-## Compiling
-
-`crystal build ./src/app.cr`
-
-### Deploying
-
-Once compiled you are left with a binary `./app`
-
-* for help `./app --help`
-* viewing routes `./app --routes`
-* run on a different port or host `./app -h 0.0.0.0 -p 80`
+Point a browser to [localhost:8085](http://localhost:8085), and you're good to go.

docker-compose.yml

@@ -0,0 +1,35 @@
+version: "3.7"
+services:
+  redis:
+    image: eqalpha/keydb
+    restart: always
+    hostname: redis
+    environment:
+      - TZ=$TZ
+
+  drivers:
+    build:
+      context: .
+      args:
+        crystal_version: ${CRYSTAL_VERSION:-1.0.0}
+    image: placeos/drivers
+    restart: always
+    container_name: placeos-drivers
+    hostname: drivers
+    environment:
+      - CRYSTAL_PATH=lib:/lib/local-shards
+    depends_on:
+      - redis
+    ports:
+      - 127.0.0.1:8085:8080
+      - 127.0.0.1:4444:4444
+    volumes:
+      - ./drivers/:/src/drivers/
+      - ./repositories/:/src/repositories/
+      - ./lib/:/lib/local-shards/
+      - ./src/:/src/src
+      - ./spec/:/src/spec
+      - ./.git:/src/.git
+    environment:
+      - REDIS_URL=redis://redis:6379
+      - TZ=$TZ

docs/directory_structure.md

@@ -0,0 +1,20 @@
+# Directory Structures
+
+PlaceOS core / drivers makes the assumption that the working directory one level
+up from the scratch directory. An example deployment structure:
+
+* Working dir: `/home/placeos/core`
+* Executable: `/home/placeos/core/bin/core`
+* Driver repositories: `/home/placeos/repositories`
+  * PlaceOS Drivers: `/home/placeos/repositories/drivers`
+* Driver executables: `/home/placeos/core/bin/drivers`
+  * Samsung driver: `/home/placeos/core/bin/drivers/353b53_samsung_display_md_series_cr`
+
+However when developing the structure will look more like:
+
+* Working dir: `/home/steve/drivers`
+* Driver repository: `/home/steve/drivers`
+* Driver executables: `/home/steve/drivers/bin/drivers`
+  * Samsung driver: `/home/placeos/core/bin/drivers/353b53_samsung_display_md_series_cr`
+
+The primary difference between production and development is PlaceOS core, in production, will be cloning repositories and installing shards as required.