ring 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fcab09a1f05cbf0146dceaf01263e00664faff5d6c12e95944e4015f7e1e38ff
+  data.tar.gz: 6050b229822b33f9518be0937bf126a2b1b551f268f2acb66a2e153abb024ca2
+SHA512:
+  metadata.gz: e64cb1c418da9fb4bce3150f832b2f128090edff75780be9dc0358e3c0df7796998028c779b4a06c0154466eb6f0701509d3cf9c65cbe75e58cb192086164c74
+  data.tar.gz: f8cd9f89dc97e4115917b5f15221c3f91947b28d9a5f4ca336855e168cb8eba025834282569f80964bb9b3c2a31819b229fe06386f4c25d54c60130a991e890c

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Trae Robrock
+
+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,39 @@
+# Ring
+*R*ails + P*ing* = Ring
+
+This is a simple Rails engine that provides a health check endpoint you can use for load balancer
+health check, external health checks, or anything else.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ring'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install ring
+```
+
+## Usage
+By default this will return a status `:ok`, but you can configure it to exercise other services you
+might have to include those in the health. For example, it might be good to run `User.first` to
+ensure your database connection is healthy. You can do that by creating an initializer with content
+similar to:
+
+```ruby
+Ring.configure do |config|
+  config.add_check :database, -> { User.first }
+end
+```
+
+This will now include the health of the database in the status code and the output of the endpoint.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Ring'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/controllers/ring/application_controller.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Ring
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/ring/ping_controller.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Ring
+  class PingController < ApplicationController
+    def show
+      respond_to do |format|
+        format.html { render plain: hash_to_text(status_content), status: status_code }
+        format.json { render json: status_content, status: status_code }
+      end
+    end
+
+    private
+
+    def hash_to_text(hash)
+      hash.map { |data| data.join(':') }.join("\n")
+    end
+
+    def status_content
+      return @status_content if defined?(@status_content) && @status_content
+
+      @status_content = {
+        status: readable_status_code(status_code)
+      }
+      all_checks.each do |(name, check)|
+        @status_content[name] = readable_status_code(status_code_name(check))
+      end
+      @status_content
+    end
+
+    def status_code
+      @status_code ||= status_code_name(all_checks.all?(&:last))
+    end
+
+    def status_code_name(value)
+      value ? :ok : :service_unavailable
+    end
+
+    def readable_status_code(status_code)
+      status_code.to_s.humanize.upcase
+    end
+
+    def all_checks
+      @all_checks ||= Ring.checks.map { |name, check| [name, check.call] }
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Ring::Engine.routes.draw do
+  root to: 'ping#show'
+end

data/lib/ring.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'ring/engine'
+
+module Ring
+  mattr_reader :checks
+  @@checks = {} # rubocop:disable Style/ClassVars
+
+  def self.configure
+    yield self
+  end
+
+  def self.add_check(name, check)
+    @@checks[name] = check
+  end
+end

data/lib/ring/engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Ring
+  class Engine < ::Rails::Engine
+    isolate_namespace Ring
+  end
+end

data/lib/ring/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Ring
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: ring
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Trae Robrock
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+description: A simple rails engine to provide a health check endpoint.
+email:
+- trobrock@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/ring/application_controller.rb
+- app/controllers/ring/ping_controller.rb
+- config/routes.rb
+- lib/ring.rb
+- lib/ring/engine.rb
+- lib/ring/version.rb
+homepage: https://github.com/trobrock/ring
+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: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A simple rails engine to provide a health check endpoint.
+test_files: []