Class: Crm::ReviewsIoController

Inherits:
CrmController show all
Defined in:
app/controllers/crm/reviews_io_controller.rb

Overview

CRM controller for viewing Reviews.io data
This is a read-only interface - reviews cannot be created, edited, or deleted from CRM
All review management must be done through the Reviews.io dashboard

Constant Summary

Constants included from Controllers::ReferenceFindable

Controllers::ReferenceFindable::ID_EMBEDDED_PATTERNS

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 Www::SeoHelper

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

#access_denied, #context_id, #context_object, #crm_home_path, #current_ability, #default_url_options, #download_temp, #get_tempfile_path_for_download, #initialize_crm_lazy_chunks, #record_not_found, #redirect_to_job_or_fallback, #render_edit_action, #set_context, #set_download_path, #stash_file_for_temp_download

Methods inherited from ApplicationController

#account_impersonated?, #add_to_flash, #append_token, #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::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, #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_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!, #authenticate_account_from_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, #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 Www::ImagesHelper

#image_asset_tag, #image_asset_url

Methods included from Www::SeoHelper

#add_page_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

#generate_headlineObject

POST /reviews/:id/generate_headline
Calls the LLM to suggest a headline; returns JSON — no page reload.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
# File 'app/controllers/crm/reviews_io_controller.rb', line 118

def generate_headline
  @review = ReviewsIo.find(params[:id])

  if @review.comments.blank?
    return render json: { error: 'This review has no comment body to generate a headline from.' },
                  status: :unprocessable_entity
  end

  headline = ReviewHeadlineGenerator.call(@review.comments)
  render json: { headline: headline }
rescue RubyLLM::RateLimitError
  render json: { error: 'AI service is rate-limited. Please try again in a moment.' },
         status: :too_many_requests
rescue RubyLLM::Error => e
  render json: { error: "AI service error: #{e.message}" }, status: :service_unavailable
end

#importObject



72
73
74
75
# File 'app/controllers/crm/reviews_io_controller.rb', line 72

def import
  ReviewsIoImportWorker.perform_async
  redirect_to reviews_io_index_path, notice: 'Review import has been queued. It may take a few minutes to complete.'
end

#import_imagesObject



105
106
107
108
109
110
111
112
113
114
# File 'app/controllers/crm/reviews_io_controller.rb', line 105

def import_images
  @review = ReviewsIo.find(params[:id])
  result = ReviewsIoImageImporter.new(@review, force: params[:force].present?).call

  if result.success?
    redirect_to reviews_io_path(@review), notice: "Imported #{result.imported_count} photo(s) into the image library."
  else
    redirect_to reviews_io_path(@review), alert: "Import completed with errors: #{result.errors.join('; ')}"
  end
end

#indexObject



7
8
9
10
11
12
13
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
# File 'app/controllers/crm/reviews_io_controller.rb', line 7

def index
  params[:q] ||= {}

  # Wildcard search across multiple fields
  search_query = params[:search_query].to_s.strip.presence
  if search_query
    params[:q][:comments_or_title_or_sku_or_author_name_or_order_id_cont] = search_query
  end

  @q = ReviewsIo.all.ransack(params[:q])
  @q.sorts = 'review_date desc' if @q.sorts.blank?

  @reviews = @q.result

  # Filter by customer (through orders)
  if params.dig(:q, :by_customer_id).present?
    customer_order_ids = Order.where(customer_id: params[:q][:by_customer_id]).pluck(:id, :reference_number).flatten.map(&:to_s)
    @reviews = @reviews.where(order_id: customer_order_ids) if customer_order_ids.any?
  end

  @pagy, @reviews = pagy(@reviews, items: 25)

  # Preload orders by ID and by reference_number to avoid N+1 queries
  order_ids = @reviews.map(&:order_id).compact.uniq
  if order_ids.any?
    orders = Order.includes(:customer).where(id: order_ids).or(Order.includes(:customer).where(reference_number: order_ids))
    @orders_by_id = orders.index_by { |o| o.id.to_s }
    @orders_by_reference = orders.index_by(&:reference_number)
  else
    @orders_by_id = {}
    @orders_by_reference = {}
  end

  # Preload items by SKU to avoid N+1 queries
  skus = @reviews.map(&:sku).compact.uniq
  @items_by_sku = skus.any? ? Item.where(sku: skus).index_by(&:sku) : {}

  # Preload which reviews have imported images
  review_ids = @reviews.map(&:id)
  @reviews_with_images = review_ids.any? ? ReviewsIoImage.where(reviews_io_id: review_ids).distinct.pluck(:reviews_io_id).to_set : Set.new

  # Stats for the summary cards
  @product_review_count = ReviewsIo.active.product_reviews.count
  @store_review_count = ReviewsIo.active.store_reviews.count
  @product_avg_rating = ReviewsIo.active.product_reviews.average(:rating)&.round(2)
  @store_avg_rating = ReviewsIo.active.store_reviews.average(:rating)&.round(2)

  # Tags for the filter dropdown
  @available_tags = ReviewsIo.all_tags
end

#showObject



58
59
60
61
62
63
64
65
66
67
68
69
70
# File 'app/controllers/crm/reviews_io_controller.rb', line 58

def show
  @review = ReviewsIo.find(params[:id])
  @review_images = @review.images.order(created_at: :desc)
  @available_tags = ReviewsIo.all_tags

  if @review.order_id.present?
    @order = Order.find_by(id: @review.order_id) ||
             Order.find_by(reference_number: @review.order_id)
    customer = @order&.customer
    @customer_full_name    = customer&.full_name.presence
    @customer_profile_name = customer&.profile&.friendly_name.presence
  end
end

#toggle_hiddenObject



77
78
79
80
81
82
# File 'app/controllers/crm/reviews_io_controller.rb', line 77

def toggle_hidden
  @review = ReviewsIo.find(params[:id])
  @review.update!(hidden: !@review.hidden)
  status = @review.hidden? ? 'hidden from public' : 'visible to public'
  redirect_to reviews_io_path(@review), notice: "Review is now #{status}."
end

#update_avatarObject



91
92
93
94
95
96
97
98
99
100
101
102
103
# File 'app/controllers/crm/reviews_io_controller.rb', line 91

def update_avatar
  @review = ReviewsIo.find(params[:id])
  image_id = review_avatar_params[:avatar_image_id].presence&.to_i

  if image_id && !Image.exists?(image_id)
    redirect_to reviews_io_path(@review), alert: "Image ##{image_id} not found in the library."
    return
  end

  @review.update!(avatar_image_id: image_id)
  notice = image_id ? "Avatar set to image ##{image_id}." : 'Avatar cleared.'
  redirect_to reviews_io_path(@review), notice: notice
end

#update_headlineObject

PATCH /reviews/:id/update_headline
Persists (or clears) the custom_headline. Returns JSON.



137
138
139
140
141
# File 'app/controllers/crm/reviews_io_controller.rb', line 137

def update_headline
  @review = ReviewsIo.find(params[:id])
  @review.update!(custom_headline: params[:custom_headline].presence)
  render json: { custom_headline: @review.custom_headline }
end

#update_tagsObject



84
85
86
87
88
89
# File 'app/controllers/crm/reviews_io_controller.rb', line 84

def update_tags
  @review = ReviewsIo.find(params[:id])
  new_tags = review_tags_params[:tags]&.reject(&:blank?) || []
  @review.update!(tags: new_tags)
  redirect_to reviews_io_path(@review), notice: 'Tags updated successfully.'
end