zabbixapi 0.4.8 → 0.4.9

data/README.md

@@ -212,11 +212,25 @@ zbx.graphs.delete(zbx.graphs.get_id(:name => "graph"))
 ### Create screen for host  ###
 ```ruby
 zbx.screens.get_or_create_for_host(
-  :hostname => "hostname",
+  :host => "hostname",
   :graphids => zbx.graphs.get_ids_by_host(:host => "hostname")
 )
 ```
 
+### Create UserGroup, add user and add rights ###
+```ruby
+zbx.usergroups.add(:name => "Some user group")
+zbx.usergroups.add_user(
+  :usrgrpids => [zbx.usergroups.get_id(:name => "Some user group")],
+  :userids => [zbx.users.get_id(:name => "Some user")]
+)
+# get read permissions for UserGroup on all hostgroup
+zbx.usergroups.set_perm_read(
+   :usrgrpids => zbx.usergroups.get_or_create(:name => "Some user group"),
+   :hostgroupids => zbx.hostgroups.all.values
+)
+```
+
 ### Custom queries
 ```ruby
 zbx.query(

data/lib/zabbixapi/hostgroups.rb

@@ -40,6 +40,18 @@ class ZabbixApi
       end
     end
 
+    # Return all hostgroups
+    # 
+    # * *Returns* :
+    #   - Hash with {"Hostgroup1" => "id1", "Hostgroup2" => "id2"}
+    def all
+      result = {}
+      @client.api_request(:method => "hostgroup.get", :params => {:output => "extend"}).each do |hostgrp|
+        result[hostgrp['name']] = hostgrp['groupid']
+      end
+      result
+    end
+
     def get_id(data)
       result = get_full_data(data)
       hostgroupid = nil
@@ -48,4 +60,4 @@ class ZabbixApi
     end
 
   end
-end
+end

data/lib/zabbixapi/usergroups.rb

@@ -0,0 +1,125 @@
+class ZabbixApi
+  class Usergroups
+
+    def initialize(options = {})
+      @client = Client.new(options)
+      @options = options
+    end
+
+    # Create UserGroup
+    #
+    # * *Args*    :
+    #   - +data+ -> Hash with :name => "UserGroup"
+    # * *Returns* :
+    #   - Nil or Integer
+    def create(data)
+      result = @client.api_request(:method => "usergroup.create", :params => data)
+      result ? result['usrgrpids'][0].to_i : nil
+    end
+
+    # Add UserGroup
+    # Synonym create
+    def add(data)
+      create(data)
+    end
+
+    # Delete UserGroup
+    #
+    # * *Args*    :
+    #   - +data+ -> Array with usrgrpids
+    # * *Returns* :
+    #   - Nil or Integer
+    def delete(data)
+      result = @client.api_request(:method => "usergroup.delete", :params => data)
+      result ? result['usrgrpids'][0].to_i : nil
+    end
+
+    # Destroy UserGroup
+    # Synonym delete
+    def destroy(data)
+      delete(data)
+    end
+
+    # Get UserGroup info
+    #
+    # * *Args*    :
+    #   - +data+ -> Hash with :name => "UserGroup"
+    # * *Returns* :
+    #   - Nil or Integer
+    def get_full_data(data)
+      @client.api_request(
+        :method => "usergroup.get", 
+        :params => {
+          :filter => [data[:name]],
+          :output => "extend"
+          }
+        )
+    end
+
+    def get(data)
+      get_full_data(data)
+    end
+
+    # Return usrgrpid
+    # 
+    # * *Args*    :
+    #   - +data+ -> Hash with :name => "UserGroup"
+    # * *Returns* :
+    #   - Nil or Integer 
+    def get_id(data)
+      result = get_full_data(data)
+      usrgrpid = nil
+      result.each { |usr| usrgrpid = usr['usrgrpid'].to_i if usr['name'] == data[:name] }
+      usrgrpid
+    end
+
+    # Return usrgrpid
+    # 
+    # * *Args*    :
+    #   - +data+ -> Hash with :name => "UserGroup"
+    # * *Returns* :
+    #   - Integer
+    def get_or_create(data)
+      usrgrpid = get_id(data)
+      if usrgrpid.nil?
+        usrgrpid = create(data)
+      end
+      usrgrpid
+    end
+
+    # Set read permisssion for usrgrp on some hostgroup
+    # 
+    # * *Args*    :
+    #   - +data+ -> Hash with :usrgrpids => id, :hostgroupids => []
+    # * *Returns* :
+    #   - Integer
+    def set_perm_read(data)
+      result = @client.api_request(
+        :method => "usergroup.massAdd", 
+        :params => {
+          :usrgrpids => [data[:usrgrpids]],
+          :rights => data[:hostgroupids].map { |t| {:permission => 2, :id => t} }
+        }
+      )
+      result ? result['usrgrpids'][0].to_i : nil
+    end
+
+    # Update usergroup, add user
+    # 
+    # * *Args*    :
+    #   - +data+ -> Hash with :usrgrpids => id, :userids => []
+    # * *Returns* :
+    #   - Integer
+    def add_user(data)
+      result = @client.api_request(
+        :method => "usergroup.massAdd", 
+        :params => {
+          :usrgrpids => data[:usrgrpids],
+          :userids => data[:userids]
+        }
+      )
+      result ? result['usrgrpids'][0].to_i : nil
+    end
+
+  end
+end

data/lib/zabbixapi/version.rb

@@ -1,3 +1,3 @@
 class ZabbixApi
-  VERSION = "0.4.8"
+  VERSION = "0.4.9"
 end

data/lib/zabbixapi.rb

@@ -10,6 +10,7 @@ require "zabbixapi/triggers"
 require "zabbixapi/items"
 require "zabbixapi/graphs"
 require "zabbixapi/screens"
+require "zabbixapi/usergroups"
 
 class ZabbixApi
 
@@ -24,6 +25,7 @@ class ZabbixApi
   attr :triggers
   attr :graphs
   attr :screens
+  attr :usergroups
 
   def self.connect(options = {})
     new(options)
@@ -49,6 +51,7 @@ class ZabbixApi
     @triggers = Triggers.new(options)
     @graphs = Graphs.new(options)
     @screens = Screens.new(options)
+    @usergroups = Usergroups.new(options)
   end
 
 end

data/spec/localhost.rb

@@ -1,7 +1,6 @@
 require 'zabbixapi'
 
 # settings
-#api_url = 'http://zabbix/zabbix12/api_jsonrpc.php'
 api_url = 'http://zabbix/api_jsonrpc.php'
 #api_url = 'http://zabbix/zabbix20/api_jsonrpc.php'
 
@@ -12,7 +11,7 @@ zbx = ZabbixApi.connect(
   :url => api_url,
   :user => api_login,
   :password => api_password,
-  :debug => false
+  :debug => true
 )
 
 hostgroup = "hostgroup______1"
@@ -23,8 +22,10 @@ host = "hostname____1"
 trigger = "trigger____1"
 user = "user____1"
 user2 = "user____2"
+usergroup = "SomeUserGroup"
 graph = "graph___a"
 
+
 puts "### Zabbix API server version #{zbx.server.version} ###"
 
 describe ZabbixApi, "test_api" do
@@ -49,6 +50,10 @@ describe ZabbixApi, "test_api" do
     zbx.hostgroups.get_or_create(:name => hostgroup).should be_kind_of(Integer)
   end
 
+  it "HOSTGROUP: Get all" do
+    zbx.hostgroups.all.should be_kind_of(Hash)
+  end
+
   it "TEMPLATE: Create" do
     zbx.templates.create(
       :host => template,
@@ -353,10 +358,36 @@ describe ZabbixApi, "test_api" do
     zbx.users.get_id(:name => "#{user}_____")
   end
 
+  it "USERGROUPS: Create" do
+    zbx.usergroups.create(:name => usergroup).should be_kind_of(Integer)
+  end
+
+  it "USERGROUPS: Create or update" do
+    zbx.usergroups.get_or_create(:name => usergroup).should be_kind_of(Integer)
+  end
+
+  it "USERGROUPS: Add user" do
+    zbx.usergroups.add_user(
+        :usrgrpids => [zbx.usergroups.get_id(:name => usergroup)],
+        :userids => [zbx.users.get_id(:name => user2)]
+    ).should be_kind_of(Integer)
+  end
+
+  it "USERGROUPS: Set UserGroup read perm" do
+    puts zbx.usergroups.set_perm_read(
+      :usrgrpids => zbx.usergroups.get_or_create(:name => usergroup).to_s,
+      :hostgroupids => zbx.hostgroups.all.values
+    )
+  end
+
   it "USER: Delete" do
     zbx.users.delete(zbx.users.get_id(:name => user2)).should be_kind_of(Integer)
   end
 
+  it "USERGROUPS: Delete" do
+    zbx.usergroups.delete([zbx.usergroups.get_id(:name => usergroup)]).should be_kind_of(Integer)
+  end
+
   it "QUERY" do
     zbx.query(
       :method => "apiinfo.version", 

data/spec/run.rb

@@ -20,6 +20,7 @@ host = "hostname"
 trigger = "trigger"
 user = "user"
 user2 = "user2"
+usergroup = "SomeUserGroup"
 graph = "graph"
 
 puts "### Zabbix API server version #{zbx.server.version} ###"
@@ -46,6 +47,10 @@ describe ZabbixApi, "test_api" do
     zbx.hostgroups.get_or_create(:name => hostgroup).should be_kind_of(Integer)
   end
 
+  it "HOSTGROUP: Get all" do
+    zbx.hostgroups.all.should be_kind_of(Hash)
+  end
+
   it "TEMPLATE: Create" do
     zbx.templates.create(
       :host => template,
@@ -350,10 +355,36 @@ describe ZabbixApi, "test_api" do
     zbx.users.get_id(:name => "#{user}_____")
   end
 
+  it "USERGROUPS: Create" do
+    zbx.usergroups.create(:name => usergroup).should be_kind_of(Integer)
+  end
+
+  it "USERGROUPS: Create or update" do
+    zbx.usergroups.get_or_create(:name => usergroup).should be_kind_of(Integer)
+  end
+
+  it "USERGROUPS: Add user" do
+    zbx.usergroups.add_user(
+        :usrgrpids => [zbx.usergroups.get_id(:name => usergroup)],
+        :userids => [zbx.users.get_id(:name => user2)]
+    ).should be_kind_of(Integer)
+  end
+
+  it "USERGROUPS: Set UserGroup read perm" do
+    puts zbx.usergroups.set_perm_read(
+      :usrgrpids => zbx.usergroups.get_or_create(:name => usergroup).to_s,
+      :hostgroupids => zbx.hostgroups.all.values
+    )
+  end
+
   it "USER: Delete" do
     zbx.users.delete(zbx.users.get_id(:name => user2)).should be_kind_of(Integer)
   end
 
+  it "USERGROUPS: Delete" do
+    zbx.usergroups.delete([zbx.usergroups.get_id(:name => usergroup)]).should be_kind_of(Integer)
+  end
+
   it "QUERY" do
     zbx.query(
       :method => "apiinfo.version", 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zabbixapi
 version: !ruby/object:Gem::Version
-  version: 0.4.8
+  version: 0.4.9
   prerelease: 
 platform: ruby
 authors:
@@ -37,6 +37,7 @@ files:
 - lib/zabbixapi/server.rb
 - lib/zabbixapi/templates.rb
 - lib/zabbixapi/triggers.rb
+- lib/zabbixapi/usergroups.rb
 - lib/zabbixapi/users.rb
 - lib/zabbixapi/version.rb
 - spec/localhost.rb
@@ -57,7 +58,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1867199744098275115
+      hash: 772966212321473365
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: