obsws 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c275787361111b1b84f2f5023d5d24e45b174540a8e687aaaae2fa647b89eecc
-  data.tar.gz: 738122bc2be93730ef117240c467ec261ab6918c406dea273eefc134d5f74362
+  metadata.gz: c7826cef2f98842479438cf09ac7dec77e7c8e24a8adca3dcf55fce92676c2f4
+  data.tar.gz: 0c5dc416a213a344488cf2059d789aa07536d83440b14fd9c2d41918821e5a9c
 SHA512:
-  metadata.gz: 121d5bf831969d5bd92244efb4c6ae94fdea7e6a47b16c9b7bbee80626e6739664433bb04e3225aef2eaa759127ee074841e05b430331c3bd987762c8623f15c
-  data.tar.gz: e67e598037d689469263721e2408eacebd6469e32a5b55e50f43876efe33d5b3b581e99ec2d804ed28549079f6b4855c76e8508e65e46d504bca12e75e32fff9
+  metadata.gz: 178671ff1a8f5577694fe4d7f02e0c96f6d37ef50ec36ba6ee802f6999ad5fc470695ade79caf2393b32eb9d0fc325236131490f5348a020d9fb73eb6aaa219d
+  data.tar.gz: bb0fe9a35b56699bd64b0f0d55d1f203ceaa7fe1abfafcc5d3ca23cb3207275662f223a1d4a124e1a89f52c724d688fdfaf5f548bec5586155ee732d99bebb08

data/README.md

@@ -109,7 +109,13 @@ def on_scene_created(data):
 
 ### Errors
 
-If a request fails an `OBSWSError` will be raised with a status code.
+If a general error occurs an `OBSWSError` will be raised.
+
+If a connection attempt fails or times out an `OBSWSConnectionError` will be raised.
+
+If a request fails an `OBSWSRequestError` will be raised with a status code.
+
+- The request name and code are retrievable through attributes {OBSWSRequestError}.name and {OBSWSRequestError}.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,12 +1,3 @@
-require "digest/sha2"
-require "json"
-require "waitutil"
-
-require_relative "driver"
-require_relative "error"
-require_relative "logger"
-require_relative "mixin"
-
 module OBSWS
   class Base
     include Logging
@@ -21,8 +12,7 @@ module OBSWS
       port = kwargs[:port] || 4455
       @password = kwargs[:password] || ""
       @subs = kwargs[:subs] || 0
-      setup_driver(host, port)
-      start_driver
+      setup_driver(host, port) and start_driver
       WaitUtil.wait_for_condition(
         "successful identification",
         delay_sec: 0.01,

data/lib/obsws/driver.rb

@@ -1,6 +1,3 @@
-require "socket"
-require "websocket/driver"
-
 module OBSWS
   module Driver
     class Socket

data/lib/obsws/event.rb

@@ -1,9 +1,3 @@
-require "json"
-
-require_relative "util"
-require_relative "mixin"
-require_relative "logger"
-
 module OBSWS
   module Events
     module SUBS
@@ -42,15 +36,16 @@ module OBSWS
       end
 
       def add_observer(observer)
-        observer = [observer] if !observer.respond_to? :each
+        observer = [observer] unless observer.respond_to? :each
         observer.each { |o| observers << o unless observers.include? o }
       end
 
       def remove_observer(observer)
-        observers.delete(observer)
+        observer = [observer] unless observer.respond_to? :each
+        observers.reject! { |o| observer.include? o }
       end
 
-      def notify_observers(event, data)
+      private def notify_observers(event, data)
         observers.each do |o|
           if o.is_a? Method
             if o.name.to_s == "on_#{snakecase(event)}"
@@ -62,6 +57,7 @@ module OBSWS
         end
       end
 
+      alias_method :callbacks, :observers
       alias_method :register, :add_observer
       alias_method :deregister, :remove_observer
     end
@@ -76,6 +72,11 @@ module OBSWS
         kwargs[:subs] ||= SUBS::LOW_VOLUME
         @base_client = Base.new(**kwargs)
         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)
