Class: IntrospectiveGrape::API

Inherits:
Grape::API::Instance
  • Object
show all
Extended by:
CreateHelpers, Doc, Filters, Helpers, SnakeParams, Traversal
Includes:
Grape::Kaminari
Defined in:
lib/introspective_grape/api.rb

Overview

rubocop:disable Metrics/ClassLength

Constant Summary collapse

PLURAL_REFLECTIONS = 
[ActiveRecord::Reflection::HasManyReflection, ActiveRecord::Reflection::HasManyReflection].freeze
PG2RUBY =

mapping of activerecord/postgres ‘type’s to ruby data classes, where they differ

{ datetime: DateTime }.freeze

Constants included from Helpers

Helpers::API_ACTIONS

Class Method Summary collapse

Methods included from Helpers

all_or_none, authentication_method, authentication_method=, default_includes, exclude_actions, include_actions, paginate, pagination, skip_presence_validations, whitelist

Methods included from CreateHelpers

add_new_records_to_root_record, create_new_record

Methods included from Filters

apply_filter_params, apply_filters, apply_simple_filter, custom_filter, custom_filters, declare_filter_params, declare_simple_filter, default_sort, filter_doc, filter_on, filters, humanize_date_range, identifier_filter?, simple_filters, special_filter_enabled?, timestamp_filter

Methods included from Traversal

find_leaf, find_leaves, verify_record_found, verify_records_found

Methods included from Doc

create_documentation, destroy_documentation, index_documentation, show_documentation, update_documentation

Methods included from SnakeParams

snake_params_before_validation

Class Method Details

.add_destroy_param(dsl, model, reflection, action) ⇒ Object 



442
443
444
445
446
447
448
449
450
451
 
# File 'lib/introspective_grape/api.rb', line 442

def add_destroy_param(dsl, model, reflection, action)
  return if action == :create

  raise "#{model} does not accept nested attributes for #{reflection}" unless model.nested_attributes_options[reflection.to_sym]

  return unless model.nested_attributes_options[reflection.to_sym][:allow_destroy]

  # If destruction is allowed append the _destroy field
  dsl.optional '_destroy', type: Integer
end

.build_nested_attributes(routes, hash) ⇒ Object 



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/introspective_grape/api.rb', line 299

def build_nested_attributes(routes, hash)
  # Recursively re-express the flat attributes hash from nested routes as nested
  # attributes that can be used to perform an update on the root model.

  # do nothing if the params are already nested.
  return {} if routes.blank? || hash[routes.first.param]

  route  = routes.shift
  # change 'x_id' to 'x_attributes': { id: id, y_attributes: {} }
  id      = hash.delete route.key
  attributes = id ? { id: id } : {}

  attributes.merge!( hash ) if routes.blank? # assign param values to the last reference

  if route.many? # nest it in an array if it is a has_many association
    { route.param => [attributes.merge( build_nested_attributes(routes, hash) )] }
  else
    { route.param => attributes.merge( build_nested_attributes(routes, hash) ) }
  end
end

.build_routes(routes, model, reflection_name = nil) ⇒ Object 



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/introspective_grape/api.rb', line 272

def build_routes(routes, model, reflection_name=nil)
  routes = routes.clone
  # routes: the existing routes array passed from the parent
  # model:  the model being manipulated in this leaf
  # reflection_name: the association name from the original strong_params declaration
  #
  # Constructs an array representation of the route's models and their associations,
  # a /root/:rootId/branch/:branchId/leaf/:leafId path would have flat array like
  # [root, branch, leaf] representing the path structure and its models, used to
  # manipulate ActiveRecord relationships and params hashes and so on.
  parent_model = routes.last&.model
  return routes if model == parent_model

  name        = reflection_name || model.name.underscore
  reflection  = parent_model&.reflections&.fetch(reflection_name)
  swagger_key = IntrospectiveGrape.config.camelize_parameters ? "#{name.singularize.camelize(:lower)}Id" : "#{name.singularize}_id"

  routes.push OpenStruct.new(klass: self, name: name, param: "#{name}_attributes", model: model,
                             many?: plural?(parent_model, reflection),
                             key: "#{name.singularize}_id".to_sym,
                             swagger_key: swagger_key, reflection: reflection)
