abril_heartbeat 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e46a565059cc447a70e723f46152dfd92da1593a
-  data.tar.gz: 93eb57ddb1256eb7b8e5e10d9f9f757b675075cc
+  metadata.gz: 151615ea0de619412b3cdd9ca7e08adb5d650931
+  data.tar.gz: d881ece89929c7e6b36f8f6bf944f72fd1f32773
 SHA512:
-  metadata.gz: e17eb02e8102b3b2412c2fd7b6affd21c2691c745160979e8839409027eb223d3a331a09c7ec340b74db380e14e2e90383e768b45518beb7c5b8ac1779951032
-  data.tar.gz: cd842688fcfcf30515e44808779c489901f88fa910d572b53f4bb6248fafa91a2621ea34ddfc096c2620eb0420a8c1325fe43e9fdc57c597228cb25b361286b9
+  metadata.gz: 198171c751b44416d834ec25782b56572e07c0510402b4764027140396efbf80227211ddba1097233cbe80d1058846aed34c954d69f4a8fb06b5d0f1a22148c1
+  data.tar.gz: 8c4a95edbe456febc7338c6a959c33fb8fe3514f777c35b7df0eff2e57b8b02a2ad5d21ce760c063c7b37807474f685a9089c8403c02e7bc93e63529f649d720

data/lib/abril_heartbeat.rb

@@ -1,25 +1,25 @@
-require "json"
-require "abril_heartbeat/version"
-require "abril_heartbeat/heartbeater"
+require 'json'
+require 'abril_heartbeat/version'
+require 'abril_heartbeat/heartbeater'
 
 # Config Loader
-require "abril_heartbeat/config_loader"
+require 'abril_heartbeat/config_loader'
 
 # Checkers
-require "abril_heartbeat/checkers/abstract_checker"
-require "abril_heartbeat/checkers/rest_checker"
-require "abril_heartbeat/checkers/mongo_checker"
-require "abril_heartbeat/checkers/mysql_checker"
-require "abril_heartbeat/checkers/redis_checker"
+require 'abril_heartbeat/checkers/abstract_checker'
+require 'abril_heartbeat/checkers/rest_checker'
+require 'abril_heartbeat/checkers/mongo_checker'
+require 'abril_heartbeat/checkers/mysql_checker'
+require 'abril_heartbeat/checkers/redis_checker'
 
 # Wrappers
-require "abril_heartbeat/wrappers/mongo_wrapper"
-require "abril_heartbeat/wrappers/mysql_wrapper"
-require "abril_heartbeat/wrappers/redis_wrapper"
+require 'abril_heartbeat/wrappers/mongo_wrapper'
+require 'abril_heartbeat/wrappers/mysql_wrapper'
+require 'abril_heartbeat/wrappers/redis_wrapper'
 
 module AbrilHeartbeat
   class Middleware
-    def initialize(app, options={})
+    def initialize(app, options = {})
       @app = app
       @file_path = options[:file_path]
     end
@@ -36,7 +36,7 @@ module AbrilHeartbeat
     private
 
     def response
-      Heartbeater.new({:file_path => @file_path}).run!
+      Heartbeater.new(file_path: @file_path).run!
     end
 
     def request

data/lib/abril_heartbeat/checkers/abstract_checker.rb

@@ -1,22 +1,20 @@
 module AbrilHeartbeat
   class AbstractChecker
-    def self.is_running?
-      raise NotImplementedError
+    def self.running?
+      fail NotImplementedError
     end
 
     def self.module_name
-      raise NotImplementedError
+      fail NotImplementedError
     end
 
     def self.run!
       status, message = check!
-      { module_name => { "status" => status, "status_message" => message }}
+      { module_name => { 'status' => status, 'status_message' => message } }
     end
 
-    private
-
     def self.check!
-      raise NotImplementedError
+      fail NotImplementedError
     end
   end
 end

