katalyst-healthcheck 0.2.8 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95661561842df409390e4a798c57b959bcbc39d0803f526fe39c4781b1e87903
-  data.tar.gz: a022ff2050eb06f96fa641bad74b0a1a0132b09b2e09cd9171654e2ce93f179d
+  metadata.gz: c405714831e17ff682cee082363e5e3b9433dd622aae6f125c7d6f8cb9e260ba
+  data.tar.gz: 5c72ee6dbe280e60404ae84b02b4f7db11a9aa59d8b313a638b5fa8b64c0d1ba
 SHA512:
-  metadata.gz: bc2f21383a0ae5f28f40c072e746e265d481d5a3d99659f2b9dfe4bc2e73e85471a6d3a452f66ce4d3f26aed2eedecd36eab6fc9e4efd1e1936a33a7603a0c91
-  data.tar.gz: f6ade891f379e6abd9a959f07568e9e230a3d7ddeea83cd8337656bc8594536091a39bdcac3c948e9da42a4c7efeab8f41de074e8d9c7f285772d937bf03e086
+  metadata.gz: 5fd33513793e0523ea4e6ff37d5210f0409c1dd6572c9715d97034664164ad1c3f2517bed5b514695b189e59f1170fcd58cb29873e6e03483c46047217acc3f0
+  data.tar.gz: b8edd34e5e1c248fedce6067fd6224b50d513b9c4742dc05cdf248c7059222cf00a1aebb4d3a2a7e9b354ffa4b382533977a8325095343bafed5916945ef7ae7

data/README.md

