okcomputer 1.13.0 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37e364f1ba01c9b0870d4ffbcd50eda067955be8
-  data.tar.gz: e48b355fab4c30d2d93b6e7522cfe04fa9fd8896
+  metadata.gz: 772de60494a5720e23c186c4fc990e17e4457391
+  data.tar.gz: 70f52075d802e604aa84580aee2a50b2eb563060
 SHA512:
-  metadata.gz: 926f7f507821ba687d71819408ed602449ec719c76ff15465cbef8144d7c8069d89dc9afced614c530339e99e4c49d46bb112b45d68ab0c4cbba1825bb6c3999
-  data.tar.gz: 06f15affbb329a66e9ce414c6deb67aa697b0454ce8f4e61535bcc07078f5c7e100588b96a60abff0145613af2d154ad86510b11461daabc875c9b1993ba9deb
+  metadata.gz: 8996e1acb30679e1ec535a82415bbdf05560d3823fc6dfc59d62a6367c481da6e8965d46cc37d8dfb3647d8eb79c6694f13451da65211b98ab7f621e9de60e83
+  data.tar.gz: 3708ef0ded13c99216a1d00befcba8e3e33011526df7fd3030d4e4bb71544a9511310fbade738bf507ec1ff44a28dc498f45c46c99c493c0614a4d0d7eff7c73

data/lib/ok_computer/built_in_checks/ping_check.rb

@@ -42,7 +42,7 @@ module OkComputer
     rescue SocketError => e
       addl_message = "connection to #{host} on port #{port} failed with '#{e.message}': "
       raise ConnectionFailed, addl_message + e.message
-    rescue TimeoutError => e
+    rescue Timeout::Error => e
       addl_message = "#{host} did not respond on port #{port} within #{request_timeout} seconds: "
       raise ConnectionFailed, addl_message + e.message
     rescue => e

data/lib/ok_computer/check.rb

@@ -45,6 +45,14 @@ module OkComputer
       {registrant_name => {:message => message, :success => success?, :time => time}}.to_json
     end
 
+    def <=>(check)
+      if check.is_a?(CheckCollection)
+        -1
+      else
+        registrant_name <=> check.registrant_name
+      end
+    end
+
     # Public: Whether the check passed
     #
     # Returns a boolean

data/lib/ok_computer/check_collection.rb

@@ -1,32 +1,88 @@
 module OkComputer
   class CheckCollection
-    attr_accessor :registry
+    attr_accessor :collection, :registrant_name, :display
 
     # Public: Initialize a new CheckCollection
     #
-    # registry - a Hash of checks, with keys being unique names and values
-    #   being Check instances
-    def initialize(registry={})
-      self.registry = registry
+    # display - the display name for the Check Collection
+    def initialize(display)
+      self.display = display
+      self.collection = {}
     end
 
-    # Public: Run the registry's checks
+    # Public: Run the collection's checks
     def run
       OkComputer.check_in_parallel ? check_in_parallel : check_in_sequence
     end
 
+    # Public: Returns a check or collection if it's in the check collection
+    #
+    # key - a check or collection name
+    # throws a KeyError when the key is not found
+    def fetch(key, default=nil)
+      found_in = self_and_sub_collections.detect{ |c| c[key] }
+      raise KeyError unless found_in
+      found_in[key]
+    end
+
+    # Public: Returns a  check or collection if it's in the check collection
+    #
+    # key - a check or collection name
+    def [](key)
+      fetch(key)
+      rescue KeyError
+    end
+
     # Public: The list of checks in the collection
     #
-    # Returns an Array of the registry's values
+    # Returns an Array of the collection's values
     def checks
-      registry.values
+      collection.values
+    end
+
+    def <=>(check)
+      if check.is_a?(CheckCollection)
+        registrant_name <=> check.registrant_name
+      else
+        1
+      end
+    end
+
+    alias_method :values, :checks
+
+    def check_names
+      collection.keys
+    end
+
+    alias_method :keys, :check_names
+
+    def sub_collections
+      checks.select{ |c| c.is_a?(CheckCollection)}
+    end
+
+    def self_and_sub_collections
+      [collection] + sub_collections
+    end
+
+    # Public: Registers a check into the collection
+    #
+    # Returns the check
+    def register(name, check)
+      collection[name] = check
+    end
+
+    # Public: Deregisters a check from the collection
+    #
+    # Returns the check
+    def deregister(name)
+      check = collection.delete(name)
     end
 
     # Public: The text of each check in the collection
     #
     # Returns a String
     def to_text
-      checks.map(&:to_text).join("\n")
+      "#{display}\n#{checks.sort.map{ |c| "#{"\s\s" unless c.is_a?(CheckCollection)}#{c.to_text}"}.join("\n")}"
     end
 
     # Public: The JSON of each check in the collection

data/lib/ok_computer/registry.rb

@@ -9,43 +9,58 @@ module OkComputer
     # check_name - The name of the check to retrieve
     #
     # Returns the registered check or raises Registry::CheckNotFound
-    def self.fetch(check_name)
-      registry.fetch(check_name)
+    def self.fetch(name)
+      default_collection.fetch(name)
     rescue KeyError
       raise CheckNotFound, "No matching check"
     end
 
     # Public: Return an object containing all the registered checks
     #
-    # Returns a CheckCollection instance
+    # Returns the default_collection CheckCollection instance
     def self.all
-      CheckCollection.new registry
+      default_collection
+    end
+
+    # Private: The list of registered checks, keyed by their unique names
+    #
+    # Returns a Hash
+    singleton_class.send(:alias_method, :registry, :all)
+
+    # Public: The default collection of checks
+    #
+    # Returns @default_collection
+    def self.default_collection
+      @default_collection ||= CheckCollection.new('Default Collection')
     end
 
     # Public: Register the given check with OkComputer
     #
     # check_name - The name of the check to retrieve
     # check_object - Instance of Checker to register
-    def self.register(check_name, check_object)
+    # collection_name - The name of the check collection the check should be registered to
+    def self.register(check_name, check_object, collection_name=nil)
       check_object.registrant_name = check_name
-      registry[check_name] = check_object
+      find_collection(collection_name).register(check_name, check_object)
     end
 
     # Public: Remove the check of the given name being checked
     #
     # check_name - The name of the check to retrieve
-    def self.deregister(check_name)
-      registry.delete(check_name)
+    # collection_name - The name of the check collection the check should be deregistered from
+    def self.deregister(check_name, collection_name=nil)
+      find_collection(collection_name).deregister(check_name)
     end
 
-    # Private: The list of registered checks, keyed by their unique names
-    #
-    # Returns a Hash
-    def self.registry
-      @registry ||= {}
+    private_class_method def self.find_collection(collection_name=nil)
+      collection_name ? default_collection.fetch(collection_name) : default_collection
+    rescue KeyError
+      raise CollectionNotFound
     end
 
+
     # used when fetching a check that has not been registered
     CheckNotFound = Class.new(StandardError)
+    CollectionNotFound = Class.new(StandardError)
   end
 end

data/lib/ok_computer/version.rb

@@ -1,3 +1,3 @@
 module OkComputer
-  VERSION = '1.13.0'
+  VERSION = '1.14.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: okcomputer
 version: !ruby/object:Gem::Version
-  version: 1.13.0
+  version: 1.14.0
 platform: ruby
 authors:
 - Patrick Byrne
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-24 00:00:00.000000000 Z
+date: 2017-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
@@ -124,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: A simple, extensible health-check monitor