obsws 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ac01e29c9776d0288fc46118847ca4054596a940173b68aec224fb888a7d6ed
-  data.tar.gz: baef83a80ef328743d2579a74d31d7e9b6bc46203f6a5e0af4072dfa08a26ed7
+  metadata.gz: c128f9332d398f7aebf7cfa0f25c3e5ab1dbd9a1d3b083699ace811a9a8ecc9c
+  data.tar.gz: f587866f6b9546d3d681091f5fd525ba2b8a16f1b243e5f3e49edae61cd79e8e
 SHA512:
-  metadata.gz: 71f5a718e0dfaec48b05f4f8a1e49637f0d60a20f56d8870987588cfe4ae1938b67d04043fae20cc612d1f61d8d48b22cff3a908ffe045fb0b1bbf432736f00a
-  data.tar.gz: 7a95faceaa4022bab0c8045b7068bca4ceee6a86a4e21c303e34a589cbc80d45b358ba2f12a365c8c45abed5c2eae4a5b49ae4ea97ac45c06bcf743ab8a796a4
+  metadata.gz: 6386ad4234987f9d527fdadd19674039162b2d446bb7edf1afc44621f65631738f69c1887442f1a99851b82516bbd4f857b13e59999dd987071fd74c9aa8b46a
+  data.tar.gz: 2e1caa11d9206f3029256796aa56f29a1dd1e41f217859c30d8c7bfd0deecc761cf0ba9ca01bf05952bf7617c22bbcfeae849f0df8856462fadff14f05c1623c

data/README.md

@@ -115,6 +115,19 @@ If a request fails an `OBSWSError` will be raised with a status code.
 
 For a full list of status codes refer to [Codes](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#requeststatus)
 
+### Logging
+
+To see the raw messages set log level to debug
+
+example:
+
+```ruby
+require "obsws"
+
+OBSWS::LOGGER.debug!
+...
+```
+
 ### Tests
 
 To run all tests:

data/lib/obsws/base.rb

@@ -45,12 +45,12 @@ module OBSWS
         @closed = true
       end
       @driver.on :message do |msg|
-        LOGGER.debug("received [#{msg}] passing to handler")
+        LOGGER.debug("received: #{msg.data}")
         msg_handler(JSON.parse(msg.data, symbolize_names: true))
       end
       start_driver
       WaitUtil.wait_for_condition(
-        "waiting successful identification",
+        "successful identification",
         delay_sec: 0.01,
         timeout_sec: 3
       ) { @identified }
@@ -75,15 +75,20 @@ module OBSWS
     end
 
     def identify(auth)
-      LOGGER.info("initiating authentication") if auth
-      payload = {
-        op: Mixin::OPCodes::IDENTIFY,
-        d: {
-          rpcVersion: 1,
-          eventSubscriptions: @subs
+      if auth
+        if @password.empty?
+          raise OBSWSError("auth enabled but no password provided")
+        end
+        LOGGER.info("initiating authentication")
+        payload = {
+          op: Mixin::OPCodes::IDENTIFY,
+          d: {
+            rpcVersion: 1,
+            eventSubscriptions: @subs
+          }
         }
-      }
-      payload[:d][:authentication] = auth_token(**auth) if auth
+        payload[:d][:authentication] = auth_token(**auth)
+      end
       @driver.text(JSON.generate(payload))
     end
 
@@ -108,8 +113,8 @@ module OBSWS
         }
       }
       payload[:d][:requestData] = data if data
+      LOGGER.debug("sending request: #{payload}")
       queued = @driver.text(JSON.generate(payload))
-      LOGGER.debug("request with id #{id} queued? #{queued}")
     end
   end
 end

data/lib/obsws/req.rb

@@ -28,7 +28,7 @@ module OBSWS
       ensure
         close
         WaitUtil.wait_for_condition(
-          "driver has closed",
+          "driver to close",
           delay_sec: 0.01,
           timeout_sec: 1
         ) { @base_client.closed }
@@ -42,7 +42,7 @@ module OBSWS
         id = rand(1..1000)
         @base_client.req(id, req, data)
         WaitUtil.wait_for_condition(
-          "reponse id matches request id",
+          "reponse id to match request id",
           delay_sec: 0.001,
           timeout_sec: 3
         ) { @response[:requestId] == id }

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.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - onyx_online
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-18 00:00:00.000000000 Z
+date: 2022-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: observer