end

.check_model_for_type(model, field) ⇒ Object 



421
422
423
 
# File 'lib/introspective_grape/api.rb', line 421

def check_model_for_type(model, field)
  (model.try(:grape_param_types) || {}).with_indifferent_access[field]
end

.convert_nested_params_hash(dsl, routes) ⇒ Object 



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/introspective_grape/api.rb', line 224

def convert_nested_params_hash(dsl, routes)
  root  = routes.first
  klass = self
  dsl.after_validation do
    next unless params[root.key] # there was no one, nothing to see

    # After Grape validates its parameters:
    # 1) Find the root model instance for the API if its passed (implicitly either
    #    an update/destroy on the root node or it's a nested route
    # 2) For nested endpoints convert the params hash into Rails-compliant nested
    #    attributes, to be passed to the root instance for update. This keeps
    #    behavior consistent between bulk and single record updates.
    @model = root.model.includes( root.klass.default_includes(root.model) ).find(params[root.key])
    @params.merge!( klass.merge_nested_params(routes, params) )
  end
end

.db_type_constant(db_type) ⇒ Object 



425
426
427
428
429
430
431
 
# File 'lib/introspective_grape/api.rb', line 425

def db_type_constant(db_type)
  begin
    db_type.to_s.camelize.constantize
  rescue StandardError
    nil
  end
end

.define_create(dsl, routes, model, api_params) ⇒ Object 



173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/introspective_grape/api.rb', line 173

def define_create(dsl, routes, model, api_params)
  name  = routes.last.name.singularize
  klass = routes.first.klass
  dsl.desc "create a #{name}" do
    detail klass.create_documentation(name)
  end
  dsl.params do
    klass.generate_params(self, :create, model, api_params, true)
  end
  dsl.post do
    representation = @model ? klass.add_new_records_to_root_record(self, routes, params, @model) : klass.create_new_record(self, routes, params)
    present representation, with: "#{klass}::#{model}Entity".constantize
  end
end

.define_destroy(dsl, routes, _model, _api_params) ⇒ Object

rubocop:enable Metrics/AbcSize



212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/introspective_grape/api.rb', line 212

def define_destroy(dsl, routes, _model, _api_params)
  klass = routes.first.klass
  name = routes.last.name.singularize
  dsl.desc "destroy a #{name}" do
    detail klass.destroy_documentation(name)
  end
  dsl.delete ":#{routes.last.swagger_key}" do
    authorize @model, :destroy?
    present status: (klass.find_leaf(routes, @model, params).destroy ? true : false)
  end
end

.define_endpoints(routes, api_params) ⇒ Object 



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/introspective_grape/api.rb', line 253

def define_endpoints(routes, api_params)
  # De-reference these as local variables from their class scope, or when we make
  # calls to the API they will be whatever they were last set to by the recursive
  # calls to "nest_routes".
  routes     = routes.clone
  api_params = api_params.clone
  model      = routes.last.model || return

  # We define the param keys for ID fields in camelcase for swagger's URL substitution,
  # they'll come back in snake case in the params hash, the API as a whole is agnostic:
  namespace = routes[0..-2].map {|p| "#{p.name.pluralize}/:#{p.swagger_key}/" }.join + routes.last.name.pluralize

  klass      = self # the 'resource' block changes the context to the Grape::API::Instance...
  resource namespace do
    klass.convert_nested_params_hash(self, routes)
    klass.define_restful_api(self, routes, model, api_params)
  end
end

.define_index(dsl, routes, model, api_params) ⇒ Object 



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
 
# File 'lib/introspective_grape/api.rb', line 133

