obsws 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f23333577b91916057461d9084494c147f63cd3feb90e121ab33c5b795af1566
-  data.tar.gz: e5b31955a09ace6b520351252034ca8b1bb8932698859b12a3af3dd2b70485d9
+  metadata.gz: c125c30687cdcd22d868636a4d7bfbe7776939a8b4997842785b3868e7959151
+  data.tar.gz: 7f4c51a8231083c220c95d4e0fa34da8bf7712307adcd21b32565043a3e28d7f
 SHA512:
-  metadata.gz: 14411743ad90540ec041ed46c30f1347512174a876a6891bf1351c7f4025c712cc9f57aad1911adabc1368fb1f907b982f519ad713404d516d88af42a0687120
-  data.tar.gz: 28ac135781ba0610baa21912d9105b1ebd3762b682693d9866172a0ae7dde9e322de68174f7bf23da8fb6d8faf813128fc1a6c1e3d04557be533d4cded5ef59c
+  metadata.gz: 5b14e996f1e06788e88b66d44fef72f06d5ba0ad07b38e83332a19dfa833c724f33ea2a2119336105cca63034f0a015e53a38b60d1049dc8745ae9be92d51028
+  data.tar.gz: bfd3821cefe5a515feca6746edb5d042141492061bfa6303f1c6daf56a2215d0c4ce076224bb3b7873879649fe96f36a4ee223e6aeae08020988f3d8790fe26c

data/README.md

@@ -28,37 +28,39 @@ bundle install
 
 #### Example `main.rb`
 
-pass `host`, `port` and `password` as keyword arguments.
+Pass `host`, `port` and `password` as keyword arguments.
 
 ```ruby
 require "obsws"
 
-def main
-  OBSWS::Requests::Client
-    .new(host: "localhost", port: 4455, password: "strongpassword")
-    .run do |client|
-      # Toggle the mute state of your Mic input
-      client.toggle_input_mute("Mic/Aux")
-    end
+class Main
+  def run
+    OBSWS::Requests::Client
+      .new(host: "localhost", port: 4455, password: "strongpassword")
+      .run do |client|
+        # Toggle the mute state of your Mic input
+        client.toggle_input_mute("Mic/Aux")
+      end
+  end
 end
 
-main if $0 == __FILE__
+Main.new.run if $PROGRAM_NAME == __FILE__
 ```
 
+Passing OBSWS::Requests::Client.run a block closes the socket once the block returns.
+
 ### Requests
 
-Method names for requests match the API calls but snake cased. `run` accepts a block that closes the socket once you are done.
+Method names for requests match the API calls but snake cased.
 
 example:
 
 ```ruby
-r_client.run do
-  # GetVersion
-  resp = r_client.get_version
+# GetVersion
+resp = r_client.get_version
 
-  # SetCurrentProgramScene
-  r_client.set_current_program_scene("BRB")
-end
+# SetCurrentProgramScene
+r_client.set_current_program_scene("BRB")
 ```
 
 For a full list of requests refer to [Requests](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#requests)

data/lib/obsws/base.rb

@@ -2,7 +2,6 @@ require "socket"
 require "websocket/driver"
 require "digest/sha2"
 require "json"
-require "observer"
 require "waitutil"
 
 require_relative "mixin"
@@ -23,10 +22,10 @@ module OBSWS
   end
 
   class Base
-    include Observable
     include Mixin::OPCodes
 
-    attr_reader :id, :driver, :closed
+    attr_reader :closed
+    attr_writer :updater
 
     def initialize(**kwargs)
       host = kwargs[:host] || "localhost"
@@ -56,7 +55,7 @@ module OBSWS
       ) { @identified }
     end
 
-    def start_driver
+    private def start_driver
       Thread.new do
         @driver.start
 
@@ -68,6 +67,12 @@ module OBSWS
       end
     end
 
+    public def stop_driver
+      @driver.close
+    end
+
+    private
+
     def auth_token(salt:, challenge:)
       Digest::SHA256.base64digest(
         Digest::SHA256.base64digest(@password + salt) + challenge
@@ -99,12 +104,11 @@ module OBSWS
       when Mixin::OPCodes::IDENTIFIED
         @identified = true
       when Mixin::OPCodes::EVENT, Mixin::OPCodes::REQUESTRESPONSE
-        changed
-        notify_observers(data[:op], data[:d])
+        @updater.call(data[:op], data[:d])
       end
     end
 
-    def req(id, type_, data = nil)
+    public def req(id, type_, data = nil)
       payload = {
         op: Mixin::OPCodes::REQUEST,
         d: {
@@ -114,7 +118,7 @@ module OBSWS
       }
       payload[:d][:requestData] = data if data
       LOGGER.debug("sending request: #{payload}")
-      queued = @driver.text(JSON.generate(payload))
+      @driver.text(JSON.generate(payload))
     end
   end
 end

data/lib/obsws/event.rb

@@ -70,20 +70,18 @@ module OBSWS
         kwargs[:subs] ||= SUBS::LOW_VOLUME
         @base_client = Base.new(**kwargs)
         LOGGER.info("#{self} succesfully identified with server")
-        @base_client.add_observer(self)
+        @base_client.updater = ->(op_code, data) {
+          if op_code == Mixin::OPCodes::EVENT
+            event = data[:eventType]
+            data = data.fetch(:eventData, {})
+            notify_observers(event, Mixin::Data.new(data, data.keys))
+          end
+        }
       end
 
       def to_s
         self.class.name.split("::").last(2).join("::")
       end
-
-      def update(op_code, data)
-        if op_code == Mixin::OPCodes::EVENT
-          event = data[:eventType]
-          data = data.key?(:eventData) ? data[:eventData] : {}
-          notify_observers(event, Mixin::Data.new(data, data.keys))
-        end
-      end
     end
   end
 end

data/lib/obsws/mixin.rb

@@ -18,7 +18,7 @@ module OBSWS
       def initialize(resp, fields)
         @resp = resp
         @fields = fields
-        self.make_field_methods *fields
+        make_field_methods(*fields)
       end
 
       def empty? = @fields.empty?
@@ -33,9 +33,11 @@ module OBSWS
     end
 
     module TearDown
-      def close
-        @base_client.driver.close
+      def stop_driver
+        @base_client.stop_driver
       end
+
+      alias_method :close, :stop_driver
     end
 
     module OPCodes

data/lib/obsws/req.rb

@@ -15,7 +15,9 @@ module OBSWS
       def initialize(**kwargs)
         @base_client = Base.new(**kwargs)
         LOGGER.info("#{self} succesfully identified with server")
-        @base_client.add_observer(self)
+        @base_client.updater = ->(op_code, data) {
+          @response = data if op_code == Mixin::OPCodes::REQUESTRESPONSE
+        }
         @response = {requestId: 0}
       end
 
@@ -26,7 +28,7 @@ module OBSWS
       def run
         yield(self)
       ensure
-        close
+        stop_driver
         WaitUtil.wait_for_condition(
           "driver to close",
           delay_sec: 0.01,
@@ -34,10 +36,6 @@ module OBSWS
         ) { @base_client.closed }
       end
 
-      def update(op_code, data)
-        @response = data if op_code == Mixin::OPCodes::REQUESTRESPONSE
-      end
-
       def call(req, data = nil)
         id = rand(1..1000)
         @base_client.req(id, req, data)

data/lib/obsws/version.rb

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

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: obsws
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - onyx_online
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-19 00:00:00.000000000 Z
+date: 2023-07-26 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: observer
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: websocket-driver
   requirement: !ruby/object:Gem::Requirement