zabbixapi 0.5.0b → 0.5.0b2

data/README.md

@@ -225,13 +225,35 @@ zbx.usergroups.add_user(
   :userids => [zbx.users.get_id(:name => "Some user")]
 )
 # set write and read permissions for UserGroup on all hostgroups
-zbx.usergroups.set_perm_read(
+zbx.usergroups.set_perm(
    :usrgrpid => zbx.usergroups.get_or_create(:name => "Some user group"),
-   :hostgroupids => zbx.hostgroups.all.values,
+   :hostgroupids => zbx.hostgroups.all.values, # kind_of Array
    :permission => 3 # 2- read (by default) and 3 - write and read
 )
 ```
 
+### Create MediaType and add it to user ###
+```ruby
+zbx.mediatypes.create_or_update(
+  :description => "mediatype",
+  :type => 0,
+  :smtp_server => "127.0.0.1",
+  :smtp_email => "zabbix@test.com"
+)
+zbx.users.add_medias(
+  :userids => [zbx.users.get_id(:name => "user")],
+  :media => [
+    {
+      :mediatypeid => zbx.mediatypes.get_id(:description => "mediatype"), 
+      :sendto => "test@test", 
+      :active => 0, 
+      :period => "1-7,00:00-24:00",
+      :severity => "56"
+    }
+  ]
+)
+```
+
 ### Custom queries
 ```ruby
 zbx.query(

data/lib/zabbixapi.rb

@@ -11,6 +11,7 @@ require "zabbixapi/items"
 require "zabbixapi/graphs"
 require "zabbixapi/screens"
 require "zabbixapi/usergroups"
+require "zabbixapi/mediatypes"
 
 class ZabbixApi
 
@@ -26,6 +27,7 @@ class ZabbixApi
   attr :graphs
   attr :screens
   attr :usergroups
+  attr :mediatypes
 
   def self.connect(options = {})
     new(options)
@@ -52,6 +54,7 @@ class ZabbixApi
     @graphs = Graphs.new(options)
     @screens = Screens.new(options)
     @usergroups = Usergroups.new(options)
+    @mediatypes = Mediatypes.new(options)
   end
 
 end

data/lib/zabbixapi/mediatypes.rb

@@ -0,0 +1,110 @@
+class ZabbixApi
+  class Mediatypes
+
+    def initialize(options = {})
+      @client = Client.new(options)
+      @options = options
+      @default_mediatype_options = {
+        :description => "", #Name
+        :type => 0,         #0 - Email, 1 - External script, 2 - SMS, 3 - Jabber, 100 - EzTexting
+        :smtp_server => "", 
+        :smtp_helo   => "",
+        :smtp_email  => "",  #Email address of Zabbix server
+        :exec_path => "",    #Name of external script
+        :gsm_modem => "",    #Serial device name of GSM modem
+        :username  => "",    #Jabber user name used by Zabbix server
+        :passwd    => ""     #Jabber password used by Zabbix server
+      }
+    end
+
+    # Create MediaType
+    #
+    # * *Args*    :
+    #   - +data+ -> Hash with :description => "MediaGroup" and mediatype options
+    # * *Returns* :
+    #   - Nil or Integer
+    def create(data)
+      result = @client.api_request(:method => "mediatype.create", :params => data)
+      result ? result['mediatypeids'][0].to_i : nil
+    end
+
+    # Add MediaType
+    # Synonym create
+    def add(data)
+      create(data)
+    end
+
+    # Delete MediaType
+    #
+    # * *Args*    :
+    #   - +data+ -> Array with mediatypeids
+    # * *Returns* :
+    #   - Nil or Integer
+    def delete(data)
+      result = @client.api_request(:method => "mediatype.delete", :params => [data])
+      result ? result['mediatypeids'][0].to_i : nil
+    end
+
+    # Destroy MediaType
+    # Synonym delete
+    def destroy(data)
+      delete(data)
+    end
+
+    # Get MediaType info
+    #
+    # * *Args*    :
+    #   - +data+ -> Hash with :description => "MediaType"
+    # * *Returns* :
+    #   - Nil or Integer
+    def get_full_data(data)
+      @client.api_request(
+        :method => "mediatype.get", 
+        :params => {
+          :search => {:description => data[:description]},
+          :output => "extend"
+          }
+        )
+    end
+
+    def get(data)
+      get_full_data(data)
+    end
+
+    # Return MediaTypeid
+    # 
+    # * *Args*    :
+    #   - +data+ -> Hash with :description => "MediaType"
+    # * *Returns* :
+    #   - Nil or Integer 
+    def get_id(data)
+      result = get_full_data(data)
+      mediatypeid = nil
+      result.each { |mt| mediatypeid = mt['mediatypeid'].to_i if mt['description'] == data[:description] }
+      mediatypeid
+    end
+
+    # Return MediaTypeid
+    # 
+    # * *Args*    :
+    #   - +data+ -> Hash with :description => "MediaType"
+    # * *Returns* :
+    #   - Nil or Integer
+    def update(data)
+      result = @client.api_request(:method => "mediatype.update", :params => data)
+      result.empty? ? nil : result['mediatypeids'][0].to_i
+    end
+
+    # Return MediaTypeid
+    # 
+    # * *Args*    :
+    #   - +data+ -> Hash with :name => "UserGroup"
+    # * *Returns* :
+    #   - Integer
+    def create_or_update(data)
+      mediatypeid = get_id(:description => data[:description], :mediatypeid => data[:mediatypeid])
+      mediatypeid ? update(data.merge(:mediatypeid => mediatypeid)) : create(data)      
+    end
+
+  end
+end

data/lib/zabbixapi/usergroups.rb

@@ -93,7 +93,7 @@ class ZabbixApi
     #   - +data+ -> Hash with :usrgrpids => id, :hostgroupids => [], :permission => 2,3 (read and read write)
     # * *Returns* :
     #   - Integer
-    def set_perm(data)
+    def set_perms(data)
       permission = data[:permission] || 2 
       result = @client.api_request(
         :method => "usergroup.massAdd", 

data/lib/zabbixapi/users.rb

@@ -36,6 +36,22 @@ class ZabbixApi
       get_full_data(data)
     end
 
+    def create_or_update(data)
+      userid = get_id(:name => data[:name])
+      userid ? update(data.merge(:userid => userid)) : create(data)
+    end
+
+    def add_medias(data)
+      result = @client.api_request(
+        :method => "user.addMedia", 
+        :params => {
+          :users => data[:userids].map { |t| {:userid => t} },
+          :medias => data[:media]
+        }
+      )
+      result ? result['userids'][0].to_i : nil
+    end
+
     def get_id(data)
       result = get_full_data(data)
       userid = nil
@@ -49,4 +65,4 @@ class ZabbixApi
     end
 
   end
-end
+end

data/lib/zabbixapi/version.rb

@@ -1,3 +1,3 @@
 class ZabbixApi
-  VERSION = "0.5.0b"
+  VERSION = "0.5.0b2"
 end

data/spec/localhost.rb

@@ -11,7 +11,7 @@ zbx = ZabbixApi.connect(
   :url => api_url,
   :user => api_login,
   :password => api_password,
-  :debug => true
+  :debug => false
 )
 
 hostgroup = "hostgroup______1"
@@ -24,6 +24,7 @@ user = "user____1"
 user2 = "user____2"
 usergroup = "SomeUserGroup"
 graph = "graph___a"
+mediatype = "somemediatype"
 
 
 puts "### Zabbix API server version #{zbx.server.version} ###"
@@ -346,6 +347,15 @@ describe ZabbixApi, "test_api" do
     ).should be_kind_of(Integer)
   end
 
+  it "USER: Create or update" do
+    zbx.users.create_or_update(
+      :alias => "Test #{user}",
+      :name => user,
+      :surname => user,
+      :passwd => user
+    ).should be_kind_of(Integer)
+  end
+
   it "USER: Find" do
     zbx.users.get_full_data(:name => user)[0]['name'].should be_kind_of(String)
   end
@@ -374,11 +384,48 @@ describe ZabbixApi, "test_api" do
   end
 
   it "USERGROUPS: Set UserGroup read & write perm" do
-    puts zbx.usergroups.set_perm(
+    zbx.usergroups.set_perms(
       :usrgrpid => zbx.usergroups.get_or_create(:name => usergroup).to_s,
       :hostgroupids => zbx.hostgroups.all.values,
       :permission => 3
-    )
+    ).should be_kind_of(Integer)
+  end
+
+  it "MEDIATYPE: Create" do
+    zbx.mediatypes.create(
+      :description => mediatype,
+      :type => 0,
+      :smtp_server => "127.0.0.1",
+      :smtp_email => "zabbix@test.com"
+    ).should be_kind_of(Integer)
+  end
+
+  it "MEDIATYPE: Update or create" do
+    zbx.mediatypes.create_or_update(
+      :description => mediatype,
+      :smtp_email => "zabbix2@test.com"
+    ).should be_kind_of(Integer)
+  end
+
+  it "USER: Add mediatype" do
+    zbx.users.add_medias(
+      :userids => [zbx.users.get_id(:name => user2)],
+      :media => [
+        {
+          :mediatypeid => zbx.mediatypes.get_id(:description => mediatype), 
+          :sendto => "test@test", 
+          :active => 0, 
+          :period => "1-7,00:00-24:00",
+          :severity => "56"
+        }
+      ]
+    ).should be_kind_of(Integer)
+  end
+
+  it "MEDIATYPE: Delete" do
+    zbx.mediatypes.delete(
+      zbx.mediatypes.get_id(:description => mediatype)
+    ).should be_kind_of(Integer)
   end
 
   it "USER: Delete" do

data/spec/run.rb

@@ -22,6 +22,7 @@ user = "user"
 user2 = "user2"
 usergroup = "SomeUserGroup"
 graph = "graph"
+mediatype = "somemediatype"
 
 puts "### Zabbix API server version #{zbx.server.version} ###"
 
@@ -343,6 +344,15 @@ describe ZabbixApi, "test_api" do
     ).should be_kind_of(Integer)
   end
 
+  it "USER: Create or update" do
+    zbx.users.create_or_update(
+      :alias => "Test #{user}",
+      :name => user,
+      :surname => user,
+      :passwd => user
+    ).should be_kind_of(Integer)
+  end
+
   it "USER: Find" do
     zbx.users.get_full_data(:name => user)[0]['name'].should be_kind_of(String)
   end
@@ -371,11 +381,48 @@ describe ZabbixApi, "test_api" do
   end
 
   it "USERGROUPS: Set UserGroup read & write perm" do
-    puts zbx.usergroups.set_perm(
+    zbx.usergroups.set_perms(
       :usrgrpid => zbx.usergroups.get_or_create(:name => usergroup).to_s,
       :hostgroupids => zbx.hostgroups.all.values,
       :permission => 3
-    )
+    ).should be_kind_of(Integer)
+  end
+
+  it "MEDIATYPE: Create" do
+    zbx.mediatypes.create(
+      :description => mediatype,
+      :type => 0,
+      :smtp_server => "127.0.0.1",
+      :smtp_email => "zabbix@test.com"
+    ).should be_kind_of(Integer)
+  end
+
+  it "MEDIATYPE: Update or create" do
+    zbx.mediatypes.create_or_update(
+      :description => mediatype,
+      :smtp_email => "zabbix2@test.com"
+    ).should be_kind_of(Integer)
+  end
+
+  it "USER: Add mediatype" do
+    zbx.users.add_medias(
+      :userids => [zbx.users.get_id(:name => user2)],
+      :media => [
+        {
+          :mediatypeid => zbx.mediatypes.get_id(:description => mediatype), 
+          :sendto => "test@test", 
+          :active => 0, 
+          :period => "1-7,00:00-24:00",
+          :severity => "56"
+        }
+      ]
+    ).should be_kind_of(Integer)
+  end
+
+  it "MEDIATYPE: Delete" do
+    zbx.mediatypes.delete(
+      zbx.mediatypes.get_id(:description => mediatype)
+    ).should be_kind_of(Integer)
   end
 
   it "USER: Delete" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zabbixapi
 version: !ruby/object:Gem::Version
-  version: 0.5.0b
+  version: 0.5.0b2
   prerelease: 5
 platform: ruby
 authors:
@@ -33,6 +33,7 @@ files:
 - lib/zabbixapi/hostgroups.rb
 - lib/zabbixapi/hosts.rb
 - lib/zabbixapi/items.rb
+- lib/zabbixapi/mediatypes.rb
 - lib/zabbixapi/screens.rb
 - lib/zabbixapi/server.rb
 - lib/zabbixapi/templates.rb
@@ -58,7 +59,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3354477705725061225
+      hash: -4429484017589887978
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: