easymon 1.6.3 → 1.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82da9dec5eb66912f758fe04075ef2121f8c10d4659ab4c3b7cb79b43fc47bba
-  data.tar.gz: 03ef075f7573a79461e40e6924a1c0a57d8cafa6292b7381217a0e2dfe2aef06
+  metadata.gz: 7bc697369e22923ddb3ad6cdee3577767e064e7fa3bc96e0d377cf8d19e0f8a9
+  data.tar.gz: d0527f2b8b69761afe25d4d103f2b382fd438147087edb788179c86de7462f1e
 SHA512:
-  metadata.gz: 37b5c45c57e1fefb47d3eca2549d3bd5dc611697cb5c6efa577f94f8646c67e8240c38ef0de7021dc5f1a9de157fb06bd6ed9f40addeb74f180b61a78ee04912
-  data.tar.gz: 829e5f4a17106de067477d9ffc11d64fc631562a560732945e7b21a15d6b013b19fe49f0b96d7ab3c7e29b45cb3c84ebc23df6b018f450dee1acbd8613cecd9e
+  metadata.gz: 43eb27d784907c6fe180edbc543da84fdc83b06cae7e9dde06f9fe4a5e1223c4e4f6b621a4a0064443eeaca97cba6b7e7adb9f0d0320b261db54d43d259b2faa
+  data.tar.gz: d529dd1f51527b4d42db73967e225913b4625ce68f24e26dd28b8e4f31abc4340be3bca36d064aba331b97da5381ccff193be8918d26d781239b7623a49341f5

data/README.md

@@ -124,6 +124,7 @@ check.
  * Semaphore
  * Traffic Enabled
  * Split ActiveRecord
+ * Multi ActiveRecord
  * Http
 
 ### ActiveRecord
@@ -194,18 +195,8 @@ For example, given the following other class:
 
 ````ruby
 module Easymon
-  class Base < ActiveRecord::Base
-    def establish_connection(spec = nil)
-      if spec
-        super
-      elsif config = Easymon.database_configuration
-        super config
-      end
-    end
-    def database_configuration
-      env = "#{Rails.env}_replica"
-      config = YAML.load_file(Rails.root.join('config/database.yml'))[env]
-    end
+  class Replica < ActiveRecord::Base
+    establish_connection :"primary_replica"
   end
 end
 ````
