istat 0.0.1

data/lib/istat/frames/register.rb

@@ -0,0 +1,61 @@
+# Copyright (c) 2011 Vincent Landgraf
+# 
+# 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.
+module Istat
+  module Frames
+    class RegisterRequest < Request
+      # create a new register request frame
+      # @param [String] hostname the hostname to use for registering (e.g. example.com)
+      # @param [String] duuid the duuid to use for registering (e.g. 19be1f6285ae9019254c93a880db7285)
+      def initialize(hostname, duuid)
+        super create([:h, hostname], [:duuid, duuid])
+      end
+    end
+    
+    class RegisterResponse < Response
+      # check if the user has to authorize using password
+      # @return [Boolean] true if the user should authorize
+      def authorize?
+        @root.attributes["ath"].to_i == 1
+      end
+      
+      # calculate the uptime value
+      # @return [Integer] a timestamp (Time.now - val)
+      def uptime
+        @root.attributes["n"].to_i
+      end
+      
+      # calculate the next_uptime value
+      # @return [Integer] a timestamp (Time.now - val)
+      def next_uptime
+        @root.attributes["c"].to_i
+      end
+      
+      # @return static value 6
+      def ss
+        @root.attributes["ss"].to_i
+      end
+      
+      # @return static value 2
+      def pl
+        @root.attributes["pl"].to_i
+      end
+    end
+  end
+end

data/lib/istat/utils.rb

@@ -0,0 +1,35 @@
+require "openssl"
+
+# Copyright (c) 2011 Vincent Landgraf
+# 
+# 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.
+module Istat
+  module Utils    
+    # generate a pseudo random uuid based on openssl random
+    # @return [String] the generated uuid
+    # @example
+    #   Istat::Utils.uuid # => '19be1f6285ae9019254c93a880db7285'
+    #
+    def self.uuid(size = 16)
+      OpenSSL::Random.random_bytes(size).unpack("C" * size).map do |char| 
+        "%02x" % char
+      end.join
+    end
+  end
+end

data/lib/istat/version.rb

@@ -0,0 +1,22 @@
+# Copyright (c) 2011 Vincent Landgraf
+# 
+# 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.
+module Istat
+  VERSION = "0.0.1"
+end

data/lib/istat.rb

@@ -0,0 +1,9 @@
+lib = File.dirname(__FILE__)
+require File.join(lib, "istat", "utils")
+require File.join(lib, "istat", "frames", "base")
+require File.join(lib, "istat", "frames", "authentication")
+require File.join(lib, "istat", "frames", "connection_test")
+require File.join(lib, "istat", "frames", "register")
+require File.join(lib, "istat", "frames", "measurement")
+require File.join(lib, "istat", "client")
+require File.join(lib, "istat", "version")

data/spec/client_spec.rb

@@ -0,0 +1,50 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Istat::Client do
+  before(:each) do
+    @client = Istat::Client.new(SERVER.host, SERVER.port, SERVER.password,
+                                LOGGER)
+  end
+  
+  it "should be possible to connect and disconnect to/from an istat server" do
+    @client.connect!.should be_true
+    @client.close!.should be_true
+  end
+  
+  it "should be possible to test a connection" do
+    @client.connect!.should be_true
+    @client.online?.should be_true
+    @client.close!.should be_true
+  end
+
+  it "should be possible to register the host" do
+    @client.connect!.should be_true
+    @client.register!
+    @client.close!.should be_true
+  end
+  
+  it "should be possible to authorize correctly" do
+    @client.connect!.should be_true
+    @client.register!
+    @client.authenticate!
+    @client.close!.should be_true
+  end
+  
+  it "should be possible to use Client#start to start, authenticate, register and stop" do
+    @client.start do |session|
+      session.connection_frame.uptime.should > 0
+    end
+  end
+  
+  it "should be possible to request host data" do
+    @client.start do |session|
+      response = session.fetch
+      response.network?.should be_true
+      response.cpu?.should be_true
+      response.memory?.should be_true
+      response.load?.should be_true
+      response.uptime?.should be_true
+      response.disks?.should be_true
+    end
+  end
+end

