obsws 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 339b5706222511d0cf272eff7040f45dc5bc1cffdfdc6b6d0cc59ea299c325e1
-  data.tar.gz: 2070c51a27e764297d2555bd958411fd8ee06c49f98bd09fa6144f7fba5790c8
+  metadata.gz: 951d942da5f3b7b0895acdd2921ac74b1fa21a1f3e4a56e58ea58c053ca2a51e
+  data.tar.gz: 5f1c953ecfe4b187b63f2aae17cae497e5475dc049c7fb06a5d84451795e7ae3
 SHA512:
-  metadata.gz: c80761585030c73bd304de37ead5ea8f5260116f7e2acb6a15549d920695be579c0fc0ffa9f0485569ffd56f4c11b6ca027711eeadb2ecb81c8b9b3016e68396
-  data.tar.gz: 13fc659eb70544b51555cb9f68608927f64671377f550ae78c3d9a83b60de2f42050d17403ae72aeb701525fc15e48a5086d37f05c780b4055a24cfe252bd0a1
+  metadata.gz: c6aacbdc428e859c97669718b2df5f447fb6a136dd9def91b87613c40b7f25798236db96ddb3c29d629b30dbcebc8250f2566334fa5c82572eec4d9cf64e140f
+  data.tar.gz: d2729c6a1d9c50c37dac5f204d2d654375822b3f70911a420ba81b386d75f8afa2e5f7ead8cce0e496b12d221afeacaa9987119465136da19342c42785fc7102

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+Before any major/minor/patch bump all unit tests will be run to verify they pass.
+
+## [0.0.1] - 2021-10-22
+
+### Added
+
+-   Initial Commit
+-   Base class, Request and Event client classes.
+-   Unit tests
+-   README.md

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Onyx and Iris
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -17,7 +17,7 @@
 pass `host`, `port` and `password` as keyword arguments.
 
 ```ruby
-require_relative "lib/obsws"
+require "obsws"
 
 def main
   r_client =

data/lib/obsws/base.rb

@@ -37,11 +37,8 @@ module OBSWS
       @socket = TCPSocket.new(host, port)
       @driver =
         WebSocket::Driver.client(Socket.new("ws://#{host}:#{port}", @socket))
-      @ready = false
-      @closed = false
       @driver.on :open do |msg|
         LOGGER.debug("driver socket open")
-        @ready = true
       end
       @driver.on :close do |msg|
         LOGGER.debug("driver socket closed")
@@ -51,21 +48,23 @@ module OBSWS
         LOGGER.debug("received [#{msg}] passing to handler")
         msg_handler(JSON.parse(msg.data, symbolize_names: true))
       end
-      Thread.new { start_driver }
+      start_driver
       WaitUtil.wait_for_condition(
-        "driver socket ready",
+        "waiting authentication successful",
         delay_sec: 0.01,
-        timeout_sec: 0.5
-      ) { @ready }
+        timeout_sec: 3
+      ) { @authenticated }
     end
 
     def start_driver
-      @driver.start
+      Thread.new do
+        @driver.start
 
-      loop do
-        @driver.parse(@socket.readpartial(4096))
-      rescue EOFError
-        break
+        loop do
+          @driver.parse(@socket.readpartial(4096))
+        rescue EOFError
+          break
+        end
       end
     end
 
@@ -85,6 +84,7 @@ module OBSWS
           eventSubscriptions: @subs
         }
       }
+      LOGGER.debug("initiating authentication")
       @driver.text(JSON.generate(payload))
     end
 
@@ -92,9 +92,11 @@ module OBSWS
       op_code = data[:op]
       case op_code
       when Mixin::OPCodes::HELLO
+        LOGGER.debug("hello received, passing to auth")
         authenticate(data[:d][:authentication])
       when Mixin::OPCodes::IDENTIFIED
-        LOGGER.debug("Authentication successful")
+        LOGGER.debug("authentication successful")
+        @authenticated = true
       when Mixin::OPCodes::EVENT, Mixin::OPCodes::REQUESTRESPONSE
         changed
         notify_observers(op_code, data[:d])

data/lib/obsws/req.rb

@@ -51,6 +51,10 @@ module OBSWS
           raise OBSWSError.new(error.join("\n"))
         end
         @response[:responseData]
+      rescue WaitUtil::TimeoutError
+        msg = "no response with matching id received"
+        LOGGER.error(msg)
+        raise OBSWSError.new(msg)
       end
 
       def get_version

data/lib/obsws/version.rb

@@ -11,7 +11,7 @@ module OBSWS
     end
 
     def patch
-      1
+      2
     end
 
     def to_a

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: obsws
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - onyx_online
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-22 00:00:00.000000000 Z
+date: 2022-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: observer
@@ -106,15 +106,17 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 11.2.2
-description: A Ruby wrapper around the OBS Websocket v5 protocol
+description: A Ruby wrapper around OBS Websocket v5
 email: code@onyxandiris.online
 executables: []
 extensions: []
 extra_rdoc_files:
 - README.md
 - CHANGELOG.md
+- LICENSE
 files:
 - CHANGELOG.md
+- LICENSE
 - README.md
 - lib/obsws.rb
 - lib/obsws/base.rb
@@ -144,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.12
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: OBS Websocket v5 wrapper