tribune-is_it_working 1.0.9 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f70db6751d5a718bc6c9c4210f01ecccabe49fe5be8ad6422a2a2992598df58
-  data.tar.gz: 973f90428a9a853723cf309f74ed0719447585ee630393382acfdae9ae84239a
+  metadata.gz: c06c40921e40bbcd62cb5442f165837704997ed0676bfa6ffedcbdec26886b10
+  data.tar.gz: 046d065c1c02741933ecc2df05867014cbf6ad262f66f596ae31d234b3fcce34
 SHA512:
-  metadata.gz: 60c6c990e0888cca33a78a71c1aaec08cf6d57cf51504c81c0fa2732c7e10e579b0afe1ed1b3a39c467cc8a176cc7cf3ffdd31f49e22060f524bacb1a824f8f9
-  data.tar.gz: 43f6eb2a43e569e7fc4d8c0dcf383b02581cf7a8041d9536a5c81da1e4ce06f38ea01c4df7002042b5db15b48528590872ece003b8d05b9eea614fddf8fba101
+  metadata.gz: e3dcd717dea11e62123bae07dc0f8cc031e9ff6aca8bb8389b9ce605964065b045f763b8aa63c1fa50707cb8e10b01a68cb9d7dd8cf55e38eb105cfd5a4817f1
+  data.tar.gz: e18cdba1a5ff9767468717dae3d2fabe1a8ec4f68273d2f7c09b26779f62939219169b63e63a72b796ed7154d09c7652693abd67b3e5ebe704cfdf2560e8053a

data/lib/is_it_working/checks/url_check.rb

@@ -8,6 +8,8 @@ module IsItWorking
   # Available options are:
   #
   # * <tt>:get</tt> - The URL to get.
+  # * <tt>:post</tt> - The URL to post.
+  # * <tt>:payload</tt> - Request body parameters.
   # * <tt>:headers</tt> - Hash of headers to send with the request
   # * <tt>:proxy</tt> - Hash of proxy server information. The hash must contain a <tt>:host</tt> key and may contain <tt>:port</tt>, <tt>:username</tt>, and <tt>:password</tt>
   # * <tt>:username</tt> - Username to use for Basic Authentication
@@ -15,35 +17,56 @@ module IsItWorking
   # * <tt>:open_timeout</tt> - Time in seconds to wait for opening the connection (defaults to 5 seconds)
   # * <tt>:read_timeout</tt> - Time in seconds to wait for data from the connection (defaults to 10 seconds)
   # * <tt>:alias</tt> - Alias used for reporting in case making the URL known to the world could provide a security risk.
-  #
+  # * <tt>:follow_redirect</tt> - Follow 302 redirect or not (defaults to true)
   # === Example
   #
   #   IsItWorking::Handler.new do |h|
   #     h.check :url, :get => "http://services.example.com/api", :headers => {"Accept" => "text/xml"}
+  #     h.check :url, :post => "http://services.example.com/api",:headers => {"Content-Type" => "application/json"}
   #   end
   class UrlCheck
+
+    attr_reader :request_method, :request_payload
+    # Follow 302 redirect or not, default is true
+    attr_reader :follow_redirect
+
     def initialize(options={})
-      raise ArgumentError.new(":get must provide the URL to check") unless options[:get]
-      @uri = URI.parse(options[:get])
+      # TODO: Add support for PUT, DELETE & PATCH request methods
+      raise ArgumentError.new(":get|:post must provide the URL to check") unless options[:get] || options[:post]
+      # request method (get|post|put|delete)
+      @request_method = if options.key?(:get)
+                          :get
+                        elsif options.key?(:post)
+                          :post
+                        else
+                          :get # fallback
+                        end
+      @request_payload = options[:payload]
+      @follow_redirect = options[:follow_redirect].nil? ? true : options[:follow_redirect]
+      @uri = URI.parse(options[request_method])
       @headers = options[:headers] || {}
       @proxy = options[:proxy]
       @username = options[:username]
       @password = options[:password]
       @open_timeout = options[:open_timeout] || 5
       @read_timeout = options[:read_timeout] || 10
-      @alias = options[:alias] || options[:get]
+      @alias = options[:alias] || options[request_method]
     end
     
     def call(status)
       t = Time.now
       response = perform_http_request
+      ok_msg = "#{request_method.upcase} #{@alias} responded with response '#{response.code} #{response.message}'"
       if response.is_a?(Net::HTTPSuccess)
