obsws 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 951d942da5f3b7b0895acdd2921ac74b1fa21a1f3e4a56e58ea58c053ca2a51e
-  data.tar.gz: 5f1c953ecfe4b187b63f2aae17cae497e5475dc049c7fb06a5d84451795e7ae3
+  metadata.gz: 8812e43e45759a458a445608809725e4a270daa04a3b715997541eed5bc85e5b
+  data.tar.gz: 0500dfc0223ad3f489016791fc0ca51800ec903d0bf7e57305216ff0844ee722
 SHA512:
-  metadata.gz: c6aacbdc428e859c97669718b2df5f447fb6a136dd9def91b87613c40b7f25798236db96ddb3c29d629b30dbcebc8250f2566334fa5c82572eec4d9cf64e140f
-  data.tar.gz: d2729c6a1d9c50c37dac5f204d2d654375822b3f70911a420ba81b386d75f8afa2e5f7ead8cce0e496b12d221afeacaa9987119465136da19342c42785fc7102
+  metadata.gz: ef31376738aa182535f924e6981dab5eb8b83ec0e8254335d15e6fbab6ce952638c43c9769f21bd50c79b4b4e61750a7d16bdd2dc3910636b7e44957177bfdb2
+  data.tar.gz: fb4f85815ecfce661e4c46ba63bf008b4eb3c3d89d728a646b1a9c3ce40f22dea1ea00ded2b272abf82d4bb53e79ac275f1345ba87de45e2e4beb2d57f611f82

data/README.md

@@ -1,4 +1,5 @@
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/onyx-and-iris/voicemeeter-api-ruby/blob/dev/LICENSE)
+[![Gem Version](https://badge.fury.io/rb/obsws.svg)](https://badge.fury.io/rb/obsws)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/onyx-and-iris/obsws-ruby/blob/dev/LICENSE)
 [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/plugin-ruby)
 
 # A Ruby wrapper around OBS Studio WebSocket v5.0
@@ -10,6 +11,19 @@
     -   With the release of OBS Studio version 28, Websocket plugin is included by default. But it should be manually installed for earlier versions of OBS.
 -   Ruby 3.0 or greater
 
+## Installation
+
+### Bundler
+
+```
+bundle add 'obsws'
+bundle install
+```
+
+### Gem
+
+`gem install 'obsws'`
+
 ## `Use`
 
 #### Example `main.rb`

data/lib/obsws/base.rb

@@ -50,10 +50,10 @@ module OBSWS
       end
       start_driver
       WaitUtil.wait_for_condition(
-        "waiting authentication successful",
+        "waiting successful identification",
         delay_sec: 0.01,
         timeout_sec: 3
-      ) { @authenticated }
+      ) { @identified }
     end
 
     def start_driver
@@ -74,32 +74,28 @@ module OBSWS
       )
     end
 
-    def authenticate(auth)
-      token = auth_token(**auth)
+    def identify(auth)
+      LOGGER.info("initiating authentication") if auth
       payload = {
         op: Mixin::OPCodes::IDENTIFY,
         d: {
           rpcVersion: 1,
-          authentication: token,
           eventSubscriptions: @subs
         }
       }
-      LOGGER.debug("initiating authentication")
+      payload[:d][:authentication] = auth_token(**auth) if auth
       @driver.text(JSON.generate(payload))
     end
 
     def msg_handler(data)
-      op_code = data[:op]
-      case op_code
+      case data[:op]
       when Mixin::OPCodes::HELLO
-        LOGGER.debug("hello received, passing to auth")
-        authenticate(data[:d][:authentication])
+        identify(data[:d][:authentication])
       when Mixin::OPCodes::IDENTIFIED
-        LOGGER.debug("authentication successful")
-        @authenticated = true
+        @identified = true
       when Mixin::OPCodes::EVENT, Mixin::OPCodes::REQUESTRESPONSE
         changed
-        notify_observers(op_code, data[:d])
+        notify_observers(data[:op], data[:d])
       end
     end
 

data/lib/obsws/event.rb

@@ -77,9 +77,14 @@ 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)
       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/lib/obsws/mixin.rb

@@ -5,7 +5,7 @@ module OBSWS
     module Meta
       include Util
 
-      def make_response_methods(*params)
+      def make_field_methods(*params)
         params.each do |param|
           define_singleton_method(param.to_s.to_snake) { @resp[param] }
         end
@@ -18,7 +18,7 @@ module OBSWS
       def initialize(resp, fields)
         @resp = resp
         @fields = fields
-        self.make_response_methods *fields
+        self.make_field_methods *fields
       end
 
       def empty? = @fields.empty?

data/lib/obsws/req.rb

@@ -14,10 +14,15 @@ module OBSWS
 
       def initialize(**kwargs)
         @base_client = Base.new(**kwargs)
+        LOGGER.info("#{self} succesfully identified with server")
         @base_client.add_observer(self)
         @response = { requestId: 0 }
       end
 
+      def to_s
+        "#{self.class.name.split("::").last(2).join("::")}"
+      end
+
       def run
         yield
       ensure

data/lib/obsws/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: obsws
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - onyx_online
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-23 00:00:00.000000000 Z
+date: 2022-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: observer
@@ -146,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.12
 signing_key:
 specification_version: 4
 summary: OBS Websocket v5 wrapper