Class: Www::ReviewsController

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

Overview

Controller: reviews.

Constant Summary collapse

REVIEWS_PER_PAGE =

Reviews per page.

24
SORT_OPTIONS =

Available sort options.

{
  'newest'  => 'Newest First',
  'oldest'  => 'Oldest First',
  'highest' => 'Highest Rated',
  'lowest'  => 'Lowest Rated'
}.freeze

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

Constants included from SeoHelper

SeoHelper::AWARDS, SeoHelper::CA_ADDRESS, SeoHelper::CA_BUSINESS_HOURS, SeoHelper::CA_CONTACT_POINT, SeoHelper::CA_CURRENCIES, SeoHelper::CA_DESCRIPTION, SeoHelper::CA_FOUNDING_DATE, SeoHelper::CA_GLOBAL_LOCATION_NUMBER, SeoHelper::CA_LEGAL_NAME, SeoHelper::CA_LOCAL_BUSINESS, SeoHelper::CA_ONLINE_STORE, SeoHelper::CA_RETURN_POLICY, SeoHelper::CA_SALES_DEPARTMENT, SeoHelper::CA_SERVICE_AREA, SeoHelper::CA_URL, SeoHelper::CA_VAT_ID, SeoHelper::CA_WAREHOUSE_DEPARTMENT, SeoHelper::CA_WAREHOUSE_HOURS, SeoHelper::COMPANY_EMAIL, SeoHelper::COMPANY_LOGO, SeoHelper::COMPANY_NAME, SeoHelper::COMPANY_SLOGAN, SeoHelper::EXPERTISE, SeoHelper::FAX_NUMBER, SeoHelper::GS1_COMPANY_PREFIX, SeoHelper::ISO6523_CODE, SeoHelper::PAYMENT_METHODS, SeoHelper::PHONE_NUMBER, SeoHelper::PRIMARY_NAICS, SeoHelper::REFUND_TYPE, SeoHelper::RETURN_FEES, SeoHelper::RETURN_METHOD, SeoHelper::RETURN_POLICY_CATEGORY, SeoHelper::SECONDARY_NAICS, SeoHelper::SOCIAL_PROFILES, SeoHelper::US_ADDRESS, SeoHelper::US_BUSINESS_HOURS, SeoHelper::US_CONTACT_POINT, SeoHelper::US_CURRENCIES, SeoHelper::US_DESCRIPTION, SeoHelper::US_FOUNDING_DATE, SeoHelper::US_GLOBAL_LOCATION_NUMBER, SeoHelper::US_IMAGE, SeoHelper::US_LEGAL_NAME, SeoHelper::US_LOCAL_BUSINESS, SeoHelper::US_ONLINE_STORE, SeoHelper::US_RETURN_POLICY, SeoHelper::US_SALES_DEPARTMENT, SeoHelper::US_SERVICE_AREA, SeoHelper::US_TAX_ID, SeoHelper::US_URL, SeoHelper::US_WAREHOUSE_DEPARTMENT, SeoHelper::US_WAREHOUSE_HOURS

Constants included from IconHelper

IconHelper::CUSTOM_ICON_MAP, IconHelper::CUSTOM_SVG_DIR, IconHelper::DEFAULT_FAMILY

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?, #stamp_impersonation_context, #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, #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 ApplicationHelper

#better_number_to_currency, #check_force_logout, #check_or_cross, #check_or_times, #embedded_tab_frame_id, #error_messages, #general_disclaimer_on_product_installation_and_local_codes, #gridjs_from_html_table, #gridjs_table, #is_wy_ip, #line_break, #parent_layout, #pass_or_fail, #render_error_messages_list, #render_video_card, #resolved_auth_form_turbo_frame, #return_path_or, #safe_css_color, #set_return_path_if_present, #set_section_if_present, #tab_frame_id, #to_underscore, #track_page?, #turbo_section_wrapper, #turbo_tabs_request?, #url_on_same_domain_as_request, #widget_index_daily_focus_index_path, #working_hours?, #yes_or_no, #yes_or_no_highlighted, #yes_or_no_with_check_or_cross, #youtube_video

Methods included from UppyUploaderHelper

#file_uploader, #image_uploader, #large_file_uploader_s3, #lead_sketch_uploader, #rma_image_uploader, #rma_image_uploader_s3, #uppy_uploader, #video_uploader

Methods included from ImagesHelper

#image_asset_tag, #image_asset_url

Methods included from SeoHelper

#add_page_schema, #add_webpage_schema, #canada?, #company_social_links, #ensure_context_json, #json_ld_script_tag, #local_business_schema, #online_store_id, #online_store_schema, #page_main_entity, #page_main_entity_json, #render_auto_collection_page_schema, #render_collection_page_schema, #render_local_business_schema, #render_online_store_schema, #render_page_schemas, #render_page_video_schemas, #render_webpage_schema, #render_webpage_schema_with_collections, #usa?

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?

Methods included from IconHelper

#account_nav_icon, #fa_icon, #star_rating_html

