Module: Rhino::Routes

Defined in:
lib/rhino/routes.rb

Overview

Dynamic route registration from Rhino configuration. Mirrors the Laravel routes/api.php behavior exactly.

Class Method Summary collapse

Class Method Details

.draw(router) ⇒ Object 



8
9
10
11
12
13
14
15
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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/rhino/routes.rb', line 8

def draw(router)
  config = Rhino.config

  # Fail fast on route groups that would silently shadow each other (same
  # prefix + intersecting host-set + overlapping models). Without a
  # distinguishing domain, two or more overlapping groups need distinct
  # prefixes.
  Rhino::Routing::RouteGroupValidator.validate(config)

  route_groups = config.route_groups

  # Sort: literal prefixes first, parameterized (containing ':') last
  sorted_groups = route_groups.sort_by { |_name, cfg| cfg[:prefix].include?(":") ? 1 : 0 }

  # Build a domain constraint for a group, or nil when the group has no
  # domain (matches any host — the default, backward-compatible behavior).
  domain_constraint = lambda do |group_config|
    domain = group_config && group_config[:domain]
    return nil if domain.nil? || domain.to_s.empty?

    Rhino::Routing::DomainConstraint.new(domain)
  end

  tenant_constraint = config.has_tenant_group? ? domain_constraint.call(route_groups[:tenant]) : nil

  # Per-group auth route registration (GROUP_AUTH_DESIGN.md §5). For each
  # group that opted into `auth: true`, register the full auth route set
  # under the group's prefix/domain, tagging each route with the group's
  # route_group default so the controller can resolve the group.
  auth_groups = config.auth_enabled_groups

  # GROUP_AUTH_DESIGN.md §11.1: an auth-enabled group with an empty prefix
  # AND no domain would register an auth route identical to the legacy
  # /api/auth/* set; the legacy route would win with no route_group, so the
  # group's hooks/membership never engage (spurious login 403). Such a
  # group IS the default/legacy auth: the legacy routes adopt its
  # route_group, and we do NOT register a colliding second set for it.
  #
  # If TWO or more such groups exist they are genuinely indistinguishable;
  # the route-group validator raises before we get here. So at most one.
  legacy_group_override = config.auth_enabled_legacy_groups.first

  # The legacy unprefixed /api/auth/* set always remains. It maps to:
  #   1. the single empty-prefix/no-domain auth-enabled group (§11.1), else
  #   2. the ':default' group when one is configured, else
  #   3. no group (nil) — today's group-less behavior.
  legacy_auth_group =
    if legacy_group_override
      legacy_group_override.to_s
    elsif route_groups.key?(:default)
      "default"
    end

  # The override group must not also register its own per-group auth set,
  # because that set would be byte-for-byte the legacy one (collision).
  auth_groups = auth_groups.reject { |name| name == legacy_group_override }

  router.instance_eval do
    scope path: "api", defaults: { format: :json } do
      # ---------------------------------------------------------------
      # Per-group auth routes (auth: true groups)
      # ---------------------------------------------------------------
      # Routing precedence is first-match-wins. A group with an empty
      # prefix and a domain produces an auth path (e.g. /api/auth/login)
      # identical to the legacy set. If the legacy (host-unconstrained)
      # routes were registered first they would shadow the group route on
      # the group's domain, so route_group would never resolve and the
      # group's hooks/membership checks would never engage. To avoid that,
      # all DOMAIN-CONSTRAINED group auth routes are registered BEFORE the
      # legacy set; the host constraint keeps them inert on other hosts.
      # Prefixed (non-domain) group routes have a distinct path and may be
      # registered after the legacy set without conflict.
      grouped_auth = auth_groups.group_by do |group_name|
        dc = domain_constraint.call(route_groups[group_name])
        dc ? :domain : :plain
      end

      draw_group_auth = lambda do |group_name|
        group_config = route_groups[group_name]
        group_prefix = group_config[:prefix].to_s
        auth_path = [group_prefix, "auth"].reject(&:blank?).join("/")
        group_auth_constraint = domain_constraint.call(group_config)

        draw_auth_routes = lambda do
          scope path: auth_path, defaults: { route_group: group_name.to_s } do
            post "login", to: "rhino/auth#login", as: "rhino_#{group_name}_auth_login"
            post "password/recover", to: "rhino/auth#recover_password", as: "rhino_#{group_name}_auth_recover"
            post "password/reset", to: "rhino/auth#reset", as: "rhino_#{group_name}_auth_reset"
            post "register", to: "rhino/auth#register_with_invitation", as: "rhino_#{group_name}_auth_register"
            post "logout", to: "rhino/auth#logout", as: "rhino_#{group_name}_auth_logout"
          end
        end

        if group_auth_constraint
          constraints(group_auth_constraint) { instance_exec(&draw_auth_routes) }
        else
          instance_exec(&draw_auth_routes)
        end
      end

      # Domain-constrained group auth routes FIRST (they may collide on
      # path with the legacy set; the host constraint disambiguates).
      (grouped_auth[:domain] || []).each { |group_name| instance_exec(group_name, &draw_group_auth) }

      # ---------------------------------------------------------------
      # Auth Routes (legacy, always registered)
      # ---------------------------------------------------------------
      scope path: "auth", defaults: { route_group: legacy_auth_group } do
        post "login", to: "rhino/auth#login"
        post "password/recover", to: "rhino/auth#recover_password"
        post "password/reset", to: "rhino/auth#reset"
        post "register", to: "rhino/auth#register_with_invitation"
        post "logout", to: "rhino/auth#logout"
      end

      # Prefixed (non-domain) group auth routes after the legacy set.
      (grouped_auth[:plain] || []).each { |group_name| instance_exec(group_name, &draw_group_auth) }

      # ---------------------------------------------------------------
      # Invitation accept (public, always registered)
      # ---------------------------------------------------------------
      post "invitations/accept", to: "rhino/invitations#accept"

      # ---------------------------------------------------------------
      # Tenant-specific routes (invitations + nested)
      # ---------------------------------------------------------------
      if config.has_tenant_group?
        tenant_config = route_groups[:tenant]
        tenant_prefix = tenant_config[:prefix]

        # Invitation routes under tenant prefix
        invitation_prefix = tenant_prefix.present? ? "#{tenant_prefix}/invitations" : "invitations"

        # Nested operations under tenant prefix
        nested_config = config.nested
        nested_path = nested_config[:path] || "nested"
        nested_prefix = tenant_prefix.present? ? "#{tenant_prefix}/#{nested_path}" : nested_path

        # Tenant invitation + nested routes inherit the tenant group's
        # domain (matches Laravel, which constrains these to the tenant
        # domain). When there is no tenant domain they match any host.
        draw_tenant_routes = lambda do
          scope path: invitation_prefix do
            get "/", to: "rhino/invitations#index"
            post "/", to: "rhino/invitations#create"
            post ":id/resend", to: "rhino/invitations#resend"
            delete ":id", to: "rhino/invitations#cancel"
          end

          post nested_prefix, to: "rhino/resources#nested", as: :rhino_nested
        end

        if tenant_constraint
          constraints(tenant_constraint) { instance_exec(&draw_tenant_routes) }
        else
          instance_exec(&draw_tenant_routes)
        end
      else
        # No tenant group — register nested at top level
        nested_config = config.nested
        nested_path = nested_config[:path] || "nested"
        post nested_path, to: "rhino/resources#nested", as: :rhino_nested
      end

      # ---------------------------------------------------------------
      # Per-group CRUD routes
      # ---------------------------------------------------------------
      sorted_groups.each do |group_name, group_config|
        group_prefix = group_config[:prefix]
        group_models = config.models_for_group(group_name)
        group_constraint = domain_constraint.call(group_config)

        group_models.each do |slug|
          model_class_name = config.models[slug]
          model_class = begin
            model_class_name.constantize
          rescue NameError
            next
          end

          except_actions = model_class.try(:rhino_except_actions_list) || []

          route_prefix = [group_prefix, slug.to_s].reject(&:blank?).join("/")

          # Each model's CRUD routes live inside a path scope. When the
          # group declares a domain, that scope is additionally wrapped in
          # a host constraint so the routes only match on that domain.
          draw_model_routes = lambda do
          scope path: route_prefix, defaults: { model_slug: slug.to_s, route_group: group_name.to_s } do
            unless except_actions.include?("index")
              get "/", to: "rhino/resources#index", as: "rhino_#{group_name}_#{slug}_index"
            end

            unless except_actions.include?("store")
              post "/", to: "rhino/resources#store", as: "rhino_#{group_name}_#{slug}_store"
            end

            if model_class.try(:uses_soft_deletes?)
              unless except_actions.include?("trashed")
                get "trashed", to: "rhino/resources#trashed", as: "rhino_#{group_name}_#{slug}_trashed"
              end

              unless except_actions.include?("restore")
                post ":id/restore", to: "rhino/resources#restore", as: "rhino_#{group_name}_#{slug}_restore"
              end

              unless except_actions.include?("forceDelete")
                delete ":id/force-delete", to: "rhino/resources#force_delete", as: "rhino_#{group_name}_#{slug}_force_delete"
              end
            end

            unless except_actions.include?("show")
              get ":id", to: "rhino/resources#show", as: "rhino_#{group_name}_#{slug}_show"
            end

            unless except_actions.include?("update")
              put ":id", to: "rhino/resources#update", as: "rhino_#{group_name}_#{slug}_update"
            end

            unless except_actions.include?("destroy")
              delete ":id", to: "rhino/resources#destroy", as: "rhino_#{group_name}_#{slug}_destroy"
            end
          end
          end

          if group_constraint
            constraints(group_constraint) { instance_exec(&draw_model_routes) }
          else
            instance_exec(&draw_model_routes)
          end
        end
      end
    end
  end
end