-        status.ok("GET #{@alias} responded with response '#{response.code} #{response.message}'")
+        status.ok(ok_msg)
+      # 200 ok for 302 unless follow_redirect
+      elsif response.is_a?(Net::HTTPRedirection) && !follow_redirect
+        status.ok(ok_msg)
       else
-        status.fail("GET #{@alias} failed with response '#{response.code} #{response.message}'")
+        status.fail("#{request_method.upcase} #{@alias} failed with response '#{response.code} #{response.message}'")
       end
     rescue Timeout::Error
-      status.fail("GET #{@alias} timed out after #{Time.now - t} seconds")
+      status.fail("#{request_method.upcase} #{@alias} timed out after #{Time.now - t} seconds")
     end
     
     private
@@ -70,7 +93,14 @@ module IsItWorking
     
       # Perform an HTTP request and return the response
       def perform_http_request #:nodoc:
-        request = Net::HTTP::Get.new(@uri.request_uri, @headers)
+        case request_method
+        when :post
+          request = Net::HTTP::Post.new(@uri.request_uri, @headers)
+          # Assign request_payload to body if it present
+          request.body = request_payload.to_json unless request_payload.blank?
+        else
+          request = Net::HTTP::Get.new(@uri.request_uri, @headers)
+        end
         request.basic_auth(@username, @password) if @username || @password
         http = instantiate_http
         http.start do

data/lib/is_it_working/filter.rb

@@ -19,12 +19,13 @@ module IsItWorking
     attr_reader :name, :async
     
     # name and description of Component
-    attr_reader :component_name, :description
+    attr_reader :component_name, :component_type, :description
 
     # Create a new filter to run a status check. The name is used for display purposes.
-    def initialize(name, component_name, description, check, async = true)
+    def initialize(name, component_name, component_type, description, check, async = true)
       @name = name
       @component_name = component_name
+      @component_type = component_type
       @description = description
       @check = check
       @async = async
@@ -33,7 +34,7 @@ module IsItWorking
     # Run a status the status check. This method keeps track of the time it took to run
     # the check and will trap any unexpected exceptions and report them as failures.
     def run
-      status = IsItWorking::Status.new(name, component_name, description)
+      status = IsItWorking::Status.new(name, component_name, component_type, description)
       runner = (async ? AsyncRunner : SyncRunner).new do
         t = Time.now
         begin

data/lib/is_it_working/handler.rb

@@ -104,9 +104,11 @@ module IsItWorking
       # New Params:
       # @param: component_name [String] optional
       #   => for which component checking health-check (ex: dss-url, zephr-url, active_record etc)
+      # @param: component_type [String] optional
+      #   => for which component_type checking health-check (ex: Database, MemCache etc)
       # @param: description [String] optional
       #   => Description for health-check for component
-      @filters << IsItWorking::Filter.new(name, options[:component_name],
+      @filters << IsItWorking::Filter.new(name, options[:component_name], options[:component_type],
                                           options[:description], check, options[:async])
     end
     
@@ -163,15 +165,14 @@ module IsItWorking
       # Seperate method for rendeing/returning JSON
       def render_json(statuses, elapsed_time) #:nodoc:
         fail = statuses.all?{|s| s.success?}
-        messages = []
         components = []
         total_fail_count = 0
         statuses.each do |status|
           status.messages.each do |m|
-            messages << "#{m.ok? ? 'OK:  ' : 'FAIL:'} #{status.name} - #{m.message} (#{status.time ? sprintf('%0.000f', status.time * 1000) : '?'}ms)"
             message = { name: status.name,
                         component_name: status.component_name,
-                       info: "#{m.message} (#{status.time ? sprintf('%0.000f', status.time * 1000) : '?'}ms",
+                        component_type: status.component_type,
+                       info: "#{m.message} (#{status.time ? sprintf('%0.000f', status.time * 1000) : '?'}ms)",
                        time: status.time,
                        success: m.ok? ? true : false,
                        description: status.description }

data/lib/is_it_working/status.rb

@@ -22,7 +22,7 @@ module IsItWorking
     attr_reader :name
 
     # name and description of Component
-    attr_reader :component_name, :description
+    attr_reader :component_name, :component_type, :description
 
     # The messages set on the status check.
     attr_reader :messages
@@ -30,9 +30,10 @@ module IsItWorking
     # The amount of time it takes to complete the status check.
     attr_accessor :time
 
-    def initialize(name, component_name, description)
+    def initialize(name, component_name, component_type, description)
       @name = name
       @component_name = component_name
+      @component_type = component_type
       @description = description
       @messages = []
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tribune-is_it_working
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.1.2
 platform: ruby
 authors:
 - Brian Durand