rails-healthcheck 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93243a699dc2f935af3516530f2f2ef1e0878a228fb29dc188a99b75d79f1c18
-  data.tar.gz: 876d3d9252ed1fb4c489d3f2227d1a283978a18619f266dfec238d45fe4d486d
+  metadata.gz: 0f365d0578746bf65bd75b360fbf3af46e3cba738a6eb9c9a3e88df133efee7c
+  data.tar.gz: e7c5d26b27e0f939a07e20a70f69dcac975ac9efc1d3ee06ec12d7a81f2f22dc
 SHA512:
-  metadata.gz: 28b69c054262a373359500d270e831a5beaf184253c92283a004cce9b13cf68cc8b70bc9417571dfc91614a43f3e06630856b3ffae4725121b3f9749aeafab3b
-  data.tar.gz: fde9c2623fa346ed3d46ed72b85c9cda0ff2e1106328fe01122e62e800dc3dd619170591b6871a2e66ac1a9425c2a83d5b684f0d72b7af75eb89f06949cc9eb2
+  metadata.gz: 8d1d0412ade72f8d0a06d9ce2160164109e0d21bbe3c7cf13c1798267ecf59746581671602b552d6d023514e70c435c986749b15575844b328e2403f23ab0230
+  data.tar.gz: 400bee85de2479a5ae575a54c085c597fee2b46709c0cfa1066d628d17bf46d511a92563834ae0007613bad885130895555b38ea0d2df2c61e2db8aa4e113d72

data/README.md

@@ -18,7 +18,7 @@ gem 'rails-healthcheck'
 and run:
 
 ```
-rails healthcheck:install
+rails generate healthcheck:install
 ```
 
 ## Settings

data/app/controllers/healthcheck/healthchecks_controller.rb

@@ -23,13 +23,17 @@ module Healthcheck
     end
 
     def success
-      head Healthcheck.success
+      head Healthcheck.configuration.success
     end
 
     def error
-      return head(Healthcheck.error) unless Healthcheck.verbose
+      return head(Healthcheck.configuration.error) unless Healthcheck.configuration.verbose
 
-      render json: { code: Healthcheck.error, errors: checker.errors.as_json }, status: Healthcheck.error
+      render json: {
+        code: Healthcheck.configuration.error,
+        errors: checker.errors.as_json
+      },
+             status: Healthcheck.configuration.error
     end
   end
 end

data/lib/generators/healthcheck/install_generator.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+
+module Healthcheck
+  class InstallGenerator < Rails::Generators::Base
+    def create_initializer_file
+      create_file(
+        'config/initializers/healthcheck.rb',
+        <<~HEALTHCHECK_INITIALIZER_TEXT
+          # frozen_string_literal: true
+
+          Healthcheck.configure do |config|
+            config.success = 200
+            config.error = 503
+            config.verbose = false
+            config.route = '/healthcheck'
+            config.method = :get
+
+            # -- Checks --
+            # config.add_check :database, -> { ActiveRecord::Base.connection.execute('select 1') }
+            # config.add_check :migrations,-> { ActiveRecord::Migration.check_pending! }
+            # config.add_check :cache, -> { Rails.cache.read('some_key') }
+            # config.add_check :environments, -> { Dotenv.require_keys('ENV_NAME', 'ANOTHER_ENV') }
+          end
+        HEALTHCHECK_INITIALIZER_TEXT
+      )
+      route 'Healthcheck.routes(self)'
+    end
+  end
+end

data/lib/healthcheck/checker.rb

@@ -9,7 +9,7 @@ module Healthcheck
     end
 
     def check
-      Healthcheck.checks.map { |c| Thread.new { execute(c) } }.each(&:join)
+      Healthcheck.configuration.checks.map { |c| Thread.new { execute(c) } }.each(&:join)
     end
 
     def errored?

data/lib/healthcheck/router.rb

@@ -3,7 +3,10 @@
 module Healthcheck
   class Router
     def self.mount(router)
-      router.send(Healthcheck.method, Healthcheck.route => 'healthcheck/healthchecks#check')
+      router.send(
+        Healthcheck.configuration.method,
+        Healthcheck.configuration.route => 'healthcheck/healthchecks#check'
+      )
     end
   end
 end