data/spec/frames/authentication_spec.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Authentication" do
+  context Istat::Frames::AuthenticationRequest do
+    it "should be possible to generate a correct password frame" do
+      frame = Istat::Frames::AuthenticationRequest.new("test")
+      frame.to_s.should == "test"
+    end
+  end
+  
+  context Istat::Frames::AuthenticationResponse do
+    it "should be possible to parse the authentication response" do
+      xml = %{<?xml version="1.0" encoding="UTF-8"?><isr ready="1"></isr>}
+      frame = Istat::Frames::AuthenticationResponse.new(xml)
+      frame.ready?.should be_true
+      frame.rejected?.should be_false
+      xml = %{<?xml version="1.0" encoding="UTF-8"?><isr athrej="1"></isr>}
+      frame = Istat::Frames::AuthenticationResponse.new(xml)
+      frame.rejected?.should be_true
+      frame.ready?.should be_false
+    end
+  end
+end

data/spec/frames/connection_test_spec.rb

@@ -0,0 +1,18 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "ConnectionTest" do
+  context Istat::Frames::ConnectionTestRequest do
+    it "should be possible to generate a correct request" do
+      frame = Istat::Frames::ConnectionTestRequest.new
+      frame.to_s.should == "<?xml version='1.0' encoding='UTF-8'?><isr><conntest/></isr>"
+    end
+  end
+  
+  context Istat::Frames::ConnectionTestResponse do
+    it "should be possible to parse a response" do
+      xml = %{<?xml version="1.0" encoding="UTF-8"?><isr></isr>}
+      frame = Istat::Frames::ConnectionTestResponse.new(xml)
+      frame.success?.should be_true
+    end
+  end
+end

data/spec/frames/measurement_request_spec.rb

@@ -0,0 +1,117 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Measurement" do
+  context Istat::Frames::MeasurementRequest do
+    it "should be possible to generate a correct request" do
+      frame = Istat::Frames::MeasurementRequest.new(1)
+      frame.to_s.should == "<?xml version='1.0' encoding='UTF-8'?><isr><rid>1</rid><c>-1</c><n>-1</n><m>-1</m><lo>-1</lo><t>-1</t><f>-1</f><u>-1</u><d>-1</d></isr>"
+    end
+  end
+  
+  context Istat::Frames::MeasurementResponse do
+    before(:each) do
+      @frame = Istat::Frames::MeasurementResponse.new(%Q{
+        <?xml version="1.0" encoding="UTF-8"?>
+        <isr ds="0" ts="0" fs="0" rid="1">
+          <CPU>
+            <c id="28388970" u="0" s="0" n="0"></c>
+            <c id="28388971" u="0" s="0" n="0"></c>
+            <c id="28388972" u="0" s="0" n="0"></c>
+            <c id="28388973" u="0" s="0" n="0"></c>
+          </CPU>
+          <NET if="1">
+            <n id="28388970" d="4177773" u="232278672" t="1304082088"></n>
+            <n id="28388971" d="4177773" u="232278672" t="1304082089"></n>
+            <n id="28388972" d="4177773" u="232278672" t="1304082090"></n>
+            <n id="28388973" d="4177773" u="232278672" t="1304082091"></n>
+          </NET>
+          <MEM w="25938" a="27620" i="11664" f="7983" t="73207" su="3" st="36861" pi="0" po="0"></MEM>
+          <LOAD one="0" fv="0" ff="0"></LOAD>
+          <UPT u="28388036"></UPT>
+          <DISKS>
+            <d n="/" uuid="/dev/vzfs" f="9226" p="39.931"></d>
+          </DISKS>
+          <TEMPS>
+            <t i="5" t="64"></t>
+            <t i="4" t="30"></t>
+            <t i="0" t="30"></t>
+            <t i="2" t="29"></t>
+            <t i="6" t="61"></t>
+            <t i="1" t="52"></t>
+            <t i="3" t="50"></t>
+          </TEMPS>
+          <FANS>
+            <f i="0" s="1999"></f>
+          </FANS>
+        </isr>
+      })
+    end
+
+    it "should be possible to parse the cpus" do
+      @frame.cpu?.should be_true
+      @frame.cpu.should == [
+        { :id => 28388970, :user => 0, :system => 0, :nice => 0 },
+        { :id => 28388971, :user => 0, :system => 0, :nice => 0 },
+        { :id => 28388972, :user => 0, :system => 0, :nice => 0 },
+        { :id => 28388973, :user => 0, :system => 0, :nice => 0 }
+      ]
+    end
+
+    it "should be possible to parse the network" do
+      @frame.network?.should be_true
+      @frame.network.should == {
+        1 => [
+          { :id => 28388970, :d => 4177773, :u => 232278672, :t => 1304082088 },
+          { :id => 28388971, :d => 4177773, :u => 232278672, :t => 1304082089 },
+          { :id => 28388972, :d => 4177773, :u => 232278672, :t => 1304082090 },
+          { :id => 28388973, :d => 4177773, :u => 232278672, :t => 1304082091 }
+        ]
+      }
+    end
+
+    it "should be possible to parse the memory" do
+      @frame.memory?.should be_true
+      @frame.memory.should == {
+        :wired => 25938,
+        :active => 27620,
+        :inactive => 11664,
+        :free => 7983,
+        :total => 73207,
+        :swap_used => 3,
+        :swap_total => 36861,
+        :page_ins => 0,
+        :page_outs => 0
+      }
+    end
+
+    it "should be possible to parse the load" do
+      @frame.load?.should be_true
+      @frame.load.should == [0, 0, 0]
+    end
+
+    it "should be possible to parse the uptime" do
+      @frame.uptime?.should be_true
+      @frame.uptime.year.should == 2010
+    end
+    
+    it "should be possible to parse the temps" do
+      @frame.temps?.should be_true
+      @frame.temps.should == [30, 52, 29, 50, 30, 64, 61]
+    end
+    
+    it "should be possbile to parse the fans" do
+      @frame.fans?.should be_true
+      @frame.fans.should == [1999]
+    end
+
+    it "should be possible to parse the disks" do
+      @frame.disks?.should be_true
+      @frame.disks.should == [
+        :label => "/", 
+        :uuid => "/dev/vzfs",
+        :free => 9226,
+        :percent_used => 39.931
+      ]
+    end
+  end
+end

