prtg 0.0.7 → 0.1.0

data/lib/prtg.rb

@@ -4,6 +4,8 @@ $LOAD_PATH.unshift dir unless $LOAD_PATH.include?(dir)
 require "rubygems"
 require "#{dir}/prtg/client"
 require "#{dir}/prtg/query"
+require "#{dir}/prtg/table_query"
+require "#{dir}/prtg/historic_data_query"
 require "#{dir}/prtg/utils"
 
 # This is a wrapper for the api of paessler's prtg monitoring tool.
@@ -14,7 +16,7 @@ require "#{dir}/prtg/utils"
 #   http.verify_mode = OpenSSL::SSL::VERIFY_NONE
 #
 #   client = Prtg::Client.new(:host => http, :username => "foo", :password => "bar")
-#   p client.live_data(:sensors)
+#   p client.table(:sensors)
 module Prtg
-  VERSION = "0.0.5"
+  VERSION = "0.1.0"
 end

data/lib/prtg/client.rb

@@ -77,35 +77,17 @@ module Prtg # :nodoc:
     end
 
     def live_data(content)
-      Prtg::Query.new(self, content)
+      warn "[DEPRECATION] Client#live_data is depricated. Please use 'Client#table.content(#{ content }) instead."
+      table.content(content)
     end
 
-    def api_request(params)
-      url_params = Utils.url_params(auth_params.merge(params))
-
-      response = host.get(
-        "/api/table.xml?#{ url_params }",
-        { "Accept-Encoding" => "*"}
-      )
-
-      parse_response(response)
+    def table
+      Prtg::TableQuery.new(@host, auth_params)
     end
 
-    def method_missing(*args)
-      super(*args)
+    def historicdata
+      Prtg::HistoricDataQuery.new(@host, auth_params)
     end
 
-    private
-
-    def parse_response(response)
-      hash = XmlSimple.xml_in(response.body, "ForceArray" => false)
-
-      if hash["error"]
-        raise hash["error"]
-
-      else
-        hash["item"]
-      end
-    end
   end
 end

data/lib/prtg/historic_data_query.rb

@@ -0,0 +1,16 @@
+require "prtg/query"
+
+module Prtg # :nodoc
+
+  # Proxy class to caspule request
+  class HistoricDataQuery
+
+    include Prtg::Query
+
+    api_url '/api/historicdata.xml'
+
+    VALUES = [:id, :sdate, :edate, :avg]
+    VALUES.each { |k| api_value k }
+
+  end
+end

data/lib/prtg/query.rb

@@ -1,60 +1,81 @@
 module Prtg # :nodoc:
 
-  # Proxy class to caspule request
-  class Query
+  module Query
 
-    # BlankSlate
-    instance_methods.each { |m| undef_method m unless m =~ /^(__|send|object_id)/ }
+    module ClassMethods
 
-    def initialize(client, content)
-      @prtg_client = client
-      @query_hash = {}
-      @query_hash[:output]  = :xml
-      @query_hash[:content] = content
-    end
+      def api_url(url)
+        define_method(:api_url) { url }
+      end
 
-    # This single values for the query.
-    # They are pretty much like sql.
-    #
-    # content is like a table
-    # count is like LIMIT
-    # start is like OFFSET
-    VALUES = [:count, :start, :output, :id]
-
-    VALUES.each do |key|
-      define_method key do |value|
-        @query_hash[key] = value
-        self
+      def api_value(name)
+        define_method name do |value|
+          @query[name] = value
+          self
+        end
+      end
+
+      def api_list(name)
+        define_method name do |*args|
+          @query[name] = (@query[name] || []) | args
+          self
+        end
       end
+
     end
 
-    MULTIPLE_VALUES = [:columns]
+    module InstanceMethods
+
+      def initialize(host, auth_params={})
+        @host = host
+        @query = {}.merge(auth_params)
+        @query[:output]  = :xml
+      end
 
-    MULTIPLE_VALUES.each do |key|
-      define_method key do |*args|
-        @query_hash[key] = (@query_hash[key] || []) | args
+      def execute
+        url_params = Utils.url_params(@query)
+
+        parse_response @host.get(
+          "#{ api_url }?#{ url_params }",
+          { "Accept-Encoding" => "*"}
+        )
+      end
+
+      def add_filter(name, value)
+        @query[name.to_sym] = value
         self
       end
-    end
 
-   def execute
-     @prtg_client.api_request(@query_hash)
-   end
+      def method_missing(*args, &block)
+        if args.first.to_s.start_with? "filter"
+          add_filter(*args)
+        else
+          execute.send(*args, &block)
+        end
+      end
 
-   private
+      private
 
-   def add_filter(name, value)
-     @query_hash[name.to_sym] = value
-     self
-   end
+      def parse_response(response)
+        hash = XmlSimple.xml_in(response.body, "ForceArray" => false)
 
-   def method_missing(*args, &block)
-     if args.first.to_s.start_with? "filter"
-       add_filter(*args)
-     else
-       execute.send(*args, &block)
-     end
-   end
+        if hash["error"]
+          raise hash["error"]
+
+        else
+          hash["item"]
+        end
+      end
+    end
+
+    def self.included(receiver)
+      receiver.class_exec do
+        # BlankSlate
+        instance_methods.each { |m| undef_method m unless m =~ /^(__|send|object_id)/ }
+      end
+      receiver.extend         ClassMethods
+      receiver.send :include, InstanceMethods
+    end
 
   end
 end

data/lib/prtg/table_query.rb

@@ -0,0 +1,18 @@
+require "prtg/query"
+module Prtg # :nodoc:
+
+  # Proxy class to caspule request
+  class TableQuery
+
+    include Prtg::Query
+
+    api_url '/api/table.xml'
+
+    VALUES = [:content, :count, :start, :output, :id]
+    VALUES.each { |k| api_value k }
+
+    MULTIPLE_VALUES = [:columns]
+    MULTIPLE_VALUES.each { |k| api_list k }
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prtg
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-08 00:00:00.000000000 Z
+date: 2014-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xml-simple
@@ -27,7 +27,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.1.1
-description: This gem is a wrapper around the prth http api.Prtg is an network monitoring
+description: This gem is a wrapper around the prtg http api.Prtg is an network monitoring
   solution which provides a api to retrieve several information about monitored devices.
 email: k@kanello.de
 executables: []
@@ -38,6 +38,8 @@ files:
 - lib/prtg/query.rb
 - lib/prtg/client.rb
 - lib/prtg/utils.rb
+- lib/prtg/historic_data_query.rb
+- lib/prtg/table_query.rb
 homepage: http://github.com/ikaros/Prtg-for-Ruby
 licenses: []
 post_install_message: 
@@ -63,3 +65,4 @@ signing_key:
 specification_version: 3
 summary: Wrapper for the prtg network monitor api (http://www.paessler.com/prtg)
 test_files: []
+has_rdoc: