zabbix_protocol 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 68192799b80b8e4af27e6cd775304e0566eec47c
+  data.tar.gz: f327dd238150587052b9553adf9e9f17cc5350a4
+SHA512:
+  metadata.gz: 9594e301b14992cc73313977997aa1517ebda8c61072651e521ea89613f18a6212710c6e6ab3a13a64b8836b712922d963a6f9151bdae8b061a64cf0a5fb12b0
+  data.tar.gz: 4832ed560cc62c9c825bc83396e64261bcf45fc483330f0b4bbafd09f1686db83a63bed19513f199ee442bef9be18f0e907bf1b9f5a4d31ad88b5b68736494bf

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+test.rb

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--colour

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+- 2.0.0
+script:
+- bundle install
+- bundle exec rake

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in zabbix_protocol.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Genki Sugawara
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,89 @@
+# ZabbixProtocol
+
+Zabbix protocols builder/parser.
+
+see http://www.zabbix.org/wiki/Docs/protocols
+
+[![Gem Version](https://badge.fury.io/rb/zabbix_protocol.svg)](http://badge.fury.io/rb/zabbix_protocol)
+[![Build Status](https://travis-ci.org/winebarrel/zabbix_protocol.svg?branch=master)](https://travis-ci.org/winebarrel/zabbix_protocol)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zabbix_protocol'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zabbix_protocol
+
+## Usage
+
+### Zabbix 1.4 Passive checks
+
+http://www.zabbix.org/wiki/Docs/protocols/zabbix_agent/1.4
+
+```ruby
+require 'socket'
+require 'zabbix_protocol'
+
+AGENT_PORT = 10050
+
+TCPSocket.open("127.0.0.1", AGENT_PORT) do |sock|
+  data = "system.cpu.load[all,avg1]"
+
+  sock.print ZabbixProtocol.dump(data)
+  p ZabbixProtocol.load(sock.read) #=> 0.04
+end
+```
+
+### Zabbix 1.6 Active agents
+
+http://www.zabbix.org/wiki/Docs/protocols/zabbix_agent/1.6
+
+```ruby
+require 'socket'
+require 'zabbix_protocol'
+
+SERVER_PORT = 10051
+
+TCPSocket.open("127.0.0.1", SERVER_PORT) do |sock|
+  data = {"request" => "active checks", "host" => "my server"}
+
+  sock.print ZabbixProtocol.dump(data)
+  p ZabbixProtocol.load(sock.read)
+  #=> {"response"=>"success", "data"=>[]}
+end
+```
+
+### Zabbix sender 1.8 protocol
+
+http://www.zabbix.org/wiki/Docs/protocols/zabbix_sender/1.8
+
+```ruby
+require 'socket'
+require 'zabbix_protocol'
+
+SERVER_PORT = 10051
+
+TCPSocket.open("127.0.0.1", SERVER_PORT) do |sock|
+  data = {
+    "request" => "sender data",
+    "data" => [{
+      "host" => "my server",
+      "key" => "my.key",
+      "value" => "1"
+    }]
+  }
+
+  sock.print ZabbixProtocol.dump(data)
+  p ZabbixProtocol.load(sock.read)
+  #=> {"response"=>"success", "info"=>"Processed 0 Failed 1 Total 1 Seconds spent 0.000018"}
+end
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new("spec")
+
+task :default => :spec

data/lib/zabbix_protocol/version.rb

@@ -0,0 +1,3 @@
+module ZabbixProtocol
+  VERSION = "0.1.0"
+end

data/lib/zabbix_protocol.rb

@@ -0,0 +1,66 @@
+require "multi_json"
+
+require "zabbix_protocol/version"
+
+module ZabbixProtocol
+  class Error < StandardError; end
+
+  # http://www.zabbix.org/wiki/Docs/protocols/zabbix_agent/1.4
+  HEADER  = "ZBXD"
+  VERSION = "\x01"
+  DATA_LEN_BYTES = 8
+
+  MIN_RESPONSE_LEN = HEADER.length + VERSION.length + DATA_LEN_BYTES
+
+  def self.dump(data)
+    if data.is_a?(Hash)
+      data = MultiJson.dump(data)
+    else
+      data = data.to_s
+      data << "\n" unless data =~ /\n\z/
+    end
+
+    [
+      HEADER,
+      VERSION,
+      [data.length].pack('Q'),
+      data
+    ].join
+  end
+
+  def self.load(res_data)
+    unless res_data.is_a?(String)
+      raise TypeError, "wrong argument type #{res_data.class} (expected String)"
+    end
+
+    if res_data.length < MIN_RESPONSE_LEN
+      raise Error, "response data is too short"
+    end
+
+    data = res_data.dup
+    header = data.slice!(0, HEADER.length)
+
+    if header != HEADER
+      raise Error, "invalid header: #{header.inspect}"
+    end
+
+    version = data.slice!(0, VERSION.length)
+
+    if version != VERSION
+      raise Error, "unsupported version: #{version.inspect}"
+    end
+
+    data_len = data.slice!(0, DATA_LEN_BYTES)
+    data_len = data_len.unpack("Q").first
+
+    if data_len != data.length
+      raise Error, "invalid data length: expected=#{data_len}, actual=#{data.length}"
+    end
+
+    begin
+      MultiJson.load(data)
+    rescue MultiJson::ParseError
+      data
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require "zabbix_protocol"

data/spec/zabbix_protocol_spec.rb

@@ -0,0 +1,68 @@
+describe ZabbixProtocol do
+  subject { described_class }
+
+  context "when request" do
+    it "should convert string to zabbix request" do
+      res = subject.dump("system.cpu.load[all,avg1]")
+      expect(res).to eq "ZBXD\x01\x1A\x00\x00\x00\x00\x00\x00\x00" +
+       "system.cpu.load[all,avg1]\n"
+    end
+
+    it "should convert hash to zabbix request" do
+      req_data = {
+        "request" => "sender.data",
+        "data" => [{
+          "host" => "LinuxDB3",
+          "key" => "db.connections",
+          "value" => "43"
+        }]
+      }
+
+      res = subject.dump(req_data)
+      expect(res).to eq "ZBXD\x01Z\x00\x00\x00\x00\x00\x00\x00" +
+        '{"request":"sender.data","data":[{"host":"LinuxDB3","key":"db.connections","value":"43"}]}'
+    end
+  end
+
+  context "when response" do
+    it "should parse float" do
+      res_data = "ZBXD\x01\b\x00\x00\x00\x00\x00\x00\x001.000000"
+      data = subject.load(res_data)
+      expect(data).to eq 1.0
+    end
+
+    it "should parse hash" do
+      res_data = "ZBXD\x01$\x00\x00\x00\x00\x00\x00\x00{\n\t\"response\":\"success\",\n\t\"data\":[]}"
+      data = subject.load(res_data)
+      expect(data).to eq({"response"=>"success", "data"=>[]})
+    end
+  end
+
+  context "when error happen" do
+    it "raise error when response is not string" do
+      expect {
+        subject.load(1)
+      }.to raise_error "wrong argument type Fixnum (expected String)"
+    end
+
+    it "raise error when response is too short string" do
+      expect {
+        subject.load("x")
+      }.to raise_error "response data is too short"
+    end
+
+    it "raise error when unsupported version" do
+      expect {
+        res_data = "ZBXD\x02\b\x00\x00\x00\x00\x00\x00\x001.000000"
+        subject.load(res_data)
+      }.to raise_error 'unsupported version: "\\u0002"'
+    end
+
+    it "raise error when invalid data length" do
+      expect {
+        res_data = "ZBXD\x01\x00\x00\x00\x00\x00\x00\x00\x001.000000"
+        subject.load(res_data)
+      }.to raise_error "invalid data length: expected=0, actual=8"
+    end
+  end
+end

data/zabbix_protocol.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zabbix_protocol/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "zabbix_protocol"
+  spec.version       = ZabbixProtocol::VERSION
+  spec.authors       = ["Genki Sugawara"]
+  spec.email         = ["sgwr_dts@yahoo.co.jp"]
+  spec.summary       = %q{Zabbix protocols builder/parser.}
+  spec.description   = %q{Zabbix protocols builder/parser.}
+  spec.homepage      = "https://github.com/winebarrel/zabbix_protocol"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "multi_json"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", ">= 3.0.0"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: zabbix_protocol
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Genki Sugawara
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Zabbix protocols builder/parser.
+email:
+- sgwr_dts@yahoo.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/zabbix_protocol.rb
+- lib/zabbix_protocol/version.rb
+- spec/spec_helper.rb
+- spec/zabbix_protocol_spec.rb
+- zabbix_protocol.gemspec
+homepage: https://github.com/winebarrel/zabbix_protocol
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Zabbix protocols builder/parser.
+test_files:
+- spec/spec_helper.rb
+- spec/zabbix_protocol_spec.rb