rack-ecg 0.0.1 → 0.1.0

data/lib/rack/ecg/check_registry.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+require "singleton"
+
+module Rack
+  class ECG
+    class CheckRegistry
+      # Raised when a check didn't exist during lookup
+      CheckNotRegistered = Class.new(StandardError)
+      include Singleton
+
+      # Constructs the singleton instance of the registry
+      def initialize
+        @registry = {}
+      end
+
+      # Register a check class by name
+      #
+      # @param [Symbol] name Desired check name
+      # @param [Class] check_class Class implementing check functionality
+      def register(name, check_class)
+        @registry[name] = check_class
+      end
+
+      # Fetches the registered check class by name
+      #
+      # @param [Symbol] name Registered check name
+      # @raise [CheckNotRegistered] if the named check has not been registered
+      def lookup(name)
+        @registry.fetch(name) { raise CheckNotRegistered, "Check '#{name}' is not registered" }
+      end
+
+      # (see #lookup)
+      def self.lookup(name)
+        instance.lookup(name)
+      end
+
+      # (see #register)
+      def self.register(name, check_class)
+        instance.register(name, check_class)
+      end
+    end
+  end
+end

data/lib/rack/ecg/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
 module Rack
   class ECG
-    VERSION = "0.0.1"
+    # Library version.
+    VERSION = "0.1.0"
   end
 end

data/rack-ecg.gemspec

@@ -1,28 +1,45 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'rack/ecg/version'
+# frozen_string_literal: true
+
+require_relative "lib/rack/ecg/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "rack-ecg"
   spec.version       = Rack::ECG::VERSION
   spec.authors       = ["Envato", "Julian Doherty"]
   spec.email         = ["julian@envato.com"]
-  spec.summary       = %q{Rack middleware serving a health check page}
-  spec.description   = %q{rack-ecg allows you to serve a page that shows you facts about your deployed app to allow you to check that everything is running as it should: git revision, database migrations, and more}
+  spec.summary       = 'Rack middleware serving a health check page'
+  spec.description   = <<-EOF
+    rack-ecg allows you to serve a page that shows you facts about your deployed
+    app to allow you to check that everything is running as it should: git
+    revision, database migrations, and more
+  EOF
   spec.homepage      = "https://github.com/envato/rack-ecg"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/envato/rack-ecg/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "rack"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  spec.add_runtime_dependency("rack")
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.2.0"
-  spec.add_development_dependency "rack-test", "~> 0.6.3"
-  spec.add_development_dependency "pry", "~> 0.10.1"
+  spec.add_development_dependency("rake", "~> 13.0")
+  spec.add_development_dependency("bundler", "~> 2.2.1")
+  spec.add_development_dependency("rspec", "~> 3.10.0")
+  spec.add_development_dependency("rack-test", "~> 1.1.0")
+  spec.add_development_dependency("pry", "~> 0.13.0")
+  spec.add_development_dependency("rubocop-shopify", "~> 1.0.0")
+  spec.add_development_dependency("yard", "~> 0.9.24")
+  spec.add_development_dependency("redcarpet", "~> 3.5.0")
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rack-ecg
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Envato
 - Julian Doherty
-autorequire: 
-bindir: bin
+autorequire:
+bindir: exe
 cert_chain: []
-date: 2015-04-09 00:00:00.000000000 Z
+date: 2020-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -26,106 +26,169 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 2.2.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 2.2.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.10.0
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.3
+        version: 1.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.3
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.1
+        version: 0.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-shopify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.24
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.1
-description: 'rack-ecg allows you to serve a page that shows you facts about your
-  deployed app to allow you to check that everything is running as it should: git
-  revision, database migrations, and more'
+        version: 0.9.24
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+description: |2
+      rack-ecg allows you to serve a page that shows you facts about your deployed
+      app to allow you to check that everything is running as it should: git
+      revision, database migrations, and more
 email:
 - julian@envato.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".yardopts"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
+- bin/setup
 - examples/basic.ru
 - examples/checks.ru
+- examples/hook.ru
 - examples/mounted_path.ru
+- examples/parameters.ru
+- examples/stand_alone.ru
 - lib/rack-ecg.rb
 - lib/rack/ecg.rb
+- lib/rack/ecg/check.rb
+- lib/rack/ecg/check/active_record_connection.rb
+- lib/rack/ecg/check/error.rb
+- lib/rack/ecg/check/git_revision.rb
+- lib/rack/ecg/check/http.rb
+- lib/rack/ecg/check/migration_version.rb
+- lib/rack/ecg/check/redis_connection.rb
+- lib/rack/ecg/check/sequel_connection.rb
+- lib/rack/ecg/check_factory.rb
+- lib/rack/ecg/check_registry.rb
 - lib/rack/ecg/version.rb
 - rack-ecg.gemspec
-- spec/rack_middleware_spec.rb
-- spec/spec_helper.rb
 homepage: https://github.com/envato/rack-ecg
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/envato/rack-ecg
+  source_code_uri: https://github.com/envato/rack-ecg
+  changelog_uri: https://github.com/envato/rack-ecg/blob/main/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -133,18 +196,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
-signing_key: 
+rubygems_version: 3.2.2
+signing_key:
 specification_version: 4
 summary: Rack middleware serving a health check page