@@ -219,6 +210,31 @@ check = Easymon::SplitActiveRecordCheck.new {
 Easymon::Repository.add("split-database", check)
 ````
 
+### Multi ActiveRecord
+`Easymon::MultiActiveRecordCheck` is similar to the `SplitActiveRecordCheck`,
+but it can take an arbitrary number of databases:
+
+```ruby
+module Easymon
+  class PrimaryReplica < ActiveRecord::Base
+    establish_connection :"primary_replica"
+  end
+
+  class OtherReplica < ActiveRecord::Base
+    establish_connection :"other_replica"
+  end
+end
+
+check = Easymon::MultiActiveRecordCheck.new {
+   {
+     "Primary": ActiveRecord::Base.connection,
+     "PrimaryReplica": Easymon::PrimaryReplica.connection
+     "OtherReplica": Easymon::OtherReplica.connection
+   }
+}
+Easymon::Repository.add("multi-database", check)
+```
+
 ### Http
 `Easymon::HttpCheck` will check the return status of a HEAD request to a URL.
 Great for checking service endpoint availability! The following will make a

data/Rakefile

@@ -37,4 +37,4 @@ Rake::TestTask.new(:test) do |t|
 end
 
 
-task :default => :test
+task default: :test

data/app/controllers/easymon/checks_controller.rb

@@ -7,7 +7,7 @@ module Easymon
     # the latter for forward compatibility.
     unless defined?(before_action)
       class << self
-        %w( before ).each do |callback|
+        %w[ before ].each do |callback|
           alias_method :"#{callback}_action", :"#{callback}_filter"
         end
       end
@@ -18,7 +18,7 @@ module Easymon
     rescue_from Easymon::NoSuchCheck do |e|
       respond_to do |format|
         format.any(:text, :html) { render_result "Check Not Found", :not_found }
-        format.json { render :json => "Check Not Found", :status => :not_found }
+        format.json { render json: "Check Not Found", status: :not_found }
       end
     end
 
@@ -34,7 +34,7 @@ module Easymon
       unless checklist.empty?
         # override response_status if we have a "critical" checklist
         unless Easymon::Repository.critical.empty?
-          critical_checks = checklist.items.map{|name, entry| checklist.results[name] if Easymon::Repository.critical.include?(name)}.compact
+          critical_checks = checklist.items.map { |name, entry| checklist.results[name] if Easymon::Repository.critical.include?(name) }.compact
           critical_success = critical_checks.all?(&:success?)
           response_status = critical_success ? :ok : :service_unavailable
           message = add_prefix(critical_success, message)
@@ -45,7 +45,7 @@ module Easymon
 
       respond_to do |format|
          format.any(:text, :html) { render_result message, response_status }
-         format.json { render :json => checklist, :status => response_status }
+         format.json { render json: checklist, status: response_status }
       end
     end
 
@@ -77,9 +77,9 @@ module Easymon
         end
         format.json do
           if is_critical
-            render :json => checklist, :status => checklist.response_status
+            render json: checklist, status: checklist.response_status
           else
-            render :json => result, :status => result.response_status
+            render json: result, status: result.response_status
           end
         end
       end

data/config/routes.rb

@@ -1,6 +1,6 @@
 # use `mount Easymon::Engine => "/up"` in the host application routes.rb
-if Gem::Version.new(Rails.version) >= Gem::Version.new('3.1')
+if Gem::Version.new(Rails.version) >= Gem::Version.new("3.1")
   Easymon::Engine.routes.draw do
     Easymon.routes(self)
   end
-end
+end

data/lib/easymon/checklist.rb

@@ -1,4 +1,4 @@
-require 'benchmark'
+require "benchmark"
 
 module Easymon
   class Checklist
@@ -8,7 +8,7 @@ module Easymon
     attr_accessor :items
     attr_accessor :results
 
-    def initialize(items={})
+    def initialize(items = {})
       self.items = items
       self.results = {}
     end
@@ -20,11 +20,11 @@ module Easymon
         hash[name] = Easymon::Result.new(check_result, timing, check[:critical])
         hash
       end
-      [self.success?, self.to_s]
+      [ self.success?, self.to_s ]
     end
 
     def timing
-      results.values.map{|r| r.timing}.inject(0, :+)
+      results.values.map { |r| r.timing }.inject(0, :+)
     end
 
     def to_text
@@ -32,12 +32,12 @@ module Easymon
     end
 
     def to_s
-      results.map{|name, result| "#{name}: #{result.to_s}"}.join("\n") +
+      results.map { |name, result| "#{name}: #{result}" }.join("\n") +
       "\n - Total Time - " + Easymon.timing_to_ms(self.timing) + "ms"
     end
 
     def to_hash
-      combined = {:timing => Easymon.timing_to_ms(timing)}
+      combined = { timing: Easymon.timing_to_ms(timing) }
       results.each do |name, result|
         combined[name] = result.to_hash
       end
@@ -67,4 +67,4 @@ module Easymon
       raise NoSuchCheck, "No check named '#{name}'"
     end
   end
-end
+end

data/lib/easymon/checks/active_record_check.rb

@@ -1,11 +1,11 @@
 module Easymon
   class ActiveRecordCheck
     attr_accessor :klass
-    
+
     def initialize(klass)
       self.klass = klass
-    end 
-    
+    end
+
     def check
       check_status = database_up?
       if check_status
@@ -13,9 +13,9 @@ module Easymon
       else
         message = "Down"
       end
-      [check_status, message]
+      [ check_status, message ]
     end
-    
+
     private
       def database_up?
         klass.connection.connect!

data/lib/easymon/checks/active_record_mysql_writeable_check.rb

@@ -14,7 +14,7 @@ module Easymon
       else
         message = "@@read_only is 1"
       end
-      [check_status, message]
+      [ check_status, message ]
     end
 
     private

data/lib/easymon/checks/http_check.rb

@@ -1,13 +1,13 @@
-require 'net/https'
+require "net/https"
 
 module Easymon
   class HttpCheck
     attr_accessor :url
-    
+
     def initialize(url)
       self.url = url
-    end 
-    
+    end
+
     def check
       check_status = http_up?(url)
       if check_status
@@ -15,9 +15,9 @@ module Easymon
       else
         message = "Down"
       end
-      [check_status, message]
+      [ check_status, message ]
     end
-    
+
     private
       def http_up?(url)
         http_head(url).is_a?(Net::HTTPSuccess)

data/lib/easymon/checks/memcached_check.rb

@@ -1,11 +1,11 @@
 module Easymon
   class MemcachedCheck
     attr_accessor :cache
-    
+
     def initialize(cache)
       self.cache = cache
-    end 
-    
+    end
+
     def check
       check_status = memcached_up?
       if check_status
@@ -13,9 +13,9 @@ module Easymon
       else
         message = "Down"
       end
-      [check_status, message]
+      [ check_status, message ]
     end
-    
+
     private
       def memcached_up?
         cache.write "health_check", 1
@@ -24,4 +24,4 @@ module Easymon
         false
       end
   end
-end
+end

data/lib/easymon/checks/multi_active_record_check.rb

@@ -0,0 +1,52 @@
+module Easymon
+  class MultiActiveRecordCheck
+    attr_accessor :block
+    attr_accessor :results
+
+    # Here we pass a block so we get a fresh instance of ActiveRecord::Base or
+    # whatever other class we might be using to make database connections
+    #
+    # For example, given the following other class:
+    # module Easymon
+    #   class PrimaryReplica < ActiveRecord::Base
+    #     establish_connection :"primary_replica"
+    #   end
+    #
+    #   class OtherReplica < ActiveRecord::Base
+    #     establish_connection :"other_replica"
+    #   end
+    # end
+    #
+    # We would check both it and ActiveRecord::Base like so:
+    # check = Easymon::MultiActiveRecordCheck.new {
+    #    {
+    #      "Primary": ActiveRecord::Base.connection,
+    #      "PrimaryReplica": Easymon::PrimaryReplica.connection
+    #      "OtherReplica": Easymon::OtherReplica.connection
+    #    }
+    # }
+    # Easymon::Repository.add("multi-database", check)
+
+    def initialize(&block)
+      self.block = block
+    end
+
+    def check
+      connections = Hash(@block.call)
+
+      results = connections.transform_values { |connection| database_up?(connection) }
+
+      status = results.map { |db_name, result| "#{db_name}: #{result ? 'Up' : 'Down'}" }.join(" - ")
+
+      [ (results.any? && results.values.all?), status ]
+    end
+
+    private
+      def database_up?(connection)
+        connection.connect!
+        connection.active?
+      rescue
+        false
+      end
+  end
+end

data/lib/easymon/checks/redis_check.rb

@@ -15,13 +15,13 @@ module Easymon
       else
         message = "Down"
       end
-      [check_status, message]
+      [ check_status, message ]
     end
 
     private
       def redis_up?
         redis = Redis.new(@config)
-        reply = redis.ping == 'PONG'
+        reply = redis.ping == "PONG"
         if redis.respond_to? :close
           redis.close              # Redis 4+
         else
@@ -32,4 +32,4 @@ module Easymon
         false
       end
   end
-end
+end

data/lib/easymon/checks/redis_writeable_check.rb

@@ -12,7 +12,7 @@ module Easymon
       check_status = redis_writeable?
       message = check_status ? "Writeable" : "Read Only"
 
-      [check_status, message]
+      [ check_status, message ]
     end
 
     private

data/lib/easymon/checks/semaphore_check.rb

@@ -1,11 +1,11 @@
 module Easymon
   class SemaphoreCheck
     attr_accessor :file_name
-    
+
     def initialize(file_name)
       self.file_name = file_name
-    end 
-    
+    end
+
     def check
       check_status = semaphore_exists?
       if check_status
@@ -13,9 +13,9 @@ module Easymon
       else
         message = "#{file_name} does not exist!"
       end
-      [check_status, message]
+      [ check_status, message ]
     end
-    
+
     private
       def semaphore_exists?
         Rails.root.join(file_name).exist?
@@ -23,4 +23,4 @@ module Easymon
         false
       end
   end
-end
+end

data/lib/easymon/checks/split_active_record_check.rb

@@ -8,25 +8,14 @@ module Easymon
     #
     # For example, given the following other class:
     # module Easymon
-    #   class Base < ActiveRecord::Base
-    #     def establish_connection(spec = nil)
-    #       if spec
-    #         super
-    #       elsif config = Easymon.database_configuration
-    #         super config
-    #       end
-    #     end
-    #
-    #     def database_configuration
-    #       env = "#{Rails.env}_replica"
-    #       config = YAML.load_file(Rails.root.join('config/database.yml'))[env]
-    #     end
+    #   class Replica < ActiveRecord::Base
+    #     establish_connection :"primary_replica"
     #   end
     # end
     #
     # We would check both it and ActiveRecord::Base like so:
     # check = Easymon::SplitActiveRecordCheck.new {
-    #   [ActiveRecord::Base.connection, Easymon::Base.connection] 
+    #   [ActiveRecord::Base.connection, Easymon::Replica.connection]
     # }
     # Easymon::Repository.add("split-database", check)
     def initialize(&block)
@@ -37,16 +26,17 @@ module Easymon
     def check
       connections = Array(@block.call)
 
-      results = connections.map{|connection| database_up?(connection) }
+      results = connections.map { |connection| database_up?(connection) }
 
       primary_status = results.first ? "Primary: Up" : "Primary: Down"
       replica_status = results.last ? "Replica: Up" : "Replica: Down"
 
-      [(results.all? && results.count > 0), "#{primary_status} - #{replica_status}"]
+      [ (results.all? && results.count > 0), "#{primary_status} - #{replica_status}" ]
     end
 
     private
       def database_up?(connection)
+        connection.connect!
         connection.active?
       rescue
         false

data/lib/easymon/checks/traffic_enabled_check.rb

@@ -7,7 +7,7 @@ module Easymon
       else
         message = "DISABLED"
       end
-      [check_status, message]
+      [ check_status, message ]
     end
   end
-end
+end

data/lib/easymon/engine.rb

@@ -1,7 +1,7 @@
 module Easymon
   class Engine < ::Rails::Engine
     # Rails Engines weren't isolated until v3.1
-    if Gem::Version.new(Rails.version) >= Gem::Version.new('3.1')
+    if Gem::Version.new(Rails.version) >= Gem::Version.new("3.1")
       isolate_namespace Easymon
     end
   end

data/lib/easymon/repository.rb

@@ -3,7 +3,7 @@ module Easymon
     attr_reader :repository
 
     def self.fetch(name)
-      return repository.fetch(name)
+      repository.fetch(name)
     rescue IndexError
       raise NoSuchCheck, "No check named '#{name}'"
     end
@@ -16,8 +16,8 @@ module Easymon
       repository.keys
     end
 
-    def self.add(name, check, is_critical=false)
-      entry = {:check => check, :critical => is_critical ? true : false}
+    def self.add(name, check, is_critical = false)
+      entry = { check: check, critical: is_critical ? true : false }
       repository[name] = entry
     end
 
@@ -30,7 +30,7 @@ module Easymon
     end
 
     def self.critical
-      repository.map{ |name, entry| name if entry[:critical] }.compact
+      repository.map { |name, entry| name if entry[:critical] }.compact
     end
   end
-end
+end

data/lib/easymon/result.rb

@@ -33,7 +33,7 @@ module Easymon
     end
 
     def to_hash
-      {:success => success, :message => message, :timing => Easymon.timing_to_ms(timing), :critical => critical}
+      { success: success, message: message, timing: Easymon.timing_to_ms(timing), critical: critical }
     end
   end
-end
+end

data/lib/easymon/testing.rb

@@ -7,11 +7,11 @@ module Easymon
     end
 
     def stub_service_success(name)
-      stub_check(name).returns([true, "Up"])
+      stub_check(name).returns([ true, "Up" ])
     end
 
     def stub_service_failure(name)
-      stub_check(name).returns([false, "Down"])
+      stub_check(name).returns([ false, "Down" ])
     end
   end
 end

data/lib/easymon/version.rb

@@ -1,3 +1,3 @@
 module Easymon
-    VERSION = "1.6.3"
+    VERSION = "1.6.4"
 end

data/lib/easymon.rb

@@ -9,6 +9,7 @@ require "easymon/result"
 
 require "easymon/checks/active_record_check"
 require "easymon/checks/active_record_mysql_writeable_check"
+require "easymon/checks/multi_active_record_check"
 require "easymon/checks/split_active_record_check"
 require "easymon/checks/redis_check"
 require "easymon/checks/redis_writeable_check"
@@ -55,25 +56,25 @@ module Easymon
       # Rails 2.3.x (anything less than 3, really)
       $:.unshift File.expand_path(File.join(
         File.dirname(__FILE__),
-        "..","app","controllers"))
-      require 'easymon/checks_controller'
+        "..", "app", "controllers"))
+      require "easymon/checks_controller"
 
       mapper.instance_eval do
