Module: RailsApiKeys::UI::RouteMapper

Defined in:
lib/rails_api_keys/ui/route_mapper.rb

Overview

Adds rails_api_keys_ui to the host routes DSL.

Instance Method Summary collapse

Instance Method Details

#rails_api_keys_ui(options = {}) ⇒ Object

Draws +index+/+create+/+destroy+ API key routes for one owner mount.

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :owner (Symbol, String, Proc) —

    key owner resolution (:current_user, :company, or callable)

  • :authorize (Proc) —

    optional per-mount authorize override

  • :controller (String) —

    host or engine controller

  • :path (String) —

    URL path segment (default "api_keys")

  • :name (String, Symbol) —

    mount registry key



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/rails_api_keys/ui/route_mapper.rb', line 16

def rails_api_keys_ui(options = {})
  opts = options.dup
  mount_name = (opts.delete(:name) || default_rails_api_keys_ui_mount_name).to_s
  owner = opts.key?(:owner) ? opts.delete(:owner) : :current_user
  authorize = opts.delete(:authorize)
  controller = opts.delete(:controller) || "rails_api_keys/ui/api_keys"
  path = opts.delete(:path) || "api_keys"
  as = opts.delete(:as)

  RailsApiKeys::UI.mounts.register(
    mount_name,
    owner: owner,
    authorize: authorize
  )

  resource_options = {
    only: %i[index create destroy],
    controller: controller,
    path: path,
    defaults: { rails_api_keys_ui_mount: mount_name }
  }
  resource_options[:as] = as if as

  resources :api_keys, **resource_options, **opts
end