+      else
         @base_client.updater = ->(op_code, data) {
           if op_code == Mixin::OPCodes::EVENT
             logger.debug("received: #{data}")

data/lib/obsws/logger.rb

@@ -1,9 +1,7 @@
-require "logger"
-
 module OBSWS
   module Logging
     def logger
-      @logger = Logger.new($stdout, level: ENV.fetch("OBSWS_LOG_LEVEL", "WARN"))
+      @logger ||= Logger.new($stdout, level: ENV.fetch("OBSWS_LOG_LEVEL", "WARN"))
       @logger.progname = instance_of?(::Module) ? name : self.class.name
       @logger
     end

data/lib/obsws/mixin.rb

@@ -1,5 +1,3 @@
-require_relative "util"
-
 module OBSWS
   module Mixin
     module Meta
@@ -26,11 +24,11 @@ module OBSWS
       def attrs = @fields.map { |f| snakecase(f.to_s) }
     end
 
-    class Response < MetaObject
-    end
+    class Response < MetaObject; end
+    # Represents a request response object
 
-    class Data < MetaObject
-    end
+    class Data < MetaObject; end
+    # Represents an event data object
 
     module TearDown
       def stop_driver

data/lib/obsws/req.rb

@@ -1,22 +1,18 @@
-require "waitutil"
-
-require_relative "base"
-require_relative "error"
-require_relative "util"
-require_relative "mixin"
-require_relative "logger"
-
 module OBSWS
   module Requests
     class Client
       include Logging
-      include Error
       include Mixin::TearDown
       include Mixin::OPCodes
 
       def initialize(**kwargs)
         @base_client = Base.new(**kwargs)
         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)
+      else
         @base_client.updater = ->(op_code, data) {
           logger.debug("response received: #{data}")
           @response = data if op_code == Mixin::OPCodes::REQUESTRESPONSE
@@ -47,20 +43,24 @@ module OBSWS
           delay_sec: 0.001,
           timeout_sec: 3
         ) { @response[:requestId] == id }
-        if !@response[:requestStatus][:result]
-          error = [
-            "Request #{@response[:requestType]} returned code #{@response[:requestStatus][:code]}"
-          ]
-          if @response[:requestStatus].key?(:comment)
-            error += ["With message: #{@response[:requestStatus][:comment]}"]
-          end
-          raise OBSWSError.new(error.join("\n"))
+        unless @response[:requestStatus][:result]
+          raise OBSWSRequestError.new(@response[:requestType], @response[:requestStatus][:code], @response[:requestStatus][:comment])
         end
         @response[:responseData]
-      rescue WaitUtil::TimeoutError
-        msg = "no response with matching id received"
-        logger.error(msg)
-        raise OBSWSError.new(msg)
+      rescue OBSWSRequestError => e
+        err_msg = [
+          "#{e.class.name}: #{e.message}",
+          *e.backtrace
+        ]
+        logger.error(err_msg.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)
       end
 
       def get_version

data/lib/obsws/version.rb

@@ -1,5 +1,5 @@
 module OBSWS
-  module Version
+  module VERSION
     module_function
 
     def major
@@ -7,7 +7,7 @@ module OBSWS
     end
 
     def minor
-      4
+      5
     end
 
     def patch
@@ -22,6 +22,4 @@ module OBSWS
       to_a.join(".")
     end
   end
-
-  VERSION = Version.to_s
 end

data/lib/obsws.rb

@@ -1,5 +1,42 @@
+require "digest/sha2"
+require "json"
+require "waitutil"
+require "socket"
+require "websocket/driver"
+require "logger"
+
+require_relative "obsws/logger"
+require_relative "obsws/driver"
+require_relative "obsws/util"
+require_relative "obsws/mixin"
+require_relative "obsws/base"
+
 require_relative "obsws/req"
 require_relative "obsws/event"
 
+require_relative "obsws/version"
+
 module OBSWS
+  class OBSWSError < StandardError; end
+
+  class OBSWSConnectionError < OBSWSError; end
+
+  class OBSWSRequestError < OBSWSError
+    attr_reader :name, :code
+
+    def initialize(name, code, msg)
+      @name = name
+      @code = code
+      @msg = msg
+      super(message)
+    end
+
+    def message
+      msg = [
+        "Request #{@name} returned code #{@code}."
+      ]
+      msg << "With message: #{@msg}" if @msg
+      msg.join(" ")
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: obsws
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - onyx_online
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-27 00:00:00.000000000 Z
+date: 2023-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: websocket-driver
@@ -107,7 +107,6 @@ files:
 - lib/obsws.rb
 - lib/obsws/base.rb
 - lib/obsws/driver.rb
-- lib/obsws/error.rb
 - lib/obsws/event.rb
 - lib/obsws/logger.rb
 - lib/obsws/mixin.rb

data/lib/obsws/error.rb

@@ -1,6 +0,0 @@
-module OBSWS
-  module Error
-    class OBSWSError < StandardError
-    end
-  end
-end