-        connect "#{path}.:format", :controller => "easymon/checks", :action => "index"
-        connect "#{path}/:check.:format", :controller => "easymon/checks", :action => "show"
+        connect "#{path}.:format", controller: "easymon/checks", action: "index"
+        connect "#{path}/:check.:format", controller: "easymon/checks", action: "show"
       end
     elsif Easymon.rails30?
       # Greater than 3.0, but less than 3.1
       mapper.instance_eval do
-        get "#{path}(.:format)", :controller => 'easymon/checks', :action => 'index'
-        get "#{path}/:check", :controller => 'easymon/checks', :action => 'show'
+        get "#{path}(.:format)", controller: "easymon/checks", action: "index"
+        get "#{path}/:check", controller: "easymon/checks", action: "show"
       end
     elsif Easymon.mountable_engine?
       # Rails 3.1+
       mapper.instance_eval do
-        get "/(.:format)", :to => "checks#index"
-        root :to => "checks#index"
-        get "/:check", :to => "checks#show"
+        get "/(.:format)", to: "checks#index"
+        root to: "checks#index"
+        get "/:check", to: "checks#show"
       end
     end
   end

data/test/controllers/easymon/checks_controller_test.rb

@@ -1,8 +1,7 @@
-require 'test_helper'
+require "test_helper"
 
 module Easymon
   class ChecksControllerTest < ActionController::TestCase
