Class: V0::SearchClickTrackingController

Inherits:
ApplicationController show all
Includes:
ActionView::Helpers::SanitizeHelper
Defined in:
app/controllers/v0/search_click_tracking_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

#click_params ⇒ Object (private) 



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

def click_params
  params.permit(:url, :query, :position, :module_code, :user_agent)
end

#create ⇒ Object

Sends click tracking data to search.gov analytics, based on the passed url, query, position, client_ip, and user_agent.



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

def create
  response = SearchClickTracking::Service.new(url, query, position, user_agent, module_code).track_click
  if response.success?
    render nothing: true, status: :no_content
  else
    render json: response.body, status: :bad_request
  end
end

#module_code ⇒ String (private)

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

Returns:

  • (String)

See Also:



63
64
65
 
# File 'app/controllers/v0/search_click_tracking_controller.rb', line 63

def module_code
  sanitize click_params['module_code']
end

#position ⇒ String (private)

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

Returns:

  • (String)

See Also:



54
55
56
 
# File 'app/controllers/v0/search_click_tracking_controller.rb', line 54

def position
  sanitize click_params['position']
end

#query ⇒ String (private)

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

Returns:

  • (String)

See Also:



45
46
47
 
# File 'app/controllers/v0/search_click_tracking_controller.rb', line 45

def query
  sanitize click_params['query']
end

#url ⇒ String (private)

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

Returns:

  • (String)

See Also:



36
37
38
 
# File 'app/controllers/v0/search_click_tracking_controller.rb', line 36

def url
  sanitize click_params['url']
end

#user_agent ⇒ String (private)

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

Returns:

  • (String)

See Also:



72
73
74
 
# File 'app/controllers/v0/search_click_tracking_controller.rb', line 72

def user_agent
  sanitize click_params['user_agent']
end