Instance Method Details

#create_by_order_email ⇒ Object

Actions that originally only flashed + redirected (no mailer)



211
 
# File 'app/controllers/www/reviews_controller.rb', line 211

def create_by_order_email      = legacy_review_flash_redirect

#create_from_support_email ⇒ Object 



212
 
# File 'app/controllers/www/reviews_controller.rb', line 212

def create_from_support_email  = legacy_review_flash_redirect

#create_order_item_review ⇒ Object

Actions that originally sent a mailer notification



215
 
# File 'app/controllers/www/reviews_controller.rb', line 215

def create_order_item_review   = legacy_review_redirect('create_order_item_review')

#index ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'app/controllers/www/reviews_controller.rb', line 23

def index
  @sort       = params[:sort].presence_in(SORT_OPTIONS.keys) || 'newest'
  @min_rating = params[:min_rating].to_i.clamp(0, 5)

  scope = build_review_scope
  begin
    @pagy, @reviews = pagy(:keyset, scope, page: params[:after].presence, limit: REVIEWS_PER_PAGE)
  rescue ArgumentError, JSON::ParserError
    redirect_to url_for(request.query_parameters.except('after')) and return
  end
  @next_cursor = @pagy.next

  # Single cheap query drives both ETag and freshness check.
  # If the CDN revalidates and nothing has changed we skip all expensive queries.
  last_touched = ReviewsIo.active.visible.maximum(:updated_at) || 1.year.ago
  unless stale?(etag: [@reviews.map(&:id), @sort, @min_rating, I18n.locale],
                last_modified: last_touched,
                public: true)
    return
  end

  @avatar_urls  = batch_review_avatar_urls(@reviews)
  @professions  = batch_review_professions(@reviews)

  # Global stats — always for all visible reviews, not filtered
  @review_avg   = ReviewsIo.active.visible.average(:rating)&.round(2)
  @review_count = ReviewsIo.active.visible.count
  @review_dist  = ReviewsIo.active.visible.group(:rating).count

  # Filtered count — used to give feedback when star filter is active
  @matched_count = @min_rating > 0 ? scope.unscope(:order).count : nil

  # Vary on Accept so HTML and turbo-stream responses get separate cache buckets.
  response.set_header('Vary', 'Accept')
  # public_cache_expires_in: 0 lets browsers always revalidate via If-None-Match
  # (stale? responds with 304 when data is unchanged — skips expensive queries).
  # Cloudflare edge still caches for 10 min via Cloudflare-CDN-Cache-Control.
  set_cloudflare_cache(
    time_in_secs:            10.minutes.to_i,
    public_cache_expires_in: 0,
    tags:                    ['reviews-index']
  )

  respond_to do |format|
    format.html { @reviews_schema = build_reviews_schema }
    format.turbo_stream
  end
end

#item ⇒ Object 



78
 
# File 'app/controllers/www/reviews_controller.rb', line 78

def item; end

#new_order_items_review ⇒ Object 



217
 
# File 'app/controllers/www/reviews_controller.rb', line 217

def new_order_items_review     = legacy_review_redirect('new_order_items_review')

#new_order_review ⇒ Object 



216
 
# File 'app/controllers/www/reviews_controller.rb', line 216

def new_order_review           = legacy_review_redirect('new_order_review')

#new_support_review ⇒ Object 



218
 
# File 'app/controllers/www/reviews_controller.rb', line 218

def new_support_review         = legacy_review_redirect('new_support_review')

#product_index ⇒ Object

Legacy route: 301 redirects to new hierarchical URL



97
98
99
100
101
102
103
104
 
# File 'app/controllers/www/reviews_controller.rb', line 97

def product_index
  result = CatalogPathResolver.new.resolve_legacy_product_line(params[:product_line_url], section: :reviews)
  if result.redirect?
    redirect_to result.redirect_to, status: :moved_permanently
  else
    redirect_to cms_link('/products'), notice: result.error_message || 'Reviews not found.'
  end
end

#show ⇒ Object 



72
73
74
75
76
 
# File 'app/controllers/www/reviews_controller.rb', line 72

def show
  # Legacy review pages - redirect to Reviews.io widget page
  flash[:info] = 'Our review system has been updated. Please browse our latest reviews below.'
  redirect_to cms_link('/reviews')
end

#snooze ⇒ Object 



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'app/controllers/www/reviews_controller.rb', line 80

def snooze
  if params[:order_reference_number].present?
    encrypted_order_reference_number = params.delete(:order_reference_number)
    @order = Order.find_by(reference_number: Encryption.decrypt_string(encrypted_order_reference_number))
    if @order.reviewed
      flash[:info] = 'This order has been reviewed already and it cannot be snoozed.'
    else
      @order.update(review_snoozed_until: Date.current + 1.month)
      flash[:info] = 'We snoozed this review for now. We will send you a new reminder in 30 days.'
    end
  else
    flash[:error] = 'Order # not present. Please make sure you have the correct url.'
  end
  redirect_to cms_link('/')
end