rack-ecg 0.0.5 → 0.1.0

data/lib/rack/ecg/check.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "rack/ecg/check_registry"
 require "rack/ecg/check/error"
 require "rack/ecg/check/git_revision"
@@ -10,14 +11,33 @@ require "rack/ecg/check/sequel_connection"
 module Rack
   class ECG
     module Check
+      # Possible recognised check statuses.
       module Status
-        OK = "ok".freeze
-        ERROR = "error".freeze
+        # Indicates the check was successful.
+        OK = "ok"
+        # Indicates the check errored.
+        ERROR = "error"
       end
 
       class Result < Struct.new(:name, :status, :value)
+        # Format the result as a JSON compatible hash.
+        #
+        # @return [Hash<Object, Hash<Symbol, Object>>] Result in a hash format.
+        # @example A HTTP success response
+        #   puts result.as_json
+        #   # {:http=>{:status=>"ok", :value=>"online"}}
+        def as_json
+          { name => { status: status, value: value } }
+        end
+
+        # Return the result as a JSON object.
+        #
+        # @return [String] Result in a JSON object string.
+        # @example A HTTP success response
+        #   puts result.to_json
+        #   # {"http": {"status": "ok", "value": "online"}}
         def to_json
-          {name => {:status => status, :value => value}}
+          JSON.dump(as_json)
         end
       end
     end

data/lib/rack/ecg/check/active_record_connection.rb

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
 module Rack
   class ECG
     module Check
+      # @!method initialize
+      #   Checks whether ActiveRecord is currently connected to the default
+      #   database.
       class ActiveRecordConnection
         def result
           value = ""

data/lib/rack/ecg/check/error.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
 module Rack
   class ECG
     module Check
-      # if rack-ecg is serving a request - http is obviously working so far...
-      # this is basically a "hello-world"
+      # @!method initialize
+      #   Always returns a basic error for testing purposes.
       class Error
         def result
           Result.new(:error, Status::ERROR, "PC LOAD LETTER")
@@ -10,7 +11,6 @@ module Rack
       end
 
       CheckRegistry.instance.register(:error, Error)
-
     end
   end
 end

data/lib/rack/ecg/check/git_revision.rb

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
 module Rack
   class ECG
     module Check
+      # @!method initialize
+      #   Returns the SHA1 of the current commit, as reported by the git
+      #   executable.
       class GitRevision
         def result
           _stdin, stdout, stderr, wait_thread = Open3.popen3("git rev-parse HEAD")
@@ -17,7 +21,6 @@ module Rack
       end
 
       CheckRegistry.instance.register(:git_revision, GitRevision)
-
     end
   end
 end

data/lib/rack/ecg/check/http.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
 module Rack
   class ECG
     module Check
-      # if rack-ecg is serving a request - http is obviously working so far...
-      # this is basically a "hello-world"
+      # @!method initialize
+      #   Always returns a success.
       class Http
         def result
           Result.new(:http, Status::OK, "online")
@@ -10,7 +11,6 @@ module Rack
       end
 
       CheckRegistry.instance.register(:http, Http)
-
     end
   end
 end

data/lib/rack/ecg/check/migration_version.rb

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
 module Rack
   class ECG
     module Check
+      # @!method initialize
+      #   Returns the latest applied ActiveRecord migration in the default
+      #   database.
       class MigrationVersion
         def result
           value = ""
@@ -23,7 +27,6 @@ module Rack
       end
 
       CheckRegistry.instance.register(:migration_version, MigrationVersion)
-
     end
   end
 end

data/lib/rack/ecg/check/redis_connection.rb

@@ -1,6 +1,12 @@
+# frozen_string_literal: true
 module Rack
   class ECG
     module Check
+      # @!method initialize
+      #   Checks whether the global Redis client is currently connected to the
+      #   database.
+      #
+      #   Does not take any options.
       class RedisConnection
         def result
           value = ""

data/lib/rack/ecg/check/sequel_connection.rb

@@ -1,8 +1,15 @@
+# frozen_string_literal: true
 module Rack
   class ECG
     module Check
       class SequelConnection
         attr_reader :connection_parameters, :name
+
+        # Checks whether Sequel can connect to the database identified by the
+        # ++connection++ option.
+        #
+        # @option parameters connection [String,Hash] Sequel connection parameters to check
+        # @option parameters name [String,nil] Name to distinguish multiple Sequel checks
         def initialize(parameters = {})
           @connection_parameters = parameters[:connection]
           @name = parameters[:name]
@@ -16,10 +23,10 @@ module Rack
               status = Status::ERROR
               value = "Sequel Connection parameters not found"
             elsif defined?(::Sequel)
-              ::Sequel.connect(connection_parameters) { |db|
+              ::Sequel.connect(connection_parameters) do |db|
                 value = db.test_connection
                 status = Status::OK
-              }
+              end
             else
               status = Status::ERROR
               value = "Sequel not found"

data/lib/rack/ecg/check_factory.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "rack/ecg/check"
 
 module Rack

data/lib/rack/ecg/check_registry.rb

@@ -1,27 +1,40 @@
+# 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
 
-      def initialize()
+      # 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.new("Check '#{name}' is not registered") }
+        @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

data/lib/rack/ecg/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
 module Rack
   class ECG
-    VERSION = "0.0.5"
+    # 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.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Envato
 - Julian Doherty
-autorequire: 
-bindir: bin
+autorequire:
+bindir: exe
 cert_chain: []
-date: 2017-05-12 00:00:00.000000000 Z
+date: 2020-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -26,98 +26,147 @@ 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
-- gemfiles/rack_v1.gemfile
 - lib/rack-ecg.rb
 - lib/rack/ecg.rb
 - lib/rack/ecg/check.rb
@@ -132,15 +181,14 @@ files:
 - lib/rack/ecg/check_registry.rb
 - lib/rack/ecg/version.rb
 - rack-ecg.gemspec
-- spec/check_factory_spec.rb
-- spec/check_registry_spec.rb
-- 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
@@ -148,20 +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.6.10
-signing_key: 
+rubygems_version: 3.2.2
+signing_key:
 specification_version: 4
 summary: Rack middleware serving a health check page
-test_files:
-- spec/check_factory_spec.rb
-- spec/check_registry_spec.rb
-- spec/rack_middleware_spec.rb
-- spec/spec_helper.rb
+test_files: []