Module: Roda::RodaPlugins::Kabk

Defined in:
lib/roda/plugins/kabk.rb,
lib/roda/plugins/kabk/version.rb

Overview

Kabk plugin for Roda — Smart Dispatch routing and Simurgh Panel integration.

Examples:

Plugin Registration

class App < Roda
  plugin :kabk,
         system_config: { logo_url: "/simurgh-logo.svg" },
         upload_handler: ->(file, req) { { url: "/uploads/#{file[:filename]}" } }
end

Defined Under Namespace

Modules: RequestMethods

Constant Summary collapse

VERSION =

Current version of the roda-kabk gem

"1.0.2"

Class Method Summary collapse

Class Method Details

.configure(app, opts = {}) ⇒ void

This method returns an undefined value.

Configures the plugin options for the application.

Parameters:

  • app (Class<Roda>) —

    The Roda application class.

  • opts (Hash) (defaults to: {}) —

    Configuration options.

Options Hash (opts):

  • :system_config (Hash, nil) —

    Custom system branding and localization configuration.

  • :upload_handler (Proc, #call, nil) —

    Custom file upload handler callable.



34
35
36
37
38
 
# File 'lib/roda/plugins/kabk.rb', line 34

def self.configure(app, opts = {})
  app.opts[:kabk] ||= {}
  app.opts[:kabk][:system_config] = opts[:system_config] || nil
  app.opts[:kabk][:upload_handler] = opts[:upload_handler]
end

.load_dependencies(app, _opts = {}) ⇒ void

This method returns an undefined value.

Loads plugin dependencies into the Roda application.

Parameters:

  • app (Class<Roda>) —

    The Roda application class.

  • _opts (Hash) (defaults to: {}) —

    Configuration options.



23
24
25
 
# File 'lib/roda/plugins/kabk.rb', line 23

def self.load_dependencies(app, _opts = {})
  app.plugin :all_verbs
end