Add logout method

express42 · Sep 21, 2017 · 40ea15e · 40ea15e
1 parent 6af62d6
commit 40ea15e
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 0 deletions.
diff --git a/examples/README.md b/examples/README.md
@@ -52,6 +52,21 @@ zbx = ZabbixApi.connect(
 )
 ```
 
+## Logout
+```ruby
+require "zabbixapi"
+
+zbx = ZabbixApi.connect(
+  :url => 'http://localhost/zabbix/api_jsonrpc.php',
+  :user => 'Admin',
+  :password => 'zabbix'
+)
+
+# Do stuff
+
+zbx.logout
+```
+
 ## Create Host
 ```ruby
 zbx.hosts.create(

diff --git a/lib/zabbixapi.rb b/lib/zabbixapi.rb
@@ -54,6 +54,12 @@ def query(data)
     @client.api_request(:method => data[:method], :params => data[:params])
   end
 
+  # Invalidate current authentication token
+  # @return [Boolean]
+  def logout
+    @client.logout
+  end
+
   # Initializes a new ZabbixApi object
   #
   # @param options [Hash]

diff --git a/lib/zabbixapi/client.rb b/lib/zabbixapi/client.rb
@@ -32,6 +32,16 @@ def auth
       )
     end
 
+    # Log out from the Zabbix Server
+    #
+    # @return [Boolean]
+    def logout
+      api_request(
+        :method => 'user.logout',
+        :params => []
+      )
+    end
+
     # Initializes a new Client object
     #
     # @param options [Hash]