obsws 0.3.3 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a79951b0215195512bd8972528425795f3893a3c9605009803f5583b36e54618
-  data.tar.gz: 4515b14d0bab1934e3eb1a8e5b626660a970ae1c6358c5ba2f47a6320562845b
+  metadata.gz: 9ccc4e19da8ea0f009572ea75a5f47b414c7d4e5d50955ae856eb4063081ca70
+  data.tar.gz: 2a5ec2b70667d2b80483a46c898920ed9a97d937478e45ff5f643b8e28919a18
 SHA512:
-  metadata.gz: b43b242dc256207ebf7f5ebe78e720416a68a4e9dcfc665de3a880b9a027e859db1ae805aeb9e363bb5a3f62487fb0e19ee8cda2ff2d871cec24ff82e4e7fda6
-  data.tar.gz: d13c2e1bfdd1931f251f52d42b2851040bb352ba7991ea5ec678dae5631349125440201b65e64a6c01d1d61f2419cac7911f2f64abd1765fab9870a5224bafab
+  metadata.gz: '0875434a8e3c58d82fbc0deb3be4478ab495000b37ee6282d321e32963d623dcc241c62a0257ef009ab6981ef134138e6e72ab76a1f552d46a3b928f1acc21d4'
+  data.tar.gz: 3b944c1a4ac416f12a0f5d821d73979ac4f344fa2ae186f04a0d00998bc5adf9fcf744e874d4b52f273232aec174a2da134a94f5bcd24d522d25e2b778c7bd9f

data/README.md

@@ -16,14 +16,10 @@
 ### Bundler
 
 ```
-bundle add 'obsws'
+bundle add obsws
 bundle install
 ```
 
-### Gem
-
-`gem install 'obsws'`
-
 ## `Use`
 
 #### Example `main.rb`
@@ -67,23 +63,28 @@ For a full list of requests refer to [Requests](https://github.com/obsproject/ob
 
 ### Events
 
-Register an observer class and define `on_` methods for events. Method names should match the api event but snake cased.
+Register `on_` callback methods. Method names should match the api event but snake cased.
 
 example:
 
 ```ruby
 class Observer
     def initialize
-        @e_client = OBSWS::Events::Client.new(**kwargs)
-        # register class with the event client
-        @e_client.add_observer(self)
+        @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
+    def on_current_program_scene_changed(data)
         ...
     end
-    def on_input_mute_state_changed
+    def on_input_mute_state_changed(data)
         ...
     end
     ...

data/lib/obsws/base.rb

@@ -21,8 +21,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/event.rb

@@ -42,25 +42,30 @@ module OBSWS
       end
 
       def add_observer(observer)
-        observer = [observer] if !observer.respond_to? :each
-        observer.each { |o| observers << o }
+        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.respond_to? "on_#{snakecase(event)}"
-            if data.empty?
-              o.send("on_#{snakecase(event)}")
-            else
-              o.send("on_#{snakecase(event)}", data)
+          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
       end
+
+      alias_method :callbacks, :observers
+      alias_method :register, :add_observer
+      alias_method :deregister, :remove_observer
     end
 
     class Client

data/lib/obsws/logger.rb

@@ -3,7 +3,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

@@ -26,11 +26,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

@@ -47,12 +47,12 @@ module OBSWS
           delay_sec: 0.001,
           timeout_sec: 3
         ) { @response[:requestId] == id }
-        if !@response[:requestStatus][:result]
+        unless @response[:requestStatus][:result]
           error = [
             "Request #{@response[:requestType]} returned code #{@response[:requestStatus][:code]}"
           ]
           if @response[:requestStatus].key?(:comment)
-            error += ["With message: #{@response[:requestStatus][:comment]}"]
+            error << ["With message: #{@response[:requestStatus][:comment]}"]
           end
           raise OBSWSError.new(error.join("\n"))
         end

data/lib/obsws/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: obsws
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.2
 platform: ruby
 authors:
 - onyx_online
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-26 00:00:00.000000000 Z
+date: 2023-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: websocket-driver