Class: Www::CustomerTopicsController

Inherits:
BasePortalController show all
Includes:
Controllers::Paginateable
Defined in:
app/controllers/www/customer_topics_controller.rb

Overview

Controller: customer topics.

Constant Summary

Constants included from Controllers::MasqueradeGuarded

Controllers::MasqueradeGuarded::DEFAULT_BLOCK_MESSAGE

Constants included from Controllers::AnalyticsEvents

Controllers::AnalyticsEvents::MAX_QUEUED_EVENTS, Controllers::AnalyticsEvents::SESSION_KEY

Constants included from Controllers::ErrorRendering

Controllers::ErrorRendering::NON_CONTENT_PATH_PREFIXES

Instance Method Summary collapse

Methods inherited from BasePortalController

#current_ability, #portal_party, #set_catalog, #set_webpack

Methods included from Controllers::MasqueradeGuarded

block_while_masquerading, #masquerade_blocks?

Methods inherited from ApplicationController

#account_impersonated?, #add_to_flash, #after_sign_in_path_for, #bypass_forgery_protection?, #chat_enabled?, #cloudflare_cleared?, #default_catalog, #default_url_options, #enable_turbo_frames, #find_publication, #fix_invalid_accept_header, #init_js_utils, #is_globals_call?, #layout_by_resource, #locale_store, #redirect_to, #require_employee_for_crm, #set_base_host, #set_real_ip, #set_report_errors_for, #should_render_layout?, #skip_layout_for_turbo_frame?, #stamp_impersonation_context, #tab_frame_breakout_request?, #warmlyyours_canada_ip?, #warmlyyours_ip?, #y

Methods included from Controllers::ReturnPathHandling

#check_for_return_path, #redirect_to_return_path_or_default

Methods included from Controllers::AnalyticsEvents

#consume_queued_analytics_events, #registration_lead_type, #track_event

Methods included from Controllers::DeviceDetection

#device_detector, #is_ie?

Methods included from Controllers::SubdomainDetection

#is_crm_request?, #is_www_request?, #json_request?

Methods included from Controllers::TurboSafeRedirect

#redirect_to

Methods included from Controllers::TrackingDetection

#bot_request?, #gdpr_country?, #gdpr_country_data, #prevent_bots, #set_tracking_cookie, #track_visitor?

Methods included from Controllers::AcceleratedFileSending

#send_file_accelerated, #send_upload_accelerated

Methods included from Controllers::ErrorRendering

#excp_string, #mail_to_for_error_reporting, #render_400, #render_404, #render_406, #render_410, #render_500, #render_invalid_authenticity_token, #render_ip_spoof_error, #render_unpermitted_parameters, #safe_referer_or_fallback

Methods included from Controllers::TurnstileVerification

#load_turnstile_script_tag, #turnstile_lazy_widget, #turnstile_script_tag, #turnstile_widget, #validate_turnstile!

Methods included from Controllers::CloudflareCaching

edge_cached, #edge_cached_action?, #reset_cloudflare_cache, #set_cloudflare_cache, #skip_edge_cache!, #skip_session

Methods included from Controllers::Webpackable

#preload_webpack_fonts, #webpack_css_include, #webpack_css_url, #webpack_js_include, #wpd_is_running?

Methods included from Controllers::Localizable

#cloudflare_country_locale, #determine_request_locale, #geocoder_locale, #guest_user_locale_check, #locale_optional_www_auth_path?, #param_locale, #set_locale, #set_request_locale, #skip_localization?, #warmlyyours_ip_locale

Methods included from Controllers::Authenticable

#access_denied, #authenticate_account, #authenticate_account!, #authenticate_account_from_login_token!, #check_is_a_manager, #check_is_a_sales_manager, #check_is_an_admin, #check_is_an_employee, #check_party, #clear_mismatched_guest_user, #create_guest_user, #credentials?, #current_or_guest_user, #current_or_guest_user_id_read_only, #current_user, #devise_mapping, #fully_logged_in?, #generate_bot_id, #guest_user, #identifiable?, #init_current_user, #initialize_guest, #load_context_user, #logging_in, #resource, #resource_name, #restrict_access_for_non_employees, #scrubbed_request_path, #user_object, #warn_on_session_guest_id_leak

