teamspeak3 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bebe083b0e4cee5773974e0be78e77f6680fbb9b6cb55bbdc94b63025e1ef3e
-  data.tar.gz: f0cc6ed512db322c8f62068a47c6309d1a7204790a6427a5028ee7f3d24cf20c
+  metadata.gz: 7a9a666fc2ac36dd2eeacd0a9df82c5d5d5c6f72489626f5b8a8ddd62fc704b0
+  data.tar.gz: 1227b17b8a5017667b0030a558293f13325a5c76b4dd8a53874ee607bfcf25f9
 SHA512:
-  metadata.gz: 69048c150b84329a98dc2c7070b093c01e667a8afa9353aea8faee8ca769c72be44b0421e5d51f80fb627c52c39461d068ff1b933aa5252be9f9b2881ea036c6
-  data.tar.gz: a73175a6013b5dd7a3fe3a9057b2141fedf744c2b7593dd3e8c808ad5847c4bb22a624b0ba0ddb1700b0a42da7b3291f5fc68fa3c767493188c84537edce4b05
+  metadata.gz: c0303bd9c01a7e318521dc57a7332a9757db6f41e53ceafba0f17591812938e0ad0db43d996e8887e5f45356ce89cb36a881490cca626ab13dbba30a9c212bcf
+  data.tar.gz: 2ad74c0fa4349a7b5f37e17eb28e7fd472768afb289469876388bf04d7f60737c5c366f0b764fbdcab2624168da39636ce088b38bf26063ef8ddb7c3a7a93f41

data/CHANGELOG.md

@@ -1,4 +1,12 @@
-## Release 0.0.5 (unknown)
+## Release 0.0.6 (2018-06-24)
+
+### Virtual Servers
+
+* Add method to start virtual servers (#start)
+* Add method to stop virtual servers (#stop)
+* Add method to delete/destroy virtual servers (#destroy!)
+
+## Release 0.0.5 (2018-06-21)
 
 * Add `TeamSpeak3::QueryAccount` to modify the logged in query account. (Accessible via `TeamSpeak3::Server#query_account`)
 * Add `TeamSpeak3::Server#create` to create virtual servers

data/lib/exceptions.rb

@@ -10,3 +10,5 @@ require_relative 'exceptions/max_slot_limit_reached.rb'
 require_relative 'exceptions/not_connected.rb'
 require_relative 'exceptions/query_login_failed.rb'
 require_relative 'exceptions/server_connection_failed.rb'
+require_relative 'exceptions/virtual_server_not_running.rb'
+require_relative 'exceptions/virtual_server_already_running.rb'

data/lib/exceptions/virtual_server_already_running.rb

@@ -0,0 +1,12 @@
+module TeamSpeak3
+  module Exceptions
+    class VirtualServerAlreadyRunning < TeamSpeak3::Exceptions::StandardException
+      attr_reader :server_id
+
+      def initialize(server_id)
+        @server_id = server_id
+        @message = 'The virtual server is already running'
+      end
+    end
+  end
+end

data/lib/exceptions/virtual_server_not_running.rb

@@ -0,0 +1,12 @@
+module TeamSpeak3
+  module Exceptions
+    class VirtualServerNotRunning < TeamSpeak3::Exceptions::StandardException
+      attr_reader :server_id
+
+      def initialize(server_id)
+        @server_id = server_id
+        @message = 'The virtual server is not running'
+      end
+    end
+  end
+end

data/lib/server.rb

@@ -158,6 +158,9 @@ module TeamSpeak3
     end
 
     def execute(command, params = {})
+      allow_to_fail = params[:allow_to_fail]
+      params.delete(:allow_to_fail)
+
       prepared_command = prepare_command(command, params)
       @socket.puts(prepared_command)
 
@@ -165,7 +168,7 @@ module TeamSpeak3
       response = @socket.waitfor(/error id=.*/)
 
       response = TeamSpeak3::ServerResponse.parse(response)
-      if response[:errors][:msg] != 'ok'
+      if response[:errors][:msg] != 'ok' && !allow_to_fail
         raise TeamSpeak3::Exceptions::CommandExecutionFailed.new(
           response[:errors][:id],
           response[:errors][:msg],

data/lib/teamspeak3.rb

@@ -1,7 +1,7 @@
 require 'net/telnet'
 
 module TeamSpeak3
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end
 
 # exceptions shall be required first

data/lib/virtual_server.rb

@@ -28,6 +28,35 @@ module TeamSpeak3
       @uid = params[:virtualserver_unique_identifier]
     end
 
+    def destroy!
+      execute :serverstop, sid: @id, allow_to_fail: true, ignore_active_server: true
+      execute :serverdelete, sid: @id, ignore_active_server: true
+
+      true
+    end
+
+    def start
+      begin
+        execute :serverstart, sid: @id, ignore_active_server: true
+      rescue Exceptions::CommandExecutionFailed => err
+        raise Exceptions::VirtualServerAlreadyRunning.new(@id) if err.message =~ /server got an invalid status/ && status == :online
+        raise
+      end
+
+      true
+    end
+
+    def stop
+      begin
+        execute :serverstop, sid: @id, ignore_active_server: true
+      rescue Exceptions::CommandExecutionFailed => err
+        raise Exceptions::VirtualServerNotRunning.new(@id) if err.message =~ /server is not running/
+        raise
+      end
+
+      true
+    end
+
     def channels
       channels_list = ChannelCollection.new(self)
       channels = execute :channellist, options: [:topic, :flags, :voice, :limits, :icon]
@@ -55,7 +84,9 @@ module TeamSpeak3
     end
 
     def execute(command, params = {})
-      check_active_server
+      check_active_server unless params[:ignore_active_server]
+      params.delete(:ignore_active_server)
+
       @server.execute(command, params)
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: teamspeak3
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Manuel Schnitzer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-21 00:00:00.000000000 Z
+date: 2018-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-telnet
@@ -93,6 +93,8 @@ files:
 - lib/exceptions/query_login_failed.rb
 - lib/exceptions/server_connection_failed.rb
 - lib/exceptions/standard_exception.rb
+- lib/exceptions/virtual_server_already_running.rb
+- lib/exceptions/virtual_server_not_running.rb
 - lib/query_account.rb
 - lib/server.rb
 - lib/server_response.rb