obsws 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c125c30687cdcd22d868636a4d7bfbe7776939a8b4997842785b3868e7959151
-  data.tar.gz: 7f4c51a8231083c220c95d4e0fa34da8bf7712307adcd21b32565043a3e28d7f
+  metadata.gz: f55dbfe2267a8b2dec6fc0c347b537b1a9727de641ec762d16128a40ee3397a4
+  data.tar.gz: 3ef38f6bfb12db426c31afdb130e25debda7173e135daf9d88677d6002365c55
 SHA512:
-  metadata.gz: 5b14e996f1e06788e88b66d44fef72f06d5ba0ad07b38e83332a19dfa833c724f33ea2a2119336105cca63034f0a015e53a38b60d1049dc8745ae9be92d51028
-  data.tar.gz: bfd3821cefe5a515feca6746edb5d042141492061bfa6303f1c6daf56a2215d0c4ce076224bb3b7873879649fe96f36a4ee223e6aeae08020988f3d8790fe26c
+  metadata.gz: c2914cfd19dd1107ecd0d8825ca5386b9e6574983527098801fed5f0ed3c06520490f139d9c3837d45aa2791cd8e20e263b07ada46d46d7957a399aebd629ad2
+  data.tar.gz: 1d76544ea453fc16bad1d38b64ff4328ad1665520323112694007377e75959ce78f05027cfb85ef176b74148374f15c60b03b627f92552e6741171919f930c37

data/README.md

@@ -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

@@ -6,6 +6,7 @@ require "waitutil"
 
 require_relative "mixin"
 require_relative "error"
+require_relative "logger"
 
 module OBSWS
   class Socket
@@ -22,6 +23,7 @@ module OBSWS
   end
 
   class Base
+    include Logging
     include Mixin::OPCodes
 
     attr_reader :closed
@@ -37,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
@@ -91,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))
@@ -117,7 +118,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/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} 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))

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} 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}
@@ -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,11 +7,11 @@ module OBSWS
     end
 
     def minor
-      2
+      3
     end
 
     def patch
-      1
+      0
     end
 
     def to_a

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.0
 platform: ruby
 authors:
 - onyx_online
@@ -108,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