obsws 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8812e43e45759a458a445608809725e4a270daa04a3b715997541eed5bc85e5b
-  data.tar.gz: 0500dfc0223ad3f489016791fc0ca51800ec903d0bf7e57305216ff0844ee722
+  metadata.gz: c128f9332d398f7aebf7cfa0f25c3e5ab1dbd9a1d3b083699ace811a9a8ecc9c
+  data.tar.gz: f587866f6b9546d3d681091f5fd525ba2b8a16f1b243e5f3e49edae61cd79e8e
 SHA512:
-  metadata.gz: ef31376738aa182535f924e6981dab5eb8b83ec0e8254335d15e6fbab6ce952638c43c9769f21bd50c79b4b4e61750a7d16bdd2dc3910636b7e44957177bfdb2
-  data.tar.gz: fb4f85815ecfce661e4c46ba63bf008b4eb3c3d89d728a646b1a9c3ce40f22dea1ea00ded2b272abf82d4bb53e79ac275f1345ba87de45e2e4beb2d57f611f82
+  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/event.rb

@@ -7,38 +7,30 @@ module OBSWS
   module Events
     module SUBS
       NONE = 0
-      GENERAL = (1 << 0)
-      CONFIG = (1 << 1)
-      SCENES = (1 << 2)
-      INPUTS = (1 << 3)
-      TRANSITIONS = (1 << 4)
-      FILTERS = (1 << 5)
-      OUTPUTS = (1 << 6)
-      SCENEITEMS = (1 << 7)
-      MEDIAINPUTS = (1 << 8)
-      VENDORS = (1 << 9)
-      UI = (1 << 10)
+      GENERAL = 1 << 0
+      CONFIG = 1 << 1
+      SCENES = 1 << 2
+      INPUTS = 1 << 3
+      TRANSITIONS = 1 << 4
+      FILTERS = 1 << 5
+      OUTPUTS = 1 << 6
+      SCENEITEMS = 1 << 7
+      MEDIAINPUTS = 1 << 8
+      VENDORS = 1 << 9
+      UI = 1 << 10
 
-      def low_volume
-        GENERAL | CONFIG | SCENES | INPUTS | TRANSITIONS | FILTERS | OUTPUTS |
+      LOW_VOLUME = GENERAL | CONFIG | SCENES | INPUTS | TRANSITIONS | FILTERS | OUTPUTS |
           SCENEITEMS | MEDIAINPUTS | VENDORS | UI
-      end
 
-      INPUTVOLUMEMETERS = (1 << 16)
-      INPUTACTIVESTATECHANGED = (1 << 17)
-      INPUTSHOWSTATECHANGED = (1 << 18)
-      SCENEITEMTRANSFORMCHANGED = (1 << 19)
+      INPUTVOLUMEMETERS = 1 << 16
+      INPUTACTIVESTATECHANGED = 1 << 17
+      INPUTSHOWSTATECHANGED = 1 << 18
+      SCENEITEMTRANSFORMCHANGED = 1 << 19
 
-      def high_volume
-        INPUTVOLUMEMETERS | INPUTACTIVESTATECHANGED | INPUTSHOWSTATECHANGED |
+      HIGH_VOLUME = INPUTVOLUMEMETERS | INPUTACTIVESTATECHANGED | INPUTSHOWSTATECHANGED |
           SCENEITEMTRANSFORMCHANGED
-      end
-
-      def all
-        low_volume | high_volume
-      end
 
-      module_function :low_volume, :high_volume, :all
+      ALL = LOW_VOLUME | HIGH_VOLUME
     end
 
     module Callbacks
@@ -75,7 +67,7 @@ module OBSWS
       include Mixin::OPCodes
 
       def initialize(**kwargs)
-        kwargs[:subs] = SUBS.low_volume
+        kwargs[:subs] ||= SUBS::LOW_VOLUME
         @base_client = Base.new(**kwargs)
         LOGGER.info("#{self} succesfully identified with server")
         @base_client.add_observer(self)

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 }
@@ -77,7 +77,10 @@ module OBSWS
       end
 
       def call_vendor_request(name, type_, data = nil)
-        call(requestType, requestData)
+        payload = { vendorName: name, requestType: type_ }
+        payload[:requestData] = data if data
+        resp = call("CallVendorRequest", payload)
+        Mixin::Response.new(resp, resp.keys)
       end
 
       def get_hotkey_list
@@ -261,7 +264,7 @@ module OBSWS
       end
 
       def get_group_list
-        resp = call("GetSceneList")
+        resp = call("GetGroupList")
         Mixin::Response.new(resp, resp.keys)
       end
 
@@ -329,6 +332,7 @@ module OBSWS
 
       def get_special_inputs
         resp = call("GetSpecialInputs")
+        Mixin::Response.new(resp, resp.keys)
       end
 
       def create_input(
@@ -346,6 +350,7 @@ module OBSWS
           sceneItemEnabled: scene_item_enabled
         }
         resp = call("CreateInput", payload)
+        Mixin::Response.new(resp, resp.keys)
       end
 
       def remove_input(name)
@@ -828,6 +833,7 @@ module OBSWS
 
       def stop_record
         resp = call("StopRecord")
+        Mixin::Response.new(resp, resp.keys)
       end
 
       def toggle_record_pause

data/lib/obsws/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: obsws
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - onyx_online
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-24 00:00:00.000000000 Z
+date: 2022-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: observer