data/lib/abril_heartbeat/checkers/mongo_checker.rb

@@ -1,20 +1,18 @@
 module AbrilHeartbeat
   class MongoChecker < AbstractChecker
-    def self.is_running?
-      MongoWrapper.has_client?
+    def self.running?
+      MongoWrapper.client?
     end
 
     def self.module_name
-      "MONGO"
+      'MONGO'
     end
 
-    private
-
     def self.check!
       MongoWrapper.check_status!
-      ["OK", "Everything is under control"]
+      ['OK', 'Everything is under control']
     rescue => exception
-      ["FAIL", exception.message]
+      ['FAIL', exception.message]
     end
   end
 end

data/lib/abril_heartbeat/checkers/mysql_checker.rb

@@ -1,20 +1,18 @@
 module AbrilHeartbeat
   class MysqlChecker < AbstractChecker
-    def self.is_running?
-      MysqlWrapper.has_client?
+    def self.running?
+      MysqlWrapper.client?
     end
 
     def self.module_name
-      "MYSQL"
+      'MYSQL'
     end
 
-    private
-
     def self.check!
       MysqlWrapper.check_status!
-      ["OK", "Everything is under control"]
+      ['OK', 'Everything is under control']
     rescue => exception
-      ["FAIL", exception.message]
+      ['FAIL', exception.message]
     end
   end
 end

data/lib/abril_heartbeat/checkers/redis_checker.rb

@@ -1,20 +1,18 @@
 module AbrilHeartbeat
   class RedisChecker < AbstractChecker
-    def self.is_running?
-      RedisWrapper.has_client?
+    def self.running?
+      RedisWrapper.client?
     end
 
     def self.module_name
-      "REDIS"
+      'REDIS'
     end
 
-    private
-
     def self.check!
       RedisWrapper.check_status!
-      ["OK", "Everything is under control"]
+      ['OK', 'Everything is under control']
     rescue => exception
-      ["FAIL", exception.message]
+      ['FAIL', exception.message]
     end
   end
 end

data/lib/abril_heartbeat/checkers/rest_checker.rb

@@ -1,38 +1,38 @@
-require "rest_client"
+require 'rest_client'
 
 module AbrilHeartbeat
   class RestChecker < AbstractChecker
-    def self.is_running?
+    def self.running?
       !rest_hash.empty?
     end
 
     def self.run!
       messages = rest_hash.map do |key, value|
-        status, message = check!{ value['url'] }
-        { key => { "url" => value["url"], "status" => status, "status_message" => message }}
+        status, message = check! { value['url'] }
+        { key => { 'url' => value['url'], 'status' => status, 'status_message' => message } }
       end
 
       { module_name => messages }
     end
 
     def self.module_name
-      "REST"
+      'REST'
     end
 
-    private
-
-    def self.rest_hash
-      ConfigLoader.load_by_type(:rest)
-    end
-
-    def self.check!(&block)
+    def self.check!
       url = yield
       response = RestClient.get(url)
-      [response.code, "OK"]
+      [response.code, 'OK']
     rescue RestClient::ResourceNotFound
-      [404, "Page Not Found"]
+      [404, 'Page Not Found']
     rescue => exception
       [nil, exception.message]
     end
+
+    def self.rest_hash
+      ConfigLoader.load_by_type(:rest)
+    end
+
+    private_class_method :rest_hash
   end
 end

data/lib/abril_heartbeat/config_loader.rb

@@ -1,22 +1,22 @@
 module AbrilHeartbeat
   class ConfigLoader
+    class << self
+      attr_accessor :file_path
+    end
+
     def self.load
       @file ||= load_file
     end
 
     def self.load_by_type(type)
       return load if load.empty?
-      load.select{|_, v| v['type'] == type.to_s}
-    end
-
-    def self.set_file(file_path)
-      @file_path = file_path
+      load.select { |_, v| v['type'] == type.to_s }
     end
 
     def self.load_file