-
     setup do
       @routes = Easymon::Engine.routes
       Easymon.authorize_with = nil
@@ -23,7 +22,7 @@ module Easymon
 
     test "index when a check fails" do
       Easymon::Repository.add("database", Easymon::ActiveRecordCheck.new(ActiveRecord::Base))
-      Easymon::Repository.add("redis", Easymon::RedisCheck.new(YAML.load_file(Rails.root.join("config/redis.yml"))[Rails.env].symbolize_keys))
+      Easymon::Repository.add("redis", Easymon::RedisCheck.new(YAML.load_file(Rails.root.join("config/redis.yml"), aliases: true)[Rails.env].symbolize_keys))
       Redis.any_instance.stubs(:ping).raises("boom")
       get :index
       assert_response :service_unavailable
@@ -41,7 +40,7 @@ module Easymon
 
     test "index when a non-critical check fails" do
       Easymon::Repository.add("database", Easymon::ActiveRecordCheck.new(ActiveRecord::Base), :critical)
-      Easymon::Repository.add("redis", Easymon::RedisCheck.new(YAML.load_file(Rails.root.join("config/redis.yml"))[Rails.env].symbolize_keys))
+      Easymon::Repository.add("redis", Easymon::RedisCheck.new(YAML.load_file(Rails.root.join("config/redis.yml"), aliases: true)[Rails.env].symbolize_keys))
       Redis.any_instance.stubs(:ping).raises("boom")
       get :index
       assert_response :success