@@ -58,7 +58,7 @@ the `Katalyst::Healthcheck::Monitored` concern's `healthy!` and `unhealthy` meth
 ``` ruby
 include Katalyst::Healthcheck::Monitored
 
-define_task :my_task, "My task description", interval: 1.day
+define_healthcheck_task :my_task, "My task description", interval: 1.day
 
 def do_task
   ... task code here ...

data/Rakefile

@@ -5,8 +5,4 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-
-task default: %i[spec rubocop]
+task default: %i[spec]

data/lib/katalyst/healthcheck/actions/sidekiq.rb

@@ -11,7 +11,7 @@ module Katalyst
 
         sidekiq_options retry: false
 
-        define_task :sidekiq_health, "Sidekiq background processing", interval: 60
+        define_healthcheck_task :sidekiq_health, "Sidekiq background processing", interval: 60
 
         def self.call
           perform_async

data/lib/katalyst/healthcheck/config.rb

@@ -16,8 +16,7 @@ module Katalyst
       private
 
       def build_store(name)
-        klass = "Katalyst::Healthcheck::Store::#{name.to_s.camelize}".constantize
-        klass.new
+        Object.const_get("Katalyst::Healthcheck::Store::#{name.to_s.capitalize}").new
       end
     end
   end

data/lib/katalyst/healthcheck/monitored.rb

@@ -3,16 +3,24 @@
 module Katalyst
   module Healthcheck
     module Monitored
-      extend ActiveSupport::Concern
+      def self.included(klass)
+        klass.extend(ClassMethods)
+      end
 
-      module HealthMethods
+      module ClassMethods
         # Define a task to be monitored
         # @param name [Symbol] The name of the task
         # @param description [String] A description of the task's function
         # @param interval [Integer,ActiveSupport::Duration] Expected frequency that this task runs, e.g. 1.day
-        def define_task(name, description, interval:)
+        def define_healthcheck_task(name, description, interval:)
           defined_healthcheck_tasks[name] = Task.new(name: name, description: description, interval: interval)
         end
+        alias define_task define_healthcheck_task
+
+        # @return [Hash] Defined tasks keyed by name
+        def defined_healthcheck_tasks
+          @defined_healthcheck_tasks ||= {}
+        end
 
         # Mark a task as healthy
         # @param name [Symbol] The name of the task
@@ -41,22 +49,17 @@ module Katalyst
         end
       end
 
-      class_methods do
-        include HealthMethods
-
-        attr_accessor :healthcheck_task_definitions
-
-        # @return [Hash] Defined tasks keyed by name
-        def defined_healthcheck_tasks
-          self.healthcheck_task_definitions ||= {}
-        end
+      # Mark a task as healthy
+      # @param name [Symbol] The name of the task
+      def healthy!(name)
+        self.class.healthy! name
       end
 
-      include HealthMethods
-
-      # @return [Hash] Defined tasks keyed by name
-      def defined_healthcheck_tasks
-        self.class.healthcheck_task_definitions ||= {}
+      # Mark a task as unhealthy
+      # @param name [Symbol] The name of the task
+      # @param error [String] Optional error message
+      def unhealthy!(name, error = nil)
+        self.class.unhealthy! name, error
       end
     end
   end

data/lib/katalyst/healthcheck/store/attributes.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require "date"
+
+# Inspired by ActiveModel::Attributes, but with support for Rails 3+
+module Katalyst
+  module Healthcheck
+    module Store
+      module Attributes
+        def self.included(klass)
+          klass.extend ClassMethods
+        end
+
+        module ClassMethods
+          @@attributes = {}
+
+          def attribute(name, type = :string)
+            name = name.to_s
+            serializer = case type
+                         when :integer
+                           IntegerAttribute
+                         when :datetime
+                           DateTimeAttribute
+                         else
+                           Attribute
+                         end
+            define_method(name) { @@attributes[name].read(@attributes) }
+            define_method("#{name}=") { |value| @@attributes[name].write(@attributes, value) }
+            @@attributes[name] = serializer.new(name)
+          end
+        end
+
+        def initialize(attributes)
+          @attributes = {}
+          self.attributes = attributes
+        end
+
+        def attributes
+          @attributes.keys.map { |k| [k, public_send(k)] }.to_h
+        end
+
+        def attributes=(attributes)
+          attributes.each do |k, v|
+            public_send("#{k}=", v)
+          end
+          attributes
+        end
+      end
+
+      class Attribute
+        attr_reader :key
+
+        def initialize(key)
+          @key = key
+        end
+
+        def read(attributes)
+          deserialize(attributes[key]) if attributes.has_key?(key)
+        end
+
+        def write(attributes, value)
+          if value.nil?
+            attributes.delete(key)
+          elsif value.is_a?(String) # support already serialized values
+            attributes[key] = value
+          else
+            attributes[key] = serialize(value)
+          end
+        end
+
+        private
+
+        def deserialize(value)
+          value
+        end
+
+        def serialize(value)
+          value.to_s
+        end
+      end
+
+      class IntegerAttribute < Attribute
+        private
+
+        def deserialize(value)
+          Integer(value)
+        end
+      end
+
+      class DateTimeAttribute < Attribute
+        private
+
+        def serialize(value)
+          value.iso8601
+        end
+
+        def deserialize(value)
+          DateTime.parse(value)
+        end
+      end
+    end
+  end
+end

data/lib/katalyst/healthcheck/store/redis.rb

@@ -20,8 +20,8 @@ module Katalyst
           # @return [String] Redis URL defined in rails config
           def rails_redis_url
             redis_config = rails_redis_config || {}
-            host         = redis_config[:host] || DEFAULT_HOST
-            port         = redis_config[:port] || DEFAULT_PORT
+            host         = redis_config["host"] || DEFAULT_HOST
+            port         = redis_config["port"] || DEFAULT_PORT
             "redis://#{host}:#{port}"
           end
 
@@ -62,7 +62,7 @@ module Katalyst
             if task_state.nil?
               task_data.delete(name)
             else
-              task_data[name] = serialize(task_state)
+              task_data[name] = task_state
             end
             client.set(cache_key, JSON.generate(data))
           end
@@ -76,18 +76,6 @@ module Katalyst
 
         private
 
-        # @param task_state [Hash]
-        def serialize(task_state)
-          task_state.transform_values do |value|
-            case value
-            when ActiveSupport::TimeWithZone, DateTime
-              value.strftime("%d/%m/%Y %H:%M:%S %z")
-            else
-              value
-            end
-          end
-        end
-
         def cache_key
           options.cache_key || DEFAULT_CACHE_KEY
         end
@@ -104,7 +92,7 @@ module Katalyst
         end
 
         def lock_manager
-          raise "redis url is required" if options.url.blank?
+          raise "redis url is required" unless options.url
 
           @lock_manager ||= ::Redlock::Client.new([options.url])
         end

data/lib/katalyst/healthcheck/task.rb

@@ -4,8 +4,7 @@ module Katalyst
   module Healthcheck
     # Represents a background task that runs periodically in an application
     class Task
-      include ActiveModel::Model
-      include ActiveModel::Attributes
+      include Store::Attributes
 
       TASK_GRACE_PERIOD = 10 * 60 # 10 minutes
 
@@ -65,11 +64,11 @@ module Katalyst
 
       # @return [Boolean] true if this background task is running on schedule
       def on_schedule?
-        next_time.nil? || next_time + TASK_GRACE_PERIOD > Time.current
+        next_time.nil? || next_time + TASK_GRACE_PERIOD > DateTime.now
       end
 
       def next_time
-        return nil if interval.blank?
+        return nil if interval.nil?
 
         (last_time || created_at) + interval
       end
@@ -77,7 +76,7 @@ module Katalyst
       # Mark this task as healthy and save state
       # @return [Task] This task
       def healthy!
-        self.last_time = Time.current
+        self.last_time = DateTime.now
         self.error     = nil
         self.status    = :ok
 
@@ -87,7 +86,7 @@ module Katalyst
       # Mark this task as unhealthy and save state
       # @return [Task] This task
       def unhealthy!(error = nil)
-        self.error  = error.presence || "Fail"
+        self.error  = error || "Fail"
         self.status = :fail
 
         save
@@ -96,8 +95,8 @@ module Katalyst
       # Save task state
       # @return [Task] This task
       def save
-        self.created_at ||= Time.now
-        self.updated_at = Time.now
+        self.created_at ||= DateTime.now
+        self.updated_at = DateTime.now
         store.update(name, attributes)
         self
       end

data/lib/katalyst/healthcheck/version.rb

@@ -2,6 +2,6 @@
 
 module Katalyst
   module Healthcheck
-    VERSION = "0.2.8"
+    VERSION = "0.4.0"
   end
 end

data/lib/katalyst/healthcheck.rb

@@ -1,12 +1,11 @@
 # frozen_string_literal: true
 
-require "active_support"
-require "active_model"
 require "redlock"
 
 require "katalyst/healthcheck/version"
 require "katalyst/healthcheck/railtie" if defined?(Rails)
 require "katalyst/healthcheck/config"
+require "katalyst/healthcheck/store/attributes"
 require "katalyst/healthcheck/store/memory"
 require "katalyst/healthcheck/store/redis"
 require "katalyst/healthcheck/task"

metadata

@@ -1,57 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: katalyst-healthcheck
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.4.0
 platform: ruby
 authors:
 - Katalyst Interactive
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-06 00:00:00.000000000 Z
+date: 2022-10-03 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activemodel
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '6'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '6'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.3.5
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.3.5
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: redlock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.2
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.2
+        version: '1.2'
 description: 
 email:
 - admin@katalyst.com.au
@@ -68,6 +54,7 @@ files:
 - lib/katalyst/healthcheck/monitored.rb
 - lib/katalyst/healthcheck/railtie.rb
 - lib/katalyst/healthcheck/route.rb
+- lib/katalyst/healthcheck/store/attributes.rb
 - lib/katalyst/healthcheck/store/memory.rb
 - lib/katalyst/healthcheck/store/redis.rb
 - lib/katalyst/healthcheck/task.rb
@@ -90,14 +77,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.15
 signing_key: 
 specification_version: 4
 summary: Health check routes and functions