kabk 0.2.0

data/lib/kabk/validator.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative "errors"
+
+module Kabk
+  # Handles input sanitization (strong parameters) and validation
+  class Validator
+    # Sanitizes input parameters against defined fields and validates them
+    # @param resource [Kabk::Resource]
+    # @param params [Hash] Request payload
+    # @param is_update [Boolean] Is this a PUT/update request?
+    # @return [Hash] Sanitized parameters ready for Sequel
+    def self.validate_and_sanitize!(resource, params, is_update: false)
+      sanitized = {}
+      errors = {}
+
+      # Iterate through all non-readonly fields defined in the schema
+      resource.fields.each do |field|
+        next if field.primary_key || field.readonly
+
+      # Validate required fields, ignoring absent fields on update.
+
+        key_sym = field.name.to_sym
+        key_str = field.name.to_s
+        has_key = params.key?(key_sym) || params.key?(key_str)
+        value = params[key_sym] || params[key_str]
+
+        if field.required && !has_key && !is_update
+          errors[key_str] = ["This field is required"]
+          next
+        end
+
+        next unless has_key
+
+        if value.nil? || value.to_s.strip.empty?
+          if field.required
+            errors[key_str] = ["This field is required"]
+          end
+        end
+
+        # Validate min/max length
+        if field.validation && field.type == "string" && value.is_a?(String)
+          min_len = field.validation[:min_length] || field.validation["min_length"]
+          max_len = field.validation[:max_length] || field.validation["max_length"]
+
+          errors[key_str] = ["Minimum length is #{min_len}"] if min_len && value.length < min_len
+          errors[key_str] = ["Maximum length is #{max_len}"] if max_len && value.length > max_len
+        end
+
+        sanitized[key_sym] = value
+      end
+
+      # Ensure the concurrency field is included for OCC validation.
+      if resource.concurrency_field
+        c_field = resource.concurrency_field
+        sanitized[c_field.to_sym] = params[c_field.to_sym] || params[c_field.to_s] if params.key?(c_field.to_sym) || params.key?(c_field.to_s)
+      end
+
+      raise ValidationError.new(fields: errors) unless errors.empty?
+
+      sanitized
+    end
+  end
+end

data/lib/kabk/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# Kabk module namespace
+module Kabk
+  VERSION = "0.2.0"
+end

data/lib/kabk.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative "kabk/version"
+require_relative "kabk/registry"
+require_relative "kabk/resource"
+require_relative "kabk/field"
+require_relative "kabk/resource_builder"
+require_relative "kabk/schema_renderer"
+require_relative "kabk/errors"
+require_relative "kabk/concurrency"
+require_relative "kabk/validator"
+require_relative "kabk/query_builder"
+require_relative "kabk/relation_hydrator"
+require_relative "kabk/rest_engine"
+require_relative "kabk/upload_handler"
+require_relative "kabk/export_handler"
+require_relative "kabk/adapters/base"
+require_relative "kabk/adapters/sequel_adapter"
+
+# Core namespace and entrypoint for Kabk
+module Kabk
+  # Register a new model as a resource
+  #
+  # @param name [String, Symbol] The unique identifier for the resource
+  # @param table [Class] The Model class (e.g. Sequel::Model)
+  # @param adapter [Kabk::Adapters::Base] Optional explicit adapter instance
+  # @yield Block evaluated in the context of a ResourceBuilder
+  def self.register(name:, table:, adapter: nil, &block)
+    resource = Resource.new(name: name, model_class: table)
+    builder = ResourceBuilder.new(resource)
+    builder.instance_eval(&block) if block_given?
+
+    # Fallbacks per protocol
+    resource.plural_name ||= "#{name}s"
+    resource.title ||= resource.plural_name.capitalize
+    resource.icon ||= "Database"
+    resource.api_path ||= "/api/admin/#{resource.plural_name}"
+
+    # Determine and assign adapter
+    if adapter
+      resource.adapter = adapter
+    elsif defined?(Sequel::Model) && table < Sequel::Model
+      resource.adapter = Adapters::SequelAdapter.new(resource)
+    else
+      raise ArgumentError, "Could not determine appropriate adapter for #{table}. Please provide an explicit adapter."
+    end
+
+    Registry.instance.register(resource)
+    resource
+  end
+end

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification
+name: kabk
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Parham Taheri
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+description: Framework-agnostic engine that provides resource registration, JSON schema
+  manifest generation, generic CRUD engine, server-side validation, and relation hydration.
+email:
+- Par_taheri@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- Kabk_logo.svg
+- LICENSE
+- README.md
+- doc/Kabk.html
+- doc/Kabk/Adapters.html
+- doc/Kabk/Adapters/Base.html
+- doc/Kabk/Adapters/SequelAdapter.html
+- doc/Kabk/ApiError.html
+- doc/Kabk/Auth.html
+- doc/Kabk/Auth/JwtStrategy.html
+- doc/Kabk/Concurrency.html
+- doc/Kabk/ConcurrencyConflictError.html
+- doc/Kabk/Error.html
+- doc/Kabk/ExportHandler.html
+- doc/Kabk/Field.html
+- doc/Kabk/ForbiddenError.html
+- doc/Kabk/InvalidFieldError.html
+- doc/Kabk/InvalidOldPasswordError.html
+- doc/Kabk/NotFoundError.html
+- doc/Kabk/QueryBuilder.html
+- doc/Kabk/Registry.html
+- doc/Kabk/RelationHydrator.html
+- doc/Kabk/Resource.html
+- doc/Kabk/ResourceBuilder.html
+- doc/Kabk/RestEngine.html
+- doc/Kabk/SchemaRenderer.html
+- doc/Kabk/UnauthorizedError.html
+- doc/Kabk/UploadHandler.html
+- doc/Kabk/ValidationError.html
+- doc/Kabk/Validator.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
+- docs/API_REFERENCE.md
+- lib/kabk.rb
+- lib/kabk/adapters/base.rb
+- lib/kabk/adapters/sequel_adapter.rb
+- lib/kabk/concurrency.rb
+- lib/kabk/errors.rb
+- lib/kabk/export_handler.rb
+- lib/kabk/field.rb
+- lib/kabk/query_builder.rb
+- lib/kabk/registry.rb
+- lib/kabk/relation_hydrator.rb
+- lib/kabk/resource.rb
+- lib/kabk/resource_builder.rb
+- lib/kabk/rest_engine.rb
+- lib/kabk/schema_renderer.rb
+- lib/kabk/upload_handler.rb
+- lib/kabk/validator.rb
+- lib/kabk/version.rb
+homepage: https://github.com/par-taheri/Kabk
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/par-taheri/Kabk
+  source_code_uri: https://github.com/par-taheri/Kabk
+  changelog_uri: https://github.com/par-taheri/Kabk/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.16
+specification_version: 4
+summary: Core engine for Schema-Driven Dynamic Admin Specification (Protocol v1.6.0).
+test_files: []