Class: Grape::Endpoint

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
DSL::InsideRoute, DSL::Settings
Defined in:
lib/grape/endpoint.rb

Overview

An Endpoint is the proxy scope in which all routing blocks are executed. In other words, any methods on the instance level of this class may be called from inside a ‘get`, `post`, etc.

Instance Attribute Summary collapse

Attributes included from DSL::Settings

#inheritable_setting, #top_level_setting

Class Method Summary collapse

Instance Method Summary collapse

Methods included from DSL::InsideRoute

#api_format, #body, #configuration, #content_type, #context, #declared, #entity_class_for_obj, #entity_representation_for, #error!, #http_version, post_filter_methods, #present, #rack_response, #redirect, #return_no_content, #route, #sendfile, #status, #stream, #version

Methods included from DSL::Headers

#header

Methods included from DSL::Settings

#api_class_setting, #get_or_set, #global_setting, #namespace_end, #namespace_inheritable, #namespace_inheritable_to_nil, #namespace_reverse_stackable, #namespace_reverse_stackable_with_hash, #namespace_setting, #namespace_stackable, #namespace_stackable_with_hash, #namespace_start, #route_end, #route_setting, #unset, #unset_api_class_setting, #unset_global_setting, #unset_namespace_inheritable, #unset_namespace_setting, #unset_namespace_stackable, #unset_route_setting, #within_namespace

Constructor Details

#initialize(new_settings, options = {}) { ... } ⇒ Endpoint

Note:

This happens at the time of API definition, so in this context the

Create a new endpoint. endpoint does not know if it will be mounted under a different endpoint.

Options Hash (options):

  • path (String or Array) —

    the path to this endpoint, within the current scope.

  • method (String or Array) —

    which HTTP method(s) can be used to reach this endpoint.

  • route_options (Hash)

Yields:

  • a block defining what your API should do when this endpoint is hit



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
 
# File 'lib/grape/endpoint.rb', line 80

def initialize(new_settings, options = {}, &block)
  require_option(options, :path)
  require_option(options, :method)

  self.inheritable_setting = new_settings.point_in_time_copy

  # now +namespace_stackable(:declared_params)+ contains all params defined for
  # this endpoint and its parents, but later it will be cleaned up,
  # see +reset_validations!+ in lib/grape/dsl/validations.rb
  route_setting(:declared_params, namespace_stackable(:declared_params).flatten)
  route_setting(:saved_validations, namespace_stackable(:validations))

  namespace_stackable(:representations, []) unless namespace_stackable(:representations)
  namespace_inheritable(:default_error_status, 500) unless namespace_inheritable(:default_error_status)

  @options = options

  @options[:path] = Array(options[:path])
  @options[:path] << '/' if options[:path].empty?

  @options[:method] = Array(options[:method])
  @options[:route_options] ||= {}

  @lazy_initialize_lock = Mutex.new
  @lazy_initialized = nil
  @block = nil

  @status = nil
  @stream = nil
  @body = nil
  @proc = nil

  return unless block

  @source = block
  @block = self.class.generate_api_method(method_name, &block)
end

Instance Attribute Details

#block ⇒ Object

Returns the value of attribute block.



13
14
15
 
# File 'lib/grape/endpoint.rb', line 13

def block
  @block
end

#env ⇒ Object (readonly)

Returns the value of attribute env.



14
15
16
 
# File 'lib/grape/endpoint.rb', line 14

def env
  @env
end

#options ⇒ Object

Returns the value of attribute options.



13
14
15
 
# File 'lib/grape/endpoint.rb', line 13

def options
  @options
end

#request ⇒ Object (readonly)

Returns the value of attribute request.



14
15
16
 
# File 'lib/grape/endpoint.rb', line 14

def request
  @request
end

#source ⇒ Object

Returns the value of attribute source.



13
14
15
 
# File 'lib/grape/endpoint.rb', line 13

def source
  @source
end

Class Method Details

.before_each(new_setup = false, &block) ⇒ Object 



24
25
26
27
28
29
30
31
32
33
 
# File 'lib/grape/endpoint.rb', line 24

def before_each(new_setup = false, &block)
  @before_each ||= []
  if new_setup == false
    return @before_each unless block

    @before_each << block
  else
    @before_each = [new_setup]
  end
end

.generate_api_method(method_name, &block) ⇒ Proc

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Create an UnboundMethod that is appropriate for executing an endpoint route.

The unbound method allows explicit calls to return without raising a LocalJumpError. The method will be removed, but a Proc reference to it will be returned. The returned Proc expects a single argument: the instance of Endpoint to bind to the method during the call.

Raises:

  • (NameError) —

    an instance method with the same name already exists



53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/grape/endpoint.rb', line 53

def generate_api_method(method_name, &block)
  raise NameError.new("method #{method_name.inspect} already exists and cannot be used as an unbound method name") if method_defined?(method_name)

  define_method(method_name, &block)
  method = instance_method(method_name)
  remove_method(method_name)

  proc do |endpoint_instance|
    ActiveSupport::Notifications.instrument('endpoint_render.grape', endpoint: endpoint_instance) do
      method.bind_call(endpoint_instance)
    end
  end
end

.new ⇒ Object 



20
21
22
 
# File 'lib/grape/endpoint.rb', line 20

def new(...)
  self == Endpoint ? Class.new(Endpoint).new(...) : super
end

.run_before_each(endpoint) ⇒ Object 



35
36
37
38
 
# File 'lib/grape/endpoint.rb', line 35

def run_before_each(endpoint)
  superclass.run_before_each(endpoint) unless self == Endpoint
  before_each.each { |blk| blk.try(:call, endpoint) }
end

Instance Method Details

#call(env) ⇒ Object 



217
218
219
220
 
# File 'lib/grape/endpoint.rb', line 217

def call(env)
  lazy_initialize!
  dup.call!(env)
end

#call!(env) ⇒ Object 



222
223
224
225
226
 
# File 'lib/grape/endpoint.rb', line 222

def call!(env)
  env[Grape::Env::API_ENDPOINT] = self
  @env = env
  @app.call(env)
end

#endpoints ⇒ Object

Return the collection of endpoints within this endpoint. This is the case when an Grape::API mounts another Grape::API.



230
231
232
 
# File 'lib/grape/endpoint.rb', line 230

def endpoints
  @endpoints ||= options[:app].try(:endpoints)
end

#equals?(endpoint) ⇒ Boolean 



234
235
236
 
# File 'lib/grape/endpoint.rb', line 234

def equals?(endpoint)
  (options == endpoint.options) && (inheritable_setting.to_hash == endpoint.inheritable_setting.to_hash)
end

#inherit_settings(namespace_stackable) ⇒ Object

Update our settings from a given set of stackable parameters. Used when the endpoint’s API is mounted under another one.



120
121
122
123
124
125
126
127
 
# File 'lib/grape/endpoint.rb', line 120

def inherit_settings(namespace_stackable)
  parent_validations = namespace_stackable[:validations]
  inheritable_setting.route[:saved_validations].concat(parent_validations) if parent_validations.any?
  parent_declared_params = namespace_stackable[:declared_params]
  inheritable_setting.route[:declared_params].concat(parent_declared_params.flatten) if parent_declared_params.any?

  endpoints&.each { |e| e.inherit_settings(namespace_stackable) }
end

#inspect ⇒ Object

The purpose of this override is solely for stripping internals when an error occurs while calling an endpoint through an api. See github.com/ruby-grape/grape/issues/2398 Otherwise, it calls super.



241
242
243
244
245
 
# File 'lib/grape/endpoint.rb', line 241

def inspect
  return super unless env

  "#{self.class} in '#{route.origin}' endpoint"
end

#map_routes ⇒ Object 



203
204
205
 
# File 'lib/grape/endpoint.rb', line 203

def map_routes
  options[:method].map { |method| options[:path].map { |path| yield method, path } }
end

#method_name ⇒ Object 



133
134
135
136
137
138
139
 
# File 'lib/grape/endpoint.rb', line 133

def method_name
  [options[:method],
   Namespace.joined_space(namespace_stackable(:namespace)),
   (namespace_stackable(:mount_path) || []).join('/'),
   options[:path].join('/')]
    .join(' ')
end

#mount_in(router) ⇒ Object 



151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/grape/endpoint.rb', line 151

def mount_in(router)
  return endpoints.each { |e| e.mount_in(router) } if endpoints

  reset_routes!
  routes.each do |route|
    router.append(route.apply(self))
    next unless !namespace_inheritable(:do_not_route_head) && route.request_method == Rack::GET

    route.dup.then do |head_route|
      head_route.convert_to_head_request!
      router.append(head_route.apply(self))
    end
  end
end

#namespace ⇒ Object 



213
214
215
 
# File 'lib/grape/endpoint.rb', line 213

def namespace
  @namespace ||= Namespace.joined_space_path(namespace_stackable(:namespace))
end

#prepare_default_path_settings ⇒ Object 



207
208
209
210
211
 
# File 'lib/grape/endpoint.rb', line 207

def prepare_default_path_settings
  namespace_stackable_hash = inheritable_setting.namespace_stackable.to_hash
  namespace_inheritable_hash = inheritable_setting.namespace_inheritable.to_hash
  namespace_stackable_hash.merge!(namespace_inheritable_hash)
end

#prepare_default_route_attributes ⇒ Object 



184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/grape/endpoint.rb', line 184

def prepare_default_route_attributes
  {
    namespace: namespace,
    version: prepare_version,
    requirements: prepare_routes_requirements,
    prefix: namespace_inheritable(:root_prefix),
    anchor: options[:route_options].fetch(:anchor, true),
    settings: inheritable_setting.route.except(:declared_params, :saved_validations),
    forward_match: options[:forward_match]
  }
end

#prepare_routes_requirements ⇒ Object 



177
178
179
180
181
182
 
# File 'lib/grape/endpoint.rb', line 177

def prepare_routes_requirements
  {}.merge!(*namespace_stackable(:namespace).map(&:requirements)).tap do |requirements|
    endpoint_requirements = options.dig(:route_options, :requirements)
    requirements.merge!(endpoint_requirements) if endpoint_requirements
  end
end

#prepare_version ⇒ Object 



196
197
198
199
200
201
 
# File 'lib/grape/endpoint.rb', line 196

def prepare_version
  version = namespace_inheritable(:version)
  return if version.blank?

  version.length == 1 ? version.first : version
end

#require_option(options, key) ⇒ Object

Raises:



129
130
131
 
# File 'lib/grape/endpoint.rb', line 129

def require_option(options, key)
  raise Grape::Exceptions::MissingOption.new(key) unless options.key?(key)
end

#reset_routes! ⇒ Object 



145
146
147
148
149
 
# File 'lib/grape/endpoint.rb', line 145

def reset_routes!
  endpoints&.each(&:reset_routes!)
  @namespace = nil
  @routes = nil
end

#routes ⇒ Object 



141
142
143
 
# File 'lib/grape/endpoint.rb', line 141

def routes
  @routes ||= endpoints&.collect(&:routes)&.flatten || to_routes
end

#to_routes ⇒ Object 



166
167
168
169
170
171
172
173
174
175
 
# File 'lib/grape/endpoint.rb', line 166

def to_routes
  default_route_options = prepare_default_route_attributes

  map_routes do |method, raw_path|
    prepared_path = Path.new(raw_path, namespace, prepare_default_path_settings)
    params = options[:route_options].present? ? options[:route_options].merge(default_route_options) : default_route_options
    route = Grape::Router::Route.new(method, prepared_path.origin, prepared_path.suffix, params)
    route.apply(self)
  end.flatten
end