obsws 0.5.6 → 0.5.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e1082183fb2605b7ca64747dcd88930516b4132b02f142afa7bb6db58e62120
-  data.tar.gz: 752365a78828d329a6d765a8920398efdf09a426122cc0e7b0380c8db27f9d5a
+  metadata.gz: e289e262d4b31c03c7df28ba6d638c39d04e362fb0173f2535e0bf60f188bd41
+  data.tar.gz: '0925f7d4d8695401d27dfb0d01df2c4fe5751d82d04c9bec752c981c52e1be8e'
 SHA512:
-  metadata.gz: 812133a0bf0019e5cf59c6bcae577c256b862bc497df97f2f1265e88b0c6616277b2afa44f376ae932137b2baac499cca0acf4dbf5d139e15baac268fc629818
-  data.tar.gz: a7ff0fe86ac3d988beee0d6ff2d31fd3b8e235b189afe9265e65d190bbb10953e85e7106578190fd4ece5e4e171d13ecf0aeefb16bd16d719ac203da62449799
+  metadata.gz: 79e9065b4190dd974195079e31dc191fb7412fa143297b1f6dacedb1aae2100ded74abac9c1553b7fc92dce2987f40615d1101dfe5eab987f982a3bd3a7d87dd
+  data.tar.gz: 5137c5ca260beaedcda8936532bd4d04b6154d2c4b7e4a005e5eb12ab070e5502c7231acf2539a90304170bb75ebdd2fdf96a5a7f9bf49a4eafbb6f3370a945f

data/README.md

@@ -119,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: kwargs[:connect_timeout] || 3
-      ) { @identified }
+      ) { @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/event.rb

@@ -71,6 +71,11 @@ module OBSWS
       def initialize(**kwargs)
         kwargs[:subs] ||= SUBS::LOW_VOLUME
         @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}"

data/lib/obsws/req.rb

@@ -7,6 +7,11 @@ 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
         logger.error("#{e.class.name}: #{e.message}")
@@ -43,11 +48,12 @@ module OBSWS
           timeout_sec: 3
         ) { @response[:requestId] == uuid }
         unless @response[:requestStatus][:result]
-          OBSWSRequestError.new(@response[:requestType], @response[:requestStatus][:code], @response[:requestStatus][:comment]) => e
-          logger.error(["#{e.class.name}: #{e.message}", *e.backtrace].join("\n"))
-          raise e
+          raise OBSWSRequestError.new(@response[:requestType], @response[:requestStatus][:code], @response[:requestStatus][:comment])
         end
         @response[:responseData]
+      rescue OBSWSRequestError => e
+        logger.error(["#{e.class.name}: #{e.message}", *e.backtrace].join("\n"))
+        raise
       rescue WaitUtil::TimeoutError => e
         logger.error(["#{e.class.name}: #{e.message}", *e.backtrace].join("\n"))
         raise OBSWSError.new([e.message, *e.backtrace].join("\n"))

data/lib/obsws/version.rb

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

metadata

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