Class: V0::SearchController

Inherits:
ApplicationController show all
Includes:
ActionView::Helpers::SanitizeHelper
Defined in:
app/controllers/v0/search_controller.rb

Constant Summary

Constants inherited from ApplicationController

ApplicationController::VERSION_STATUS

Constants included from SignIn::Authentication

SignIn::Authentication::BEARER_PATTERN

Constants included from ExceptionHandling

ExceptionHandling::SKIP_SENTRY_EXCEPTION_TYPES

Instance Attribute Summary

Attributes inherited from ApplicationController

#current_user

Instance Method Summary collapse

Methods inherited from ApplicationController

#clear_saved_form, #cors_preflight, #pagination_params, #render_job_id, #routing_error, #set_csrf_header

Methods included from Traceable

#set_trace_tags

Methods included from SentryControllerLogging

#set_tags_and_extra_context, #tags_context, #user_context

Methods included from SentryLogging

#log_exception_to_sentry, #log_message_to_sentry, #non_nil_hash?, #normalize_level, #rails_logger, #set_sentry_metadata

Methods included from Instrumentation

#append_info_to_payload

Methods included from SignIn::Authentication

#access_token, #access_token_authenticate, #authenticate, #authenticate_access_token, #bearer_token, #cookie_access_token, #handle_authenticate_error, #load_user, #load_user_object, #scrub_bearer_token, #validate_request_ip

Methods included from Headers

#set_app_info_headers

Methods included from ExceptionHandling

#render_errors, #report_mapped_exception, #report_original_exception, #skip_sentry_exception?, #skip_sentry_exception_types

Methods included from AuthenticationAndSSOConcerns

#authenticate, #clear_session, #extend_session!, #load_user, #log_sso_info, #render_unauthorized, #reset_session, #set_api_cookie!, #set_current_user, #set_session_expiration_header, #set_session_object, #sign_in_service_exp_time, #sign_in_service_session, #sso_cookie_content, #sso_logging_info, #validate_inbound_login_params, #validate_session

Methods included from SignIn::AudienceValidator

#authenticate, #validate_audience!

Instance Method Details

#index ⇒ Object

Returns a page of search results from the Search.gov API, based on the passed query and page.

Pagination schema follows precedent from other controllers that return pagination. For example, the app/controllers/v0/prescriptions_controller.rb.



18
19
20
21
22
23
 
# File 'app/controllers/v0/search_controller.rb', line 18

def index
  response = search_service.results
  options = { meta: { pagination: response.pagination } }

  render json: SearchSerializer.new(response, options)
end

#page ⇒ String, NilClass (private)

This is the page (number) of results the FE is requesting to have returned.

Returns a sanitized, permitted version of the passed page params. If ‘page’ is not supplied, it returns nil.

Returns:

  • (String)
  • (NilClass)

See Also:



57
58
59
 
# File 'app/controllers/v0/search_controller.rb', line 57

def page
  sanitize search_params['page']
end

#query ⇒ String (private)

Returns a sanitized, permitted version of the passed query params.

Returns:

  • (String)

See Also:



44
45
46
 
# File 'app/controllers/v0/search_controller.rb', line 44

def query
  sanitize search_params['query']
end

#search_params ⇒ Object (private) 



27
28
29
 
# File 'app/controllers/v0/search_controller.rb', line 27

def search_params
  params.permit(:query, :page)
end

#search_service ⇒ Object (private) 



31
32
33
34
35
36
37
 
# File 'app/controllers/v0/search_controller.rb', line 31

def search_service
  @search_service ||= if Flipper.enabled?(:search_use_v2_gsa)
                        SearchGsa::Service.new(query, page)
                      else
                        Search::Service.new(query, page)
                      end
end