Methods included from UrlsHelper

#catalog_breadcrumb_links, #catalog_link, #catalog_link_for_product_line, #catalog_link_for_sku, #cms_link, #delocalized_path, #path_to_sales_product_sku, #path_to_sales_product_sku_for_product_line, #path_to_sales_product_sku_for_product_line_slug, #product_line_from_catalog_link, #protocol_neutral_url, #sanitize_external_url, #valid_external_url?

Instance Method Details

#next_topic ⇒ void

This method returns an undefined value.

Marks the current topic completed and redirects to the next ongoing
topic, next category, or a completion message.



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'app/controllers/www/customer_topics_controller.rb', line 48

def next_topic
  # Save the progress of the user
  @customer_topic.presence&.update(state: :completed)
  # let's get the next topic
  next_topic = @course_category.customer_topics.sorted.ongoing.first

  if next_topic.present?
    redirect_to course_enrollment_course_category_customer_topic_path(@course_enrollment.id, @course_category.id, next_topic.id)
  elsif @course_category.next.present?
    @course_category.update(state: 'completed')
    redirect_to course_enrollment_course_category_path(@course_enrollment.id, @course_category.next.id)
  else
    flash[:info] = 'Congratulations! You have completed the course content.'
    redirect_to @course_enrollment
  end
end

#open_upload ⇒ void

This method returns an undefined value.

Streams a topic's attached upload.



80
81
82
83
84
85
86
 
# File 'app/controllers/www/customer_topics_controller.rb', line 80

def open_upload
  if (upload = @customer_topic.topic.uploads.find_by(id: params[:upload])) && upload.attachment
    send_upload_accelerated(upload)
  else
    head :not_found
  end
end

#show ⇒ void

This method returns an undefined value.

Displays a customer topic's content (articles, uploads, quiz), paginated
one content slide at a time.



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'app/controllers/www/customer_topics_controller.rb', line 14

def show
  @categories = @course_enrollment.course_categories.sorted.includes(:topic_category, customer_topics: :topic)
  @topic = @customer_topic.topic
  @topic_responses = @topic.topic_responses if @topic.present?

  # Load course dashboard stats for sidebar navigation
  dashboard = Course::DashboardStats.call(@course_enrollment.course)
  @topic_categories = dashboard.topic_categories
  @topic_exams = dashboard.topic_exams

  # Derive module counts from preloaded collection
  @module_counts = {}
  @categories.each do |category|
    @module_counts[category.id] = {
      total: category.customer_topics.size,
      completed: category.customer_topics.count { |ct| ct.state == 'completed' }
    }
  end

  @content = []
  # the content we can extract is articles, article pages and topic_responses(quizes)
  @customer_topic.topic.articles.each do |ar|
    @content += ar.uploads if ar.uploads.present? # Show uploads attached to the article independent to the article content
    @content << ar if ar.solution.present?
    @content += ar.article_pages if ar.article_pages.present?
  end

  @pagy_content, @content = pagy(:offset, @content, page: params[:slide] || 1, limit: 1)
end

#upload_thumbnail ⇒ void

This method returns an undefined value.

Streams a 600x600 thumbnail of a topic's attached upload.



91
92
93
94
95
96
97
98
 
# File 'app/controllers/www/customer_topics_controller.rb', line 91

def upload_thumbnail
  if (upload = @customer_topic.topic.uploads.find_by(id: params[:upload])) && upload&.image_attachment('600x600>')
    file_path = upload.image_attachment('600x600>').encode(:png).path
    send_file_accelerated(file_path, mime_type: 'image/png')
  else
    head :not_found
  end
end

#validate_response ⇒ void

This method returns an undefined value.

Loads the quiz response for display/streaming.



68
69
70
71
72
73
74
75
 
# File 'app/controllers/www/customer_topics_controller.rb', line 68

def validate_response
  response = params[:customer_topic][:quiz_response]
  @topic_response = TopicResponse.find(response)
  respond_to do |format|
    format.turbo_stream
    format.html { redirect_back_or_to root_path }
  end
end