def define_index(dsl, routes, model, api_params)
  root  = routes.first
  klass = routes.first.klass
  name  = routes.last.name.pluralize
  simple_filters(klass, model, api_params)

  dsl.desc "list #{name}" do
    detail klass.index_documentation(name)
  end
  dsl.params do
    klass.declare_filter_params(self, klass, model, api_params)
    use :pagination, per_page: klass.pagination[:per_page]||25, max_per_page: klass.pagination[:max_per_page], offset: klass.pagination[:offset]||0 if klass.pagination
  end
  dsl.get '/' do
    # Invoke the policy for the action, defined in the policy classes for the model:
    authorize root.model.new, :index?

    # Nested route indexes need to be scoped by the API's top level policy class:
    records = policy_scope( root.model.includes(klass.default_includes(root.model)) )
    records = klass.apply_filter_params(klass, model, api_params, params, records)
    records = records.map {|r| klass.find_leaves( routes, r, params ) }.flatten.compact.uniq

    # paginate the records using Kaminari
    records = paginate(Kaminari.paginate_array(records)) if klass.pagination
    present records, with: "#{klass}::#{model}Entity".constantize
  end
end

.define_restful_api(dsl, routes, model, api_params) ⇒ Object 



246
247
248
249
250
251
 
# File 'lib/introspective_grape/api.rb', line 246

def define_restful_api(dsl, routes, model, api_params)
  # declare index, show, update, create, and destroy methods:
  API_ACTIONS.each do |action|
    send("define_#{action}", dsl, routes, model, api_params) unless exclude_actions(model).include?(action)
  end
end

.define_routes(routes, api_params) ⇒ Object 



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/introspective_grape/api.rb', line 111

def define_routes(routes, api_params)
  define_endpoints(routes, api_params)
  # recursively define endpoints
  model = routes.last.model || return

  api_params.select {|a| a.is_a?(Hash) }.each do |nested|
    # Recursively add RESTful nested routes for every nested model:
    nested.each do |r, fields|
      # Look at model.reflections to find the association's class name:
      reflection_name = r.to_s.sub(/_attributes$/, '')
      begin
        relation = model.reflections[reflection_name].class_name.constantize
      rescue StandardError
        Rails.logger.fatal "Can't find associated model for #{r} on #{model}"
      end

      next_routes = build_routes(routes, relation, reflection_name)
      define_routes(next_routes, fields)
    end
  end
end

.define_show(dsl, routes, model, _api_params) ⇒ Object 



161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/introspective_grape/api.rb', line 161

def define_show(dsl, routes, model, _api_params)
  name  = routes.last.name.singularize
  klass = routes.first.klass
  dsl.desc "retrieve a #{name}" do
    detail klass.show_documentation(name)
  end
  dsl.get ":#{routes.last.swagger_key}" do
    authorize @model, :show?
    present klass.find_leaf(routes, @model, params), with: "#{klass}::#{model}Entity".constantize
  end
end

.define_update(dsl, routes, model, api_params) ⇒ Object 



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/introspective_grape/api.rb', line 188

def define_update(dsl, routes, model, api_params)
  klass = routes.first.klass
  name  = routes.last.name.singularize
  dsl.desc "update a #{name}" do
    detail klass.update_documentation(name)
  end
  dsl.params do
    klass.generate_params(self, :update, model, api_params, true)
  end
  dsl.put ":#{routes.last.swagger_key}" do
    authorize @model, :update?

    @model.update_attributes!( safe_params(params).permit(klass.whitelist) )

    if IntrospectiveGrape.config.skip_object_reload
      present klass.find_leaf(routes, @model, params), with: "#{klass}::#{model}Entity".constantize
    else
      default_includes = routes.first.klass.default_includes(routes.first.model)
      present klass.find_leaf(routes, @model.class.includes(default_includes).find(@model.id), params), with: "#{klass}::#{model}Entity".constantize
    end
  end
end

.file_attachment?(model, field) ⇒ Boolean

Returns:

  • (Boolean) 


397
398
399
400
401
 
# File 'lib/introspective_grape/api.rb', line 397

