status_check 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c5fae0e31034a83166c28383985871b7a80a8b5c
+  data.tar.gz: 1136aaf1178203c4424d50ed088c87c583b8d7cf
+SHA512:
+  metadata.gz: e8c89609ac382f589813c909f4b331fafc506e06cc1f436144def2639a28d7823aaa5deb767679e52e7d7e99a91d217dae34f236074a860f17a4237118919b99
+  data.tar.gz: 62538db62476991699d8a977ab92c99cf7f600fcd5fed76fdd77a08af00941c5f203255126dbcc12dba9bd1323dc75d2483385f75dfbbbbaff934d70d406548d

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea/
+.rspec
+
+# rspec failure tracking
+.rspec_status
+.idea/workspace.xml

data/.travis.yml

@@ -0,0 +1,15 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+install:
+  - bin/setup
+script:
+  - bundle exec rspec
+  - gem build status_check
+deploy:
+  provider: rubygems
+  api_key: "$RUBY_GEMS_API_KEY"
+  on:
+    branch: master
+    tags: true

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 vasilij@melnychuk.me. 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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in status_check.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    status_check (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  status_check!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Matic Insurance
+
+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,118 @@
+# StatusCheck
+
+[![Build Status](https://travis-ci.org/matic-insurance/status_check.svg?branch=master)](https://travis-ci.org/matic-insurance/status_check)
+
+Gem allows easy implementation of a status endpoint in your project. 
+It provides boilerplate code for commonly used components (Database, Redis, etc) 
+and allow usage of your custom status check. 
+
+As a result, the gem can produce hash with a status of every component or be embedded into the routes 
+for an automatic status endpoint. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'status_check'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install status_check
+
+## Quick Usage
+
+To use `status_check` you have to do 2 things:
+
+First - create initializer, where you can define what services you want to be checked.
+Example:
+```ruby
+StatusCheck.configure do |c|
+  c.check(:my_service, service: StatusCheck::Services::BlockResult, connection: ->{ MyService.is_working? })
+  c.check(:database, service: StatusCheck::Services::ActiveRecordSql, connection: ->{ ActiveRecord::Base.connection })
+  c.check(:redis, service: StatusCheck::Services::ActiveRecordSql, connection: ->{ Redis.new(url: ENV['REDIS_URL']) })
+end
+```
+
+Second - define the route in your `routes.rb` file
+```ruby
+Rails.application.routes.draw do
+  ...
+
+  match 'stats', to: StatusCheck::Router, via: :get
+
+  ...
+end
+```
+
+## Custom usage
+
+You can use status check without routing. In any place of application call:
+```ruby
+success, report = StatusCheck.verify
+puts success # true
+puts report # [{service: 'database', success: true, status: 'OK'}, {service: 'redis', success: true, status: 'OK'}] 
+```
+
+Status check return tuple where first value is boolean (is all services checks are worked) and array of 
+(details for each service)
+
+## Builtin checks
+
+#### ActiveRecordSql
+
+Check connection to sql database configured via ActiveRecord
+
+**class:** `StatusCheck::Services::ActiveRecordSql`
+**connection:** block that returns instance of activerecord db connection. `->{ ActiveRecord::Base.connection }`
+**verification:** verifies if applicaiton can read from database by executing `SELECT 1;`.    
+
+#### Redis
+
+Checks connection to redis
+
+**class:** `StatusCheck::Services::Redis`
+**connection:** block that returns instance of redis. `->{ Redis.new(url: 'redis://redis.com') }`
+**verification:** verifies if application can read from redis by executing `GET 1`.     
+
+#### BlockResult
+
+Checks if connection block returns true or false
+
+**class:** `StatusCheck::Services::BlockResult`
+**connection:** block that returns true or false depending on status. `->{ MyService.is_working? }`
+**verification:** verifies if block returns true or false.   
+
+## Custom checks
+
+There are two ways how you can implement your custom verifications. 
+
+- Implement custom service see `StatusCheck::Services::Abstract`
+- Use BlockResult service and implement verification inside of connection block
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/matic-insurance/status_check. 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.
+
+## Code of Conduct
+
+Everyone interacting in the StatusCheck project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/matic-insurance/status_check/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+[MIT](LICENSE) 
+ 
+## Author Information
+
+Made with love in Matic

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 "status_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(__FILE__)

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/status_check/configuration.rb

@@ -0,0 +1,30 @@
+module StatusCheck
+  class Configuration
+    attr_accessor :checks
+
+    AVAILABLE_SERVICES = %I{postgresql redis}
+
+    def initialize
+      @checks = {}
+    end
+
+    def check(service_name, service:, connection:)
+      service = setup_service(service, connection)
+      validate_service(service)
+      @checks[service_name] = service
+    end
+
+    private
+    def setup_service(service_class, connection)
+      service_class.new(connection)
+    rescue => ex
+      raise Errors::NotValidParams, "Service #{service_class} cannot be instantiated with connection: #{ex.message}"
+    end
+
+    def validate_service(service)
+      unless service.respond_to?(:report_status)
+        raise Errors::NotValidParams, "Service #{service.class} should respond to report_status"
+      end
+    end
+  end
+end

data/lib/status_check/errors.rb

@@ -0,0 +1,6 @@
+module StatusCheck
+  module Errors
+    class NotValidParams < StandardError; end
+    class MissingParams < StandardError; end
+  end
+end

data/lib/status_check/router.rb

@@ -0,0 +1,11 @@
+module StatusCheck
+  module Router
+    module_function
+
+    def call(hash)
+      result, report = ::StatusCheck.verify
+      status = result ? 200 : 503
+      [status, {}, [JSON.dump(report)]]
+    end
+  end
+end

data/lib/status_check/runner.rb

@@ -0,0 +1,33 @@
+module StatusCheck
+  class Runner
+    attr_reader :checks
+
+    def initialize(checks)
+      @checks = checks
+    end
+
+    def verify
+      services_status = collect_services_status
+      report_status(services_status)
+    end
+
+    private
+    def report_status(services_status)
+      overall = services_status.all? { |service| service[:success] }
+      [overall, services_status]
+    end
+
+    def collect_services_status
+      checks.each_pair.map do |name, service|
+        verify_service(name, service)
+      end
+    end
+
+    def verify_service(name, service)
+      success, status = service.report_status
+      {service: name, success: success, status: status}
+    rescue => ex
+      {service: name, success: false, status: ex.to_s}
+    end
+  end
+end

data/lib/status_check/services/abstract.rb

@@ -0,0 +1,34 @@
+module StatusCheck
+  module Services
+    class Abstract
+      attr_reader :connection
+
+      def initialize(connection)
+        @connection = connection
+      end
+
+      def command
+        raise NotImplementedError, "Check command have to be defined"
+      end
+
+      def status_message(command_result, exception = nil)
+        return exception.to_s if !command_result && exception
+        return 'FAILED' if !command_result
+        'OK'
+      end
+
+      def report_status
+        command_result = command
+        status_hash(command_result)
+      rescue StandardError => exception
+        status_hash(command_result, exception)
+      end
+
+      private
+
+      def status_hash(command_result, exception = nil)
+        [!!command_result, status_message(command_result, exception)]
+      end
+    end
+  end
+end

data/lib/status_check/services/active_record_sql.rb

@@ -0,0 +1,10 @@
+module StatusCheck
+  module Services
+    class ActiveRecordSql < Abstract
+      def command
+        connection.call.execute("SELECT 1;")
+        true
+      end
+    end
+  end
+end

data/lib/status_check/services/block_result.rb

@@ -0,0 +1,11 @@
+require_relative 'abstract'
+
+module StatusCheck
+  module Services
+    class BlockResult < Abstract
+      def command
+        !!connection.call
+      end
+    end
+  end
+end

data/lib/status_check/services/redis.rb

@@ -0,0 +1,10 @@
+module StatusCheck
+  module Services
+    class Redis < Abstract
+      def command
+        connection.call.get("1")
+        true
+      end
+    end
+  end
+end

data/lib/status_check/version.rb

@@ -0,0 +1,3 @@
+module StatusCheck
+  VERSION = "0.1.1"
+end

data/lib/status_check.rb

@@ -0,0 +1,25 @@
+require "status_check/version"
+require "status_check/errors"
+Dir[File.dirname(__FILE__) + '/status_check/services/*.rb'].each { |file| require file }
+require "status_check/configuration"
+require "status_check/router"
+require "status_check/runner"
+require 'json'
+
+module StatusCheck
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.verify
+    Runner.new(configuration.checks).verify
+  end
+end

data/status_check.gemspec

@@ -0,0 +1,42 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "status_check/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "status_check"
+  spec.version = StatusCheck::VERSION
+  spec.authors = ["Vasyl Melnychuk", "Volodymyr Mykhailyk"]
+  spec.email = ["vasyl.m@matic.com"]
+  spec.licenses = ['MIT']
+
+  spec.summary = %q{Status endpoint code to verify components availability of your application}
+  spec.description = %q{
+                          Gem allows easy implementation of a status endpoint in your project.
+                          It provides boilerplate code for commonly used components (Database, Redis, etc)
+                          and allow usage of your custom status check.
+
+                          As a result, the gem can produce hash with a status of every component or be embedded into the routes
+                          for an automatic status endpoint.
+                       }
+  spec.homepage = "https://github.com/matic-insurance/status_check"
+
+  # 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 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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: status_check
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Vasyl Melnychuk
+- Volodymyr Mykhailyk
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: "\n                          Gem allows easy implementation of a status
+  endpoint in your project.\n                          It provides boilerplate code
+  for commonly used components (Database, Redis, etc)\n                          and
+  allow usage of your custom status check.\n\n                          As a result,
+  the gem can produce hash with a status of every component or be embedded into the
+  routes\n                          for an automatic status endpoint.\n                       "
+email:
+- vasyl.m@matic.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/status_check.rb
+- lib/status_check/configuration.rb
+- lib/status_check/errors.rb
+- lib/status_check/router.rb
+- lib/status_check/runner.rb
+- lib/status_check/services/abstract.rb
+- lib/status_check/services/active_record_sql.rb
+- lib/status_check/services/block_result.rb
+- lib/status_check/services/redis.rb
+- lib/status_check/version.rb
+- status_check.gemspec
+homepage: https://github.com/matic-insurance/status_check
+licenses:
+- MIT
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Status endpoint code to verify components availability of your application
+test_files: []