obsws 0.2.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c125c30687cdcd22d868636a4d7bfbe7776939a8b4997842785b3868e7959151
-  data.tar.gz: 7f4c51a8231083c220c95d4e0fa34da8bf7712307adcd21b32565043a3e28d7f
+  metadata.gz: ddfcc82f3a8213d04134762ce838d20cfef23f61fd12bfcdb8d414ca381aaae4
+  data.tar.gz: 572f30bae6af2264b9a208eb567ceea95e95b65d6311831d7155f052147ce81f
 SHA512:
-  metadata.gz: 5b14e996f1e06788e88b66d44fef72f06d5ba0ad07b38e83332a19dfa833c724f33ea2a2119336105cca63034f0a015e53a38b60d1049dc8745ae9be92d51028
-  data.tar.gz: bfd3821cefe5a515feca6746edb5d042141492061bfa6303f1c6daf56a2215d0c4ce076224bb3b7873879649fe96f36a4ee223e6aeae08020988f3d8790fe26c
+  metadata.gz: c4a6aa4c301fd4f0a339b1f6b06a629d1051499b0cba82485ccbb93428318066515f51cdfda61b0f09c7ebd7a6c3b7a601e08d9d91f95f9111f3166235484e6c
+  data.tar.gz: 1b94ca2cf66e810b0a195fbe501518e6c87b0a26844c69303196a0f8cbe41770994d38e8613c3a7a612f723de7736b5e14afd2808fa6a70ef7dd3bfb7e5aff08

data/README.md

@@ -2,7 +2,7 @@
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/onyx-and-iris/obsws-ruby/blob/dev/LICENSE)
 [![Ruby Code Style](https://img.shields.io/badge/code_style-standard-violet.svg)](https://github.com/standardrb/standard)
 
-# A Ruby wrapper around OBS Studio WebSocket v5.0
+# Ruby Clients for OBS Studio WebSocket v5.0
 
 ## Requirements
 
@@ -114,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

@@ -1,27 +1,16 @@
-require "socket"
-require "websocket/driver"
 require "digest/sha2"
 require "json"
 require "waitutil"
 
-require_relative "mixin"
+require_relative "driver"
 require_relative "error"
+require_relative "logger"
+require_relative "mixin"
 
 module OBSWS
-  class Socket
-    attr_reader :url
-
-    def initialize(url, socket)
-      @url = url
-      @socket = socket
-    end
-
-    def write(s)
-      @socket.write(s)
-    end
-  end
-
   class Base
+    include Logging
+    include Driver
     include Mixin::OPCodes
 
     attr_reader :closed
@@ -32,21 +21,7 @@ module OBSWS
       port = kwargs[:port] || 4455
       @password = kwargs[:password] || ""
       @subs = kwargs[:subs] || 0
-
-      @socket = TCPSocket.new(host, port)
-      @driver =
-        WebSocket::Driver.client(Socket.new("ws://#{host}:#{port}", @socket))
-      @driver.on :open do |msg|
-        LOGGER.debug("driver socket open")
-      end
-      @driver.on :close do |msg|
-        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
+      setup_driver(host, port)
       start_driver
       WaitUtil.wait_for_condition(
         "successful identification",
@@ -55,22 +30,6 @@ module OBSWS
       ) { @identified }
     end
 
-    private def start_driver
-      Thread.new do
-        @driver.start
-
-        loop do
-          @driver.parse(@socket.readpartial(4096))
-        rescue EOFError
-          break
-        end
-      end
-    end
-
-    public def stop_driver
-      @driver.close
-    end
-
     private
 
     def auth_token(salt:, challenge:)
@@ -91,7 +50,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))
@@ -117,7 +76,7 @@ module OBSWS
         }
       }
       payload[:d][:requestData] = data if data
-      LOGGER.debug("sending request: #{payload}")
+      logger.debug("sending request: #{payload}")
       @driver.text(JSON.generate(payload))
     end
   end

data/lib/obsws/driver.rb

@@ -0,0 +1,51 @@
+require "socket"
+require "websocket/driver"
+
+module OBSWS
+  module Driver
+    class Socket
+      attr_reader :url
+
+      def initialize(url, socket)
+        @url = url
+        @socket = socket
+      end
+
+      def write(s)
+        @socket.write(s)
+      end
+    end
+
+    def setup_driver(host, port)
+      @socket = TCPSocket.new(host, port)
+      @driver =
+        WebSocket::Driver.client(Socket.new("ws://#{host}:#{port}", @socket))
+      @driver.on :open do |msg|
+        logger.debug("driver socket open")
+      end
+      @driver.on :close do |msg|
+        logger.debug("driver socket closed")
+        @closed = true
+      end
+      @driver.on :message do |msg|
+        msg_handler(JSON.parse(msg.data, symbolize_names: true))
+      end
+    end
+
+    private def start_driver
+      Thread.new do
+        @driver.start
+
+        loop do
+          @driver.parse(@socket.readpartial(4096))
+        rescue EOFError
+          break
+        end
+      end
+    end
+
+    public def stop_driver
+      @driver.close
+    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,9 +71,10 @@ module OBSWS
       def initialize(**kwargs)
         kwargs[:subs] ||= SUBS::LOW_VOLUME
         @base_client = Base.new(**kwargs)
-        LOGGER.info("#{self} succesfully identified with server")
+        logger.info("#{self} successfully 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))

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/req.rb

@@ -4,18 +4,21 @@ 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")
+        logger.info("#{self} successfully 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}
@@ -56,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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: obsws
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors:
 - onyx_online
@@ -106,8 +106,10 @@ files:
 - README.md
 - lib/obsws.rb
 - lib/obsws/base.rb
+- lib/obsws/driver.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