zabbixapi 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 491a14fb3d69c78a072b5f67a72fa1410835a7c6
-  data.tar.gz: 4f19756c236c435d6f253943182e8d123442e7c1
+  metadata.gz: 62d0c2a77a20181c6c206a4ef0f326816c9cd393
+  data.tar.gz: 5f56649ab7a8db90bd5ce3cf9bcd6960f9ee1c08
 SHA512:
-  metadata.gz: 36562b8555de03cff58f5e7d1b73daa12e5c3d3dfd990ddff49077b6f47470b915ccaa389c8b719f4f8681ed5cf1cf8b319ca892a6d234d183e633d0c71db04c
-  data.tar.gz: bf90b9d74bde43345caf3e66cb36f9bd059e2595e0e4fa454ec1395752b7b59e6d5d70640db1a110702b8faa0ca35e6504c34313e39f60c77f55443f983d4c03
+  metadata.gz: 8f2be925d94ce9d47224cf6724cfbaa4a686bb846ee773919e5561632913340e80846af20e6f43a2d68e85b42ed53505dd4c6a79087c76d015e6973f107627e1
+  data.tar.gz: aba85f76d861928efa429139f9aff3ecef58f6a0d6599de0c48905675eab6753f73df764b61f15d1a5b3d0c626f397b556b32a096d0b67d06f3d99be3aebeb88

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 3.1.0
+[PR #68](https://github.com/express42/zabbixapi/pull/68) Add support for scripts (Thanx @jrbeilke)
+
 ## 2.4.9
 
 [PR #55](https://github.com/express42/zabbixapi/pull/55) Add 3.2.x support (Thanx @jrbeilke)

data/README.md

@@ -31,7 +31,7 @@ We support only two last versions of zabbix (2.4 and 3.0), so you should conside
 
 ## Installation
 ```
-gem install zabbixapi -v 2.4.7
+gem install zabbixapi
 ```
 
 ## Getting Started
@@ -488,6 +488,30 @@ zbx.users.update_medias(
 )
 ```
 
+### Create Script
+```ruby
+zbx.scripts.create(
+  :name => 'Hostname',
+  :command => 'hostname'
+)
+# or use (lib merge json):
+zbx.scripts.create_or_update(
+  :name => 'Hostname',
+  :command => 'hostname',
+  :description => 'Show the system hostname'
+)
+```
+
+### Update Script
+```ruby
+zbx.scripts.update(
+  :httptestid => zbx.scripts.get_id(:name => 'Hostname'),
+  :execute_on => 0
+)
+#You can check script:
+puts zbx.scripts.get_full_data(:name => 'Hostname')
+
+
 ### Create proxy
 #### Active proxy
 ```ruby

data/lib/zabbixapi.rb

@@ -26,6 +26,7 @@ require "zabbixapi/classes/usermacros"
 require "zabbixapi/classes/users"
 require "zabbixapi/classes/configurations"
 require "zabbixapi/classes/actions"
+require "zabbixapi/classes/scripts"
 
 class ZabbixApi
 
@@ -119,4 +120,8 @@ class ZabbixApi
     @actions ||= Actions.new(@client)
   end
 
+  def scripts
+    @scripts ||= Scripts.new(@client)
+  end
+
 end

data/lib/zabbixapi/classes/scripts.rb

@@ -0,0 +1,27 @@
+class ZabbixApi
+  class Scripts < Basic
+
+    def method_name
+      "script"
+    end
+
+    def indentify
+      "name"
+    end
+
+    def execute(data)
+      @client.api_request(
+        :method => "script.execute",
+        :params => {
+          :scriptid => data[:scriptid],
+          :hostid => data[:hostid]
+        }
+      )
+    end
+
+    def getscriptsbyhost(data)
+      @client.api_request(:method => "script.getscriptsbyhosts", :params => data)
+    end
+
+  end
+end

data/lib/zabbixapi/version.rb

@@ -1,3 +1,3 @@
 class ZabbixApi
-  VERSION = "3.0.0"
+  VERSION = "3.1.0"
 end

data/spec/script.rb

@@ -0,0 +1,123 @@
+#encoding: utf-8
+
+require 'spec_helper'
+
+describe 'script' do
+  before :all do
+    @hostid = zbx.hosts.get_id(:host => 'Zabbix server')
+  end
+
+  context 'when name not exists' do
+    before do
+      @script = gen_name 'script'
+    end
+
+    describe 'create' do
+      it "should return integer id" do
+        scriptid = zbx.scripts.create(
+          :name => @script,
+          :command => 'hostname',
+        )
+        expect(scriptid).to be_kind_of(Integer)
+      end
+    end
+
+    describe 'get_id' do
+      it "should return nil" do
+        expect(zbx.scripts.get_id(:name => @script)).to be_kind_of(NilClass)
+      end
+    end
+  end
+
+  context 'when name exists' do
+    before :all do
+      @script = gen_name 'script'
+      @scriptid = zbx.scripts.create(
+        :name => @script,
+        :command => 'hostname',
+      )
+    end
+
+    describe 'get_or_create' do
+      it "should return id of script" do
+        expect(zbx.scripts.get_or_create(
+          :name => @script,
+          :command => 'hostname',
+        )).to eq @scriptid
+      end
+    end
+
+    describe 'get_full_data' do
+      it "should contains created script" do
+        expect(zbx.scripts.get_full_data(:name => @script)[0]).to include("name" => @script)
+      end
+    end
+
+    describe 'get_id' do
+      it "should return id of script" do
+        expect(zbx.scripts.get_id(:name => @script)).to eq @scriptid
+      end
+    end
+
+    it "should raise error on no identity given" do
+        expect { zbx.scripts.get_id({}) }.to raise_error(ZabbixApi::ApiError)
+    end
+
+    describe 'update' do
+      it "should return id" do
+        expect(zbx.scripts.update(
+          :scriptid => zbx.scripts.get_id(:name => @script),
+          :enable_confirmation => 1,
+          :confirmation => 'Are you sure you would like to show the system hostname?'
+        )).to eq @scriptid
+      end
+    end
+
+    describe 'create_or_update' do
+      it "should update existing script" do
+        expect(zbx.scripts.get_or_create(
+          :name => @script,
+          :command => 'hostname',
+        )).to eq @scriptid
+      end
+
+      it "should create script" do
+        new_script_id = zbx.scripts.get_or_create(
+          :name => @script + "____1",
+          :command => 'hostname',
+        )
+
+        expect(new_script_id).to be_kind_of(Integer)
+        expect(new_script_id).to be > @scriptid
+      end
+    end
+
+    # TODO: see if we can get this test working with travis ci (passes on standalone zabbix server)
+    #describe 'execute' do
+    #  it "should return success response" do
+    #    expect(zbx.scripts.execute(:scriptid => @scriptid, :hostid => @hostid)).to include("response" => "success")
+    #  end
+    #end
+
+    describe 'getscriptsbyhost' do
+      it "should return object with hostid and script" do
+        expect(zbx.scripts.getscriptsbyhost([@hostid])[@hostid.to_s].select { |script| script[:name] == @script}).to_not be_nil
+      end
+    end
+
+    describe 'delete' do
+      before :all do
+        @result = zbx.scripts.delete(@scriptid)
+      end
+
+      it "should return deleted id" do
+        expect(@result).to eq @scriptid
+      end
+
+      it "should delete script from zabbix" do
+        expect(zbx.scripts.get_id(:name => @script)).to be_nil
+      end
+    end
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zabbixapi
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Vasiliev D.V.
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-30 00:00:00.000000000 Z
+date: 2017-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -90,6 +90,7 @@ files:
 - lib/zabbixapi/classes/mediatypes.rb
 - lib/zabbixapi/classes/proxies.rb
 - lib/zabbixapi/classes/screens.rb
+- lib/zabbixapi/classes/scripts.rb
 - lib/zabbixapi/classes/server.rb
 - lib/zabbixapi/classes/templates.rb
 - lib/zabbixapi/classes/triggers.rb
@@ -112,6 +113,7 @@ files:
 - spec/mediatype.rb
 - spec/query.rb
 - spec/screen.rb
+- spec/script.rb
 - spec/server.rb
 - spec/spec_helper.rb
 - spec/template.rb
@@ -140,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: zabbixapi
-rubygems_version: 2.5.2
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Realization for Zabbix API.
@@ -158,6 +160,7 @@ test_files:
 - spec/mediatype.rb
 - spec/query.rb
 - spec/screen.rb
+- spec/script.rb
 - spec/server.rb
 - spec/spec_helper.rb
 - spec/template.rb