Class: Katello::Api::V2::ApiController

Inherits:
Api::V2::BaseController
  • Object
show all
Includes:
Concerns::Api::ApiController, Foreman::ThreadSession::Cleaner, ErrorHandling, Rendering, Katello::Api::Version2
Defined in:
app/controllers/katello/api/v2/api_controller.rb

Instance Method Summary collapse

Methods included from Rendering

#respond_for_async, #respond_for_bulk_async, #respond_for_create, #respond_for_destroy, #respond_for_index, #respond_for_show, #respond_for_status, #respond_for_update, #respond_with_template, #respond_with_template_collection, #respond_with_template_resource, #try_specific_collection_template, #try_specific_resource_template

Methods included from Katello::Api::Version2

#api_version

Instance Method Details

#full_result_response(collection) ⇒ Object 



39
40
41
42
43
44
45
 
# File 'app/controllers/katello/api/v2/api_controller.rb', line 39

def full_result_response(collection)
  { :results => collection,
    :total => collection.count,
    :page => 1,
    :per_page => collection.count,
    :subtotal => collection.count }
end

#resource_class ⇒ Object 



33
34
35
36
37
 
# File 'app/controllers/katello/api/v2/api_controller.rb', line 33

def resource_class
  @resource_class ||= resource_name.classify.constantize
rescue NameError
  @resource_class ||= "Katello::#{resource_name.classify}".constantize
end

#scoped_search(query, default_sort_by, default_sort_order, options = {}) ⇒ Object 



47
48
49
50
51
52
53
54
55
56
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
 
# File 'app/controllers/katello/api/v2/api_controller.rb', line 47

def scoped_search(query, default_sort_by, default_sort_order, options = {})
  resource = options[:resource_class] || resource_class
  includes = options.fetch(:includes, [])
  group = options.fetch(:group, nil)

  total = query.count
  query = resource.search_for(*search_options).where("#{resource.table_name}.id" => query)

  sub_total = scoped_search_sub_total(query, total, group)

  sort_attr = params[:sort_by] || default_sort_by

  if sort_attr
    sort_order = (params[:sort_order] || default_sort_order).to_s.downcase
    sort_order = default_sort_order unless ['desc', 'asc'].include?(sort_order)
    query = query.order(sort_attr => sort_order.to_sym)
  elsif options[:custom_sort]
    query = options[:custom_sort].call(query)
  end
  query = query.order("#{query.table_name}.id DESC") unless group #secondary order to ensure sort is deterministic
  query = query.includes(includes) if includes.length > 0

  if params[:full_result]
    params[:per_page] = total
  else
    query = query.paginate(paginate_options)
  end
  page = params[:page] || 1
  per_page = params[:per_page] || ::Setting::General.entries_per_page

  query = (total.zero? || sub_total.zero?) ? [] : query

  scoped_search_results(query, sub_total, total, page, per_page)
rescue ScopedSearch::QueryNotSupported => error
  return scoped_search_results(query, sub_total, total, page, per_page, error.message)
end