patch bump

error tests added

Rakefile updated with new test file names

event tasks moved into :e namespace

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    obsws (0.5.0)
+    obsws (0.5.3)
       waitutil (~> 0.2.1)
       websocket-driver (~> 0.7.5)
 

README.md

@@ -115,7 +115,7 @@ If a connection attempt fails or times out an `OBSWSConnectionError` will be rai
 
 If a request fails an `OBSWSRequestError` will be raised with a status code.
 
-- The request name and code are retrievable through attributes {OBSWSRequestError}.name and {OBSWSRequestError}.code
+- The request name and code are retrievable through attributes {OBSWSRequestError}.req_name and {OBSWSRequestError}.code
 
 For a full list of status codes refer to [Codes](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#requeststatus)
 

Rakefile

@@ -5,19 +5,25 @@ HERE = __dir__
 Minitest::TestTask.create(:test) do |t|
   t.libs << "test"
   t.warning = false
-  t.test_globs = ["test/**/*_test.rb"]
+  t.test_globs = ["test/**/test_*.rb"]
 end
 
 task default: :test
-task :events do
-  filepath = File.join(HERE, "examples", "events", "main.rb")
-  ruby filepath
-end
-task :levels do
-  filepath = File.join(HERE, "examples", "levels", "main.rb")
-  ruby filepath
-end
-task :scene_rotate do
-  filepath = File.join(HERE, "examples", "scene_rotate", "main.rb")
-  ruby filepath
+
+namespace :e do
+  desc "Runs the events example"
+  task :events do
+    filepath = File.join(HERE, "examples", "events", "main.rb")
+    ruby filepath
+  end
+  desc "Runs the levels example"
+  task :levels do
+    filepath = File.join(HERE, "examples", "levels", "main.rb")
+    ruby filepath
+  end
+  desc "Runs the scene_rotate example"
+  task :scene_rotate do
+    filepath = File.join(HERE, "examples", "scene_rotate", "main.rb")
+    ruby filepath
+  end
 end

lib/obsws.rb

@@ -22,10 +22,10 @@ module OBSWS
   class OBSWSConnectionError < OBSWSError; end
 
   class OBSWSRequestError < OBSWSError
-    attr_reader :name, :code
+    attr_reader :req_name, :code
 
-    def initialize(name, code, msg)
-      @name = name
+    def initialize(req_name, code, msg)
+      @req_name = req_name
       @code = code
       @msg = msg
       super(message)
@@ -33,7 +33,7 @@ module OBSWS
 
     def message
       msg = [
-        "Request #{@name} returned code #{@code}."
+        "Request #{@req_name} returned code #{@code}."
       ]
       msg << "With message: #{@msg}" if @msg
       msg.join(" ")

lib/obsws/base.rb

@@ -12,11 +12,12 @@ module OBSWS
       port = kwargs[:port] || 4455
       @password = kwargs[:password] || ""
       @subs = kwargs[:subs] || 0
+      @connect_timeout = kwargs[:connect_timeout] || 3
       setup_driver(host, port) and start_driver
       WaitUtil.wait_for_condition(
         "successful identification",
         delay_sec: 0.01,
-        timeout_sec: 3
+        timeout_sec: @connect_timeout
       ) { @identified }
     end
 

lib/obsws/req.rb

@@ -9,9 +9,8 @@ module OBSWS
         @base_client = Base.new(**kwargs)
         logger.info("#{self} successfully identified with server")
       rescue Errno::ECONNREFUSED, WaitUtil::TimeoutError => e
-        msg = "#{e.class.name}: #{e.message}"
-        logger.error(msg)
-        raise OBSWSConnectionError.new(msg)
+        logger.error("#{e.class.name}: #{e.message}")
+        raise OBSWSConnectionError.new(e.message)
       else
         @base_client.updater = ->(op_code, data) {
           logger.debug("response received: #{data}")
@@ -48,19 +47,11 @@ module OBSWS
         end
         @response[:responseData]
       rescue OBSWSRequestError => e
-        err_msg = [
-          "#{e.class.name}: #{e.message}",
-          *e.backtrace
-        ]
-        logger.error(err_msg.join("\n"))
+        logger.error(["#{e.class.name}: #{e.message}", *e.backtrace].join("\n"))
         raise
       rescue WaitUtil::TimeoutError => e
-        err_msg = [
-          "#{e.class.name}: #{e.message}",
-          *e.backtrace
-        ]
-        logger.error(err_msg)
-        raise OBSWSError.new(err_msg)
+        logger.error(["#{e.class.name}: #{e.message}", *e.backtrace].join("\n"))
+        raise OBSWSError.new([e.message, *e.backtrace].join("\n"))
       end
 
       def get_version

lib/obsws/version.rb

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

main.rb

@@ -1,4 +1,4 @@
-require_relative "lib/obsws"
+require "obsws"
 
 class Main
   def run

test/obsws/test_error.rb

@@ -0,0 +1,17 @@
+require_relative "../minitest_helper"
+
+class OBSWSConnectionErrorTest < Minitest::Test
+  def test_it_raises_an_obsws_connection_error_on_wrong_password
+    e = assert_raises(OBSWS::OBSWSConnectionError) { OBSWS::Requests::Client.new(host: "localhost", port: 4455, password: "wrongpassword", connect_timeout: 1).new }
+    assert_equal(e.message, "Timed out waiting for successful identification (1 seconds elapsed)")
+  end
+end
+
+class OBSWSRequestErrorTest < Minitest::Test
+  def test_it_raises_an_obsws_request_error_on_invalid_request
+    e = assert_raises(OBSWS::OBSWSRequestError) { OBSWSTest.r_client.toggle_input_mute("unknown") }
+    assert_equal(e.req_name, "ToggleInputMute")
+    assert_equal(e.code, 600)
+    assert_equal(e.message, "Request ToggleInputMute returned code 600. With message: No source was found by the name of `unknown`.")
+  end
+end