obsws 0.0.3 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 459330fa7270cc31f26449b15ceb03e53130a7499f3272a9a9d17d8ac7de0b7f
-  data.tar.gz: 46897d76b4c62720f776aabb2fea69d47fadc9a0c1d1b0041d090738e2a9c394
+  metadata.gz: 3ac01e29c9776d0288fc46118847ca4054596a940173b68aec224fb888a7d6ed
+  data.tar.gz: baef83a80ef328743d2579a74d31d7e9b6bc46203f6a5e0af4072dfa08a26ed7
 SHA512:
-  metadata.gz: a9bf8c54c209f1b18422babb02fcc631f773e0a5d46c9b8af49ba1a6e5e3077de1b89e1ce57cbc36fb5e868c41503a57d49292cc5bcb970c39127493bb1be3b5
-  data.tar.gz: 5959a9b71dceaf3af1fdbe624828e22631e45c8845e2ce232e9083565b9d62aa294690212ecc8b35f56083bb39eed94c346acf787f854414af072edbf3c9b2c8
+  metadata.gz: 71f5a718e0dfaec48b05f4f8a1e49637f0d60a20f56d8870987588cfe4ae1938b67d04043fae20cc612d1f61d8d48b22cff3a908ffe045fb0b1bbf432736f00a
+  data.tar.gz: 7a95faceaa4022bab0c8045b7068bca4ceee6a86a4e21c303e34a589cbc80d45b358ba2f12a365c8c45abed5c2eae4a5b49ae4ea97ac45c06bcf743ab8a796a4

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

@@ -7,38 +7,30 @@ module OBSWS
   module Events
     module SUBS
       NONE = 0
-      GENERAL = (1 << 0)
-      CONFIG = (1 << 1)
-      SCENES = (1 << 2)
-      INPUTS = (1 << 3)
-      TRANSITIONS = (1 << 4)
-      FILTERS = (1 << 5)
-      OUTPUTS = (1 << 6)
-      SCENEITEMS = (1 << 7)
-      MEDIAINPUTS = (1 << 8)
-      VENDORS = (1 << 9)
-      UI = (1 << 10)
+      GENERAL = 1 << 0
+      CONFIG = 1 << 1
+      SCENES = 1 << 2
+      INPUTS = 1 << 3
+      TRANSITIONS = 1 << 4
+      FILTERS = 1 << 5
+      OUTPUTS = 1 << 6
+      SCENEITEMS = 1 << 7
+      MEDIAINPUTS = 1 << 8
+      VENDORS = 1 << 9
+      UI = 1 << 10
 
-      def low_volume
-        GENERAL | CONFIG | SCENES | INPUTS | TRANSITIONS | FILTERS | OUTPUTS |
+      LOW_VOLUME = GENERAL | CONFIG | SCENES | INPUTS | TRANSITIONS | FILTERS | OUTPUTS |
           SCENEITEMS | MEDIAINPUTS | VENDORS | UI
-      end
 
-      INPUTVOLUMEMETERS = (1 << 16)
-      INPUTACTIVESTATECHANGED = (1 << 17)
-      INPUTSHOWSTATECHANGED = (1 << 18)
-      SCENEITEMTRANSFORMCHANGED = (1 << 19)
+      INPUTVOLUMEMETERS = 1 << 16
+      INPUTACTIVESTATECHANGED = 1 << 17
+      INPUTSHOWSTATECHANGED = 1 << 18
+      SCENEITEMTRANSFORMCHANGED = 1 << 19
 
-      def high_volume
-        INPUTVOLUMEMETERS | INPUTACTIVESTATECHANGED | INPUTSHOWSTATECHANGED |
+      HIGH_VOLUME = INPUTVOLUMEMETERS | INPUTACTIVESTATECHANGED | INPUTSHOWSTATECHANGED |
           SCENEITEMTRANSFORMCHANGED
-      end
-
-      def all
-        low_volume | high_volume
-      end
 
-      module_function :low_volume, :high_volume, :all
+      ALL = LOW_VOLUME | HIGH_VOLUME
     end
 
     module Callbacks
@@ -75,11 +67,16 @@ module OBSWS
       include Mixin::OPCodes
 
       def initialize(**kwargs)
-        kwargs[:subs] = SUBS.low_volume
+        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
@@ -72,7 +77,10 @@ module OBSWS
       end
 
       def call_vendor_request(name, type_, data = nil)
-        call(requestType, requestData)
+        payload = { vendorName: name, requestType: type_ }
+        payload[:requestData] = data if data
+        resp = call("CallVendorRequest", payload)
+        Mixin::Response.new(resp, resp.keys)
       end
 
       def get_hotkey_list
@@ -256,7 +264,7 @@ module OBSWS
       end
 
       def get_group_list
-        resp = call("GetSceneList")
+        resp = call("GetGroupList")
         Mixin::Response.new(resp, resp.keys)
       end
 
@@ -324,6 +332,7 @@ module OBSWS
 
       def get_special_inputs
         resp = call("GetSpecialInputs")
+        Mixin::Response.new(resp, resp.keys)
       end
 
       def create_input(
@@ -341,6 +350,7 @@ module OBSWS
           sceneItemEnabled: scene_item_enabled
         }
         resp = call("CreateInput", payload)
+        Mixin::Response.new(resp, resp.keys)
       end
 
       def remove_input(name)
@@ -823,6 +833,7 @@ module OBSWS
 
       def stop_record
         resp = call("StopRecord")
+        Mixin::Response.new(resp, resp.keys)
       end
 
       def toggle_record_pause

data/lib/obsws/version.rb

@@ -7,11 +7,11 @@ module OBSWS
     end
 
     def minor
-      0
+      1
     end
 
     def patch
-      3
+      1
     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.1
 platform: ruby
 authors:
 - onyx_online
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-23 00:00:00.000000000 Z
+date: 2022-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: observer