server_health_check 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 72039c4ebebff1777a10496fdb2ecafa05a754de
+  data.tar.gz: 2c498566a2cc648c8c8378cb3764a4842c75f62d
+SHA512:
+  metadata.gz: 5e3db55aeb1171251a5b722526b0eb5f66c848a2462b9d6dd8de6092dfcb90c90a4e560f55c021819fdcf1b80bd3b5e137a2fbf6cbacce84ba592f65b4b59d88
+  data.tar.gz: 2449cc678f11d91129dfd4da561dca35f39c448a51d9b55dfb92adcfcbb3290063d97032920287a57a55975ee02259d67a0e56297366a003463a4cc99a64b557

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,55 @@
+AllCops:
+  TargetRubyVersion: 2.2
+  Include:
+    - '**/Rakefile'
+
+StringLiterals:
+  Enabled: false
+
+LineLength:
+  Enabled: false
+
+ClassLength:
+  Enabled: false
+
+MethodLength:
+  Enabled: false
+
+AbcSize:
+  Enabled: false
+
+UnusedBlockArgument:
+  Enabled: false
+
+UnusedMethodArgument:
+  Enabled: false
+
+GuardClause:
+  Enabled: false
+
+SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+Lambda:
+  Enabled: false
+
+BlockDelimiters:
+  Enabled: false
+
+ConditionalAssignment:
+  Enabled: false
+
+RedundantBlockCall:
+  Enabled: false
+
+CyclomaticComplexity:
+  Enabled: false
+
+PerceivedComplexity:
+  Enabled: false
+
+RescueModifier:
+  Enabled: false

data/.travis.yml

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,42 @@
+# ServerHealthCheck
+
+This gem provides a standard set of health checks for web services
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'server_health_check'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install server_health_check
+
+## Usage
+
+```ruby
+class SomeController
+  def show
+    health_check = ServerHealthCheck.new
+    health_check.active_record!
+    health_check.redis!(host: 'optional', port: 1234)
+    health_check.aws_creds!
+    health_check.aws_s3!('yakmail-inbound')
+    health_check.check! do
+      # app-specific code that wouldn't belong in the gem
+      # return true or false
+    end
+    http_status = health_check.ok? ? 200 : 500
+    render status: http_status, json: {status: health_check.results}
+  end
+end
+```
+
+## Development
+Run rake to run tests before committing code

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "server_health_check"
+
+# 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/lib/server_health_check/version.rb

@@ -0,0 +1,3 @@
+class ServerHealthCheck
+  VERSION = "0.1.1".freeze
+end

data/lib/server_health_check.rb

@@ -0,0 +1,77 @@
+require "server_health_check/version"
+
+class ServerHealthCheck
+  OK = 'OK'.freeze
+
+  def initialize
+    @results = {}
+  end
+
+  def redis!(host: nil, port: 6379)
+    host ||= ENV['REDIS_HOST'] || 'localhost'
+    @results[:redis] = 'The Redis gem is not loaded'
+    redis = Redis.new(host: host, port: port)
+    begin
+      redis.ping
+      @results[:redis] = OK
+      true
+    rescue Redis::CannotConnectError => e
+      @results[:redis] = e.to_s
+      false
+    end
+  end
+
+  def active_record!
+    if ActiveRecord::Base.connected?
+      @results[:active_record] = OK
+      true
+    else
+      @results[:active_record] = "Failed: unable to connect to database"
+      false
+    end
+  end
+
+  def aws_s3!(bucket = nil)
+    bucket = Aws::S3::Bucket.new(bucket)
+    if bucket.exists?
+      @results[:S3] = OK
+      true
+    else
+      @results[:S3] = "Failed: bucket does not exists"
+      false
+    end
+  end
+
+  def aws_creds!
+    aws = Aws::S3::Client.new
+    begin
+      aws.list_buckets
+      @results[:AWS] = OK
+      true
+    rescue Aws::S3::Errors::InvalidAccessKeyId, Aws::S3::Errors::SignatureDoesNotMatch, NoMethodError => e
+      @results[:AWS] = e.to_s
+      false
+    end
+  end
+
+  def check!
+    success = yield
+    if success
+      @results[:check] = OK
+      true
+    else
+      @results[:check] = "Failed"
+      false
+    end
+    rescue => e
+      @results[:check] = e.to_s
+  end
+
+  def ok?
+    @results.all? do |key, value|
+      value == OK
+    end
+  end
+
+  attr_reader :results
+end

data/server_health_check.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'server_health_check/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "server_health_check"
+  spec.version       = ServerHealthCheck::VERSION
+  spec.authors       = ["Quenten Griffith"]
+  spec.email         = ["qgriffith@on-site.com"]
+
+  spec.summary       = %q{Healthcheck for web apps.}
+  spec.description   = %q{Health check for web apps checking things like active record, redis, and AWS.}
+  spec.homepage      = ""
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: server_health_check
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Quenten Griffith
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Health check for web apps checking things like active record, redis,
+  and AWS.
+email:
+- qgriffith@on-site.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/server_health_check.rb
+- lib/server_health_check/version.rb
+- server_health_check.gemspec
+homepage: ''
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Healthcheck for web apps.
+test_files: []