Class: Grape::Endpoint

Inherits:
Object
  • Object
show all
Defined in:
lib/grape-swagger/endpoint.rb

Constant Summary collapse

SUPPORTS_CONSUMES = 
%i[post put patch].freeze

Instance Method Summary collapse

Instance Method Details

#add_definitions_from(models) ⇒ Object 



89
90
91
92
93
 
# File 'lib/grape-swagger/endpoint.rb', line 89

def add_definitions_from(models)
  return if models.nil?

  models.each { |x| expose_params_from_model(x) }
end

#consumes_object(route, format) ⇒ Object 



167
168
169
170
 
# File 'lib/grape-swagger/endpoint.rb', line 167

def consumes_object(route, format)
  return unless SUPPORTS_CONSUMES.include?(route.request_method.downcase.to_sym)
  GrapeSwagger::DocMethods::ProducesConsumes.call(route.settings.dig(:description, :consumes) || format)
end

#contact_object(infos) ⇒ Object

contact



68
69
70
71
72
73
74
 
# File 'lib/grape-swagger/endpoint.rb', line 68

def contact_object(infos)
  {
    name: infos.delete(:contact_name),
    email: infos.delete(:contact_email),
    url: infos.delete(:contact_url)
  }.delete_if { |_, value| value.blank? }
end

#content_types_for(target_class) ⇒ Object 



8
9
10
11
12
13
14
15
16
17
18
19
20
 
# File 'lib/grape-swagger/endpoint.rb', line 8

def content_types_for(target_class)
  content_types = (target_class.content_types || {}).values

  if content_types.empty?
    formats       = [target_class.format, target_class.default_format].compact.uniq
    formats       = Grape::Formatter.formatters({}).keys if formats.empty?
    content_types = Grape::ContentTypes::CONTENT_TYPES.select do |content_type, _mime_type|
      formats.include? content_type
    end.values
  end

  content_types.uniq
end

#description_object(route) ⇒ Object 



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

def description_object(route)
  description = route.description if route.description.present?
  description = route.options[:detail] if route.options.key?(:detail)
  description ||= ''

  description
end

#http_codes_from_route(route) ⇒ Object 



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

def http_codes_from_route(route)
  if route.http_codes.is_a?(Array) && route.http_codes.any? { |code| code[:code].between?(200, 299) }
    route.http_codes.clone
  else
    success_codes_from_route(route) + (route.http_codes || route.options[:failure] || [])
  end
end

#info_object(infos) ⇒ Object

building info object



43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/grape-swagger/endpoint.rb', line 43

def info_object(infos)
  result = {
    title:             infos[:title] || 'API title',
    description:       infos[:description],
    termsOfServiceUrl: infos[:terms_of_service_url],
    contact:           contact_object(infos),
    license:           license_object(infos),
    version:           infos[:version]
  }

  GrapeSwagger::DocMethods::Extensions.add_extensions_to_info(infos, result)

  result.delete_if { |_, value| value.blank? }
end

#license_object(infos) ⇒ Object

sub-objects of info object license



60
61
62
63
64
65
 
# File 'lib/grape-swagger/endpoint.rb', line 60

def license_object(infos)
  {
    name: infos.delete(:license),
    url:  infos.delete(:license_url)
  }.delete_if { |_, value| value.blank? }
end

#method_object(route, options, path) ⇒ Object 



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/grape-swagger/endpoint.rb', line 115

def method_object(route, options, path)
  method = {}
  method[:summary]     = summary_object(route)
  method[:description] = description_object(route)
  method[:produces]    = produces_object(route, options[:produces] || options[:format])
  method[:consumes]    = consumes_object(route, options[:format])
  method[:parameters]  = params_object(route, path)
  method[:security]    = security_object(route)
  method[:responses]   = response_object(route)
  method[:tags]        = route.options.fetch(:tags, tag_object(route, path))
  method[:operationId] = GrapeSwagger::DocMethods::OperationId.build(route, path)
  method.delete_if { |_, value| value.blank? }

  [route.request_method.downcase.to_sym, method]
end

#params_object(route, path) ⇒ Object 



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/grape-swagger/endpoint.rb', line 172

def params_object(route, path)
  parameters = partition_params(route).map do |param, value|
    value = { required: false }.merge(value) if value.is_a?(Hash)
    _, value = default_type([[param, value]]).first if value == ''
    if value[:type]
      expose_params(value[:type])
    elsif value[:documentation]
      expose_params(value[:documentation][:type])
    end
    GrapeSwagger::DocMethods::ParseParams.call(param, value, path, route, @definitions)
  end

  if GrapeSwagger::DocMethods::MoveParams.can_be_moved?(parameters, route.request_method)
    parameters = GrapeSwagger::DocMethods::MoveParams.to_definition(path, parameters, route, @definitions)
  end

  parameters
end

#path_and_definition_objects(namespace_routes, options) ⇒ Object

building path and definitions objects



77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/grape-swagger/endpoint.rb', line 77

def path_and_definition_objects(namespace_routes, options)
  @paths = {}
  @definitions = {}
  namespace_routes.each_key do |key|
    routes = namespace_routes[key]
    path_item(routes, options)
  end

  add_definitions_from options[:models]
  [@paths, @definitions]
