Module: RESTFramework::Utils

Defined in:
lib/rest_framework/utils.rb

Constant Summary collapse

HTTP_METHOD_ORDERING = 
%w(GET POST PUT PATCH DELETE)

Class Method Summary collapse

Class Method Details

.comparable_path(path) ⇒ Object

Helper to normalize a path pattern by replacing URL params with generic placeholder, and removing the ‘(.:format)` at the end.



52
53
54
 
# File 'lib/rest_framework/utils.rb', line 52

def self.comparable_path(path)
  return path.gsub("(.:format)", "").gsub(/:[0-9A-Za-z_-]+/, ":x")
end

.get_request_route(application_routes, request) ⇒ Object

Helper to get the first route pattern which matches the given request.



41
42
43
 
# File 'lib/rest_framework/utils.rb', line 41

def self.get_request_route(application_routes, request)
  application_routes.router.recognize(request) { |route, _| return route }
end

.get_route_pattern(route) ⇒ Object

Helper to get the route pattern for a route, stripped of the ‘(:format)` segment.



46
47
48
 
# File 'lib/rest_framework/utils.rb', line 46

def self.get_route_pattern(route)
  return route.path.spec.to_s.gsub(/\(\.:format\)$/, "")
end

.get_routes(application_routes, request, current_route: nil) ⇒ Object

Helper for showing routes under a controller action; used for the browsable API.



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
 
# File 'lib/rest_framework/utils.rb', line 57

def self.get_routes(application_routes, request, current_route: nil)
  current_route ||= self.get_request_route(application_routes, request)
  current_path = current_route.path.spec.to_s
  current_levels = current_path.count("/")
  current_comparable_path = self.comparable_path(current_path)

  # Return routes that match our current route subdomain/pattern, grouped by controller. We
  # precompute certain properties of the route for performance.
  return application_routes.routes.map { |r|
    path = r.path.spec.to_s
    levels = path.count("/")

    # Show link if the route is GET and our current route has all required URL params.
    if r.verb == "GET" && r.path.required_names.length == current_route.path.required_names.length
      show_link_args = current_route.path.required_names.map { |n| request.params[n] }.compact
    else
      show_link_args = nil
    end

    {
      route: r,
      verb: r.verb,
      path: path,
      comparable_path: self.comparable_path(path),
      # Starts at the number of levels in current path, and removes the `(.:format)` at the end.
      relative_path: path.split("/")[current_levels..]&.join("/")&.gsub("(.:format)", ""),
      controller: r.defaults[:controller].presence,
      action: r.defaults[:action].presence,
      subdomain: r.defaults[:subdomain].presence,
      levels: levels,
      show_link_args: show_link_args,
    }
  }.select { |r|
    (
      (!r[:subdomain] || r[:subdomain] == request.subdomain.presence) &&
      r[:comparable_path].start_with?(current_comparable_path) &&
      r[:controller] &&
      r[:action]
    )
  }.sort_by { |r|
    # Sort by levels first, so the routes matching closely with current request show first, then
    # by the path, and finally by the HTTP verb.
    [r[:levels], r[:path], HTTP_METHOD_ORDERING.index(r[:verb]) || 99]
  }.group_by { |r| r[:controller] }.sort_by { |c, _r|
    # Sort the controller groups by current controller first, then depth, then alphanumerically.
    [request.params[:controller] == c ? 0 : 1, c.count("/"), c]
  }.to_h
end

.parse_extra_actions(extra_actions) ⇒ Object

Helper to take extra_actions hash and convert to a consistent format: ‘methods:, kwargs:`.



6
7
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
 
# File 'lib/rest_framework/utils.rb', line 6

def self.parse_extra_actions(extra_actions)
  return (extra_actions || {}).map do |k, v|
    kwargs = {action: k}
    path = k

    # Convert structure to path/methods/kwargs.
    if v.is_a?(Hash)  # Allow kwargs to be used to define path differently from the key.
      v = v.symbolize_keys

      # Ensure methods is an array.
      if v[:methods].is_a?(String) || v[:methods].is_a?(Symbol)
        methods = [v.delete(:methods)]
      else
        methods = v.delete(:methods)
      end

      # Override path if it's provided.
      if v.key?(:path)
        path = v.delete(:path)
      end

      # Pass any further kwargs to the underlying Rails interface.
      kwargs = kwargs.merge(v)
    elsif v.is_a?(Symbol) || v.is_a?(String)
      methods = [v]
    else
      methods = v
    end

    # Return a hash with keys: :path, :methods, :kwargs.
    {path: path, methods: methods, kwargs: kwargs}
  end
end