active_status 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d73120fdb2c6678c393901193462d336ee9f610cd14337efd0303719d0c9badc
+  data.tar.gz: a5bbe644b5e4c2656753beba09858263d31263890288b26b6b68b464bae98254
+SHA512:
+  metadata.gz: 403e849b33d8228139fd0a49c927e1347c63d659bad078156a0aa423a4246bef76820c78274ec37e9dd72b501f4e8f68ddb7ff6d9427989dc305b0e09c6759fa
+  data.tar.gz: 7958be692b57f4d01d47630b3c5c6823f25b5ff388971d28f7a745d50235a5ed7440361e0391bcd4cb99a553359e544da83cf715651ef4b6b8f77d83fc32581e

data/README.md

@@ -0,0 +1,28 @@
+# ActiveStatus
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_status'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install active_status
+```
+
+## 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/controllers/active_status/application_controller.rb

@@ -0,0 +1,14 @@
+module ActiveStatus
+  class ApplicationController < ActionController::API
+    def status
+      report = ActiveStatus::Report.new
+      report.build
+
+      if report.success?
+        head ActiveStatus.configuration.success
+      else
+        render json: report.errors, status: ActiveStatus.configuration.error
+      end
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+ActiveStatus::Engine.routes.draw do
+  root to: 'application#status'
+end

data/lib/active_status.rb

@@ -0,0 +1,20 @@
+require 'active_status/error'
+require 'active_status/engine'
+require 'active_status/report'
+require 'active_status/configuration'
+
+module ActiveStatus
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+
+    yield configuration
+  end
+
+  def self.reconfigure
+    self.configuration = Configuration.new
+  end
+end

data/lib/active_status/configuration.rb

@@ -0,0 +1,18 @@
+module ActiveStatus
+  class Configuration
+    attr_accessor :checks, :error, :success, :verbose
+
+    def initialize
+      self.checks  = []
+      self.error   = 503
+      self.success = 200
+      self.verbose = false
+    end
+
+    def check(name, &block)
+      checks << name
+
+      Report.define_check(name, block)
+    end
+  end
+end

data/lib/active_status/engine.rb

@@ -0,0 +1,5 @@
+module ActiveStatus
+  class Engine < ::Rails::Engine
+    isolate_namespace ActiveStatus
+  end
+end

data/lib/active_status/error.rb

@@ -0,0 +1,18 @@
+module ActiveStatus
+  class Error
+    attr_accessor :name, :error, :message
+
+    def initialize(name, error, message)
+      self.name    = name
+      self.error   = error.name
+      self.message = message&.squish
+    end
+
+    def as_json(_ = nil)
+      hash = { name: name, error: error }
+      return hash unless ActiveStatus.configuration.verbose
+
+      hash.merge({ message: message })
+    end
+  end
+end

data/lib/active_status/report.rb

@@ -0,0 +1,27 @@
+module ActiveStatus
+  class Report
+    attr_reader :errors
+
+    def initialize
+      @errors = []
+    end
+
+    def self.define_check(name, body)
+      define_method(name, body)
+    end
+
+    def build
+      ActiveStatus.configuration.checks.each do |check|
+        begin
+          send(check)
+        rescue StandardError => e
+          @errors << Error.new(check, e.class, e.message)
+        end
+      end
+    end
+
+    def success?
+      @errors.empty?
+    end
+  end
+end

data/lib/active_status/version.rb

@@ -0,0 +1,3 @@
+module ActiveStatus
+  VERSION = '0.1.0'.freeze
+end

data/lib/generators/active_status/install_generator.rb

@@ -0,0 +1,19 @@
+module ActiveStatus
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc 'Creates ActiveStatus initializer and add route for your application'
+
+      def self.default_generator_root
+        __dir__
+      end
+
+      def copy_initializer
+        template 'initializer.rb', 'config/initializers/active_status_config.rb'
+      end
+
+      def add_route
+        route "mount ActiveStatus::Engine => '/status'"
+      end
+    end
+  end
+end

data/lib/generators/active_status/templates/initializer.rb

@@ -0,0 +1,11 @@
+ActiveStatus.configure do |config|
+  # config.success = 200
+  # config.error   = 503
+  # config.verbose = false
+
+  # Example for checking database connection
+  #
+  # config.check :database do
+  #   ActiveRecord::Base.connection.execute('select 1')
+  # end
+end

metadata

@@ -0,0 +1,220 @@
+--- !ruby/object:Gem::Specification
+name: active_status
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Muhammad Usman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.8.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.44'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.44.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.44'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.44.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+description: Description of RailsStatusCheck.
+email:
+- uxman.sherwani@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- app/controllers/active_status/application_controller.rb
+- config/routes.rb
+- lib/active_status.rb
+- lib/active_status/configuration.rb
+- lib/active_status/engine.rb
+- lib/active_status/error.rb
+- lib/active_status/report.rb
+- lib/active_status/version.rb
+- lib/generators/active_status/install_generator.rb
+- lib/generators/active_status/templates/initializer.rb
+homepage: https://github.com/uxxman/active_status
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/uxxman/active_status
+  source_code_uri: https://github.com/uxxman/active_status
+  changelog_uri: https://github.com/uxxman/active_status/releases
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Summary of RailsStatusCheck.
+test_files: []