refactor: ACAEngine -> PlaceOS, engine-drivers -> drivers

.ameba.yml

@@ -54,7 +54,7 @@ Lint/UnreachableCode:
   Enabled: true
   Severity: Warning
   Excluded:
-  - repositories/private_drivers/lib/engine-driver/src/engine-driver/protocol/management.cr
+  - repositories/private_drivers/lib/driver/src/driver/protocol/management.cr
 
 # Run `ameba --only Style/VariableNames` for details
 Style/VariableNames:

.vscode/launch.json

@@ -5,7 +5,7 @@
       "name": "Debug",
       "type": "gdb",
       "request": "launch",
-      "target": "./bin/engine-drivers",
+      "target": "./bin/test-harness",
       "cwd": "${workspaceRoot}",
       "preLaunchTask": "Compile",
       "setupCommands": [

.vscode/tasks.json

@@ -3,7 +3,7 @@
   "tasks": [
     {
       "label": "Compile",
-      "command": "shards build --debug engine-drivers",
+      "command": "shards build --debug drivers",
       "type": "shell"
     }
   ]

Dockerfile

@@ -13,5 +13,5 @@ RUN shards build --error-trace --production
 
 # Run the app binding on port 8080
 EXPOSE 8080
-ENTRYPOINT ["/src/bin/engine-drivers"]
-CMD ["/src/bin/engine-drivers", "-b", "0.0.0.0", "-p", "8080"]
+ENTRYPOINT ["/src/bin/test-harness"]
+CMD ["/src/bin/test-harness", "-b", "0.0.0.0", "-p", "8080"]

README.md

@@ -1,8 +1,8 @@
-# Crystal Engine Drivers
+# PlaceOS Drivers
 
-[![Build Status](https://travis-ci.org/aca-labs/crystal-engine-drivers.svg?branch=master)](https://travis-ci.org/aca-labs/crystal-engine-drivers)
+[![Build Status](https://travis-ci.org/placeos/drivers.svg?branch=master)](https://travis-ci.org/placeos/drivers)
 
-Manages and tests engine drivers
+Manage and test [PlaceOS](https://place.technology) drivers.
 
 ## Development
 

docs/directory_structure.md

@@ -1,20 +1,20 @@
 # Directory Structures
 
-Engine core / drivers makes the assumption that the working directory one level
+PlaceOS core / drivers makes the assumption that the working directory one level
 up from the scratch directory. An example deployment structure:
 
-* Working dir: `/home/engine/core`
-* Executable: `/home/engine/core/bin/core`
-* Driver repositories: `/home/engine/repositories`
-  * ACA Drivers: `/home/engine/repositories/aca-engine-drivers`
-* Driver executables: `/home/engine/core/bin/drivers`
-  * Samsung driver: `/home/engine/core/bin/drivers/353b53_samsung_display_md_series_cr`
+* 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/aca-engine-drivers`
-* Driver repository: `/home/steve/aca-engine-drivers`
-* Driver executables: `/home/steve/aca-engine-drivers/bin/drivers`
-  * Samsung driver: `/home/engine/core/bin/drivers/353b53_samsung_display_md_series_cr`
+* 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 engine core, in production, will be cloning repositories and installing shards as required.
+The primary difference between production and development is PlaceOS core, in production, will be cloning repositories and installing shards as required.

docs/http-api.md

@@ -12,7 +12,7 @@ Returns the list of available drivers
 
 ```json
 
-["drivers/aca/spec_helper.cr", "..."]
+["drivers/place/spec_helper.cr", "..."]
 ```
 
 
@@ -94,7 +94,7 @@ Lists the available specs
 
 ```json
 
-["drivers/aca/spec_helper_spec.cr", "..."]
+["drivers/place/spec_helper_spec.cr", "..."]
 ```
 
 
@@ -130,7 +130,7 @@ Compiles and runs a spec and returns the output
 
 ```text
 Launching spec runner
-Launching driver: /Users/steve/Documents/projects/crystal-engine/crystal-engine-drivers/bin/drivers/drivers_aca_private_helper_cr_4f6e0cd
+Launching driver: /Users/steve/Documents/projects/placeos/drivers/bin/drivers/drivers_place_private_helper_cr_4f6e0cd
 ... starting driver IO services
 ... starting module
 ... waiting for module

docs/setup.md

@@ -1,10 +1,9 @@
 # Setup
 
-This allows you to build and test drivers without installing or running the complete
-ACA Engine service.
+This allows you to build and test drivers without installing or running the complete PlaceOS service.
 
-1. clone the drivers repository: `git clone https://github.com/aca-labs/crystal-engine-drivers engine-drivers`
-2. clone private repositories here: `mkdir ./engine-drivers/repositories`
+1. clone the drivers repository: `git clone https://github.com/placeos/drivers drivers`
+2. clone private repositories here: `mkdir ./drivers/repositories`
 
 
 ## OSX
@@ -26,7 +25,7 @@ export PKG_CONFIG_PATH=$PKG_CONFIG_PATH:/usr/local/opt/openssl/lib/pkgconfig
 ## Running Specs
 
 1. Ensure redis is running: `redis-server`
-2. Install dependencies: `cd engine-drivers; shards update`
+2. Install dependencies: `cd drivers; shards update`
 3. Launch application: `crystal run ./src/app.cr`
 4. Browse to: http://localhost:3000/
 

docs/writing-a-driver.md

@@ -97,7 +97,7 @@ end
 # A common received function for handling responses
 def received(data, task)
   # data is always `Bytes`
-  # task is always `ACAEngine::Driver::Task?` (i.e. could be nil if no active task)
+  # task is always `PlaceOS::Driver::Task?` (i.e. could be nil if no active task)
 
   # convert data into the appropriate format
   data = String.new(data)
@@ -201,7 +201,7 @@ sys.bookable #=> true
 sys.id #=> "sys-tem~id"
 sys.modules #=> ["Array", "Of", "Unique", "Module", "Names", "In", "System"]
 sys.count("Module") #=> 3
-sys.implementing(ACAEngine::Driver::Interface::Powerable) #=> ["Camera", "Display"]
+sys.implementing(PlaceOS::Driver::Interface::Powerable) #=> ["Camera", "Display"]
 
 # Look at status on a remote module
 system[:Display][:power] #=> true
@@ -377,7 +377,7 @@ Metadata is used by various components to simplify configuration.
 
 ```crystal
 
-class MyDevice < ACAEngine::Driver
+class MyDevice < PlaceOS::Driver
   generic_name :Driver
   descriptive_name "Driver model Test"
   description "This is the driver used for testing"

drivers/aca/spec_helper.cr

@@ -1,6 +1,6 @@
-module ACA; end
+module Place; end
 
-class ACA::SpecHelper < ACAEngine::Driver
+class Place::SpecHelper < PlaceOS::Driver
   def implemented_in_driver
     "woot!"
   end

drivers/bose/control_space_serial.cr

@@ -2,7 +2,7 @@ module Bose; end
 
 # Documentation: https://aca.im/driver_docs/Bose/Bose-ControlSpace-SerialProtocol-v5.pdf
 
-class Bose::ControlSpaceSerial < ACAEngine::Driver
+class Bose::ControlSpaceSerial < PlaceOS::Driver
   # Discovery Information
   tcp_port 10055
   descriptive_name "Bose ControlSpace Serial Protocol"

drivers/cisco/switch/snooping_catalyst.cr

@@ -4,7 +4,7 @@ module Cisco::Switch; end
 
 require "set"
 
-class Cisco::Switch::SnoopingCatalyst < ACAEngine::Driver
+class Cisco::Switch::SnoopingCatalyst < PlaceOS::Driver
   # Discovery Information
   descriptive_name "Cisco Catalyst Switch IP Snooping"
   generic_name :Snooping

drivers/floorsense/desks.cr

@@ -5,7 +5,7 @@ module Floorsense; end
 
 # Documentation: https://documenter.getpostman.com/view/8843075/SVmwvctF?version=latest#3bfbb050-722d-4433-889a-8793fa90af9c
 
-class Floorsense::Desks < ACAEngine::Driver
+class Floorsense::Desks < PlaceOS::Driver
   # Discovery Information
   generic_name :Desks
   descriptive_name "Floorsense Desk Tracking"
@@ -74,7 +74,7 @@ class Floorsense::Desks < ACAEngine::Driver
     if response.success?
       resp = AuthResponse.from_json(data)
       token = resp.info.not_nil!.token
-      payload, header = JWT.decode(token, verify: false, validate: false)
+      payload, _ = JWT.decode(token, verify: false, validate: false)
       @auth_expiry = (Time.unix payload["exp"].as_i64) - 5.minutes
       @auth_token = "Bearer #{token}"
     else

drivers/gantner/relaxx/protocol_json.cr

@@ -13,7 +13,7 @@ require "set"
 # User = Administrator
 # PW = Mirone59
 
-class Gantner::Relaxx::ProtocolJSON < ACAEngine::Driver
+class Gantner::Relaxx::ProtocolJSON < PlaceOS::Driver
   # Discovery Information
   tcp_port 8237
   descriptive_name "Gantner GAT Relaxx JSON API"

drivers/helvar/net.cr

@@ -2,7 +2,7 @@ module Helvar; end
 
 # Documentation: https://aca.im/driver_docs/Helvar/HelvarNet-Overview.pdf
 
-class Helvar::Net < ACAEngine::Driver
+class Helvar::Net < PlaceOS::Driver
   # Discovery Information
   tcp_port 50000
   descriptive_name "Helvar Net Lighting Gateway"

drivers/helvar/net_spec.cr

@@ -15,7 +15,7 @@ EngineSpec.mock_driver "Helvar::Net" do
   resp = exec(:get_current_preset, group: 20)
   should_send(">V:2,C:109,G:20#")
   responds("!V:2,C:109,G:20=1#")
-  expect_raises(ACAEngine::Driver::RemoteException, "invalid group index parameter for !V:2,C:109,G:20=1 (Abort)") do
+  expect_raises(PlaceOS::Driver::RemoteException, "invalid group index parameter for !V:2,C:109,G:20=1 (Abort)") do
     resp.get
   end
   status[:last_error].should eq("invalid group index parameter for !V:2,C:109,G:20=1")

drivers/lutron/lighting.cr

@@ -9,7 +9,7 @@ module Lutron; end
 # Login: lutron
 # Password: integration
 
-class Lutron::Lighting < ACAEngine::Driver
+class Lutron::Lighting < PlaceOS::Driver
   # Discovery Information
   tcp_port 23
   descriptive_name "Lutron Lighting Gateway"

drivers/message_media/sms.cr

@@ -1,9 +1,9 @@
 module MessageMedia; end
 
 # Documentation: https://developers.messagemedia.com/code/messages-api-documentation/
-require "engine-driver/interface/sms"
+require "driver/interface/sms"
 
-class MessageMedia::SMS < ACAEngine::Driver
+class MessageMedia::SMS < PlaceOS::Driver
   include Interface::SMS
 
   # Discovery Information

drivers/office_rnd/office_rnd_api.cr

@@ -4,7 +4,7 @@ require "uuid"
 require "./models"
 
 module OfficeRnd
-  class OfficeRndAPI < ACAEngine::Driver
+  class OfficeRndAPI < PlaceOS::Driver
     # Discovery Information
     generic_name :OfficeRnd
     descriptive_name "OfficeRnD REST API"

drivers/panasonic/projector/nt_control.cr

@@ -1,7 +1,7 @@
 require "digest/md5"
-require "engine-driver/interface/muteable"
-require "engine-driver/interface/powerable"
-require "engine-driver/interface/switchable"
+require "driver/interface/muteable"
+require "driver/interface/powerable"
+require "driver/interface/switchable"
 
 module Panasonic; end
 
@@ -18,7 +18,7 @@ module Panasonic::Projector; end
 # 4. Projector responds with a value
 # 5. You have to disconnect explicitly, projector won't close the connection
 
-class Panasonic::Projector::NTControl < ACAEngine::Driver
+class Panasonic::Projector::NTControl < PlaceOS::Driver
   include Interface::Powerable
   include Interface::Muteable
 
@@ -34,7 +34,7 @@ class Panasonic::Projector::NTControl < ACAEngine::Driver
     Composite
   end
 
-  include ACAEngine::Driver::Interface::InputSelection(Inputs)
+  include PlaceOS::Driver::Interface::InputSelection(Inputs)
 
   # Discovery Information
   tcp_port 1024

drivers/point_grab/cogni_point.cr

@@ -5,7 +5,7 @@ module PointGrab; end
 
 # Documentation: https://aca.im/driver_docs/PointGrab/CogniPointAPI2-1.pdf
 
-class PointGrab::CogniPoint < ACAEngine::Driver
+class PointGrab::CogniPoint < PlaceOS::Driver
   # Discovery Information
   generic_name :CogniPoint
   descriptive_name "PointGrab CogniPoint REST API"

drivers/screen_technics/connect.cr

@@ -1,13 +1,13 @@
 module ScreenTechnics; end
 
-require "engine-driver/interface/moveable"
-require "engine-driver/interface/stoppable"
+require "driver/interface/moveable"
+require "driver/interface/stoppable"
 
 # Documentation: https://aca.im/driver_docs/Screen%20Technics/Screen%20Technics%20IP%20Connect%20module.pdf
 # Default user: Admin
 # Default pass: Connect
 
-class ScreenTechnics::Connect < ACAEngine::Driver
+class ScreenTechnics::Connect < PlaceOS::Driver
   include Interface::Moveable
   include Interface::Stoppable
 

drivers/screen_technics/connect_spec.cr

@@ -52,7 +52,7 @@ EngineSpec.mock_driver "ScreenTechnics::Connect" do
     end
 
     # Original down command should have failed
-    expect_raises(ACAEngine::Driver::RemoteException, "queue cleared (Abort)") do
+    expect_raises(PlaceOS::Driver::RemoteException, "queue cleared (Abort)") do
       ret_val.get
     end
 

drivers/sony/camera/cgi_protocol.cr

@@ -1,12 +1,12 @@
-require "engine-driver/interface/camera"
+require "driver/interface/camera"
 
 module Sony; end
 
 module Sony::Camera; end
 
 # Documentation: https://aca.im/driver_docs/Sony/sony-camera-CGI-Commands-1.pdf
 
-class Sony::Camera::CGI < ACAEngine::Driver
+class Sony::Camera::CGI < PlaceOS::Driver
   # include Interface::Powerable
   include Interface::Camera
 

drivers/sony/camera/cgi_protocol_spec.cr

@@ -3,7 +3,7 @@ EngineSpec.mock_driver "Floorsense::Desks" do
   retval = exec(:query_status)
 
   # We should request a new token from Floorsense
-  expect_http_request do |request, response|
+  expect_http_request do |_request, response|
     response.status_code = 200
     response.output.puts %(AbsolutePTZF=15400,fd578,0000,cb5a&PanMovementRange=eac00,15400&PanPanoramaRange=de00,2200&PanTiltMaxVelocity=24&PtzInstance=1&TiltMovementRange=fc400,b400&TiltPanoramaRange=fc00,1200&ZoomMaxVelocity=8&ZoomMovementRange=0000,4000,7ac0&PtzfStatus=idle,idle,idle,idle&AbsoluteZoom=609)
   end

shard.lock

@@ -28,9 +28,9 @@ shards:
     github: drujensen/delimiter_tree
     version: 0.1.4
 
-  engine-driver:
-    github: aca-labs/crystal-engine-driver
-    commit: c983a7c4b7e50942358617c4e31c0e9e291912e0
+  driver:
+    github: placeos/driver
+    commit: 25f596a36cf291f489e5df0c3f862a40670a12f8
 
   etcd:
     github: aca-labs/crystal-etcd

shard.yml

@@ -1,18 +1,18 @@
-name: engine-drivers
+name: drivers
 version: 1.0.0
 
 # compile target
 targets:
-  engine-drivers:
+  test-harness:
     main: src/app.cr
 
 dependencies:
   action-controller:
     github: spider-gazelle/action-controller
     version: ~> 2.0
 
-  engine-driver:
-    github: aca-labs/crystal-engine-driver
+  driver:
+    github: placeos/driver
     branch: master
 
   exec_from: