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

Inherits:
Api::V2::BaseController
  • Object
show all
Includes:
Concerns::Api::ApiController, Concerns::Api::V2::Authorization, Foreman::Controller::CsvResponder, 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_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

#empty_search_query? ⇒ Boolean

Returns:

  • (Boolean) 


49
50
51
 
# File 'app/controllers/katello/api/v2/api_controller.rb', line 49

def empty_search_query?
  search_options[0].blank?
end

#full_result_response(collection) ⇒ Object 



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

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

#resource_class ⇒ Object 



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

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

rubocop:disable Metrics/CyclomaticComplexity rubocop:disable Metrics/MethodLength rubocop:disable Metrics/AbcSize rubocop:disable Metrics/PerceivedComplexity



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
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
117
118
119
120
121
122
123
124
125
126
127
 
# File 'app/controllers/katello/api/v2/api_controller.rb', line 57

def scoped_search(query, default_sort_by, default_sort_order, options = {})
  params[:sort_by] ||= default_sort_by
  params[:sort_order] ||= default_sort_order

  resource = options[:resource_class] || resource_class
  includes = options.fetch(:includes, [])
  group = options.fetch(:group, nil)
  params[:full_result] = true if options[:csv]
  blank_query = resource.none

  if params[:order]
    (params[:sort_by], params[:sort_order]) = params[:order].split(' ')
  else
    params[:order] = "#{params[:sort_by]} #{params[:sort_order]}"
  end

  total = scoped_search_total(query, group)
  # If you get an ArgumentError here (wrong number of arguments given)
  # it's probably because query is an array and not an ActiveRecord::Relation
  query = query.select(:id) if query.respond_to?(:select)
  query = resource.search_for(*search_options).where("#{resource.table_name}.id" => query)

  query = self.final_custom_index_relation(query) if self.respond_to?(:final_custom_index_relation)

  query = query.select(group).group(group) if group
  subtotal = total.zero? ? 0 : scoped_search_total(query, group)
  selectable = total.zero? ? 0 : scoped_search_total_selectable(query, group)

  if 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 options[:select].present? # used in /packages/thindex
    query = query.select(options[:select])
    dist_total = ActiveRecord::Base.connection.execute("SELECT COUNT(*) FROM (#{query.to_sql}) AS result_rows").first['count']
    total = dist_total
    subtotal = dist_total
    selectable = dist_total
  end
  if ::Foreman::Cast.to_bool(params[:full_result])
    params[:per_page] = total
  else
    query = query.paginate(paginate_options)
  end
  page = metadata_page # from Foreman Api::V2::BaseController
  per_page = metadata_per_page
  query = (total.zero? || subtotal.zero?) ? blank_query : query

  if options[:csv]
    query
  else
    scoped_search_results(
      query: query,
      subtotal: subtotal,
      total: total,
      page: page,
      per_page: per_page,
      selectable: selectable
    )
  end
rescue ScopedSearch::QueryNotSupported, ActiveRecord::StatementInvalid => error
  message = error.message
  if error.instance_of? ActiveRecord::StatementInvalid
    Rails.logger.error("Invalid search: #{error.message}")
    message = _('Your search query was invalid. Please revise it and try again. The full error has been sent to the application logs.')
  end

  scoped_search_results(query: blank_query, page: page, per_page: per_page, error: message)
end

#skip_session ⇒ Object 



129
130
131
 
# File 'app/controllers/katello/api/v2/api_controller.rb', line 129

def skip_session
  request.session_options[:skip] = true
end