data/lib/healthcheck/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Healthcheck
-  VERSION = '1.0.4'
+  VERSION = '1.0.5'
 end

data/lib/healthcheck.rb

@@ -9,21 +9,17 @@ require 'healthcheck/router'
 require 'healthcheck/engine'
 
 module Healthcheck
-  require 'healthcheck/railtie' if defined?(Rails)
+  module_function
 
-  Configuration::SETTINGS.each do |setting|
-    send(:define_singleton_method, setting, -> { configuration.send(setting) })
-  end
-
-  def self.configure
+  def configure
     yield(configuration)
   end
 
-  def self.configuration
+  def configuration
     @configuration ||= Configuration.new
   end
 
-  def self.routes(router)
+  def routes(router)
     Healthcheck::Router.mount(router)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-healthcheck
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - linqueta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-16 00:00:00.000000000 Z
+date: 2019-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -131,15 +131,14 @@ extra_rdoc_files: []
 files:
 - README.md
 - app/controllers/healthcheck/healthchecks_controller.rb
+- lib/generators/healthcheck/install_generator.rb
 - lib/healthcheck.rb
 - lib/healthcheck/check.rb
 - lib/healthcheck/checker.rb
 - lib/healthcheck/configuration.rb
 - lib/healthcheck/engine.rb
 - lib/healthcheck/error.rb
-- lib/healthcheck/railtie.rb
 - lib/healthcheck/router.rb
-- lib/healthcheck/tasks/setup.rake
 - lib/healthcheck/version.rb
 - lib/rails-healthcheck.rb
 homepage: https://github.com/linqueta/rails-healthcheck

data/lib/healthcheck/railtie.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require 'healthcheck'
-require 'rails'
-
-module Healthcheck
-  class Railtie < Rails::Railtie
-    rake_tasks do
-      Dir[File.join(File.dirname(__FILE__), 'tasks/*.rake')].each { |f| load f }
-    end
-  end
-end

data/lib/healthcheck/tasks/setup.rake

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-require 'fileutils'
-
-INITIALIZER = 'config/initializers/healthcheck.rb'
-OLD_ROUTES = 'config/routes.rb'
-NEW_ROUTES = 'config/routes.rb.new'
-ROUTES_SETUP = '  Healthcheck.routes(self)'
-ROUTES_INIT = 'Rails.application.routes.draw do'
-
-namespace :healthcheck do
-  desc 'Install the files and settings to the gem Healthcheck works'
-  task :install do
-    puts '  -  invoke        Rails::Healthcheck'
-    create_initializer
-    mount_route
-  end
-end
-
-def create_initializer
-  FileUtils.mkdir_p(File.dirname(INITIALIZER))
-  File.open(INITIALIZER, 'w') { |file| file << settings }
-  puts '  -    create      config/initializers/healthcheck.rb'
-end
-
-def mount_route
-  return unless File.exist?(OLD_ROUTES)
-
-  puts '  -    modify      config/routes.rb'
-  File.open(NEW_ROUTES, 'w') do |new_routes|
-    File.foreach(OLD_ROUTES) do |line|
-      new_routes.puts(line)
-      if line.strip == ROUTES_INIT
-        new_routes.puts(ROUTES_SETUP)
-        new_routes.puts ''
-      end
-    end
-  end
-
-  File.delete(OLD_ROUTES)
-  File.rename(NEW_ROUTES, OLD_ROUTES)
-end
-
-def settings
-  <<~SETTINGS
-    # frozen_string_literal: true
-
-    Healthcheck.configure do |config|
-      config.success = 200
-      config.error = 503
-      config.verbose = false
-      config.route = '/healthcheck'
-      config.method = :get
-
-      # -- Checks --
-      # Check if the db is available
-      # config.add_check :database, -> { ActiveRecord::Base.connection.execute('select 1') }
-      # Check if the db is available and without pending migrations
-      # config.add_check :migrations,-> { ActiveRecord::Migration.check_pending! }
-      # Check if the cache is available
-      # config.add_check :cache, -> { Rails.cache.read('some_key') }
-      # Check if the application required envs are defined
-      # config.add_check :environments, -> { Dotenv.require_keys('ENV_NAME', 'ANOTHER_ENV') }
-    end
-  SETTINGS
-end