-      return {} unless @file_path
+      return {} unless file_path
 
-      ::YAML.load_file(@file_path)
+      ::YAML.load_file(file_path)
     end
   end
 end

data/lib/abril_heartbeat/heartbeater.rb

@@ -1,9 +1,9 @@
-require "yaml"
+require 'yaml'
 
 module AbrilHeartbeat
   class Heartbeater
-    def initialize(options={})
-      ConfigLoader.set_file(options[:file_path]) if options[:file_path]
+    def initialize(options = {})
+      ConfigLoader.file_path = options[:file_path] if options[:file_path]
 
       @checkers = [MongoChecker, MysqlChecker, RedisChecker]
       @checkers += options[:custom_checkers] if options[:custom_checkers]
@@ -11,10 +11,10 @@ module AbrilHeartbeat
 
     def run!
       response = []
-      response << RestChecker.run! if RestChecker.is_running?
+      response << RestChecker.run! if RestChecker.running?
 
       @checkers.each do |checker|
-        response << checker.run! if checker.is_running?
+        response << checker.run! if checker.running?
       end
 
       response

data/lib/abril_heartbeat/version.rb

@@ -1,3 +1,3 @@
 module AbrilHeartbeat
-  VERSION = "1.0.0"
+  VERSION = '1.1.0'
 end

data/lib/abril_heartbeat/wrappers/mongo_wrapper.rb

@@ -4,7 +4,7 @@ module AbrilHeartbeat
       ::Mongoid.default_session.command(ping: 1)
     end
 
-    def self.has_client?
+    def self.client?
       !!defined?(Mongoid)
     end
   end

data/lib/abril_heartbeat/wrappers/mysql_wrapper.rb

@@ -4,7 +4,7 @@ module AbrilHeartbeat
       ::ActiveRecord::Base.connection.current_database
     end
 
-    def self.has_client?
+    def self.client?
       !!defined?(ActiveRecord::Base.connection)
     end
   end

data/lib/abril_heartbeat/wrappers/redis_wrapper.rb

@@ -4,7 +4,7 @@ module AbrilHeartbeat
       ::REDIS.get(:version)
     end
 
-    def self.has_client?
+    def self.client?
       !!defined?(REDIS)
     end
   end

data/spec/checkers/mongo_checker_spec.rb

@@ -24,17 +24,17 @@ describe AbrilHeartbeat::MongoChecker do
     end
   end
 
-  describe "#is_running?" do
+  describe "#running?" do
     context "when the app has a mongo client" do
-      before { allow(AbrilHeartbeat::MongoWrapper).to receive(:has_client?) { "constant" } }
+      before { allow(AbrilHeartbeat::MongoWrapper).to receive(:client?) { "constant" } }
 
-      subject { described_class.is_running? }
+      subject { described_class.running? }
 
       it { is_expected.to be_truthy }
     end
 
     context "when the app does not have a mongo client" do
-      subject { described_class.is_running? }
+      subject { described_class.running? }
 
       it { is_expected.to be_falsy }
     end

data/spec/checkers/mysql_checker_spec.rb

@@ -24,17 +24,17 @@ describe AbrilHeartbeat::MysqlChecker do
     end
   end
 
-  describe "#is_running?" do
+  describe "#running?" do
     context "when the app has a mysql client" do
-      before { allow(AbrilHeartbeat::MysqlWrapper).to receive(:has_client?) { "constant" } }
+      before { allow(AbrilHeartbeat::MysqlWrapper).to receive(:client?) { "constant" } }
 
-      subject { described_class.is_running? }
+      subject { described_class.running? }
 
       it { is_expected.to be_truthy }
     end
 
     context "when the app does not have a mysql client" do
-      subject { described_class.is_running? }
+      subject { described_class.running? }
 
       it { is_expected.to be_falsy }
     end

data/spec/checkers/redis_checker_spec.rb

