obsws 0.5.3 → 0.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4aeda40922d842790c7aa969608fe100ad4bd1b9dfc34ba586ec4d126c64abca
-  data.tar.gz: f2a6f162110e7bd46eaec6a5aa5fd1b30c684a8d0b4e1ab6e68b9e127ba1994f
+  metadata.gz: 78061cca710f6c790eacbbfce83036818edbe3c30791783af1f9131ef7407f91
+  data.tar.gz: e7399380cb61847004f1ff29fc5dbf0bc9f55edaa3063a89d99c089e9259c8f2
 SHA512:
-  metadata.gz: '065915f3edb1d8e0235ce88765fe2dde21e300f905d20d569e7cd630db8446a281be695ee8059449f77f8d224eecab4ad445ad379362e5032e5fe36a1d1e675b'
-  data.tar.gz: 562b42f5b9b0152ffe22ba3b5dda1d4553c8f09be645709e589a2cc2d0e245a091396fc6c0bc83eb0a63cb10467f10e42cb25856767ee33dbd478e8d52dc9bb1
+  metadata.gz: d7a6c5fc25ffc88c888d18c55e35a1410ac7780e4c64adf46a8dd52cf10a9ad2416de9acfffb7f33c2836e988103468dfc30336984c0908af11055b5dd6de60d
+  data.tar.gz: c65f732267e7bc4219b491f5e6ec3e5dcc6c6a36d0b891932bbdcff339dddcffea2156ef0d5fc855abdad0915c01f14262c50a33beb7842885f9895a8ff7d2f8

data/README.md

@@ -30,13 +30,17 @@ Pass `host`, `port` and `password` as keyword arguments.
 require "obsws"
 
 class Main
+  INPUT = "Mic/Aux"
+
   def run
     OBSWS::Requests::Client
       .new(host: "localhost", port: 4455, password: "strongpassword")
       .run do |client|
-        # Toggle the mute state of your Mic input
-        client.toggle_input_mute("Mic/Aux")
-      end
+      # Toggle the mute state of your Mic input and print its new mute state
+      client.toggle_input_mute(INPUT)
+      resp = client.get_input_mute(INPUT)
+      puts "Input '#{INPUT}' was set to #{resp.input_muted}"
+    end
   end
 end
 
@@ -115,7 +119,9 @@ If a connection attempt fails or times out an `OBSWSConnectionError` will be rai
 
 If a request fails an `OBSWSRequestError` will be raised with a status code.
 
-- The request name and code are retrievable through attributes {OBSWSRequestError}.req_name and {OBSWSRequestError}.code
+- The request name and code are retrievable through the following attributes:
+  - `req_name`
+  - `code`
 
 For a full list of status codes refer to [Codes](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#requeststatus)
 

data/lib/obsws/base.rb

@@ -1,10 +1,27 @@
 module OBSWS
+  class Identified
+    attr_accessor :state
+
+    def initialize
+      @state = :pending
+    end
+
+    def error_message
+      case @state
+      when :passwordless
+        "auth enabled but no password provided"
+      else
+        "failed to identify client with the websocket server"
+      end
+    end
+  end
+
   class Base
     include Logging
     include Driver::Director
     include Mixin::OPCodes
 
-    attr_reader :closed
+    attr_reader :closed, :identified
     attr_writer :updater
 
     def initialize(**kwargs)
@@ -13,11 +30,12 @@ module OBSWS
       @password = kwargs[:password] || ""
       @subs = kwargs[:subs] || 0
       setup_driver(host, port) and start_driver
+      @identified = Identified.new
       WaitUtil.wait_for_condition(
         "successful identification",
         delay_sec: 0.01,
-        timeout_sec: 3
-      ) { @identified }
+        timeout_sec: kwargs[:connect_timeout] || 3
+      ) { @identified.state != :pending }
     end
 
     private
@@ -38,7 +56,8 @@ module OBSWS
       }
       if auth
         if @password.empty?
-          raise OBSWSError("auth enabled but no password provided")
+          @identified.state = :passwordless
+          return
         end
         logger.info("initiating authentication")
         payload[:d][:authentication] = auth_token(**auth)
@@ -51,7 +70,7 @@ module OBSWS
       when Mixin::OPCodes::HELLO
         identify(data[:d][:authentication])
       when Mixin::OPCodes::IDENTIFIED
-        @identified = true
+        @identified.state = :identified
       when Mixin::OPCodes::EVENT, Mixin::OPCodes::REQUESTRESPONSE
         @updater.call(data[:op], data[:d])
       end

data/lib/obsws/req.rb

@@ -7,11 +7,15 @@ module OBSWS
 
       def initialize(**kwargs)
         @base_client = Base.new(**kwargs)
+        unless @base_client.identified.state == :identified
+          err_msg = @base_client.identified.error_message
+          logger.error(err_msg)
+          raise OBSWSConnectionError.new(err_msg)
+        end
         logger.info("#{self} successfully identified with server")
       rescue Errno::ECONNREFUSED, WaitUtil::TimeoutError => e
-        msg = "#{e.class.name}: #{e.message}"
-        logger.error(msg)
-        raise OBSWSConnectionError.new(msg)
+        logger.error("#{e.class.name}: #{e.message}")
+        raise OBSWSConnectionError.new(e.message)
       else
         @base_client.updater = ->(op_code, data) {
           logger.debug("response received: #{data}")
@@ -36,31 +40,23 @@ module OBSWS
       end
 
       def call(req, data = nil)
-        id = rand(1..1000)
-        @base_client.req(id, req, data)
+        uuid = SecureRandom.uuid
+        @base_client.req(uuid, req, data)
         WaitUtil.wait_for_condition(
           "reponse id to match request id",
           delay_sec: 0.001,
           timeout_sec: 3
-        ) { @response[:requestId] == id }
+        ) { @response[:requestId] == uuid }
         unless @response[:requestStatus][:result]
           raise OBSWSRequestError.new(@response[:requestType], @response[:requestStatus][:code], @response[:requestStatus][:comment])
         end
         @response[:responseData]
       rescue OBSWSRequestError => e
-        err_msg = [
-          "#{e.class.name}: #{e.message}",
-          *e.backtrace
-        ]
-        logger.error(err_msg.join("\n"))
+        logger.error(["#{e.class.name}: #{e.message}", *e.backtrace].join("\n"))
         raise
       rescue WaitUtil::TimeoutError => e
-        err_msg = [
-          "#{e.class.name}: #{e.message}",
-          *e.backtrace
-        ]
-        logger.error(err_msg)
-        raise OBSWSError.new(err_msg)
+        logger.error(["#{e.class.name}: #{e.message}", *e.backtrace].join("\n"))
+        raise OBSWSError.new([e.message, *e.backtrace].join("\n"))
       end
 
       def get_version

data/lib/obsws/version.rb

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

data/lib/obsws.rb

@@ -1,9 +1,10 @@
 require "digest/sha2"
 require "json"
-require "waitutil"
+require "logger"
+require "securerandom"
 require "socket"
+require "waitutil"
 require "websocket/driver"
-require "logger"
 
 require_relative "obsws/logger"
 require_relative "obsws/driver"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: obsws
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.7
 platform: ruby
 authors:
 - onyx_online