data/spec/frames/register_spec.rb

@@ -0,0 +1,22 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Registration" do
+  context Istat::Frames::RegisterRequest do
+    it "should be possible to generate a correct password frame" do
+      frame = Istat::Frames::RegisterRequest.new("macbook.local", "42c4e086890f9e2c1b2b7221b2422136")
+      frame.to_s.should == "<?xml version='1.0' encoding='UTF-8'?><isr><h>macbook.local</h><duuid>42c4e086890f9e2c1b2b7221b2422136</duuid></isr>"
+    end
+  end
+  
+  context Istat::Frames::RegisterResponse do
+    it "should be possible to parse the authentication response" do
+      xml = %Q{<?xml version="1.0" encoding="UTF-8"?><isr pl="2" ath="1" ss="6" c="28406490" n="28406489"></isr>}
+      frame = Istat::Frames::RegisterResponse.new(xml)
+      frame.ss.should == 6
+      frame.uptime == 28406489
+      frame.next_uptime.should == 28406490
+      frame.authorize?.should be_true
+      frame.pl.should == 2
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$:.push(File.expand_path(File.join(File.dirname(__FILE__), "..", "lib")))
+require "istat"
+require "uri"
+require "logger"
+LOGGER = Logger.new("debug.log")
+LOGGER.level = Logger::DEBUG
+
+SERVER = URI.parse(ENV["TEST_SERVER"] || "istat://any:10946@localhost:5109/")

data/spec/utils_spec.rb

@@ -0,0 +1,9 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Istat::Utils do
+  it "should be possible to generate a pseudo uuid" do
+    10.times do
+      Istat::Utils.uuid.size.should == 32
+    end
+  end
+end

data/test_rc.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+TEST_SERVER=istat://any:I8rAw1lhkJPMC9W0nJG7hA@ruby-consult.de:5109/ rspec spec

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification 
+name: istat
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Vincent Landgaf
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-29 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 2
+        - 1
+        version: "2.1"
+  type: :development
+  version_requirements: *id001
+description: |
+  an istat client library for ruby
+
+email: vilandgr+github@googlemail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- debug.log
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
+- istat.gemspec
+- lib/istat/client.rb
+- lib/istat/frames/authentication.rb
+- lib/istat/frames/base.rb
+- lib/istat/frames/connection_test.rb
+- lib/istat/frames/measurement.rb
+- lib/istat/frames/register.rb
+- lib/istat/utils.rb
+- lib/istat/version.rb
+- lib/istat.rb
+- README.md
+- spec/client_spec.rb
+- spec/frames/authentication_spec.rb
+- spec/frames/connection_test_spec.rb
+- spec/frames/measurement_request_spec.rb
+- spec/frames/register_spec.rb
+- spec/spec_helper.rb
+- spec/utils_spec.rb
+- test_rc.sh
+has_rdoc: true
+homepage: https://github.com/threez/istat
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: an istat client library for ruby
+test_files: 
+- spec/client_spec.rb
+- spec/frames/authentication_spec.rb
+- spec/frames/connection_test_spec.rb
+- spec/frames/measurement_request_spec.rb
+- spec/frames/register_spec.rb
+- spec/spec_helper.rb
+- spec/utils_spec.rb