healthier 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3d31d17199c50606705f54e8711cce324edaa9a2e8e56a557d73529d976ef83
-  data.tar.gz: d63895420862e07ca45402790400cbfea4c96628827f8b157506491d14b06823
+  metadata.gz: 9b9085660c0bf98cddf325db77e9d7f7a655c34e4af17e0febcc2d0468d42a10
+  data.tar.gz: b4cbbda7e758b1375c07d3ff98efa31ac85a52a9ede9c67dd2a06a95c75f9103
 SHA512:
-  metadata.gz: 9a5b5e7f4a60fdf90c0ba443761f9a27ba2992b4ef5ebb534d92825df2409d9fcaa029962867ccab53ed8deef8ecf344b0557dd76d5dc19fc6428db0f472ea50
-  data.tar.gz: 3866fec75e625ca437d672354632227901629641a97c4d04b7fb0559aa1594baee27d365e4e5fc6c59961e11009f7608560cef5df9f8a4851cc9d5c7501f52b0
+  metadata.gz: 522eea93d714a4afe55e18f20be294674a3406915b31c858567471117aa6e9089d8a8269517efb6bd2b8c29a70d895109e1047a93c7ec68a739d856b8656d6a2
+  data.tar.gz: 65e6082188ace39b2013404301fa137596b501d0f301fa0679697311038217642a08e29a7b5786fb406fdecf54016d90d49e6f652e90b89a9ae101b2db29448a

data/README.md

@@ -26,23 +26,35 @@ Or install it yourself as:
 $ gem install healthier
 ```
 
-In your application routes.rb file:
+# Installer:
 
-```ruby
-  mount Healthier::Engine => '/healthier'
+```bash
+  rails generate healthier:config
 ```
 
-In the config directory, make a healthier folder and create a file
-called services.yml:
-
+This will generate these two files:
+1. config/healthier.yml
 ```yaml
 ---
 healthier:
   depends_on:
-    - name: 'postgresql'
-    - name: 'mongodb'
-    - name: 'redis'
-    - name: 'rabbitmq'
+# Uncomment accordingly
+#    - name: 'postgresql'
+#    - name: 'mongodb'
+#    - name: 'redis'
+#    - name: 'rabbitmq'
+```
+2. config/initializers/healthier.rb
+```ruby
+Healthier.setup do |config|
+  config.depends_on = config.healthier.call
+end
+```
+
+In your application routes.rb file:
+
+```ruby
+mount Healthier::Engine => '/healthier'
 ```
 
 ENVs for basic authentication:

data/app/controllers/healthier/application_controller.rb

@@ -3,12 +3,5 @@
 module Healthier
   # ApplicationController
   class ApplicationController < ActionController::Base
-    include ActionController::HttpAuthentication::Basic::ControllerMethods
-
-    before_action :authenticate_request
-
-    def authenticate_request
-      BasicAuthService.authorize(self)
-    end
   end
 end

data/app/controllers/healthier/checks_controller.rb

@@ -3,8 +3,22 @@
 module Healthier
   # Controller for performing health checks
   class ChecksController < ApplicationController
+    include ActionController::HttpAuthentication::Basic::ControllerMethods
+
+    before_action :authenticate_request
+
     def ping
       render json: Healthier::Engine.ping!
     end
+
+    protected
+
+    def authenticate_request
+      api_authenticator.authenticate
+    end
+
+    def api_authenticator
+      Healthier::ApiAuthenticator.new(self)
+    end
   end
 end

data/lib/generators/healthier/config_generator.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Healthier
+  # Generates a healthier.yml
+  class ConfigGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    def create_healthier_file
+      create_file 'config/initializers/healthier.rb', <<~RUBY
+        # frozen_string_literal: true
+
+        Healthier.setup do |config|
+          config.depends_on = config.healthier.call
+        end
+      RUBY
+    end
+
+    def create_healthier_yaml
+      create_file 'config/healthier.yml', <<~YAML
+        ---
+        healthier:
+          # Uncomment accordingly
+          depends_on:
+        #    - name: 'postgresql'
+        #    - name: 'mongodb'
+        #    - name: 'redis'
+        #    - name: 'rabbitmq'
+      YAML
+    end
+  end
+end

data/lib/healthier/api_authenticator.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Healthier
+  # Engine
+  class ApiAuthenticator
+    attr_accessor :controller
+
+    def initialize(controller)
+      @controller = controller
+    end
+
+    def authenticate
+      send("authenticate_with_#{Healthier.auth_mechanism}")
+    end
+
+    def authenticate_with_bearer_token
+      controller.authenticate_with_http_token do |token, _options|
+        ENV['BEARER_TOKEN'] == token
+      end
+    end
+
+    def authenticate_with_basic_auth
+      controller.authenticate_or_request_with_http_basic do |username, password|
+        username == ENV['USERNAME'] && password == ENV['PASSWORD']
+      end
+    end
+  end
+end

data/lib/healthier/engine.rb

@@ -37,11 +37,7 @@ module Healthier
     end
 
     def conf
-      @conf ||= YAML.load_file(config_path)['healthier']
-    end
-
-    def config_path
-      Rails.root.join('config/healthier/services.yml')
+      @conf ||= Healthier.depends_on['healthier']
     end
 
     def ping_it(service)

data/lib/healthier/version.rb

@@ -2,5 +2,5 @@
 
 module Healthier
   # MAJOR.MINOR.PATCH
-  VERSION = '0.1.3'
+  VERSION = '0.1.5'
 end

data/lib/healthier.rb

@@ -2,8 +2,15 @@
 
 require 'healthier/version'
 require 'healthier/engine'
+require 'healthier/api_authenticator'
 
 # Healthier
 module Healthier
-  # Your code goes here...
+  def self.setup
+    yield self
+  end
+
+  mattr_accessor :healthier, default: -> { YAML.load_file(Rails.root.join('config/healthier.yml')) }
+  mattr_accessor :auth_mechanism, default: 'basic_auth'
+  mattr_accessor :depends_on, default: {}
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: healthier
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Nima Yonten
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-10 00:00:00.000000000 Z
+date: 2023-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -36,9 +36,10 @@ files:
 - Rakefile
 - app/controllers/healthier/application_controller.rb
 - app/controllers/healthier/checks_controller.rb
-- app/services/basic_auth_service.rb
 - config/routes.rb
+- lib/generators/healthier/config_generator.rb
 - lib/healthier.rb
+- lib/healthier/api_authenticator.rb
 - lib/healthier/engine.rb
 - lib/healthier/version.rb
 - lib/tasks/healthier_tasks.rake

data/app/services/basic_auth_service.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-# This module authenticates the API with Basic Auth
-class BasicAuthService
-  def self.authorize(controller)
-    controller.authenticate_or_request_with_http_basic do |username, password|
-      username == ENV['USERNAME'] && password == ENV['PASSWORD']
-    end
-  end
-end