Class: Grape::Endpoint

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

Instance Method Summary collapse

Instance Method Details

#add_definitions_from(models) ⇒ Object 



77
78
79
80
81
 
# File 'lib/grape-swagger/endpoint.rb', line 77

def add_definitions_from(models)
  return if models.nil?

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

#apply_success_codes(route) ⇒ Object 



210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/grape-swagger/endpoint.rb', line 210

def apply_success_codes(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

#consumes_object(route, format) ⇒ Object 



152
153
154
155
156
157
158
 
# File 'lib/grape-swagger/endpoint.rb', line 152

def consumes_object(route, format)
  method = route.request_method.downcase.to_sym
  format = route.settings[:description][:consumes] if route.settings[:description] && route.settings[:description][:consumes]
  mime_types = GrapeSwagger::DocMethods::ProducesConsumes.call(format) if [:post, :put].include?(method)

  mime_types
end

#contact_object(infos) ⇒ Object

contact



56
57
58
59
60
61
62
 
# File 'lib/grape-swagger/endpoint.rb', line 56

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 



6
7
8
9
10
11
12
13
14
15
16
 
# File 'lib/grape-swagger/endpoint.rb', line 6

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::Base.formatters({}).keys if formats.empty?
    content_types = Grape::ContentTypes::CONTENT_TYPES.select { |content_type, _mime_type| formats.include? content_type }.values
  end

  content_types.uniq
end

#description_object(route, markdown) ⇒ Object 



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

def description_object(route, markdown)
  description = route.options[:desc] if route.options.key?(:desc)
  description = route.description if route.description.present?
  description = "# #{description} " if markdown
  description += "\n #{route.options[:detail]}" if route.options.key?(:detail)
  description = markdown.markdown(description.to_s).chomp if markdown

  description
end

#info_object(infos) ⇒ Object

building info object



35
36
37
38
39
40
41
42
43
44
 
# File 'lib/grape-swagger/endpoint.rb', line 35

def info_object(infos)
  {
    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]
  }.delete_if { |_, value| value.blank? }
end

#license_object(infos) ⇒ Object

sub-objects of info object license



48
49
50
51
52
53
 
# File 'lib/grape-swagger/endpoint.rb', line 48

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 



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/grape-swagger/endpoint.rb', line 103

def method_object(route, options, path)
  method = {}
  method[:summary]     = summary_object(route)
  method[:description] = description_object(route, options[:markdown])
  method[:produces]    = produces_object(route, options[:produces] || options[:format])
  method[:consumes]    = consumes_object(route, options[:format])
  method[:parameters]  = params_object(route)
  method[:security]    = security_object(route)
  method[:responses]   = response_object(route, options[:markdown])
  method[:tags]        = route.options.fetch(:tags, tag_object(route))
  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) ⇒ Object 



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/grape-swagger/endpoint.rb', line 160

def params_object(route)
  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, route, @definitions)
  end

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

  parameters
end

#path_and_definition_objects(namespace_routes, options) ⇒ Object

building path and definitions objects



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

def path_and_definition_objects(namespace_routes, options)
  @paths = {}
  @definitions = {}
  namespace_routes.keys.each 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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/grape-swagger/endpoint.rb', line 84

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 



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

def produces_object(route, format)
  mime_types = GrapeSwagger::DocMethods::ProducesConsumes.call(format)

  route_mime_types = [: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, markdown) ⇒ Object 



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

def response_object(route, markdown)
  codes = (route.http_codes || route.options[:failure] || [])

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

  codes.each_with_object({}) do |value, memo|
    memo[value[:code]] = { description: value[:message] }

    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[:code].to_s.start_with?('2')) || value[:model])

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

#security_object(route) ⇒ Object 



119
120
121
 
# File 'lib/grape-swagger/endpoint.rb', line 119

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

#summary_object(route) ⇒ Object 



123
124
125
126
127
128
129
 
# File 'lib/grape-swagger/endpoint.rb', line 123

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



21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/grape-swagger/endpoint.rb', line 21

def swagger_object(target_class, request, options)
  {
    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],
    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]
  }.delete_if { |_, value| value.blank? }
end

#tag_object(route) ⇒ Object 



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

def tag_object(route)
  Array(route.path.split('{')[0].split('/').reject(&:empty?).delete_if { |i| ((i == route.prefix.to_s) || (i == route.version)) }.first)
end