healthier 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6edf83e9f94bfec7c31425fb9da3271736b0e088abffcf6075b51e9b3384776
-  data.tar.gz: 6a61b806971ab5aaea9684f8b5e29bfadd16ad60c7a4106ff1406863e6ef9278
+  metadata.gz: 711f2ef8a3f208c3e4a4cc710fc86f73ff049a1734e0726caca32ef2d3c597f0
+  data.tar.gz: ceb81192506fb5d7132840da224ac48bdb6f31d216dc2867da3d2afca0bd5576
 SHA512:
-  metadata.gz: dbdca601bebf47f6a3e8002d9cb0194bf19269a9f17f6a5833f72922fc371775a34ff018d7c30530ac8318c0bdcb3a914ef8a66c6c2d4eff4f56285faef8bd59
-  data.tar.gz: b205cd863d5c0cadadcdab264d893e5c489aa65e37e6c5399041894cc645832e077d279231ff6a5d7b2fc1daeb58da270571008257e67ab92003893da3f0de33
+  metadata.gz: 4c2b4a07809bdb88f6bd292ba9b284c5b6612ca525c0929341d4757aa01a6b98a56c3c0e60a160859e8e1b93d7c41cf13dfe9f1946997ec038b15d46b3516b8f
+  data.tar.gz: 8b260ec426e1544f745843ede0eaa38719aa08dd75636aa6a839a65412b7308d8bc2f0a90eba950779b76571d6b8117b9cb73de389861f24f6307fe335cc4731

data/README.md

@@ -1,10 +1,13 @@
 # Healthier
+
 Short description and motivation.
 
 ## Usage
+
 How to use my plugin.
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -12,17 +15,59 @@ gem "healthier"
 ```
 
 And then execute:
+
 ```bash
 $ bundle
 ```
 
 Or install it yourself as:
+
 ```bash
 $ gem install healthier
 ```
 
+# Installer:
+
+```bash
+  rails generate healthier:config
+```
+
+This will generate these two files:
+1. config/healthier.yml
+```yaml
+---
+healthier:
+  depends_on:
+# 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:
+
+```bash
+USERNAME: 'demouser'
+PASSWORD: 'demouser@2023'
+```
+
 ## Contributing
+
 Contribution directions go here.
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/services/basic_auth_service.rb

@@ -4,7 +4,7 @@
 class BasicAuthService
   def self.authorize(controller)
     controller.authenticate_or_request_with_http_basic do |username, password|
-      username == 'healthier' && password == 'Selise23'
+      username == ENV['USERNAME'] && password == ENV['PASSWORD']
     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/engine.rb

@@ -31,17 +31,13 @@ module Healthier
     FAILURE = 400
 
     def ping!
-      conf['depends_on'].each_with_object({}) do |service, obj|
-        obj[service['name']] = ping_it(service['name'])
+      conf['depends_on'].each_with_object({}) do |dependant, obj|
+        obj[dependant['name']] = ping_it(dependant['name'])
       end
     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.2'
+  VERSION = '0.1.4'
 end

data/lib/healthier.rb

@@ -5,5 +5,10 @@ require 'healthier/engine'
 
 # 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 :depends_on, default: {}
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: healthier
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Nima Yonten
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-03 00:00:00.000000000 Z
+date: 2023-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,6 +38,7 @@ files:
 - 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/engine.rb
 - lib/healthier/version.rb