poller 0.3.2 → 0.4.0

data/lib/poller/http/http_poller.rb

@@ -1,5 +1,5 @@
 # The HttpPoller will constuct an HttpProbe and sample it periodically based on
-# the value given for period_s until a timeout occurs after timeout_s seconds.
+# the value given for period_seconds until a timeout occurs after timeout_seconds.
 #
 # The proxy information is expected to be either nil or given as an OpenStruct
 # with attributes 'hostname', 'port', 'user' and 'password'.
@@ -17,12 +17,12 @@ module Poller
     class HttpPoller
       include Poller
 
-      def initialize(url, matcher, timeout_s, period_s, proxy = nil)
+      def initialize(url, matcher, timeout_seconds, period_seconds, proxy = nil)
         proxy = OpenStruct.new(proxy) if proxy.is_a?(Hash)
         probe = proxy.nil? \
           ? HttpProbe.new(url, matcher) \
           : HttpProbe.new(url, matcher, proxy.hostname, proxy.port, proxy.user, proxy.password)
-        super(probe, timeout_s, period_s, url)
+        super(probe, timeout_seconds, period_seconds, url)
       end
 
     end

data/lib/poller/poller.rb

@@ -1,36 +1,50 @@
-# This module handles the generic bits of the poller gem and
-# is intended to be mixed into any concrete Poller implementations
-# The generic parts include the periodic checking of a Probe and
-# raising a RuntimeError in case the timeout period has been exceeded.
+# This module handles the generic parts of the poller gem and
+# is intended to be mixed into all concrete Poller implementations.
+#
+# The generic parts include the periodic checking of a Probe and to
+# raise a RuntimeError in case the Timeout period has been exceeded.
 #
 # Poller expects that the probe object has methods called 'satisfied?'
-# that will return a boolean and 'sample' which takes the next sample
-# and has no explicit return value.
+# which must return a boolean and 'sample' which triggers taking the
+# next sample and which has no explicit return value.
 
 require 'poller/timeout'
 
 module Poller
   module Poller
 
-    def initialize(probe, timeout_s, period_s, name = nil)
+    def initialize(probe, timeout_seconds, period_seconds, name = nil)
       @probe = probe
-      @timeout_s = timeout_s
-      @period_s = period_s
+      @timeout_seconds = timeout_seconds
+      @period = period_seconds
       @name = name.nil? ? "no name given" : name
     end
 
     def check
-      # This following line allows us to inject a timeout object from within our tests
-      @timeout ||= Timeout.new(@timeout_s)
+      @timeout ||= Timeout.new(@timeout_seconds) # allow injecting a Timeout object from within tests
 
-      while !@probe.satisfied?
-        raise RuntimeError, "Timeout period has been exceeded for Poller (#{@name})" if @timeout.occured?
-        Kernel.sleep @period_s
+      tries = 0
+      check_started_at = Time.now
+      last_sample_took = 0
 
+      while !@timeout.occured?
+        Kernel.sleep sleep_time(@period, last_sample_took)
+        sample_started_at = Time.now
         @probe.sample
+        satisfied = @probe.satisfied?
+        last_sample_took = Time.now - sample_started_at
+        tries += 1
+        return if satisfied
       end
 
+      raise RuntimeError, "Timeout period has been exceeded for Poller (#{@name})." \
+        + " Poller tried #{tries} times which in total took #{Time.now - check_started_at} seconds."
+    end
 
+    private
+    def sleep_time(period, last_sample_took)
+      st = period - last_sample_took
+      st < 0 ? 0 : st
     end
 
   end

data/lib/poller/timeout.rb

@@ -2,9 +2,9 @@ module Poller
   class Timeout
 
     # Specify the timeout period in Integer or Floating Point representation
-    # +period_s+:: The timeout period in seconds
-    def initialize(period_s)
-      @period = period_s
+    # +period_seconds+:: The timeout period in seconds
+    def initialize(period_seconds)
+      @period = period_seconds
       @start_time = Time.now
     end
 

data/lib/poller/version.rb

@@ -1,3 +1,3 @@
 module Poller
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: poller
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-16 00:00:00.000000000 Z
+date: 2013-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec