zbx 0.1.1 → 1.0

data/README.md

@@ -39,9 +39,8 @@ end
 ZBX::API.new(username, password, api_url).host.get hostids: 10160
 
 ZBX::API.new do
-  api_url! api_url
-  username! user
-  password! password
+  set username: 'username', password: password
+  set api_url: 'http://api_url'
   host.get hostids: 10160
 end
 ```

data/Rakefile

@@ -1 +1,7 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task :default => :spec

data/lib/zbx.rb

@@ -1,9 +1,10 @@
 require "zbx/version"
 require 'zbx/entity'
+require 'zbx/http_client'
 require 'zbx/api'
+
 require 'json'
 require 'net/http'
 
 module ZBX
 end
-

data/lib/zbx/api.rb

@@ -14,22 +14,15 @@ module ZBX
 
     def initialize user=nil, pass=nil, url=nil, &b
       @auth = nil
-      @user = user
-      @pass = pass
-      @api_url = url
-      instance_eval(&b) if block_given?
-    end
-
-    def username! username
-      @user, @auth = username, nil
-    end
+      @user, @pass, @http = user, pass, HttpClient.new url
 
-    def password! password
-      @pass, @auth = password, nil
+      instance_eval(&b) if block_given?
     end
 
-    def api_url! api_url
-      @api_url, @auth = api_url, nil
+    def set option={}
+      @user, @auth = option[:username], nil if option[:username]
+      @pass, @auth = option[:password], nil if option[:password]
+      @http.api_url = option[:api_url] if option[:api_url]
     end
 
     def request method, params={}
@@ -42,18 +35,18 @@ module ZBX
       # - auth            = an authentication token
 
       params[:output] ||= "extend"
-      _request(method: method,
-               params: params,
-               auth: auth!,
-               id: _id,
-               jsonrpc: '2.0')
+      @http.request(method: method,
+                    params: params,
+                    auth: auth!,
+                    id: _id,
+                    jsonrpc: '2.0')
     end
 
     def auth!
-      @auth ||= _request(method: "user.login",
-                         params: {user: @user, password: @pass},
-                         id: _id,
-                         jsonrpc: '2.0')
+      @auth ||= @http.request(method: "user.login",
+                              params: {user: @user, password: @pass},
+                              id: _id,
+                              jsonrpc: '2.0')
 
       # if login failed, we raise an auth error !
       @auth or raise "Authentication failed"
@@ -65,30 +58,6 @@ module ZBX
 
     private
 
-    def _http
-      # Our http client. Borrowed from zabbixapi(https://github.com/vadv/zabbixapi)
-      @http ||= Net::HTTP.new _uri.host, _uri.port
-      if _uri.port == 443
-        @http.use_ssl = true
-        @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-      end
-      @http
-    end
-
-    def _uri
-      @uri ||= URI.parse(@api_url)
-    end
-
-    def _request options={}
-      # send post request
-      req = Net::HTTP::Post.new _uri.request_uri
-      req.add_field('Content-Type', 'application/json-rpc')
-      req.body = options.to_json
-      JSON.parse(_http.request(req).body)['result']
-    rescue
-      nil
-    end
-
     def _id
       rand(100000)
     end

data/lib/zbx/http_client.rb

@@ -0,0 +1,42 @@
+module ZBX
+  # HttpClient
+  # send http request for api
+
+  class HttpClient
+    def initialize api_url=nil
+      @api_url = api_url
+    end
+
+    def request options={}
+      # send post request
+      req = Net::HTTP::Post.new uri.request_uri
+      req.add_field('Content-Type', 'application/json-rpc')
+      req.body = options.to_json
+      JSON.parse(http.request(req).body)['result']
+    rescue
+      nil
+    end
+
+    def http
+      # Our http client. Borrowed from zabbixapi(https://github.com/vadv/zabbixapi)
+      @http ||= Net::HTTP.new uri.host, uri.port
+      if uri.port == 443
+        @http.use_ssl = true
+        @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      @http
+    end
+
+    def uri
+      @uri ||= URI.parse(@api_url)
+    end
+
+    def api_url= url
+      @api_url, @uri, @http = url, nil, nil
+      self
+    end
+  end
+end
+
+
+

data/lib/zbx/version.rb

@@ -1,3 +1,3 @@
 module ZBX
-  VERSION = "0.1.1"
+  VERSION = "1.0"
 end

data/spec/auth_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe ZBX::API do
+  api_url = 'http://localhost/api_jsonrpc.php'
+  before(:each) do
+    @invalid_client = ZBX::API.new "fakeusername", "fakepassword", api_url
+    @valid_client = ZBX::API.new "wenjun.yan", "123456", api_url
+  end
+
+  describe "invalid client authentication" do
+    it "should raise a runtime error!" do
+      expect { @invalid_client.auth! }.to raise_error(RuntimeError, /Authentication/)
+    end
+  end
+
+  describe "valid client authentication" do
+    it "should not raise any error" do
+      expect { @valid_client.auth! }.to_not raise_error
+    end
+
+    it "should return a authentication token, which is a string" do
+      token = @valid_client.auth!
+      token.should be_an(String)
+    end
+  end
+end

data/spec/functional_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe ZBX::API do
+  api_url = 'http://localhost/api_jsonrpc.php'
+
+  before(:each) do
+    @client = ZBX::API.new "wenjun.yan", "123456", api_url
+  end
+
+  describe "Using host.get to check if api request works " do
+    it "should return an not-empty array" do
+      ret = @client.host.get hostids: 10163
+      ret.should be_an(Array)
+      ret.first["hostid"].should eq("10163")
+    end
+
+    it "should return an empty array" do
+      ret = @client.host.get hostids: 1111111
+      ret.should be_an(Array)
+      ret.should be_empty
+    end
+  end
+
+  describe "Overwriting the default param `output`" do
+    it "should works and the returned host object has only hostid" do
+      ret = @client.host.get hostids: 10163, output: "hostid"
+      ret.first.size.should eq(1)
+      ret.first.should have_key("hostid")
+    end
+
+    it "should works and the returned host objectt has only hostid and host" do
+      ret = @client.host.get hostids: 10163, output: ["hostid", "host"]
+      ret.first.size.should eq(2)
+      ret.first.should have_key("hostid")
+      ret.first.should have_key("host")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'bundler/setup'
+require 'zbx'
+
+RSpec.configure do |config|
+end

data/zbx.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = ZBX::VERSION
   spec.authors       = ["wenjun.yan"]
   spec.email         = ["mylastnameisyan@gmail.com"]
-  spec.description   = %q{yet another zabbix api}
+  spec.description   = %q{yet another zabbix api wrapper and a dsl}
   spec.summary       = %q{zabbix api in ruby way}
   spec.homepage      = ""
   spec.license       = "MIT"
@@ -20,4 +20,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zbx
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: '1.0'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-21 00:00:00.000000000 Z
+date: 2013-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -43,7 +43,23 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: yet another zabbix api
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: yet another zabbix api wrapper and a dsl
 email:
 - mylastnameisyan@gmail.com
 executables: []
@@ -58,7 +74,11 @@ files:
 - lib/zbx.rb
 - lib/zbx/api.rb
 - lib/zbx/entity.rb
+- lib/zbx/http_client.rb
 - lib/zbx/version.rb
+- spec/auth_spec.rb
+- spec/functional_spec.rb
+- spec/spec_helper.rb
 - zbx.gemspec
 homepage: ''
 licenses:
@@ -85,5 +105,8 @@ rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: zabbix api in ruby way
-test_files: []
+test_files:
+- spec/auth_spec.rb
+- spec/functional_spec.rb
+- spec/spec_helper.rb
 has_rdoc: