obsws 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f55dbfe2267a8b2dec6fc0c347b537b1a9727de641ec762d16128a40ee3397a4
-  data.tar.gz: 3ef38f6bfb12db426c31afdb130e25debda7173e135daf9d88677d6002365c55
+  metadata.gz: ddfcc82f3a8213d04134762ce838d20cfef23f61fd12bfcdb8d414ca381aaae4
+  data.tar.gz: 572f30bae6af2264b9a208eb567ceea95e95b65d6311831d7155f052147ce81f
 SHA512:
-  metadata.gz: c2914cfd19dd1107ecd0d8825ca5386b9e6574983527098801fed5f0ed3c06520490f139d9c3837d45aa2791cd8e20e263b07ada46d46d7957a399aebd629ad2
-  data.tar.gz: 1d76544ea453fc16bad1d38b64ff4328ad1665520323112694007377e75959ce78f05027cfb85ef176b74148374f15c60b03b627f92552e6741171919f930c37
+  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
 

data/lib/obsws/base.rb

@@ -1,29 +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
@@ -34,20 +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|
-        msg_handler(JSON.parse(msg.data, symbolize_names: true))
-      end
+      setup_driver(host, port)
       start_driver
       WaitUtil.wait_for_condition(
         "successful identification",
@@ -56,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:)

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

@@ -71,7 +71,7 @@ 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}")

data/lib/obsws/req.rb

@@ -16,7 +16,7 @@ module OBSWS
 
       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

data/lib/obsws/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: obsws
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - onyx_online
@@ -106,6 +106,7 @@ 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