end

#path_item(routes, options) ⇒ Object

path object



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/grape-swagger/endpoint.rb', line 96

def path_item(routes, options)
  routes.each do |route|
    next if hidden?(route, options)

    @item, path = GrapeSwagger::DocMethods::PathString.build(route, options)
    @entity = route.entity || route.options[:success]

    verb, method_object = method_object(route, options, path)

    if @paths.key?(path.to_s)
      @paths[path.to_s][verb] = method_object
    else
      @paths[path.to_s] = { verb => method_object }
    end

    GrapeSwagger::DocMethods::Extensions.add(@paths[path.to_s], @definitions, route)
  end
end

#produces_object(route, format) ⇒ Object 



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

def produces_object(route, format)
  return ['application/octet-stream'] if file_response?(route.attributes.success) &&
                                         !route.attributes.produces.present?

  mime_types = GrapeSwagger::DocMethods::ProducesConsumes.call(format)

  route_mime_types = %i[formats content_types produces].map do |producer|
    possible = route.options[producer]
    GrapeSwagger::DocMethods::ProducesConsumes.call(possible) if possible.present?
  end.flatten.compact.uniq

  route_mime_types.present? ? route_mime_types : mime_types
end

#response_object(route) ⇒ Object 



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

def response_object(route)
  codes = http_codes_from_route(route)
  codes.map! { |x| x.is_a?(Array) ? { code: x[0], message: x[1], model: x[2] } : x }

  codes.each_with_object({}) do |value, memo|
    value[:message] ||= ''
    memo[value[:code]] = { description: value[:message] }
    next build_file_response(memo[value[:code]]) if file_response?(value[:model])

    response_model = @item
    response_model = expose_params_from_model(value[:model]) if value[:model]

    if memo.key?(200) && route.request_method == 'DELETE' && value[:model].nil?
      memo[204] = memo.delete(200)
      value[:code] = 204
    end

    next if memo.key?(204)
    next unless !response_model.start_with?('Swagger_doc') && (@definitions[response_model] || value[:model])

    @definitions[response_model][:description] = description_object(route)
    # TODO: proof that the definition exist, if model isn't specified
    reference = { '$ref' => "#/definitions/#{response_model}" }
    memo[value[:code]][:schema] = if route.options[:is_array] && value[:code] < 300
                                    { type: 'array', items: reference }
                                  else
                                    reference
                                  end
  end
end

#security_object(route) ⇒ Object 



131
132
133
 
# File 'lib/grape-swagger/endpoint.rb', line 131

def security_object(route)
  route.options[:security] if route.options.key?(:security)
end

#success_codes_from_route(route) ⇒ Object 



230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/grape-swagger/endpoint.rb', line 230

def success_codes_from_route(route)
  default_code = GrapeSwagger::DocMethods::StatusCodes.get[route.request_method.downcase.to_sym]
  if @entity.is_a?(Hash)
    default_code[:code] = @entity[:code] if @entity[:code].present?
    default_code[:model] = @entity[:model] if @entity[:model].present?
    default_code[:message] = @entity[:message] || route.description || default_code[:message].sub('{item}', @item)
  else
    default_code = GrapeSwagger::DocMethods::StatusCodes.get[route.request_method.downcase.to_sym]
    default_code[:model] = @entity if @entity
    default_code[:message] = route.description || default_code[:message].sub('{item}', @item)
  end

  [default_code]
end

#summary_object(route) ⇒ Object 



135
136
137
138
139
140
141
 
# File 'lib/grape-swagger/endpoint.rb', line 135

def summary_object(route)
  summary = route.options[:desc] if route.options.key?(:desc)
  summary = route.description if route.description.present?
  summary = route.options[:summary] if route.options.key?(:summary)

  summary
end

#swagger_object(target_class, request, options) ⇒ Object

swagger spec2.0 related parts

required keys for SwaggerObject



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/grape-swagger/endpoint.rb', line 25

def swagger_object(target_class, request, options)
  object = {
    info:                info_object(options[:info].merge(version: options[:doc_version])),
    swagger:             '2.0',
    produces:            content_types_for(target_class),
    authorizations:      options[:authorizations],
    securityDefinitions: options[:security_definitions],
    security:            options[:security],
    host:                GrapeSwagger::DocMethods::OptionalObject.build(:host, options, request),
    basePath:            GrapeSwagger::DocMethods::OptionalObject.build(:base_path, options, request),
    schemes:             options[:schemes].is_a?(String) ? [options[:schemes]] : options[:schemes]
  }

  GrapeSwagger::DocMethods::Extensions.add_extensions_to_root(options, object)
  object.delete_if { |_, value| value.blank? }
end

#tag_object(route, path) ⇒ Object 



245
246
247
248
249
250
251
252
253
 
# File 'lib/grape-swagger/endpoint.rb', line 245

def tag_object(route, path)
  version = GrapeSwagger::DocMethods::Version.get(route)
  version = [version] unless version.is_a?(Array)
  Array(
    path.split('{')[0].split('/').reject(&:empty?).delete_if do |i|
      i == route.prefix.to_s || version.map(&:to_s).include?(i)
    end.first
  )
end