deskbot 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30cedc28057bdb758c62aae0df919bb8919619f6a159ebc4ee4cdf440c747d23
-  data.tar.gz: bad0a3559c5e057cc856fbeb6dc81df5ef501ec752a92546c811d67d61d73af1
+  metadata.gz: da7d37a439362a3cb1a37ce6b4fcd61695934e37eb1a7f4fed655890b0951e76
+  data.tar.gz: b282f88eccf10ff28175950599ef2c8d6ea8493e9f64bbd2f25663319df555d8
 SHA512:
-  metadata.gz: 7840b3a2e97c03d7a6f6ba3db796db078fd730df1eafe774873d3432722a80ebba75e0739cb5b98d670e349b3a875e8ac5b0e2cbdf667b91c9a3882ae8fafdeb
-  data.tar.gz: 6d8f4c44b313a04f98e06669397203fce36ee2bae3717c7066d47d65971db533d7552f426b24dd0e23e86a04c689a246d9452920d156a341f57624207a08cdcd
+  metadata.gz: 6a0b040f9fb91fbf6432655fd678f7de9597543c18e0676de849f6a0640ca64dc0b5da239e2f6c8149202b36f3de9904cede8f863e17045f5d1825ec0c7c2e77
+  data.tar.gz: 79dc6bbadff2ffff4b5e74f90c50fa7c1bb531a78ee18757501c4ffe13b2c46bc43d32e781f59adf877e3ee72163472434567fb6e53f1cd37380326c71e190c3

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## 0.2.0 - 2024-09-06
+
+- Adds `Deskbot.screen.listen` for recording device events via `device_query`.
+- Updates dependencies for cargo
+
 ## [0.1.0] - 2024-05-22
 
 - Initial release

data/Cargo.lock

@@ -1,6 +1,6 @@
 # This file is automatically @generated by Cargo.
 # It is not intended for manual editing.
-version = 3
+version = 4
 
 [[package]]
 name = "adler32"
