Merge pull request #6 from onyx-and-iris/dependabot/bundler/rexml-3.4.2

Bump rexml from 3.3.9 to 3.4.2

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    obsws (0.5.8)
+    obsws (0.6.2)
       waitutil (~> 0.2.1)
       websocket-driver (~> 0.7.5)
 
@@ -19,9 +19,9 @@ GEM
       racc
     racc (1.7.1)
     rainbow (3.1.1)
-    rake (11.3.0)
+    rake (13.0.6)
     regexp_parser (2.8.1)
-    rexml (3.2.5)
+    rexml (3.4.2)
     rubocop (1.52.1)
       json (~> 2.3)
       parallel (~> 1.10)
@@ -58,11 +58,12 @@ GEM
 
 PLATFORMS
   x64-mingw-ucrt
+  x86_64-linux
 
 DEPENDENCIES
   minitest (~> 5.16, >= 5.16.3)
   obsws!
-  rake (~> 11.2, >= 11.2.2)
+  rake (~> 13.0, >= 11.2.2)
   standard (~> 1.30)
 
 BUNDLED WITH

README.md

@@ -67,7 +67,9 @@ For a full list of requests refer to [Requests](https://github.com/obsproject/ob
 
 ### Events
 
-Register blocks with the Event client using the `on` method. The event data will be passed to the block.
+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:
 
@@ -76,10 +78,10 @@ class Observer
     def initialize
         @e_client = OBSWS::Events::Client.new(host: "localhost", port: 4455, password: "strongpassword")
         # register blocks on event types.
-        @e_client.on(:current_program_scene_changed) do |data|
+        @e_client.on :current_program_scene_changed do |data|
           ...
         end
-        @e_client.on(:input_mute_state_changed) do |data|
+        @e_client.on :input_mute_state_changed do |data|
           ...
         end
     end
@@ -95,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):
+@e_client.on :input_mute_state_changed do |data|
   p data.attrs
+end
 ```
 
 ### Errors

examples/events/main.rb

@@ -6,16 +6,16 @@ class Main
     @r_client = OBSWS::Requests::Client.new(**kwargs)
     @e_client = OBSWS::Events::Client.new(**kwargs)
 
-    @e_client.on(:current_program_scene_changed) do |data|
+    @e_client.on :current_program_scene_changed do |data|
       puts "Switched to scene #{data.scene_name}"
     end
-    @e_client.on(:scene_created) do |data|
+    @e_client.on :scene_created do |data|
       puts "scene #{data.scene_name} has been created"
     end
-    @e_client.on(:input_mute_state_changed) do |data|
+    @e_client.on :input_mute_state_changed do |data|
       puts "#{data.input_name} mute toggled"
     end
-    @e_client.on(:exit_started) do
+    @e_client.on :exit_started do
       puts "OBS closing!"
       @r_client.close
       @e_client.close

examples/levels/main.rb

@@ -14,12 +14,12 @@ class Main
     subs = OBSWS::Events::SUBS::LOW_VOLUME | OBSWS::Events::SUBS::INPUTVOLUMEMETERS
     @e_client = OBSWS::Events::Client.new(subs:, **kwargs)
 
-    @e_client.on(:input_mute_state_changed) do |data|
+    @e_client.on :input_mute_state_changed do |data|
       if data.input_name == DEVICE
         puts "#{DEVICE} mute toggled"
       end
     end
-    @e_client.on(:input_volume_meters) do |data|
+    @e_client.on :input_volume_meters do |data|
       fget = ->(x) { (x > 0) ? (20 * Math.log(x, 10)).round(1) : -200.0 }
 
       data.inputs.each do |d|

lib/obsws.rb

@@ -18,10 +18,13 @@ 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
 

lib/obsws/event.rb

@@ -28,8 +28,8 @@ module OBSWS
       ALL = LOW_VOLUME | HIGH_VOLUME
     end
 
-    module EventDirector
-      include Util::String
+    module Director
+      using Util::CoreExtensions
 
       def observers
         @observers ||= {}
@@ -40,23 +40,23 @@ module OBSWS
       end
 
       def register(cbs)
-        cbs = [cbs] unless cbs.respond_to? :each
+        cbs = Array(cbs) unless cbs.respond_to? :each
         cbs.each { |cb| on(cb.name[3..].to_sym, cb) }
       end
 
       def deregister(cbs)
-        cbs = [cbs] unless cbs.respond_to? :each
+        cbs = Array(cbs) unless cbs.respond_to? :each
         cbs.each { |cb| observers[cb.name[3..].to_sym]&.reject! { |o| cbs.include? o } }
       end
 
       def fire(event, data)
-        observers[snakecase(event).to_sym]&.each { |block| data.empty? ? block.call : block.call(data) }
+        observers[event.snakecase.to_sym]&.each { |block| data.empty? ? block.call : block.call(data) }
       end
     end
 
     class Client
       include Logging
-      include EventDirector
+      include Events::Director
       include Mixin::TearDown
       include Mixin::OPCodes
 

lib/obsws/mixin.rb

@@ -1,16 +1,17 @@
 module OBSWS
   module Mixin
     module Meta
-      include Util::String
+      using Util::CoreExtensions
 
       def make_field_methods(*params)
         params.each do |param|
-          define_singleton_method(snakecase(param.to_s)) { @resp[param] }
+          define_singleton_method(param.to_s.snakecase) { @resp[param] }
         end
       end
     end
 
     class MetaObject
+      using Util::CoreExtensions
       include Mixin::Meta
 
       def initialize(resp, fields)
@@ -21,14 +22,14 @@ module OBSWS
 
       def empty? = @fields.empty?
 
-      def attrs = @fields.map { |f| snakecase(f.to_s) }
+      def attrs = @fields.map { |f| f.to_s.snakecase }
     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

lib/obsws/util.rb

@@ -1,16 +1,17 @@
 module OBSWS
   module Util
-    module String
-      def camelcase(s)
-        s.split("_").map(&:capitalize).join
+    module CoreExtensions
+      refine String do
+        def camelcase
+          split("_").map(&:capitalize).join
         end
 
-      def snakecase(s)
-        s
-          .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+        def snakecase
+          gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
             .gsub(/([a-z\d])([A-Z])/, '\1_\2')
             .downcase
         end
       end
     end
   end
+end

lib/obsws/version.rb

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

obsws.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "waitutil", "~> 0.2.1"
   spec.add_development_dependency "standard", "~> 1.30"
   spec.add_development_dependency "minitest", "~> 5.16", ">= 5.16.3"
-  spec.add_development_dependency "rake", "~> 11.2", ">= 11.2.2"
+  spec.add_development_dependency "rake", ">= 11.2.2", "~> 13.0"
   spec.required_ruby_version = ">= 3.0"
   spec.metadata = {
     "source_code_uri" => "https://github.com/onyx-and-iris/obsws-ruby"