monitor_page 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8a03ac4d174c4df6f065e924816f97b23006d393
+  data.tar.gz: 8816a43169b12265fa961bb85be2cbd632d7ff92
+SHA512:
+  metadata.gz: 569f38fae88e403df8fd22b143a9fd7e24da4b0cd4c44fb0df411c737a52a291ac5414b9e830244f28c08a90e6153e8378644f90616f72ec403994e9e55fcf40
+  data.tar.gz: d63f6656c654af8c05d7bcf1f36eb356e159150044bac0eed7148a67c7773849e29a8100e7c3b0cb7483dc588a9dae8300f0fc1b1690e82c701e7c249fa5055e

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Chris Gooley
+
+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,63 @@
+# MonitorPage
+A gem to view status checks of multiple services from a single page.
+
+## Usage
+Create an initializer and setup your checks. Each check should have a `pass` and an `error` call.
+
+```ruby
+MonitorPage.configure do
+  permit '1.1.1.1', '1.1.2.2' # optional, will be available everywhere if left out
+
+  check 'Sidekiq' do
+    if Sidekiq::Queue.all.select{ |q| q.size > 50 }.any?
+      error "Sidekiq has too many jobs"
+    else
+      pass
+    end
+  end
+
+  check 'Passing Check' do
+    pass
+  end
+
+  check 'Failing Check' do
+    error "GAME OVER MAN, GAME OVER!"
+  end
+end
+```
+
+In your routes:
+```ruby
+  mount MonitorPage::Engine, at: '/monitor_page'
+```
+
+Visiting `/monitor_page` should give you something like this:
+```
+Sidekiq: Passed
+Passing Check: Passed
+Failing Check: Failed - GAME OVER MAN, GAME OVER!
+-----------
+Overall: Failed
+```
+
+`Overall` will always display `Passed` or `Failed` based on if all the above checks have passed or if there is a failure.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'monitor_page'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install monitor_page
+```
+
+## 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,32 @@
+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    = 'MonitorPage'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+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/assets/config/monitor_page_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/monitor_page .js
+//= link_directory ../stylesheets/monitor_page .css

data/app/controllers/monitor_page/application_controller.rb

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

data/app/controllers/monitor_page/status_controller.rb

@@ -0,0 +1,30 @@
+require_dependency "monitor_page/application_controller"
+
+module MonitorPage
+  class StatusController < ApplicationController
+    layout 'monitor_page/application'
+
+    def index
+      if MonitorPage.allowed_ips && !MonitorPage.allowed_ips.include?(request.remote_ip)
+        render html: 'Forbidden' and return
+      end
+
+      check_results = MonitorPage.checks.map{|c| c.call }
+
+      overall_pass = check_results.inject(true) { |res, check| res && check[:result] }
+
+      results = check_results.map do |r|
+        if r[:result]
+          "#{r[:label]}: Passed"
+        else
+          "#{r[:label]}: Failed - #{r[:message]}"
+        end
+      end
+
+      results << "-----------"
+      results << "Overall: #{overall_pass ? 'Passed' : 'Failed'}"
+
+      render html: results.join("<br/>").html_safe
+    end
+  end
+end

data/app/helpers/monitor_page/application_helper.rb

@@ -0,0 +1,4 @@
+module MonitorPage
+  module ApplicationHelper
+  end
+end

data/app/helpers/monitor_page/status_helper.rb

@@ -0,0 +1,4 @@
+module MonitorPage
+  module StatusHelper
+  end
+end

data/app/jobs/monitor_page/application_job.rb

@@ -0,0 +1,4 @@
+module MonitorPage
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/monitor_page/application_mailer.rb

@@ -0,0 +1,6 @@
+module MonitorPage
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/monitor_page/application_record.rb

@@ -0,0 +1,5 @@
+module MonitorPage
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/layouts/monitor_page/application.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Monitor Page</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,4 @@
+MonitorPage::Engine.routes.draw do
+
+  root to: 'status#index'
+end

data/lib/monitor_page.rb

@@ -0,0 +1,5 @@
+require "monitor_page/engine"
+
+module MonitorPage
+  # Your code goes here...
+end

data/lib/monitor_page/engine.rb

@@ -0,0 +1,52 @@
+require "ipaddr"
+
+module MonitorPage
+  class Engine < ::Rails::Engine
+    isolate_namespace MonitorPage
+  end
+
+  class << self
+    attr_accessor :checks, :allowed_ips
+
+    def checks
+      @checks || []
+    end
+
+    def configure &block
+      instance_eval(&block)
+    end
+
+    def check(label, &block)
+      self.checks += [Proc.new { StatusCheck.create_check(label, &block) }]
+    end
+
+    def permit(ips)
+      ip_ranges = ips.is_a?(String) ? ips.split(/,\s?/) : ips
+      self.allowed_ips
+    end
+  end
+
+  class StatusCheck
+    attr_accessor :label
+
+    def initialize(label)
+      @label = label
+    end
+
+    def self.create_check(label, &block)
+      new(label).create_check(&block)
+    end
+
+    def create_check(&block)
+      instance_eval(&block)
+    end
+
+    def pass
+      return { label: label, result: true }
+    end
+
+    def error(message)
+      return { label: label, result: false, message: message }
+    end
+  end
+end

data/lib/monitor_page/version.rb

@@ -0,0 +1,3 @@
+module MonitorPage
+  VERSION = '0.1.1'
+end

data/lib/tasks/monitor_page_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :monitor_page do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: monitor_page
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Chris Gooley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- chris@gooddogdesign.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/monitor_page_manifest.js
+- app/controllers/monitor_page/application_controller.rb
+- app/controllers/monitor_page/status_controller.rb
+- app/helpers/monitor_page/application_helper.rb
+- app/helpers/monitor_page/status_helper.rb
+- app/jobs/monitor_page/application_job.rb
+- app/mailers/monitor_page/application_mailer.rb
+- app/models/monitor_page/application_record.rb
+- app/views/layouts/monitor_page/application.html.erb
+- config/routes.rb
+- lib/monitor_page.rb
+- lib/monitor_page/engine.rb
+- lib/monitor_page/version.rb
+- lib/tasks/monitor_page_tasks.rake
+homepage: ''
+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.6.12
+signing_key: 
+specification_version: 4
+summary: A gem to view status checks of multiple services from a single page.
+test_files: []