@@ -24,17 +24,17 @@ describe AbrilHeartbeat::RedisChecker do
     end
   end
 
-  describe "#is_running?" do
+  describe "#running?" do
     context "when the app has a redis client" do
-      before { allow(AbrilHeartbeat::RedisWrapper).to receive(:has_client?) { "constant" } }
+      before { allow(AbrilHeartbeat::RedisWrapper).to receive(:client?) { "constant" } }
 
-      subject { described_class.is_running? }
+      subject { described_class.running? }
 
       it { is_expected.to be_truthy }
     end
 
     context "when the app does not have a redis client" do
-      subject { described_class.is_running? }
+      subject { described_class.running? }
 
       it { is_expected.to be_falsy }
     end

data/spec/checkers/rest_checker_spec.rb

@@ -17,9 +17,9 @@ describe AbrilHeartbeat::RestChecker do
     let(:response) {{ "MODEL" => [{"api_success"=>{"url"=>"http://www.scudelletti.com", "status"=>"OK", "status_message"=>"Everything is OK"}}, {"api_not_found"=>{"url"=>"http://www.scudelletti.com/not_found", "status"=>"OK", "status_message"=>"Everything is OK"}}, {"api_wrong_url"=>{"url"=>"I am a wrong url", "status"=>"OK", "status_message"=>"Everything is OK"}}] }}
   end
 
-  describe "#is_running?" do
+  describe "#running?" do
     context "when there is rest calls" do
-      subject { described_class.is_running? }
+      subject { described_class.running? }
 
       it { is_expected.to be_truthy }
     end
@@ -27,7 +27,7 @@ describe AbrilHeartbeat::RestChecker do
     context "when there is not rest calls" do
       before { allow(AbrilHeartbeat::ConfigLoader).to receive(:load) { {} } }
 
-      subject { described_class.is_running? }
+      subject { described_class.running? }
 
       it { is_expected.to be_falsy }
     end

data/spec/heartbeater_spec.rb

@@ -14,8 +14,8 @@ describe AbrilHeartbeat::Heartbeater do
 
       context "when the app has more than one dependency" do
         before do
-          allow(AbrilHeartbeat::RestChecker).to receive(:is_running?) { true }
-          allow(AbrilHeartbeat::MongoChecker).to receive(:is_running?) { true }
+          allow(AbrilHeartbeat::RestChecker).to receive(:running?) { true }
+          allow(AbrilHeartbeat::MongoChecker).to receive(:running?) { true }
         end
 
         it { is_expected.to eql([{"REST" => "MOCK"}, {"MONGO" => "MOCK"}]) }
@@ -23,8 +23,8 @@ describe AbrilHeartbeat::Heartbeater do
 
       context "when the app just have on kind of dependency" do
         before do
-          allow(AbrilHeartbeat::RestChecker).to receive(:is_running?) { false }
-          allow(AbrilHeartbeat::MongoChecker).to receive(:is_running?) { true }
+          allow(AbrilHeartbeat::RestChecker).to receive(:running?) { false }
+          allow(AbrilHeartbeat::MongoChecker).to receive(:running?) { true }
         end
 
         it { is_expected.to eql([{"MONGO" => "MOCK"}]) }
@@ -32,18 +32,18 @@ describe AbrilHeartbeat::Heartbeater do
     end
 
     describe "Custom checkers" do
-      let(:custom_checker) { double("CustomChecker", is_running?: true) }
+      let(:custom_checker) { double("CustomChecker", running?: true) }
 
       subject { described_class.new({file_path: file_path, custom_checkers: [custom_checker]}) }
 
       before do
-        allow(AbrilHeartbeat::RestChecker).to receive(:is_running?) { false }
-        allow(AbrilHeartbeat::MongoChecker).to receive(:is_running?) { false }
-        allow(AbrilHeartbeat::MysqlChecker).to receive(:is_running?) { false }
+        allow(AbrilHeartbeat::RestChecker).to receive(:running?) { false }
+        allow(AbrilHeartbeat::MongoChecker).to receive(:running?) { false }
+        allow(AbrilHeartbeat::MysqlChecker).to receive(:running?) { false }
       end
 
       it "returns the status codes" do
