abril_heartbeat 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e46a565059cc447a70e723f46152dfd92da1593a
+  data.tar.gz: 93eb57ddb1256eb7b8e5e10d9f9f757b675075cc
+SHA512:
+  metadata.gz: e17eb02e8102b3b2412c2fd7b6affd21c2691c745160979e8839409027eb223d3a331a09c7ec340b74db380e14e2e90383e768b45518beb7c5b8ac1779951032
+  data.tar.gz: cd842688fcfcf30515e44808779c489901f88fa910d572b53f4bb6248fafa91a2621ea34ddfc096c2620eb0420a8c1325fe43e9fdc57c597228cb25b361286b9

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in abril_heartbeat.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Diogo Scudelletti
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,122 @@
+# Abril Heartbeat
+
+This GEM is a middleware which adds a heartbeat route to your Apps, a route which checks your external dependencies such as MySQL, Mongo, Redis and REST APIs.  
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'abril_heartbeat'
+```
+
+Set the middleware on your app.
+
+Rails Example
+In the config/application.rb file add the following middleware.
+
+```ruby
+config.middleware.use "AbrilHeartbeat::Middleware"
+```
+
+Then access the `/heartbeat` in your app.
+
+Response's example
+```json
+[{
+  MONGO: {
+    status: "FAIL",
+    status_message: "Could not connect to any secondary or primary nodes for replica set <Moped::Cluster nodes=[<Moped::Node resolved_address="
+    127.0.0.1: 27017 ">]>"
+  }
+}]
+```
+
+### REST Configuration
+
+Create a heartbeat.yml to your REST APIs.
+
+heartbeat.yml example:
+```yaml
+api_success:
+  url: 'http://some.awesomeapi.com'
+  type: 'rest'
+
+api_not_found:
+  url: 'http://another.api.com'
+  type: 'rest'
+```
+
+For APIs checking, create a heartbeat.yml and pass it in the middleware initialization:
+```ruby
+config.middleware.use "AbrilHeartbeat::Middleware", :file_path => "#{File.dirname(__FILE__)}/heartbeat.yml"
+```
+
+Response's example
+```json
+[{
+  REST: [{
+    api_success: {
+      url: "http://some.awesomeapi.com",
+      status: 200,
+      status_message: "OK"
+    }
+  }, {
+    api_not_found: {
+      url: "http://another.api.com",
+      status: 404,
+      status_message: "Page Not Found"
+    }
+  }, {
+    api_wrong_url: {
+      url: "I am a wrong url",
+      status: null,
+      status_message: "bad URI(is not URI?): http://I am a wrong url"
+    }
+  }]
+}, {
+  MONGO: {
+    status: "FAIL",
+    status_message: "Could not connect to any secondary or primary nodes for replica set <Moped::Cluster nodes=[<Moped::Node resolved_address="
+    127.0.0.1: 27017 ">]>"
+  }
+}]
+```
+
+### Redis Configuration
+
+By Default we access a REDIS client variable, which contains the redis client.
+
+### Mongo Configuration
+
+By default we use the Mongoid class of your app to check the connection.
+
+### ActiveRecord Configuration
+
+By default we use the ActiveRecord to check the connection.
+
+## Creating your own checkers.
+
+In the middleware initialization you can pass your own checkers:
+
+```ruby
+config.middleware.use "AbrilHeartbeat::Middleware", {custom_checkers: [YourCustomCheckerClass]}
+```
+
+You custom checker class must implement the `AbrilHeartbeat::AbstractChecker` interface.
+
+## Future
+
+* add new MongoDrivers to support more apps
+* use the yaml file to get the Redis client instance
+* basic auth? At this moment you must handle the request before our middleware
+* add a initializer to config the heartbeat route
+
+
+## Contributing
+
+1. Fork it ( https://github.com/abril/abril_heartbeat/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/abril_heartbeat.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'abril_heartbeat/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "abril_heartbeat"
+  spec.version       = AbrilHeartbeat::VERSION
+  spec.authors       = ["Diogo Scudelletti"]
+  spec.email         = ["diogo@scudelletti.com"]
+  spec.summary       = %q{Builds a heartbeat route for Apps}
+  spec.description   = %q{This GEM is a middleware which adds a heartbeat route to your Apps, a route which checks your external dependencies such as MySQL, Mongo, Redis and REST APIs.}
+  spec.homepage      = "https://github.com/abril/abril_heartbeat"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rack", "~> 1.4.5"
+  spec.add_dependency "rest-client", "~> 1.7.2"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1.0"
+  spec.add_development_dependency "rack-test", "~> 0.6.2"
+  spec.add_development_dependency "factory_girl", "~> 4.4.0"
+  spec.add_development_dependency "vcr", "~> 2.9.3"
+  spec.add_development_dependency "webmock", "~> 1.18.0"
+  spec.add_development_dependency "pry-nav", "~> 0.2.4"
+end

data/lib/abril_heartbeat.rb

@@ -0,0 +1,46 @@
+require "json"
+require "abril_heartbeat/version"
+require "abril_heartbeat/heartbeater"
+
+# 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"
+
+# Wrappers
+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={})
+      @app = app
+      @file_path = options[:file_path]
+    end
+
+    def call(env)
+      @env = env
+      if request.path == '/heartbeat'
+        [200, { 'Content-Type' => 'text/json' }, [response.to_json]]
+      else
+        @app.call(env)
+      end
+    end
+
+    private
+
+    def response
+      Heartbeater.new({:file_path => @file_path}).run!
+    end
+
+    def request
+      Rack::Request.new @env
+    end
+  end
+end

data/lib/abril_heartbeat/checkers/abstract_checker.rb

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

data/lib/abril_heartbeat/checkers/mongo_checker.rb

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

data/lib/abril_heartbeat/checkers/mysql_checker.rb

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

data/lib/abril_heartbeat/checkers/redis_checker.rb

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

data/lib/abril_heartbeat/checkers/rest_checker.rb

@@ -0,0 +1,38 @@
+require "rest_client"
+
+module AbrilHeartbeat
+  class RestChecker < AbstractChecker
+    def self.is_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 }}
+      end
+
+      { module_name => messages }
+    end
+
+    def self.module_name
+      "REST"
+    end
+
+    private
+
+    def self.rest_hash
+      ConfigLoader.load_by_type(:rest)
+    end
+
+    def self.check!(&block)
+      url = yield
+      response = RestClient.get(url)
+      [response.code, "OK"]
+    rescue RestClient::ResourceNotFound
+      [404, "Page Not Found"]
+    rescue => exception
+      [nil, exception.message]
+    end
+  end
+end

data/lib/abril_heartbeat/config_loader.rb

@@ -0,0 +1,22 @@
+module AbrilHeartbeat
+  class ConfigLoader
+    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
+    end
+
+    def self.load_file
+      return {} unless @file_path
+
+      ::YAML.load_file(@file_path)
+    end
+  end
+end

data/lib/abril_heartbeat/heartbeater.rb

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