obsws 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 459330fa7270cc31f26449b15ceb03e53130a7499f3272a9a9d17d8ac7de0b7f
-  data.tar.gz: 46897d76b4c62720f776aabb2fea69d47fadc9a0c1d1b0041d090738e2a9c394
+  metadata.gz: 8812e43e45759a458a445608809725e4a270daa04a3b715997541eed5bc85e5b
+  data.tar.gz: 0500dfc0223ad3f489016791fc0ca51800ec903d0bf7e57305216ff0844ee722
 SHA512:
-  metadata.gz: a9bf8c54c209f1b18422babb02fcc631f773e0a5d46c9b8af49ba1a6e5e3077de1b89e1ce57cbc36fb5e868c41503a57d49292cc5bcb970c39127493bb1be3b5
-  data.tar.gz: 5959a9b71dceaf3af1fdbe624828e22631e45c8845e2ce232e9083565b9d62aa294690212ecc8b35f56083bb39eed94c346acf787f854414af072edbf3c9b2c8
+  metadata.gz: ef31376738aa182535f924e6981dab5eb8b83ec0e8254335d15e6fbab6ce952638c43c9769f21bd50c79b4b4e61750a7d16bdd2dc3910636b7e44957177bfdb2
+  data.tar.gz: fb4f85815ecfce661e4c46ba63bf008b4eb3c3d89d728a646b1a9c3ce40f22dea1ea00ded2b272abf82d4bb53e79ac275f1345ba87de45e2e4beb2d57f611f82

data/README.md

@@ -1,5 +1,5 @@
 [![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/voicemeeter-api-ruby/blob/dev/LICENSE)
+[![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
@@ -11,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

@@ -74,7 +74,8 @@ module OBSWS
       )
     end
 
-    def authenticate(auth = nil)
+    def identify(auth)
+      LOGGER.info("initiating authentication") if auth
       payload = {
         op: Mixin::OPCodes::IDENTIFY,
         d: {
@@ -89,14 +90,8 @@ module OBSWS
     def msg_handler(data)
       case data[:op]
       when Mixin::OPCodes::HELLO
-        if data[:d].key? :authentication
-          LOGGER.debug("initiating authentication")
-        else
-          LOGGER.debug("authentication disabled... skipping.")
-        end
-        authenticate(data[:d][:authentication])
+        identify(data[:d][:authentication])
       when Mixin::OPCodes::IDENTIFIED
-        LOGGER.debug("client succesfully identified with server")
         @identified = true
       when Mixin::OPCodes::EVENT, Mixin::OPCodes::REQUESTRESPONSE
         changed

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
-      3
+      0
     end
 
     def to_a

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: obsws
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  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