-test_files:
-- spec/rack_middleware_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/.travis.yml

@@ -1,15 +0,0 @@
-language: ruby
-rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.5
-  - 2.2.1
-  - ruby-head
-  - jruby
-notifications:
-  webhooks:
-    urls:
-      - https://webhooks.gitter.im/e/b627d6a74f88be59d0b9
-    on_success: change  # options: [always|never|change] default: always
-    on_failure: always  # options: [always|never|change] default: always
-    on_start: false     # default: false - rbx-2

data/spec/rack_middleware_spec.rb

@@ -1,146 +0,0 @@
-require "open3"
-require "stringio"
-
-RSpec.describe "when used as middleware" do
-  let(:app) {
-    opts = options
-    Rack::Builder.new do
-      use Rack::ECG, opts
-      run lambda {|env|
-        if env["PATH_INFO"] == "/hello/world"
-          [200, {}, ["Hello, World"]]
-        else
-          [404, {}, ["Goodbye, World"]]
-        end
-      }
-    end
-  }
-  let(:options) {
-    {} # empty default
-  }
-
-  context "main app" do
-    it "responds OK for normal requests" do
-      get "/hello/world"
-      expect(last_response).to be_ok
-    end
-
-    it "doesn't include an X-Rack-ECG-Version custom header" do
-      get "/hello/world"
-      expect(last_response.header["X-Rack-ECG-Version"]).to be_nil
-    end
-  end
-
-  context "ecg app" do
-    it "responds " do
-      get "/_ecg"
-      expect(last_response).to be_ok
-    end
-
-    it "includes an X-Rack-ECG-Version custom header" do
-      get "/_ecg"
-      expect(last_response.header["X-Rack-ECG-Version"]).to eq(Rack::ECG::VERSION)
-    end
-
-    context "when `at` config option is set" do
-      let(:options) {
-        {at: "/health_check"}
-      }
-
-      it "responds from that path" do
-        get "/health_check"
-        expect(last_response.header["X-Rack-ECG-Version"]).to eq(Rack::ECG::VERSION)
-      end
-    end
-
-    context "when all checks pass" do
-      it "has a success error code" do
-        get "_ecg"
-        expect(last_response.status).to eq(200)
-      end
-    end
-
-    context "when a checks errors" do
-      let(:options) {
-        { checks: [:error] }
-      }
-      it "has a success error code" do
-        get "_ecg"
-        expect(last_response.status).to eq(500)
-      end
-    end
-
-    context "git revision" do
-      let(:options) {
-        { checks: [:git_revision] }
-      }
-      context "when available" do
-        let(:sha) { "cafe1234" }
-        it "is reported" do
-          expect(Open3).to receive(:popen3).
-            with("git rev-parse HEAD").
-            and_return([
-              nil,                                                    # stdin
-              StringIO.new(sha + "\n"),                               # stdout
-              StringIO.new(),                                         # stderr
-              double(value: double(Process::Status, success?: true))  # wait thread & process status
-            ])
-          get "/_ecg"
-          expect(json_body["git_revision"]["status"]).to eq("ok")
-          expect(json_body["git_revision"]["value"]).to eq(sha)
-        end
-      end
-
-      context "when not available" do
-        let(:error_message) { "git had a sad" }
-        it "is reported" do
-          expect(Open3).to receive(:popen3).
-            with("git rev-parse HEAD").
-            and_return([
-              nil,                                                    # stdin
-              StringIO.new(),                                         # stdout
-              StringIO.new(error_message + "\n"),                     # stderr
-              double(value: double(Process::Status, success?: false)) # wait thread & process status
-            ])
-          get "/_ecg"
-          expect(json_body["git_revision"]["status"]).to eq("error")
-          expect(json_body["git_revision"]["value"]).to eq("git had a sad")
-        end
-      end
-    end
-
-    context "migration version" do
-      let(:options) {
-        { checks: [:migration_version] }
-      }
-      context "when availabile" do
-        it "is reported" do
-          class ActiveRecord
-            class Base
-              def self.connection
-              end
-            end
-          end
-          version = "123456"
-          connection = double("connection")
-          expect(ActiveRecord::Base).to receive(:connection).and_return(connection)
-          expect(connection).to receive(:execute).
-            with("select max(version) as version from schema_migrations").
-            and_return([{"version" => version}])
-          get "/_ecg"
-          expect(json_body["migration_version"]["status"]).to eq("ok")
-          expect(json_body["migration_version"]["value"]).to eq(version)
-        end
-      end
-
-      context "when not available" do
-        it "is reported" do
-          Object.send(:remove_const, :ActiveRecord) if defined?(ActiveRecord)
-          get "/_ecg"
-          expect(json_body["migration_version"]["status"]).to eq("error")
-          expect(json_body["migration_version"]["value"]).to eq("ActiveRecord not found")
-        end
-      end
-    end
-  end
-end