poller 0.2.0 → 0.3.0

data/lib/matchers/http/response_body_contains.rb

@@ -1,15 +1,20 @@
-# This class expects a Net::HTTPResponse object and a second argument in its constructor.
-# The second argument can be a String or a Regexp
+# This class expects a search_term in its constructor which can be
+# either a String or a Regexp
+#
+# The matches? method takes a Net::HTTPResponse object and will apply
+# the search_term to the HTTPResponse.body
 
 module Matchers
   module HTTP
 
     class ResponseBodyContains
 
+      # @param search_term [String | Regexp] - the search term
       def initialize(search_term)
         @search_term = search_term
       end
 
+      # @param http_response [Net::HTTPResponse object] - the http response
       def matches?(http_response)
         return @search_term.match(http_response.body) if @search_term.class == Regexp
         http_response.body.include?(@search_term)

data/lib/matchers/xml/document_contains_xpath.rb

@@ -0,0 +1,37 @@
+# This class expects a String holding an XPath expression and an optional
+# number of occurrences of the XPath to be found in the document.
+#
+# The matches? method takes a Net::HTTPResponse object and will apply
+# the search_term to the result of the XPath querying the HTTPResponse.body
+#
+# = Examples
+#   dcx = DocumentContainsXPath.new('//ElementA/ElementB')
+#
+#   dcx = DocumentContainsXPath.new('//ElementA/ElementB', 3)
+#
+
+require 'rexml/document'
+
+module Matchers
+  module XML
+
+    class DocumentContainsXPath
+
+      # @param xpath_expr_s [String] - the XPath expression
+      # @param optional occurences [Integer] - the number of occurences expected in document
+      def initialize(xpath_expr_s, occurrences = 1)
+        @xpath_expr_s = xpath_expr_s
+        @occurrences = occurrences
+      end
+
+      # @param http_response [Net::HTTPResponse object] - the http response
+      def matches?(http_response)
+        xml_doc = REXML::Document.new(http_response.body)
+        nodes = REXML::XPath.match(xml_doc, @xpath_expr_s)
+        nodes.count >= @occurrences
+      end
+
+    end
+
+  end
+end

data/lib/matchers/xml/xpath_contains_text.rb

@@ -0,0 +1,36 @@
+# This class expects a String holding an XPath expression and a search_term
+# in its constructor which can be either a String or a Regexp
+#
+# The matches? method takes a Net::HTTPResponse object and will apply
+# the search_term to the result of the XPath querying the HTTPResponse.body
+#
+# = Example
+#   xct = XPathContainsText.new('//ElementA/ElementB', 'Text that I expect')
+#
+
+require 'rexml/document'
+
+module Matchers
+  module XML
+
+    class XPathContainsText
+
+      # @param xpath_expr_s [String] - the XPath expression
+      # @param search_term [String | Regexp] - the search term
+      def initialize(xpath_expr_s, search_term)
+        @xpath_expr_s = xpath_expr_s
+        @search_term = search_term
+      end
+
+      # @param http_response [Net::HTTPResponse object] - the http response
+      def matches?(http_response)
+        xml_doc = REXML::Document.new(http_response.body)
+        xpath = REXML::XPath.first(xml_doc, @xpath_expr_s)
+        return @search_term.match(xpath.text) if @search_term.class == Regexp
+        xpath.text.include?(@search_term)
+      end
+
+    end
+
+  end
+end

data/lib/poller.rb

@@ -1,2 +1,4 @@
 require 'poller/http/http_poller'
 require 'matchers/http/response_body_contains'
+require 'matchers/xml/xpath_contains_text'
+require 'matchers/xml/document_contains_xpath'

data/lib/poller/http/http_probe.rb

@@ -1,12 +1,13 @@
 # The HttpProbe class is built on top of the Ruby built-in net/http library.
-# Proxy support is provided. Please note that the Net::HTTP::Proxy  method will
-# return a Net::HTTP object if no proxy information is given (ie proxy_hostname is nil)
+# Proxy support is provided. Please note that the Net::HTTP::Proxy method will
+# return a Net::HTTP object if no proxy information is given (ie if proxy_hostname
+# is nil).
 #
 # The 'sample' method will wrap any Exception it may catch into a RuntimeError.
 #
-# Equally, any HTTP Response other than Net::HTTPSuccess will also get wrapped
+# Equally, any HTTP Response other than Net::HTTPOK will also get wrapped
 # into a RuntimeError as this class expects a GET request to return 200|OK or
-# equivalent HTTP Success objects in its current implementation.
+# in its current implementation. Redirects will therefore be regarded as a failure.
 #
 # HttpProbe also expects a matcher to be passed in. The matcher must return
 # either 'true or 'false' when given the http_response for evaluation via
@@ -14,7 +15,7 @@
 #
 # SSL is supported but certificates are not verified.
 #
-# Basic Auth is also supported in case userinfo appears in URL.
+# Basic Auth is also supported in case userinfo appears in the passed in URL.
 
 require 'uri'
 require 'net/http'

data/lib/poller/version.rb

@@ -1,3 +1,3 @@
 module Poller
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: poller
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-20 00:00:00.000000000 Z
+date: 2013-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.12.0
+        version: 2.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.12.0
+        version: 2.13.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/matchers/http/response_body_contains.rb
+- lib/matchers/xml/document_contains_xpath.rb
+- lib/matchers/xml/xpath_contains_text.rb
 - lib/poller/http/http_poller.rb
 - lib/poller/http/http_probe.rb
 - lib/poller/poller.rb
@@ -59,7 +61,8 @@ files:
 - lib/poller/version.rb
 - lib/poller.rb
 homepage: https://github.com/mkrogemann/poller
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -78,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Pollers and Probes