poller 0.1.1

data/lib/matchers/http/response_body_contains.rb

@@ -0,0 +1,21 @@
+# This class expects a Net::HTTPResponse object and a second argument in its constructor.
+# The second argument can be a String or a Regexp
+
+module Matchers
+  module HTTP
+
+    class ResponseBodyContains
+
+      def initialize(search_term)
+        @search_term = search_term
+      end
+
+      def matches?(http_response)
+        return @search_term.match(http_response.body) if @search_term.class == Regexp
+        http_response.body.include?(@search_term)
+      end
+
+    end
+
+  end
+end

data/lib/poller.rb

@@ -0,0 +1,2 @@
+require 'poller/http/http_poller'
+require 'matchers/http/response_body_contains'

data/lib/poller/http/http_poller.rb

@@ -0,0 +1,31 @@
+# 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 proxy information is expected to be either nil or given as an OpenStruct
+# with attributes 'hostname', 'port', 'user' and 'password'.
+# It is also possible to pass in the information as a Hash that will get converted
+# internally into an OpenStruct. In this case, make sure you use these keys:
+# { :hostname => 'proxy.internal.com', :port => 8080, :user => 'user', :password => 'pwd' }
+
+require 'poller/poller'
+require 'poller/http/http_probe'
+require 'ostruct'
+
+module Poller
+  module HTTP
+
+    class HttpPoller
+      include Poller
+
+      def initialize(url, matcher, timeout_s, period_s, 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)
+      end
+
+    end
+
+  end
+end

data/lib/poller/http/http_probe.rb

@@ -0,0 +1,47 @@
+# 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)
+#
+# 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
+# into a RuntimeError as this class expects a GET request to return 200|OK or
+# equivalent HTTP Success objects in its current implementation.
+#
+# 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
+# its 'matches?' method.
+
+require 'uri'
+require 'net/http'
+
+module Poller
+  module HTTP
+
+    class HttpProbe
+
+      def initialize(url_s, matcher, proxy_hostname = nil, proxy_port = nil, proxy_user = nil, proxy_pwd = nil)
+        @uri = URI(url_s)
+        @matcher = matcher
+        @proxy = Net::HTTP::Proxy(proxy_hostname, proxy_port, proxy_user, proxy_pwd)
+      end
+
+      def sample
+        begin
+          @http_response = @proxy.get_response(@uri)
+          return if @http_response.class == Net::HTTPOK
+        rescue Exception => e
+          raise RuntimeError, "#sample caught an Exception of class #{e.class} with message: #{e.message}"
+        end
+        raise RuntimeError, "HTTP request failed, the error class is: #{@http_response.class}"
+      end
+
+      def satisfied?
+        return false if @http_response.nil?
+        @matcher.matches?(@http_response)
+      end
+
+    end
+
+  end
+end

data/lib/poller/poller.rb

@@ -0,0 +1,37 @@
+# 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.
+#
+# 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.
+
+require 'poller/timeout'
+
+module Poller
+  module Poller
+
+    def initialize(probe, timeout_s, period_s, name = nil)
+      @probe = probe
+      @timeout_s = timeout_s
+      @period_s = period_s
+      @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)
+
+      while !@probe.satisfied?
+        raise RuntimeError, "Timeout period has been exceeded for Poller (#{@name})" if @timeout.occured?
+        Kernel.sleep @period_s
+
+        @probe.sample
+      end
+
+
+    end
+
+  end
+end

data/lib/poller/timeout.rb

@@ -0,0 +1,17 @@
+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
+      @start_time = Time.now
+    end
+
+    # Returns true if timeout period has elapsed, false if not
+    def occured?
+      Time.now - @start_time >= @period
+    end
+
+  end
+end

data/lib/poller/version.rb

@@ -0,0 +1,3 @@
+module Poller
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: poller
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Markus Krogemann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+description: Implementations of Poller and Probe as inspired by Steve Freeman and
+  Nat Pryce in their GOOS book
+email:
+- markus@krogemann.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/matchers/http/response_body_contains.rb
+- lib/poller/http/http_poller.rb
+- lib/poller/http/http_probe.rb
+- lib/poller/poller.rb
+- lib/poller/timeout.rb
+- lib/poller/version.rb
+- lib/poller.rb
+homepage: https://github.com/mkrogemann/poller
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Pollers and Probes
+test_files: []