server_health_check-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 462bcb33ddff0e63b2fdd82b38cb734578ca4ee0
+  data.tar.gz: 4756e7c64b8553709ae490e4db8c8af9b49f1520
+SHA512:
+  metadata.gz: 517e853cf964201158a34b1a855cd385c18946f0edc5b590b4d14e656cb9183b1eeb7b45269744cf9c12d8d15347b04c9421ab355c343d46c609fac2a7d3b096
+  data.tar.gz: 79768519e033f82d43b741b801c7120cbb849f5a257bd64f9b293951e526ccc25dbeb8931a3708e4bebc19a506651cd4bd69d6fc1e4e2be8447a8ea578a2a96d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.13.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mjstone@on-site.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Mike Virata-Stone
+
+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,101 @@
+# server_health_check-rails
+
+This gem provides a rails engine that automatically hooks in with the
+[server_health_check gem](https://github.com/on-site/server_health_check). It
+will add a /health and /health/:id endpoint which will return a JSON string of
+the results of either all configured health checks, or just the one provided.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "server_health_check-rails"
+```
+
+And then execute:
+
+    $ bundle
+
+Then configure your checks with the gem using the built in `server_health_check`
+checks, or your own custom checks:
+
+```ruby
+# config/initializers/health_checks.rb
+ServerHealthCheckRails.check_active_record!
+ServerHealthCheckRails.check_redis!(host: "someredis.host", port: 1234)
+ServerHealthCheckRails.check_aws_s3!("aws-bucket-to-check")
+ServerHealthCheckRails.check_aws_creds!
+ServerHealthCheckRails.check "custom_check" do
+  # Do some work here, then return true if it succeeded for false if not
+  # (exceptions will be caught by the server_health_check gem and the message
+  # will be reported as the status).
+  true
+end
+```
+
+And mount the engine in your routes file:
+
+```ruby
+# config/routes.rb
+Rails.application.routes.draw do
+  mount ServerHealthCheckRails::Engine, at: "/"
+  # Your routes here
+end
+```
+
+## Usage
+
+You can now use your health checks in some automated service to monitor your app
+with your custom checks.
+
+You may use the endpoint for all checks at `/health`, which might result in
+something like the following, though without the formatting:
+
+```json
+{
+    "status": {
+        "active_record": "OK",
+        "redis": "OK",
+        "aws_s3": "Failed",
+        "aws_creds": "OK",
+        "custom_check": "OK"
+    }
+}
+```
+
+If you want to just check a single check, you can just use that in the url like
+`/health/custom_check`:
+
+```json
+{
+    "status": {
+        "custom_check": "OK"
+    }
+}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake test` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/on-site/server_health_check-rails. This project is intended
+to be a safe, welcoming space for collaboration, and contributors are expected
+to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of
+conduct.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/app/controllers/server_health_check_rails/application_controller.rb

@@ -0,0 +1,5 @@
+module ServerHealthCheckRails
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/server_health_check_rails/health_controller.rb

@@ -0,0 +1,13 @@
+module ServerHealthCheckRails
+  class HealthController < ServerHealthCheckRails::ApplicationController
+    def index
+      check = ServerHealthCheckRails::HealthCheck.all
+      render status: check.http_status, json: check.to_h
+    end
+
+    def show
+      check = ServerHealthCheckRails::HealthCheck.new(params[:id])
+      render status: check.http_status, json: check.to_h
+    end
+  end
+end

data/app/models/server_health_check_rails/health_check.rb

@@ -0,0 +1,26 @@
+module ServerHealthCheckRails
+  class HealthCheck
+    def initialize(*checks)
+      @check = ServerHealthCheck.new
+      ServerHealthCheckRails.apply_checks(@check, checks)
+    end
+
+    def self.all
+      new(*ServerHealthCheckRails.all_checks)
+    end
+
+    def http_status
+      if @check.ok?
+        200
+      else
+        500
+      end
+    end
+
+    def to_h
+      {
+        status: @check.results
+      }
+    end
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "server_health_check/rails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/routes.rb

@@ -0,0 +1,3 @@
+ServerHealthCheckRails::Engine.routes.draw do
+  resources :health, only: [:index, :show]
+end

data/lib/server_health_check-rails.rb

@@ -0,0 +1 @@
+require "server_health_check_rails"

data/lib/server_health_check/rails.rb

@@ -0,0 +1 @@
+require "server_health_check_rails"

data/lib/server_health_check_rails.rb

@@ -0,0 +1,60 @@
+require "server_health_check"
+require "server_health_check_rails/version"
+require "server_health_check_rails/engine"
+require "set"
+
+module ServerHealthCheckRails
+  class << self
+    def all_checks
+      raise ArgumentError, "Please configure server_health_check-rails!" if @checks.nil?
+      @checks.keys
+    end
+
+    def apply_checks(server_health_check, checks)
+      raise ArgumentError, "Please configure server_health_check-rails!" if @checks.nil?
+      checks = Set.new(checks)
+
+      @checks.each do |name, check|
+        next unless checks.include?(name)
+        check.call(server_health_check)
+      end
+    end
+
+    def check(name, &block)
+      add_check name do |server_health_check|
+        server_health_check.check!(name, &block)
+      end
+    end
+
+    def check_active_record!
+      add_check "active_record" do |server_health_check|
+        server_health_check.active_record!
+      end
+    end
+
+    def check_redis!(host: nil, port: 6379)
+      add_check "redis" do |server_health_check|
+        server_health_check.redis! host: nil, port: 6379
+      end
+    end
+
+    def check_aws_s3!(bucket = nil)
+      add_check "aws_s3" do |server_health_check|
+        server_health_check.aws_s3! bucket
+      end
+    end
+
+    def check_aws_creds!
+      add_check "aws_creds" do |server_health_check|
+        server_health_check.aws_creds!
+      end
+    end
+
+    private
+
+    def add_check(name, &block)
+      @checks ||= {}
+      @checks[name] = block
+    end
+  end
+end

data/lib/server_health_check_rails/engine.rb

@@ -0,0 +1,5 @@
+module ServerHealthCheckRails
+  class Engine < ::Rails::Engine
+    isolate_namespace ServerHealthCheckRails
+  end
+end

data/lib/server_health_check_rails/version.rb

@@ -0,0 +1,3 @@
+module ServerHealthCheckRails
+  VERSION = "0.1.0"
+end

data/server_health_check-rails.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'server_health_check_rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "server_health_check-rails"
+  spec.version       = ServerHealthCheckRails::VERSION
+  spec.authors       = ["Mike Virata-Stone"]
+  spec.email         = ["mjstone@on-site.com"]
+
+  spec.summary       = %q{Healthcheck for Rails apps.}
+  spec.description   = %q{Health check for Rails apps checking things like active record, redis, and AWS.}
+  spec.homepage      = "https://github.com/on-site/server_health_check-rails"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rails", ">= 3.0", "< 6.0"
+  spec.add_runtime_dependency "server_health_check", "~> 1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: server_health_check-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mike Virata-Stone
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: server_health_check
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Health check for Rails apps checking things like active record, redis,
+  and AWS.
+email:
+- mjstone@on-site.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/controllers/server_health_check_rails/application_controller.rb
+- app/controllers/server_health_check_rails/health_controller.rb
+- app/models/server_health_check_rails/health_check.rb
+- bin/console
+- bin/setup
+- config/routes.rb
+- lib/server_health_check-rails.rb
+- lib/server_health_check/rails.rb
+- lib/server_health_check_rails.rb
+- lib/server_health_check_rails/engine.rb
+- lib/server_health_check_rails/version.rb
+- server_health_check-rails.gemspec
+homepage: https://github.com/on-site/server_health_check-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Healthcheck for Rails apps.
+test_files: []