obsws 0.5.8 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e289e262d4b31c03c7df28ba6d638c39d04e362fb0173f2535e0bf60f188bd41
-  data.tar.gz: '0925f7d4d8695401d27dfb0d01df2c4fe5751d82d04c9bec752c981c52e1be8e'
+  metadata.gz: a2b42a23b71da1f893d08f8f1ffba2b178dd48cefa35627afd0bcdbf839fd6c7
+  data.tar.gz: 1654fafec480037f48b39eed30fa36e862b1cafe56d5c5af9e6fcaaa76a1e337
 SHA512:
-  metadata.gz: 79e9065b4190dd974195079e31dc191fb7412fa143297b1f6dacedb1aae2100ded74abac9c1553b7fc92dce2987f40615d1101dfe5eab987f982a3bd3a7d87dd
-  data.tar.gz: 5137c5ca260beaedcda8936532bd4d04b6154d2c4b7e4a005e5eb12ab070e5502c7231acf2539a90304170bb75ebdd2fdf96a5a7f9bf49a4eafbb6f3370a945f
+  metadata.gz: e54a03b4df1b1e77ab27fe25980ac759ff38c204885e1fdd6d4f07747b1485a8d00bbf77a75a866e2e8fa3d664d44c53cff10e5b9276772894131afbb0c53f8d
+  data.tar.gz: 0a9c417863aed8279eca8c838db1ddd635b4bc7eaba4fa2bb49e1141a313f9fa20cfeb281e5de79a21393b368e0f660e6beef526bf57505a01449024202abf61

data/README.md

@@ -67,7 +67,9 @@ For a full list of requests refer to [Requests](https://github.com/obsproject/ob
 
 ### Events
 
-Register `on_` callback methods. Method names should match the api event but snake cased.
+Register blocks with the Event client using the `on` method. Event tokens should match the event name but snake cased.
+
+The event data will be passed to the block.
 
 example:
 
@@ -75,23 +77,14 @@ example:
 class Observer
     def initialize
         @e_client = OBSWS::Events::Client.new(host: "localhost", port: 4455, password: "strongpassword")
-        # register callback methods with the Event client
-        @e_client.register(
-          [
-            method(:on_current_program_scene_changed),
-            method(:on_input_mute_state_changed)
-          ]
-        )
-    end
-
-    # define "on_" event methods.
-    def on_current_program_scene_changed(data)
-        ...
+        # register blocks on event types.
+        @e_client.on :current_program_scene_changed do |data|
+          ...
+        end
+        @e_client.on :input_mute_state_changed do |data|
+          ...
+        end
     end
-    def on_input_mute_state_changed(data)
-        ...
-    end
-    ...
 end
 ```
 
@@ -104,11 +97,12 @@ For both request responses and event data you may inspect the available attribut
 example:
 
 ```ruby
-resp = cl.get_version
+resp = @r_client.get_version
 p resp.attrs
 
-def on_scene_created(data):
-    p data.attrs
+@e_client.on :input_mute_state_changed do |data|
+  p data.attrs
+end
 ```
 
 ### Errors

data/lib/obsws/base.rb

@@ -29,8 +29,8 @@ module OBSWS
       port = kwargs[:port] || 4455
       @password = kwargs[:password] || ""
       @subs = kwargs[:subs] || 0
-      setup_driver(host, port) and start_driver
       @identified = Identified.new
+      setup_driver(host, port) and start_driver
       WaitUtil.wait_for_condition(
         "successful identification",
         delay_sec: 0.01,

data/lib/obsws/event.rb

@@ -28,43 +28,35 @@ module OBSWS
       ALL = LOW_VOLUME | HIGH_VOLUME
     end
 
-    module Callbacks
+    module EventDirector
       include Util::String
 
       def observers
-        @observers ||= []
+        @observers ||= {}
       end
 
-      def add_observer(observer)
-        observer = [observer] unless observer.respond_to? :each
-        observer.each { |o| observers << o unless observers.include? o }
+      def on(event, method = nil, &block)
+        (observers[event] ||= []) << (block || method)
       end
 
-      def remove_observer(observer)
-        observer = [observer] unless observer.respond_to? :each
-        observers.reject! { |o| observer.include? o }
+      def register(cbs)
+        cbs = Array(cbs) unless cbs.respond_to? :each
+        cbs.each { |cb| on(cb.name[3..].to_sym, cb) }
       end
 
-      private def notify_observers(event, data)
-        observers.each do |o|
-          if o.is_a? Method
-            if o.name.to_s == "on_#{snakecase(event)}"
-              data.empty? ? o.call : o.call(data)
-            end
-          elsif o.respond_to? "on_#{snakecase(event)}"
-            data.empty? ? o.send("on_#{snakecase(event)}") : o.send("on_#{snakecase(event)}", data)
-          end
-        end
+      def deregister(cbs)
+        cbs = Array(cbs) unless cbs.respond_to? :each
+        cbs.each { |cb| observers[cb.name[3..].to_sym]&.reject! { |o| cbs.include? o } }
       end
 
-      alias_method :callbacks, :observers
-      alias_method :register, :add_observer
-      alias_method :deregister, :remove_observer
+      def fire(event, data)
+        observers[snakecase(event).to_sym]&.each { |block| data.empty? ? block.call : block.call(data) }
+      end
     end
 
     class Client
       include Logging
-      include Callbacks
+      include EventDirector
       include Mixin::TearDown
       include Mixin::OPCodes
 
@@ -87,7 +79,7 @@ module OBSWS
             logger.debug("received: #{data}")
             event = data[:eventType]
             data = data.fetch(:eventData, {})
-            notify_observers(event, Mixin::Data.new(data, data.keys))
+            fire(event, Mixin::Data.new(data, data.keys))
           end
         }
       end

data/lib/obsws/mixin.rb

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

data/lib/obsws/version.rb

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

data/lib/obsws.rb

@@ -18,26 +18,22 @@ require_relative "obsws/event"
 require_relative "obsws/version"
 
 module OBSWS
+  # Base OBSWS error class
   class OBSWSError < StandardError; end
 
+  # Raised when a connection fails or times out
   class OBSWSConnectionError < OBSWSError; end
 
+  # Raised when a request returns an error code
   class OBSWSRequestError < OBSWSError
     attr_reader :req_name, :code
 
-    def initialize(req_name, code, msg)
+    def initialize(req_name, code, comment)
       @req_name = req_name
       @code = code
-      @msg = msg
+      message = "Request #{@req_name} returned code #{@code}."
+      message << " With message: #{comment}" if comment
       super(message)
     end
-
-    def message
-      msg = [
-        "Request #{@req_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.5.8
+  version: 0.6.1
 platform: ruby
 authors:
 - onyx_online
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-11 00:00:00.000000000 Z
+date: 2023-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: websocket-driver