def file_attachment?(model, field)
  (model.respond_to?(:uploaders) && model.uploaders[field.to_sym]) || # carrierwave
    (model.respond_to?(:attachment_definitions) && model.attachment_definitions[field.to_sym]) ||
    (defined?(Paperclip::Attachment) && model.send(:new).try(field).is_a?(Paperclip::Attachment))
end

.find_relation(model, reflection) ⇒ Object 



389
390
391
392
393
394
395
 
# File 'lib/introspective_grape/api.rb', line 389

def find_relation(model, reflection)
  begin
    model.reflections[reflection].class_name.constantize
  rescue StandardError
    model
  end
end

.generate_nested_params(dsl, action, model, fields) ⇒ Object 



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/introspective_grape/api.rb', line 354

def generate_nested_params(dsl, action, model, fields)
  klass = self
  fields.each do |r, v|
    # Look at model.reflections to find the association's class name:
    reflection = r.to_s.sub(/_attributes$/, '') # the reflection name
    relation   = find_relation(model, reflection)

    if file_attachment?(model, r)
      # Handle Carrierwave file upload fields
      s = i(filename type name tempfile head) - v
      Rails.logger.warn "Missing required file upload parameters #{s} for uploader field #{r}" if s.present?
    elsif plural_reflection?(model, reflection)
      # In case you need a refresher on how these work:
      # http://api.rubyonrails.org/classes/ActiveRecord/NestedAttributes/ClassMethods.html
      dsl.optional r, type: Array do |dl|
        klass.generate_params(dl, action, relation, v)
        klass.add_destroy_param(dl, model, reflection, action)
      end
    else
      # TODO: handle any remaining correctly. Presently defaults to a Hash
      # http://www.rubydoc.info/github/rails/rails/ActiveRecord/Reflection
      # ThroughReflection, HasOneReflection,
      # HasAndBelongsToManyReflection, BelongsToReflection
      dsl.optional r, type: Hash do |dl|
        klass.generate_params(dl, action, relation, v)
        klass.add_destroy_param(dl, model, reflection, action)
      end
    end
  end
end

.generate_params(dsl, action, model, fields, is_root_endpoint = false) ⇒ Object 



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/introspective_grape/api.rb', line 320

def generate_params(dsl, action, model, fields, is_root_endpoint=false)
  # We'll be doing a recursive walk (to handle nested attributes) down the
  # whitelisted params, generating the Grape param definitions by introspecting
  # on the model and its associations.
  raise "Invalid action: #{action}" unless i(update create).include?(action)

  # dsl   : The Grape::Validations::ParamsScope object
  # action: create or update
  # model : The ActiveRecord model class
  # fields: The whitelisted data structure for Rails' strong params, from which we
  #         infer Grape's parameters

  # skip the ID param at the root level endpoint, so we don't duplicate the URL parameter (api/v#/model/modelId)
  fields -= [:id] if is_root_endpoint

  fields.each do |field|
    if field.is_a?(Hash)
      generate_nested_params(dsl, action, model, field)
    elsif action == :create && param_required?(model, field)
      # All params are optional on an update, only require them during creation.
      # Updating a record with new child models will have to rely on ActiveRecord
      # validations:
      dsl.requires field, { type: param_type(model, field) }.merge( validations(model, field) )
    else
      # dsl.optional field, *options
      dsl.optional field, { type: param_type(model, field) }.merge( validations(model, field) )
    end
  end
end

.inherited(child) ⇒ Object 



59
60
61
62
63
64
65
66
67
 
# File 'lib/introspective_grape/api.rb', line 59

def inherited(child)
  super(child)
  child.before do
    # Ensure that a user is logged in.
    send(IntrospectiveGrape::API.authentication_method(self))
  end

  child.snake_params_before_validation if IntrospectiveGrape.config.camelize_parameters
end

.merge_nested_params(routes, params) ⇒ Object 



241
242
243
244
 
# File 'lib/introspective_grape/api.rb', line 241

