obsws 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f23333577b91916057461d9084494c147f63cd3feb90e121ab33c5b795af1566
-  data.tar.gz: e5b31955a09ace6b520351252034ca8b1bb8932698859b12a3af3dd2b70485d9
+  metadata.gz: f55dbfe2267a8b2dec6fc0c347b537b1a9727de641ec762d16128a40ee3397a4
+  data.tar.gz: 3ef38f6bfb12db426c31afdb130e25debda7173e135daf9d88677d6002365c55
 SHA512:
-  metadata.gz: 14411743ad90540ec041ed46c30f1347512174a876a6891bf1351c7f4025c712cc9f57aad1911adabc1368fb1f907b982f519ad713404d516d88af42a0687120
-  data.tar.gz: 28ac135781ba0610baa21912d9105b1ebd3762b682693d9866172a0ae7dde9e322de68174f7bf23da8fb6d8faf813128fc1a6c1e3d04557be533d4cded5ef59c
+  metadata.gz: c2914cfd19dd1107ecd0d8825ca5386b9e6574983527098801fed5f0ed3c06520490f139d9c3837d45aa2791cd8e20e263b07ada46d46d7957a399aebd629ad2
+  data.tar.gz: 1d76544ea453fc16bad1d38b64ff4328ad1665520323112694007377e75959ce78f05027cfb85ef176b74148374f15c60b03b627f92552e6741171919f930c37

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)
@@ -112,15 +114,12 @@ For a full list of status codes refer to [Codes](https://github.com/obsproject/o
 
 ### Logging
 
-To see the raw messages set log level to debug
+To enable logs set an environmental variable `OBSWS_LOG_LEVEL` to the appropriate level.
 
-example:
-
-```ruby
-require "obsws"
+example in powershell:
 
-OBSWS::LOGGER.debug!
-...
+```powershell
+$env:OBSWS_LOG_LEVEL="DEBUG"
 ```
 
 ### Tests

data/lib/obsws/base.rb

@@ -2,11 +2,11 @@ require "socket"
 require "websocket/driver"
 require "digest/sha2"
 require "json"
-require "observer"
 require "waitutil"
 
 require_relative "mixin"
 require_relative "error"
+require_relative "logger"
 
 module OBSWS
   class Socket
@@ -23,10 +23,11 @@ module OBSWS
   end
 
   class Base
-    include Observable
+    include Logging
     include Mixin::OPCodes
 
-    attr_reader :id, :driver, :closed
+    attr_reader :closed
+    attr_writer :updater
 
     def initialize(**kwargs)
       host = kwargs[:host] || "localhost"
@@ -38,14 +39,13 @@ module OBSWS
       @driver =
         WebSocket::Driver.client(Socket.new("ws://#{host}:#{port}", @socket))
       @driver.on :open do |msg|
-        LOGGER.debug("driver socket open")
+        logger.debug("driver socket open")
       end
       @driver.on :close do |msg|
-        LOGGER.debug("driver socket closed")
+        logger.debug("driver socket closed")
         @closed = true
       end
       @driver.on :message do |msg|
-        LOGGER.debug("received: #{msg.data}")
         msg_handler(JSON.parse(msg.data, symbolize_names: true))
       end
       start_driver
@@ -56,7 +56,7 @@ module OBSWS
       ) { @identified }
     end
 
-    def start_driver
+    private def start_driver
       Thread.new do
         @driver.start
 
@@ -68,6 +68,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
@@ -86,7 +92,7 @@ module OBSWS
         if @password.empty?
           raise OBSWSError("auth enabled but no password provided")
         end
-        LOGGER.info("initiating authentication")
+        logger.info("initiating authentication")
         payload[:d][:authentication] = auth_token(**auth)
       end
       @driver.text(JSON.generate(payload))
@@ -99,12 +105,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: {
@@ -113,8 +118,8 @@ module OBSWS
         }
       }
       payload[:d][:requestData] = data if data
-      LOGGER.debug("sending request: #{payload}")
-      queued = @driver.text(JSON.generate(payload))
+      logger.debug("sending request: #{payload}")
+      @driver.text(JSON.generate(payload))
     end
   end
 end

data/lib/obsws/event.rb

@@ -2,6 +2,7 @@ require "json"
 
 require_relative "util"
 require_relative "mixin"
+require_relative "logger"
 
 module OBSWS
   module Events
@@ -62,6 +63,7 @@ module OBSWS
     end
 
     class Client
+      include Logging
       include Callbacks
       include Mixin::TearDown
       include Mixin::OPCodes
@@ -69,21 +71,20 @@ module OBSWS
       def initialize(**kwargs)
         kwargs[:subs] ||= SUBS::LOW_VOLUME
         @base_client = Base.new(**kwargs)
-        LOGGER.info("#{self} succesfully identified with server")
-        @base_client.add_observer(self)
+        logger.info("#{self} succesfully identified with server")
+        @base_client.updater = ->(op_code, data) {
+          if op_code == Mixin::OPCodes::EVENT
+            logger.debug("received: #{data}")
+            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/logger.rb

@@ -0,0 +1,11 @@
+require "logger"
+
+module OBSWS
+  module Logging
+    def logger
+      @logger = Logger.new($stdout, level: ENV.fetch("OBSWS_LOG_LEVEL", "WARN"))
+      @logger.progname = instance_of?(::Module) ? name : self.class.name
+      @logger
+    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

@@ -4,18 +4,23 @@ 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} succesfully identified with server")
-        @base_client.add_observer(self)
+        logger.info("#{self} succesfully identified with server")
+        @base_client.updater = ->(op_code, data) {
+          logger.debug("response received: #{data}")
+          @response = data if op_code == Mixin::OPCodes::REQUESTRESPONSE
+        }
         @response = {requestId: 0}
       end
 
@@ -26,7 +31,7 @@ module OBSWS
       def run
         yield(self)
       ensure
-        close
+        stop_driver
         WaitUtil.wait_for_condition(
           "driver to close",
           delay_sec: 0.01,
@@ -34,10 +39,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)
@@ -58,7 +59,7 @@ module OBSWS
         @response[:responseData]
       rescue WaitUtil::TimeoutError
         msg = "no response with matching id received"
-        LOGGER.error(msg)
+        logger.error(msg)
         raise OBSWSError.new(msg)
       end
 

data/lib/obsws/util.rb

@@ -2,12 +2,11 @@ module OBSWS
   module Util
     class ::String
       def to_camel
-        self.split(/_/).map(&:capitalize).join
+        split("_").map(&:capitalize).join
       end
 
       def to_snake
-        self
-          .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+        gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
           .gsub(/([a-z\d])([A-Z])/, '\1_\2')
           .downcase
       end

data/lib/obsws/version.rb

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

data/lib/obsws.rb

@@ -1,11 +1,5 @@
-require "logger"
-
 require_relative "obsws/req"
 require_relative "obsws/event"
 
 module OBSWS
-  include Logger::Severity
-
-  LOGGER = Logger.new(STDOUT)
-  LOGGER.level = WARN
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: obsws
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 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
@@ -122,6 +108,7 @@ files:
 - lib/obsws/base.rb
 - lib/obsws/error.rb
 - lib/obsws/event.rb
+- lib/obsws/logger.rb
 - lib/obsws/mixin.rb
 - lib/obsws/req.rb
 - lib/obsws/util.rb