@@ -51,7 +50,7 @@ module Easymon
 
     test "index returns valid json" do
       Easymon::Repository.add("database", Easymon::ActiveRecordCheck.new(ActiveRecord::Base))
-      get :index, :format => :json
+      get :index, format: :json
 
       json = JSON.parse(response.body)
 
@@ -61,14 +60,14 @@ module Easymon
 
     test "show when the check passes" do
       Easymon::Repository.add("database", Easymon::ActiveRecordCheck.new(ActiveRecord::Base))
-      get :show, :params => { check: "database" }
+      get :show, params: { check: "database" }
       assert_response :success
       assert response.body.include?("Up"), "Response should include message text, got #{response.body}"
     end
 
     test "show json when the check passes" do
       Easymon::Repository.add("database", Easymon::ActiveRecordCheck.new(ActiveRecord::Base))
-      get :show, :params => { :check => "database", :format => :json }
+      get :show, params: { check: "database", format: :json }
 
       json = JSON.parse(response.body)
 
@@ -80,16 +79,16 @@ module Easymon
       Easymon::Repository.add("database", Easymon::ActiveRecordCheck.new(ActiveRecord::Base))
       ActiveRecord::Base.connection.stubs(:active?).raises("boom")
 
-      get :show, :params => { :check => "database" }
+      get :show, params: { check: "database" }
 
       assert_response :service_unavailable
       assert response.body.include?("Down"), "Response should include failure text, got #{response.body}"
     end
 
     test "show if the check is not found" do
-      Easymon::Repository.names.each {|name| Easymon::Repository.remove(name)}
+      Easymon::Repository.names.each { |name| Easymon::Repository.remove(name) }
 
-      get :show, :params => { :check => "database" }
+      get :show, params: { check: "database" }
       assert_response :not_found
     end
 
@@ -99,7 +98,7 @@ module Easymon
       get :index
       assert_response :forbidden
 
-      get :show, :params => { :check => "database" }
+      get :show, params: { check: "database" }
       assert_response :forbidden
     end
   end