def merge_nested_params(routes, params)
  attr = params.reject {|k| [routes.first.key, :api_key].include?(k) }
  build_nested_attributes(routes[1..-1], attr)
end

.param_required?(model, field) ⇒ Boolean

Returns:

  • (Boolean) 


433
434
435
436
437
438
439
440
 
# File 'lib/introspective_grape/api.rb', line 433

def param_required?(model, field)
  # Detect if the field is a required field for the create action
  return false if skip_presence_validations.include?(field)

  validated_field = field.match?(/_id/) ? field.to_s.sub(/_id\z/, '').to_sym : field.to_sym

  model.validators_on(validated_field).any? {|v| v.is_a? ActiveRecord::Validations::PresenceValidator }
end

.param_type(model, field) ⇒ Object 



403
404
405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/introspective_grape/api.rb', line 403

def param_type(model, field)
  # Translate from the AR type to the GrapeParam types
  field   = field.to_s
  db_type = (model&.try(:columns_hash) || {})[field]&.type

  # Check if it's a file attachment, look for an override class from the model,
  # check PG2RUBY, use the database type, or fail over to a String:
  uploaded_file?(model, field)           ||
    check_model_for_type(model, field)   ||
    PG2RUBY[db_type]                     ||
    db_type_constant(db_type)            ||
    String # default to String if nothing else works
end

.plural?(model, reflection) ⇒ Boolean

Returns:

  • (Boolean) 


295
296
297
 
# File 'lib/introspective_grape/api.rb', line 295

def plural?(model, reflection)
  (model && PLURAL_REFLECTIONS.include?(reflection.class))
end

.plural_reflection?(model, reflection) ⇒ Boolean

Returns:

  • (Boolean) 


385
386
387
 
# File 'lib/introspective_grape/api.rb', line 385

def plural_reflection?(model, reflection)
  PLURAL_REFLECTIONS.include?( model.reflections[reflection].class )
end

.restful(model, strong_params = [], routes = []) ⇒ Object

rubocop:disable Metrics/AbcSize

Raises:



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
 
# File 'lib/introspective_grape/api.rb', line 76

def restful(model, strong_params=[], routes=[])
  raise IntrospectiveGrapeError.new("#{model.name}'s attribute_param_types class method needs to be changed to grape_param_types") if model.respond_to?(:attribute_param_types)

  # Recursively define endpoints for the model and any nested models.
  #
  # model: the model class for the API
  # whitelist: a list of fields in Rail's strong params structure, also used to
  #            generate grape's permitted params.
  # routes: An array of OpenStruct representations of a nested route's ancestors
  #

  # Defining the api will break pending migrations during db:migrate, so bail:
  begin ActiveRecord::Migration.check_pending! rescue return end

  # normalize the whitelist to symbols
  strong_params.map! {|f| f.is_a?(String) ? f.to_sym : f }
  # default to a flat representation of the model's attributes if left unspecified
  strong_params = strong_params.blank? ? model.attribute_names.map(&:to_sym) - i(id updated_at created_at) : strong_params

  # The strong params will be the same for all routes, differing from the Grape params
  # when routes are nested
  whitelist = whitelist( strong_params )

  # As routes are nested keep track of the routes, we are preventing siblings from
  # appending to the routes array here:
  routes = build_routes(routes, model)
  define_routes(routes, whitelist)

  # Top level declaration of the Grape::API namespace for the resource:
  resource routes.first.name.pluralize do
    # yield to append additional routes under the root namespace
    yield if block_given?
  end
end

.uploaded_file?(model, field) ⇒ Boolean

Returns:

  • (Boolean) 


417
418
419
 
# File 'lib/introspective_grape/api.rb', line 417

def uploaded_file?(model, field)
  file_attachment?(model, field) && Rack::Multipart::UploadedFile
end

.validations(model, field) ⇒ Object 



350
351
352
 
# File 'lib/introspective_grape/api.rb', line 350

def validations(model, field)
  (model.try(:grape_validations) || {}).with_indifferent_access[field] || {}
end