@@ -30,7 +30,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "3a2fd0359d0cd30b15419bcce7e6641a3cbe2046c612b3900216dc64bc989558"
 dependencies = [
  "cocoa",
- "core-foundation",
+ "core-foundation 0.7.0",
  "core-graphics",
  "image",
  "libc",
@@ -43,21 +43,19 @@ dependencies = [
 
 [[package]]
 name = "bindgen"
-version = "0.69.4"
+version = "0.72.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a00dc851838a2120612785d195287475a3ac45514741da670b735818822129a0"
+checksum = "993776b509cfb49c750f11b8f07a46fa23e0a1386ffc01fb1e7d343efc387895"
 dependencies = [
  "bitflags 2.5.0",
  "cexpr",
  "clang-sys",
  "itertools",
- "lazy_static",
- "lazycell",
  "proc-macro2 1.0.83",
  "quote 1.0.36",
  "regex",
  "rustc-hash",
- "shlex",
+ "shlex 1.3.0",
  "syn 2.0.65",
 ]
 
@@ -140,7 +138,7 @@ checksum = "0c49e86fc36d5704151f5996b7b3795385f50ce09e3be0f47a0cfde869681cf8"
 dependencies = [
  "bitflags 1.3.2",
  "block",
- "core-foundation",
+ "core-foundation 0.7.0",
  "core-graphics",
  "foreign-types",
  "libc",
@@ -159,7 +157,17 @@ version = "0.7.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "57d24c7a13c43e870e37c1556b74555437870a04514f7685f5b354e090567171"
 dependencies = [
- "core-foundation-sys",
+ "core-foundation-sys 0.7.0",
+ "libc",
+]
+
+[[package]]
+name = "core-foundation"
+version = "0.9.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "91e195e091a93c46f7102ec7818a2aa394e1e1771c3ab4825963fa03e45afb8f"
+dependencies = [
+ "core-foundation-sys 0.8.7",
  "libc",
 ]
 
@@ -169,6 +177,12 @@ version = "0.7.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "b3a71ab494c0b5b860bdc8407ae08978052417070c2ced38573a9157ad75b8ac"
 
+[[package]]
+name = "core-foundation-sys"
+version = "0.8.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "773648b94d0e5d620f64f280777445740e61fe701025087ec8b57f45c791888b"
+
 [[package]]
 name = "core-graphics"
 version = "0.19.2"
@@ -176,7 +190,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "b3889374e6ea6ab25dba90bb5d96202f61108058361f6dc72e8b03e6f8bbe923"
 dependencies = [
  "bitflags 1.3.2",
- "core-foundation",
+ "core-foundation 0.7.0",
  "foreign-types",
  "libc",
 ]
@@ -230,11 +244,26 @@ name = "deskbot"
 version = "0.1.0"
 dependencies = [
  "autopilot",
+ "device_query",
  "image",
  "magnus",
  "opencv",
 ]
 
+[[package]]
+name = "device_query"
+version = "4.0.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d7331225604b9b097b41872d550134933d4be83465d70a2c4a132b929f99aaca"
+dependencies = [
+ "macos-accessibility-client",
+ "pkg-config",
+ "readkey",
+ "readmouse",
+ "windows 0.48.0",
+ "x11",
+]
+
 [[package]]
 name = "dunce"
 version = "1.0.4"
@@ -348,12 +377,6 @@ version = "1.4.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "e2abad23fbc42b3700f2f279844dc832adb2b2eb069b2df918f455c4e18cc646"
 
-[[package]]
-name = "lazycell"
-version = "1.3.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "830d08ce1d1d941e6b30645f1a0eb5643013d835ce3779a5fc208261dbe10f55"
-
 [[package]]
 name = "libc"
 version = "0.2.155"
@@ -367,7 +390,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "0c2a198fb6b0eada2a8df47933734e6d35d350665a33a3593d7164fa52c75c19"
 dependencies = [
  "cfg-if",
- "windows-targets",
+ "windows-targets 0.52.5",
 ]
 
 [[package]]
@@ -376,11 +399,21 @@ version = "0.10.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "7d947cbb889ed21c2a84be6ffbaebf5b4e0f4340638cba0444907e38b56be084"
 
+[[package]]
+name = "macos-accessibility-client"
+version = "0.0.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "edf7710fbff50c24124331760978fb9086d6de6288dcdb38b25a97f8b1bdebbb"
+dependencies = [
+ "core-foundation 0.9.4",
+ "core-foundation-sys 0.8.7",
+]
+
 [[package]]
 name = "magnus"
-version = "0.6.4"
+version = "0.8.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b1597ef40aa8c36be098249e82c9a20cf7199278ac1c1a1a995eeead6a184479"
+checksum = "3b36a5b126bbe97eb0d02d07acfeb327036c6319fd816139a49824a83b7f9012"
 dependencies = [
  "magnus-macros",
  "rb-sys",
@@ -390,9 +423,9 @@ dependencies = [
 
 [[package]]
 name = "magnus-macros"
-version = "0.6.0"
+version = "0.8.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5968c820e2960565f647819f5928a42d6e874551cab9d88d75e3e0660d7f71e3"
+checksum = "47607461fd8e1513cb4f2076c197d8092d921a1ea75bd08af97398f593751892"
 dependencies = [
  "proc-macro2 1.0.83",
  "quote 1.0.36",
@@ -498,36 +531,37 @@ checksum = "3fdb12b2476b595f9358c5161aa467c2438859caa136dec86c26fdd2efe17b92"
 
 [[package]]
 name = "opencv"
-version = "0.91.3"
+version = "0.100.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e64b5a733be752a917aa27981c1100fbc7836cf2cfe3fb06f5cac691339837b7"
+checksum = "08cb1e12c6c3f533f6b1f2c573c73ea42e07e75c4891af6cea9679508fd61e1f"
 dependencies = [
  "cc",
  "dunce",
  "jobserver",
  "libc",
  "num-traits",
- "once_cell",
  "opencv-binding-generator",
  "pkg-config",
  "semver",
- "shlex",
+ "shlex 2.0.1",
  "vcpkg",
- "windows",
+ "windows 0.62.2",
+ "winsplit",
 ]
 
 [[package]]
 name = "opencv-binding-generator"
-version = "0.89.1"
+version = "0.105.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "81af1298c489597ffdbadc7710673ec26f8a2440228992681ffa3b8f00233bd9"
+checksum = "619e1ab8e9b95beb1eb7919ab34710027894db29428634f6680dfde15eb004f0"
 dependencies = [
  "clang",
  "clang-sys",
  "dunce",
- "once_cell",
  "percent-encoding",
  "regex",
+ "semver",
+ "shlex 2.0.1",
 ]
 
 [[package]]
@@ -659,18 +693,18 @@ dependencies = [
 
 [[package]]
 name = "rb-sys"
-version = "0.9.97"
+version = "0.9.130"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "47d30bcad206b51f2f66121190ca678dce1fdf3a2eae0ac5d838d1818b19bdf5"
+checksum = "02faf625bb10ba893e3ae620f19c9fb1b5f8fcae0fe4eb86bb3f2230fad75edb"
 dependencies = [
  "rb-sys-build",
 ]
 
 [[package]]
 name = "rb-sys-build"
-version = "0.9.97"
+version = "0.9.130"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "3cbd92f281615f3c2dcb9dcb0f0576624752afbf9a7f99173b37c4b55b62dd8a"
+checksum = "05be6f9c86fe5482808162826f6c047d093b3670582296c770de1d94f8066694"
 dependencies = [
  "bindgen",
  "lazy_static",
@@ -683,9 +717,21 @@ dependencies = [
 
 [[package]]
 name = "rb-sys-env"
-version = "0.1.2"
+version = "0.2.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a35802679f07360454b418a5d1735c89716bde01d35b1560fc953c1415a0b3bb"
+checksum = "cca7ad6a7e21e72151d56fe2495a259b5670e204c3adac41ee7ef676ea08117a"
+
+[[package]]
+name = "readkey"
+version = "0.2.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8a36870cefdfcff57edbc0fa62165f42dfd4e5a0d8965117c1ea84c5700e4450"
+
+[[package]]
+name = "readmouse"
+version = "0.2.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "be105c72a1e6a5a1198acee3d5b506a15676b74a02ecd78060042a447f408d94"
 
 [[package]]
 name = "regex"
@@ -718,9 +764,9 @@ checksum = "adad44e29e4c806119491a7f06f03de4d1af22c3a680dd47f1e6e179439d1f56"
 
 [[package]]
 name = "rustc-hash"
-version = "1.1.0"
+version = "2.1.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "08d43f7aa6b08d49f382cde6a7982047c3426db949b1424bc4b7ec9ae12c6ce2"
+checksum = "6b1e7f9a428571be2dc5bc0505c13fb6bf936822b894ec87abf8a08a4e51742d"
 
 [[package]]
 name = "scoped_threadpool"
@@ -758,6 +804,12 @@ version = "1.3.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "0fda2ff0d084019ba4d7c6f371c95d8fd75ce3524c3cb8fb653a3023f6323e64"
 
+[[package]]
+name = "shlex"
+version = "2.0.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f8fadd59c855ef2080decdef8ff161eb6661b86933c9d82e5ba29dc602a55aba"
+
 [[package]]
 name = "syn"
 version = "0.15.44"
@@ -840,31 +892,63 @@ checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f"
 
 [[package]]
 name = "windows"
-version = "0.56.0"
+version = "0.48.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e686886bc078bc1b0b600cac0147aadb815089b6e4da64016cbd754b6342700f"
+dependencies = [
+ "windows-targets 0.48.5",
+]
+
+[[package]]
+name = "windows"
+version = "0.62.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "527fadee13e0c05939a6a05d5bd6eec6cd2e3dbd648b9f8e447c6518133d8580"
+dependencies = [
+ "windows-collections",
+ "windows-core",
+ "windows-future",
+ "windows-numerics",
+]
+
+[[package]]
+name = "windows-collections"
+version = "0.3.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "1de69df01bdf1ead2f4ac895dc77c9351aefff65b2f3db429a343f9cbf05e132"
+checksum = "23b2d95af1a8a14a3c7367e1ed4fc9c20e0a26e79551b1454d72583c97cc6610"
 dependencies = [
  "windows-core",
- "windows-targets",
 ]
 
 [[package]]
 name = "windows-core"
-version = "0.56.0"
+version = "0.62.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "4698e52ed2d08f8658ab0c39512a7c00ee5fe2688c65f8c0a4f06750d729f2a6"
+checksum = "b8e83a14d34d0623b51dce9581199302a221863196a1dde71a7663a4c2be9deb"
 dependencies = [
  "windows-implement",
  "windows-interface",
+ "windows-link",
  "windows-result",
- "windows-targets",
+ "windows-strings",
+]
+
+[[package]]
+name = "windows-future"
+version = "0.3.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e1d6f90251fe18a279739e78025bd6ddc52a7e22f921070ccdc67dde84c605cb"
+dependencies = [
+ "windows-core",
+ "windows-link",
+ "windows-threading",
 ]
 
 [[package]]
 name = "windows-implement"
-version = "0.56.0"
+version = "0.60.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f6fc35f58ecd95a9b71c4f2329b911016e6bec66b3f2e6a4aad86bd2e99e2f9b"
+checksum = "053e2e040ab57b9dc951b72c264860db7eb3b0200ba345b4e4c3b14f67855ddf"
 dependencies = [
  "proc-macro2 1.0.83",
  "quote 1.0.36",
@@ -873,22 +957,62 @@ dependencies = [
 
 [[package]]
 name = "windows-interface"
-version = "0.56.0"
+version = "0.59.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "08990546bf4edef8f431fa6326e032865f27138718c587dc21bc0265bbcb57cc"
+checksum = "3f316c4a2570ba26bbec722032c4099d8c8bc095efccdc15688708623367e358"
 dependencies = [
  "proc-macro2 1.0.83",
  "quote 1.0.36",
  "syn 2.0.65",
 ]
 
+[[package]]
+name = "windows-link"
+version = "0.2.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f0805222e57f7521d6a62e36fa9163bc891acd422f971defe97d64e70d0a4fe5"
+
+[[package]]
+name = "windows-numerics"
+version = "0.3.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6e2e40844ac143cdb44aead537bbf727de9b044e107a0f1220392177d15b0f26"
+dependencies = [
+ "windows-core",
+ "windows-link",
+]
+
 [[package]]
 name = "windows-result"
-version = "0.1.1"
+version = "0.4.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7781fa89eaf60850ac3d2da7af8e5242a5ea78d1a11c49bf2910bb5a73853eb5"
+dependencies = [
+ "windows-link",
+]
+
+[[package]]
+name = "windows-strings"
+version = "0.5.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7837d08f69c77cf6b07689544538e017c1bfcf57e34b4c0ff58e6c2cd3b37091"
+dependencies = [
+ "windows-link",
+]
+
+[[package]]
+name = "windows-targets"
+version = "0.48.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "749f0da9cc72d82e600d8d2e44cadd0b9eedb9038f71a1c58556ac1c5791813b"
+checksum = "9a2fa6e2155d7247be68c096456083145c183cbbbc2764150dda45a87197940c"
 dependencies = [
- "windows-targets",
+ "windows_aarch64_gnullvm 0.48.5",
+ "windows_aarch64_msvc 0.48.5",
+ "windows_i686_gnu 0.48.5",
+ "windows_i686_msvc 0.48.5",
+ "windows_x86_64_gnu 0.48.5",
+ "windows_x86_64_gnullvm 0.48.5",
+ "windows_x86_64_msvc 0.48.5",
 ]
 
 [[package]]
@@ -897,28 +1021,55 @@ version = "0.52.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "6f0713a46559409d202e70e28227288446bf7841d3211583a4b53e3f6d96e7eb"
 dependencies = [
- "windows_aarch64_gnullvm",
- "windows_aarch64_msvc",
- "windows_i686_gnu",
+ "windows_aarch64_gnullvm 0.52.5",
+ "windows_aarch64_msvc 0.52.5",
+ "windows_i686_gnu 0.52.5",
  "windows_i686_gnullvm",
- "windows_i686_msvc",
- "windows_x86_64_gnu",
- "windows_x86_64_gnullvm",
- "windows_x86_64_msvc",
+ "windows_i686_msvc 0.52.5",
+ "windows_x86_64_gnu 0.52.5",
+ "windows_x86_64_gnullvm 0.52.5",
+ "windows_x86_64_msvc 0.52.5",
+]
+
+[[package]]
+name = "windows-threading"
+version = "0.2.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3949bd5b99cafdf1c7ca86b43ca564028dfe27d66958f2470940f73d86d75b37"
+dependencies = [
+ "windows-link",
 ]
 
+[[package]]
+name = "windows_aarch64_gnullvm"
+version = "0.48.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2b38e32f0abccf9987a4e3079dfb67dcd799fb61361e53e2882c3cbaf0d905d8"
+
 [[package]]
 name = "windows_aarch64_gnullvm"
 version = "0.52.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "7088eed71e8b8dda258ecc8bac5fb1153c5cffaf2578fc8ff5d61e23578d3263"
 
+[[package]]
+name = "windows_aarch64_msvc"
+version = "0.48.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "dc35310971f3b2dbbf3f0690a219f40e2d9afcf64f9ab7cc1be722937c26b4bc"
+
 [[package]]
 name = "windows_aarch64_msvc"
 version = "0.52.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "9985fd1504e250c615ca5f281c3f7a6da76213ebd5ccc9561496568a2752afb6"
 
+[[package]]
+name = "windows_i686_gnu"
+version = "0.48.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a75915e7def60c94dcef72200b9a8e58e5091744960da64ec734a6c6e9b3743e"
+
 [[package]]
 name = "windows_i686_gnu"
 version = "0.52.5"
@@ -931,30 +1082,60 @@ version = "0.52.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "87f4261229030a858f36b459e748ae97545d6f1ec60e5e0d6a3d32e0dc232ee9"
 
+[[package]]
+name = "windows_i686_msvc"
+version = "0.48.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8f55c233f70c4b27f66c523580f78f1004e8b5a8b659e05a4eb49d4166cca406"
+
 [[package]]
 name = "windows_i686_msvc"
 version = "0.52.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "db3c2bf3d13d5b658be73463284eaf12830ac9a26a90c717b7f771dfe97487bf"
 
+[[package]]
+name = "windows_x86_64_gnu"
+version = "0.48.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "53d40abd2583d23e4718fddf1ebec84dbff8381c07cae67ff7768bbf19c6718e"
+
 [[package]]
 name = "windows_x86_64_gnu"
 version = "0.52.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "4e4246f76bdeff09eb48875a0fd3e2af6aada79d409d33011886d3e1581517d9"
 
+[[package]]
+name = "windows_x86_64_gnullvm"
+version = "0.48.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0b7b52767868a23d5bab768e390dc5f5c55825b6d30b86c844ff2dc7414044cc"
+
 [[package]]
 name = "windows_x86_64_gnullvm"
 version = "0.52.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "852298e482cd67c356ddd9570386e2862b5673c85bd5f88df9ab6802b334c596"
 
+[[package]]
+name = "windows_x86_64_msvc"
+version = "0.48.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ed94fce61571a4006852b7389a063ab983c02eb1bb37b47f8272ce92d06d9538"
+
 [[package]]
 name = "windows_x86_64_msvc"
 version = "0.52.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "bec47e5bfd1bff0eeaf6d8b485cc1074891a197ab4225d504cb7a1ab88b02bf0"
 
+[[package]]
+name = "winsplit"
+version = "0.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3ab703352da6a72f35c39a533526393725640575bb211f61987a2748323ad956"
+
 [[package]]
 name = "x11"
 version = "2.21.0"

data/README.md

@@ -16,6 +16,9 @@ so I've rewritten matching templates to use
 
 ## Installation
 
+You will need to have installed [Rust](https://www.rust-lang.org/tools/install) and
+[opencv](https://github.com/twistedfall/opencv-rust/blob/master/INSTALL.md)
+
 Install the gem and add to the application's Gemfile by executing:
 
     $ bundle add deskbot
@@ -215,6 +218,40 @@ bitmap.all_color([255, 255, 255, 0])
 
 These will return `Deskbot::Point` objects with `x` and `y` attributes.
 
+### Listening for device events
+
+You can record device events (key presses, mouse button presses and mouse
+movements) with a blocking `listen` loop. Each event is yielded:
+
+- `Deskbot::Event::KeyDown`,
+- `Deskbot::Event::KeyUp`
+- `Deskbot::Event::MouseDown`
+- `Deskbot::Event::MouseUp`
+- `Deskbot::Event::MouseMove`
+
+```ruby
+Deskbot.screen.listen do |event|
+  case event
+  when Deskbot::Event::MouseMove
+    puts "mouse moved to #{event.x}, #{event.y}"
+  when Deskbot::Event::KeyDown
+    puts "key down: #{event.key}"
+  when Deskbot::Event::KeyUp
+    puts "key up: #{event.key}"
+  when Deskbot::Event::MouseDown
+    puts "button down: #{event.button}"
+  when Deskbot::Event::MouseUp
+    puts "button up: #{event.button}"
+  end
+end
+```
+
+Each event exposes only the fields relevant to it: key events have `key`, mouse
+button events have `button`, and mouse movement events have `x`, `y` and
+`coords`.
+
+`listen` blocks the calling thread. Raising inside the block stops listening.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.

data/ext/deskbot/Cargo.toml

@@ -10,7 +10,8 @@ publish = false
 crate-type = ["cdylib"]
 
 [dependencies]
-opencv = { version = "0.91.3", features = ["clang-runtime"] }
-magnus = { version = "0.6.2" }
-autopilot = { version = "0.4.0" }
-image = { version = "0.22.4" }
+opencv = { version = "0.100", features = ["clang-runtime"] }
+magnus = { version = "0.8" }
+autopilot = { version = "0.4" }
+device_query = "4.0"
+image = { version = "0.22" }

data/ext/deskbot/src/bitmap.rs

@@ -1,7 +1,7 @@
 extern crate autopilot;
 
 use image::open;
-use magnus::exception;
+use magnus::{Error, Ruby};
 use std::collections::HashMap;
 
 extern crate opencv;
@@ -22,8 +22,8 @@ impl Bitmap {
     pub fn save(&self, path: String) -> Result<bool, magnus::Error> {
         match self.0.image.save(path) {
             Ok(_) => Ok(true),
-            Err(_) => Err(magnus::Error::new(
-                exception::runtime_error(),
+            Err(_) => Err(Error::new(
+                Ruby::get().unwrap().exception_runtime_error(),
                 "Could not save the image",
             )),
         }

data/ext/deskbot/src/lib.rs

@@ -1,11 +1,12 @@
-use magnus::{class, function, method, prelude::*, Error, Ruby};
+use magnus::{function, method, prelude::*, Error, Ruby};
 extern crate autopilot;
 
+mod alert;
 mod bitmap;
 mod keys;
+mod listen;
 mod mouse;
 mod screen;
-mod alert;
 
 #[magnus::init]
 fn init(ruby: &Ruby) -> Result<(), Error> {
@@ -28,6 +29,8 @@ fn init(ruby: &Ruby) -> Result<(), Error> {
     module.define_singleton_method("is_point_visible", function!(screen::is_point_visible, 2))?;
     module.define_singleton_method("is_area_visible", function!(screen::is_rect_visible, 4))?;
 
+    module.define_singleton_method("listen", function!(listen::listen, 0))?;
+
     module.define_singleton_method("alert", function!(alert::alert, 1))?;
 
     module.define_singleton_method(
@@ -36,7 +39,7 @@ fn init(ruby: &Ruby) -> Result<(), Error> {
     )?;
     module.define_singleton_method("capture_screen", function!(bitmap::capture_screen, 0))?;
 
-    let bitmap = module.define_class("Bitmap", class::object())?;
+    let bitmap = module.define_class("Bitmap", ruby.class_object())?;
     bitmap.define_method("bounds", method!(bitmap::Bitmap::bounds, 0))?;
     bitmap.define_method("find", method!(bitmap::Bitmap::find, 2))?;
     bitmap.define_method("all", method!(bitmap::Bitmap::all, 2))?;

data/ext/deskbot/src/listen.rs

@@ -0,0 +1,195 @@
+use std::sync::{
+    mpsc::{self, Receiver, Sender},
+    Arc, Mutex, OnceLock,
+};
+use std::time::{Duration, SystemTime, UNIX_EPOCH};
+
+use device_query::{
+    DeviceEvents, DeviceEventsHandler, Keycode, MouseButton, MousePosition,
+};
+use magnus::{Error, RHash, Ruby, Value};
+
+/// An event captured from `device_query`, buffered until the Ruby listener
+/// thread is ready to handle it.
+enum RawEvent {
+    KeyDown(String),
+    KeyUp(String),
+    MouseDown(usize),
+    MouseUp(usize),
+    MouseMove(i64, i64),
+}
+
+/// A buffered event along with the wall-clock time (seconds since the Unix
+/// epoch, as a float) at which it was captured by `device_query`.
+type BufferedEvent = (f64, RawEvent);
+
+/// Returns the current wall-clock time in seconds (with fractional precision)
+/// since the Unix epoch.
+fn now() -> f64 {
+    let duration = SystemTime::now()
+        .duration_since(UNIX_EPOCH)
+        .expect("system clock is set before the Unix epoch");
+    duration.as_secs() as f64 + f64::from(duration.subsec_nanos()) / 1_000_000_000.0
+}
+
+/// `device_query` only allows a single event loop to be initialised for the
+/// lifetime of the process. The loop keeps polling in the background once it
+/// has started, so we cache the first `DeviceEventsHandler` we manage to
+/// create and reuse it for every `listen` call.
+static HANDLER: OnceLock<Result<DeviceEventsHandler, String>> = OnceLock::new();
+
+fn handler() -> Result<&'static DeviceEventsHandler, String> {
+    HANDLER.get_or_init(|| {
+        DeviceEventsHandler::new(Duration::from_millis(10))
+            .ok_or_else(|| "device event loop is already running".to_string())
+    })
+    .as_ref()
+    .map_err(|message| message.clone())
+}
+
+/// Converts a `Keycode`'s `Debug` variant name (e.g. `LControl`) into a
+/// lowercase snake_case string (e.g. `l_control`).
+fn keycode_to_name(keycode: Keycode) -> String {
+    let variant = format!("{keycode:?}");
+    let chars: Vec<char> = variant.chars().collect();
+    let mut name = String::with_capacity(variant.len());
+
+    for (index, character) in chars.iter().enumerate() {
+        if character.is_ascii_uppercase() {
+            let previous_is_upper = index > 0 && chars[index - 1].is_ascii_uppercase();
+            let next_is_lower =
+                index + 1 < chars.len() && chars[index + 1].is_ascii_lowercase();
+
+            if index > 0 && (next_is_lower || !previous_is_upper) {
+                name.push('_');
+            }
+
+            name.push(character.to_ascii_lowercase());
+        } else {
+            name.push(*character);
+        }
+    }
+
+    name
+}
+
+/// Turns a buffered event into a Ruby `Hash` describing it.
+fn event_to_ruby(ruby: &Ruby, event: BufferedEvent) -> Result<RHash, Error> {
+    let (recorded_at, event) = event;
+    let hash = ruby.hash_new();
+    hash.aset("recorded_at", recorded_at)?;
+
+    match event {
+        RawEvent::KeyDown(key) => {
+            hash.aset("type", "key_down")?;
+            hash.aset("key", key)?;
+        }
+        RawEvent::KeyUp(key) => {
+            hash.aset("type", "key_up")?;
+            hash.aset("key", key)?;
+        }
+        RawEvent::MouseDown(button) => {
+            hash.aset("type", "mouse_down")?;
+            hash.aset("button", button as i64)?;
+        }
+        RawEvent::MouseUp(button) => {
+            hash.aset("type", "mouse_up")?;
+            hash.aset("button", button as i64)?;
+        }
+        RawEvent::MouseMove(x, y) => {
+            hash.aset("type", "mouse_move")?;
+            hash.aset("x", x)?;
+            hash.aset("y", y)?;
+        }
+    }
+
+    Ok(hash)
+}
+
+/// Registers `device_query` callbacks that buffer events for the blocking
+/// listener to drain. Each returned guard keeps its callback alive; dropping
+/// them unregisters the callback.
+#[allow(clippy::type_complexity)]
+fn register_callbacks(
+    handler: &DeviceEventsHandler,
+    sender: &Sender<BufferedEvent>,
+) -> (
+    device_query::CallbackGuard<impl Fn(&Keycode) + Send + Sync + 'static>,
+    device_query::CallbackGuard<impl Fn(&Keycode) + Send + Sync + 'static>,
+    device_query::CallbackGuard<impl Fn(&MouseButton) + Send + Sync + 'static>,
+    device_query::CallbackGuard<impl Fn(&MouseButton) + Send + Sync + 'static>,
+    device_query::CallbackGuard<impl Fn(&MousePosition) + Send + Sync + 'static>,
+) {
+    let sender = Arc::new(Mutex::new(sender.clone()));
+
+    let key_down_sender = Arc::clone(&sender);
+    let key_down = handler.on_key_down(move |key: &Keycode| {
+        let _ = key_down_sender.lock().map(|sender| {
+            sender.send((now(), RawEvent::KeyDown(keycode_to_name(*key))))
+        });
+    });
+
+    let key_up_sender = Arc::clone(&sender);
+    let key_up = handler.on_key_up(move |key: &Keycode| {
+        let _ = key_up_sender.lock().map(|sender| {
+            sender.send((now(), RawEvent::KeyUp(keycode_to_name(*key))))
+        });
+    });
+
+    let mouse_down_sender = Arc::clone(&sender);
+    let mouse_down = handler.on_mouse_down(move |button: &MouseButton| {
+        let _ = mouse_down_sender
+            .lock()
+            .map(|sender| sender.send((now(), RawEvent::MouseDown(*button))));
+    });
+
+    let mouse_up_sender = Arc::clone(&sender);
+    let mouse_up = handler.on_mouse_up(move |button: &MouseButton| {
+        let _ = mouse_up_sender
+            .lock()
+            .map(|sender| sender.send((now(), RawEvent::MouseUp(*button))));
+    });
+
+    let mouse_move_sender = Arc::clone(&sender);
+    let mouse_move = handler.on_mouse_move(move |position: &MousePosition| {
+        let _ = mouse_move_sender.lock().map(|sender| {
+            sender.send((
+                now(),
+                RawEvent::MouseMove(position.0 as i64, position.1 as i64),
+            ))
+        });
+    });
+
+    (key_down, key_up, mouse_down, mouse_up, mouse_move)
+}
+
+/// Blocks the calling Ruby thread, yielding a `Hash` describing each device
+/// event (key down/up, mouse down/up/move) to the given block until it raises.
+pub fn listen(ruby: &Ruby) -> Result<(), Error> {
+    if !ruby.block_given() {
+        return Err(Error::new(
+            ruby.exception_arg_error(),
+            "no block given",
+        ));
+    }
+
+    let handler = handler().map_err(|message| {
+        Error::new(ruby.exception_arg_error(), message)
+    })?;
+    let (sender, receiver): (Sender<BufferedEvent>, Receiver<BufferedEvent>) = mpsc::channel();
+
+    let (_key_down, _key_up, _mouse_down, _mouse_up, _mouse_move) =
+        register_callbacks(handler, &sender);
+
+    loop {
+        let event = match receiver.recv() {
+            Ok(event) => event,
+            Err(_) => break,
+        };
+
+        let hash = event_to_ruby(ruby, event)?;
+        let _: Value = ruby.yield_value(hash)?;
+    }
+
+    Ok(())
+}

data/lib/deskbot/event.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module Deskbot
+  # Base class for the distinct device events yielded by {Screen#listen}.
+  #
+  # Listening yields an instance of one of the concrete subclasses, each of
+  # which exposes only the fields relevant to it:
+  #
+  # - {Event::KeyDown} / {Event::KeyUp} - expose `key`
+  # - {Event::MouseDown} / {Event::MouseUp} - expose `button`
+  # - {Event::MouseMove} - exposes `x`, `y` and `coords`
+  #
+  # Dispatch on the event's class rather than on a `type` value:
+  #
+  #   Deskbot.screen.listen do |event|
+  #     case event
+  #     when Deskbot::Event::KeyDown   then puts "pressed #{event.key}"
+  #     when Deskbot::Event::KeyUp     then puts "released #{event.key}"
+  #     when Deskbot::Event::MouseDown then puts "button down: #{event.button}"
+  #     when Deskbot::Event::MouseUp   then puts "button up: #{event.button}"
+  #     when Deskbot::Event::MouseMove then puts event.coords.inspect
+  #     end
+  #   end
+  #
+  # Base `Event` is abstract and is never instantiated directly; use
+  # {Event.build} to turn a native payload into the matching subclass.
+  class Event
+    # The time the event was recorded. Every concrete event exposes it.
+    attr_reader :recorded_at
+
+    # Builds the concrete event described by the raw hash yielded by the native
+    # listener.
+    def self.build(payload)
+      subclass = {
+        "key_down" => Event::KeyDown,
+        "key_up" => Event::KeyUp,
+        "mouse_down" => Event::MouseDown,
+        "mouse_up" => Event::MouseUp,
+        "mouse_move" => Event::MouseMove
+      }[payload["type"]]
+
+      unless subclass
+        raise ArgumentError,
+          "unknown event type: #{payload["type"].inspect}"
+      end
+
+      subclass.build(payload)
+    end
+
+    # Builds the recorded-at `Time` for an event from its native payload.
+    def self.recorded_at_from(payload)
+      Time.at(payload["recorded_at"])
+    end
+
+    # A key was pressed down. Exposes the pressed {#key}.
+    class KeyDown < Event
+      attr_reader :key
+
+      def initialize(key:, recorded_at:)
+        @key = key.to_sym
+        @recorded_at = recorded_at
+      end
+
+      def self.build(payload)
+        new(key: payload["key"], recorded_at: recorded_at_from(payload))
+      end
+    end
+
+    # A key was released. Exposes the released {#key}.
+    class KeyUp < Event
+      attr_reader :key
+
+      def initialize(key:, recorded_at:)
+        @key = key.to_sym
+        @recorded_at = recorded_at
+      end
+
+      def self.build(payload)
+        new(key: payload["key"], recorded_at: recorded_at_from(payload))
+      end
+    end
+
+    # A mouse button was pressed down. Exposes the pressed {#button}.
+    class MouseDown < Event
+      attr_reader :button
+
+      def initialize(button:, recorded_at:)
+        @button = button
+        @recorded_at = recorded_at
+      end
+
+      def self.build(payload)
+        new(button: payload["button"], recorded_at: recorded_at_from(payload))
+      end
+    end
+
+    # A mouse button was released. Exposes the released {#button}.
+    class MouseUp < Event
+      attr_reader :button
+
+      def initialize(button:, recorded_at:)
+        @button = button
+        @recorded_at = recorded_at
+      end
+
+      def self.build(payload)
+        new(button: payload["button"], recorded_at: recorded_at_from(payload))
+      end
+    end
+
+    # The mouse moved to a new position. Exposes {#x}, {#y} and {#coords}.
+    class MouseMove < Event
+      attr_reader :x, :y
+
+      def initialize(x:, y:, recorded_at:) # rubocop:disable Naming/MethodParameterName
+        @x = x
+        @y = y
+        @recorded_at = recorded_at
+      end
+
+      def self.build(payload)
+        new(
+          x: payload["x"],
+          y: payload["y"],
+          recorded_at: recorded_at_from(payload)
+        )
+      end
+
+      # Returns the mouse position as `[x, y]`.
+      def coords
+        [x, y]
+      end
+    end
+  end
+end

data/lib/deskbot/providers/autopilot.rb

@@ -21,6 +21,7 @@ module Deskbot
       # def screen_scale
       # def is_point_visible
       # def is_area_visible
+      # def listen
       # def capture_screen
       # def capture_screen_portion
     end

data/lib/deskbot/screen.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Deskbot
-  class Screen
+  class Screen # rubocop:disable Metrics/ClassLength
     # This is the API for any provider
 
     def initialize(provider)
@@ -127,5 +127,16 @@ module Deskbot
 
       Deskbot::Bitmap.new(bitmap)
     end
+
+    # Blocks listening for device events (key down/up, mouse down/up/move),
+    # yielding each concrete event (a subclass of {Event}) to the block. Raises
+    # to stop listening.
+    def listen
+      raise ArgumentError, "a block is required" unless block_given?
+
+      @provider.listen do |payload|
+        yield Event.build(payload)
+      end
+    end
   end
 end

data/lib/deskbot/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Deskbot
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/deskbot.rb

@@ -12,6 +12,7 @@ require_relative "deskbot/point"
 require_relative "deskbot/color"
 require_relative "deskbot/size"
 require_relative "deskbot/area"
+require_relative "deskbot/event"
 require_relative "deskbot/bitmap"
 
 require "deskbot/providers/autopilot/bitmap"

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: deskbot
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Nolan J Tait
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-25 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-matcher
@@ -88,12 +87,14 @@ files:
 - ext/deskbot/src/bitmap.rs
 - ext/deskbot/src/keys.rs
 - ext/deskbot/src/lib.rs
+- ext/deskbot/src/listen.rs
 - ext/deskbot/src/mouse.rs
 - ext/deskbot/src/screen.rs
 - lib/deskbot.rb
 - lib/deskbot/area.rb
 - lib/deskbot/bitmap.rb
 - lib/deskbot/color.rb
+- lib/deskbot/event.rb
 - lib/deskbot/point.rb
 - lib/deskbot/providers/autopilot.rb
 - lib/deskbot/providers/autopilot/bitmap.rb
@@ -101,7 +102,6 @@ files:
 - lib/deskbot/size.rb
 - lib/deskbot/types.rb
 - lib/deskbot/version.rb
-- sig/deskbot.rbs
 homepage: https://github.com/nolantait/desktbot
 licenses:
 - MIT
@@ -110,7 +110,6 @@ metadata:
   source_code_uri: https://github.com/nolantait/desktbot
   changelog_uri: https://github.com/nolantait/desktbot
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -125,8 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 3.3.11
 requirements: []
-rubygems_version: 3.5.9
-signing_key:
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Ruby dekstop automation
 test_files: []

data/sig/deskbot.rbs

@@ -1,4 +0,0 @@
-module Deskbot
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end