-        expect(custom_checker).to receive(:is_running?)
+        expect(custom_checker).to receive(:running?)
         expect(custom_checker).to receive(:run!)
 
         subject.run!

data/spec/support/shared_examples/checker_share.rb

@@ -3,7 +3,7 @@ RSpec.shared_examples "a checker" do
 
   subject{ described_class }
 
-  it { is_expected.to respond_to(:is_running?) }
+  it { is_expected.to respond_to(:running?) }
   it { is_expected.to respond_to(:module_name) }
   it { is_expected.to respond_to(:run!) }
   it { is_expected.to respond_to(:check!) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abril_heartbeat
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Diogo Scudelletti
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-29 00:00:00.000000000 Z
+date: 2014-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -180,7 +180,6 @@ files:
 - lib/abril_heartbeat/wrappers/mysql_wrapper.rb
 - lib/abril_heartbeat/wrappers/redis_wrapper.rb
 - spec/cassettes/AbrilHeartbeat_Middleware/when_middleware_handles_the_request/responds_success.yml
-- spec/cassettes/HeartbeatAbril_Middleware/when_middleware_handles_the_request/responds_success.yml
 - spec/checkers/abstract_checker_spec.rb
 - spec/checkers/mongo_checker_spec.rb
 - spec/checkers/mysql_checker_spec.rb
@@ -219,7 +218,6 @@ specification_version: 4
 summary: Builds a heartbeat route for Apps
 test_files:
 - spec/cassettes/AbrilHeartbeat_Middleware/when_middleware_handles_the_request/responds_success.yml
-- spec/cassettes/HeartbeatAbril_Middleware/when_middleware_handles_the_request/responds_success.yml
 - spec/checkers/abstract_checker_spec.rb
 - spec/checkers/mongo_checker_spec.rb
 - spec/checkers/mysql_checker_spec.rb

data/spec/cassettes/HeartbeatAbril_Middleware/when_middleware_handles_the_request/responds_success.yml

@@ -1,111 +0,0 @@
----
-http_interactions:
-- request:
-    method: get
-    uri: http://www.scudelletti.com/
-    body:
-      encoding: US-ASCII
-      string: ''
-    headers:
-      Accept:
-      - "*/*; q=0.5, application/xml"
-      Accept-Encoding:
-      - gzip, deflate
-      User-Agent:
-      - Ruby
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Date:
-      - Fri, 26 Sep 2014 13:09:40 GMT
-      Server:
-      - Apache/2.2.15 (Red Hat)
-      Last-Modified:
-      - Mon, 14 Jul 2014 11:37:00 GMT
-      Etag:
-      - '"540027-942-4fe25b58cef00"'
-      Accept-Ranges:
-      - none
-      Content-Type:
-      - text/html
-      Vary:
-      - Accept-Encoding
-      Content-Encoding:
-      - gzip
-      Content-Length:
-      - '948'
-    body:
-      encoding: ASCII-8BIT
-      string: !binary |-
-        H4sIAAAAAAAAA51W32/bNhB+319x0AsdxJacdGuHxEoRI10bYOuCOsMegqCg
-        qbPMhiI1krIqrPvfd5TkWG7aZcmTqfvF7+4+3nm29oU6+wFgtkaetQcvvcKz
-        C2lyAwtRZagUei9hAh+qZQMLs/I1twhvdC61RkuKP3EZ1FwqR78Lqbm3nE5X
-        PLNSm1nSxQzRC/QcNC8wjTJ0wsrSS6MjEEZ71D6NLlkBDy/nUNMdGW5QmRLt
-        GOq1gdrYOzAaLq/BSS0QjqfTl2O4BK5q3jjwtgFvIJNOmA0B5cqjJWxygy4o
-        Cn6HUDRdHJ5LhXGb47hLZbzNZAy/GZ2bi/l4m9GHeQRJm4+S+g7WFlcpW3tf
-        niTJijJxcW5MrpCX0sXCFIlw7vWKF1I16bnC3GLDDxdcu5Mfp9PxT9MpA4sq
-        Zc43Ct0a0TPwTYkp8/jZB28Wbtve98C2A9BK4mD8tXMHdg9uFOA6wluqagu3
-        hXrYVn9Q/Ki9LyqrpZJ0n426zJN7xixN1vTxM7kBobhzaRQ6yiURJOp0D7XU
-        73vdvrbgnydCWqFwYPBVgF49S0g4iNJ9fjOq1CtjC94Sbi/s+ugh3ym/o32j
-        47NvPAAMvPIw//3XC7jUPb+M5gq4zuCtrUoD50srFcU73oun+Wb4TRI+6Aw1
-        pq7rOPQLM6nbzkiduB3ABPezaEPIIgdnBeVa8Bxdcu9f6jwKDyCN5srk0ZYQ
-        u7LxQdEeoAk8yaVfV8sWyADF4xB6vx2At9K/q5bPgeBr6anELYbsSSC2njsU
-        153kOTBCY1Zc4NKYuxbL4ilQ7j13WH7pRc8B8/jzfbxDbYxBg9pocEXSpyLq
-        q0NASqnoBZjY2PxxBEvi5P+i6PBz7wHtv/vBUBgeu32zddpwCx9z/hek3c+X
-        L3Bze9orgyQuK7ce3bCPDv25EKbSno2B/XE+OT56+erFz69eTI7Y7cH3XC5M
-        QfPvPe264DWgayjPf/idK2Xqd9ytg9uKK4ffM6bdJO6uqIIbiXVr1FuNVpUW
-        YQ6NDuDvQbo5p2QzI6qCZm8sLHKPbxSGrxHrqsMOTsksDguEbLsV8olveK9t
-        ldw1WpDW2wq3wEhMHSXhiHXUZJAO7lJGtIMxLq3xRhgFr4FtOeycYnACbMcg
-        dgCHwHpeTzjN08ZL0e1SuumTY6eDtNwwqxx9n5KbN9c8Dw3YJXczvT0FIjsN
-        cO3fmwxjqR1aP0faDTjKadm7+2L/czBqz7Nkx5xZ0q07muftX6d/AeG2G0BC
-        CQAA
-    http_version: 
-  recorded_at: Fri, 26 Sep 2014 13:09:41 GMT
-- request:
-    method: get
-    uri: http://www.scudelletti.com/not_found
-    body:
-      encoding: US-ASCII
-      string: ''
-    headers:
-      Accept:
-      - "*/*; q=0.5, application/xml"
-      Accept-Encoding:
-      - gzip, deflate
-      User-Agent:
-      - Ruby
-  response:
-    status:
-      code: 404
-      message: ''
-    headers:
-      Date:
-      - Fri, 26 Sep 2014 13:09:41 GMT
-      Server:
-      - Apache/2.2.15 (Red Hat)
-      X-Powered-By:
-      - Phusion Passenger (mod_rails/mod_rack) 3.0.21
-      X-Cascade:
-      - pass
-      X-Xss-Protection:
-      - 1; mode=block
-      X-Content-Type-Options:
-      - nosniff
-      X-Frame-Options:
-      - SAMEORIGIN
-      Content-Length:
-      - '18'
-      Status:
-      - '404'
-      Content-Type:
-      - text/html;charset=utf-8
-      Accept-Ranges:
-      - none
-    body:
-      encoding: UTF-8
-      string: "<h1>Not Found</h1>"
-    http_version: 
-  recorded_at: Fri, 26 Sep 2014 13:09:41 GMT
-recorded_with: VCR 2.9.3