Class: Crm::SettingsController

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

Overview

Controller: settings.

Constant Summary collapse

SCOPE_SLUGS =

Mapping of URL slugs to scope names

{
  'brand_voice' => 'brand_voice',
  'brand-voice' => 'brand_voice',
  'ai_vision' => 'ai_vision',
  'ai-vision' => 'ai_vision',
  'video_processing' => 'video_processing',
  'video-processing' => 'video_processing',
  'call_transcription' => 'call_transcription',
  'call-transcription' => 'call_transcription',
  'phone_system' => 'phone_system',
  'phone-system' => 'phone_system',
  'transcription' => 'transcription',
  'ad_conversion_values' => 'ad_conversion_values',
  'ad-conversion-values' => 'ad_conversion_values',
  'outlet_purchase_commission' => 'outlet_purchase_commission',
  'outlet-purchase-commission' => 'outlet_purchase_commission'
}.freeze

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

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, #init_status_job_collector, #initialize_crm_lazy_chunks, #persist_enqueued_status_jobs, #record_not_found, #redirect_to_job_or_fallback, #render_edit_action, #set_context, #set_download_path, #stash_file_for_temp_download, #sync_admin_presence_cookie, #touch_employee_last_seen

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

#edit ⇒ void

This method returns an undefined value.

Loads a setting for editing.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'app/controllers/crm/settings_controller.rb', line 83

def edit
  @setting_key = params[:id]
  authorize! :update, Setting.permission_for(@setting_key)

  begin
    @setting_value = Setting.public_send(@setting_key)
  rescue Psych::SyntaxError => e
    # Handle YAML parsing errors gracefully
    flash.now[:alert] = "Failed to load setting value: #{e.message}. Please update this setting to fix the error."
    @setting_value = ''
  end

  @setting = Setting.find_by(var: @setting_key)
end

#index ⇒ void

This method returns an undefined value.

Lists settings, Ransack-searchable and optionally filtered to a scope
(via params[:scope_slug] or params[:q][:scope_eq]).



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
 
# File 'app/controllers/crm/settings_controller.rb', line 30

def index
  # Settings are initialized via migrations - no auto-creation here
  @q = Setting.ransack(params[:q])
  @settings = @q.result.order(:var)

  # Handle slug-based scope filtering (e.g., /settings/brand_voice)
  scope = if params[:scope_slug].present?
            SCOPE_SLUGS[params[:scope_slug]]
          elsif params.dig(:q, :scope_eq).present?
            params[:q][:scope_eq]
          end

  return if scope.blank?

  @settings = @settings.select do |setting|
    field = Setting.get_field(setting.var)
    field_scope = field&.dig(:scope)&.to_s || 'general'

    if scope == 'general'
      field_scope == 'general' || field_scope.nil?
    else
      field_scope == scope
    end
  end
end

#show ⇒ void

This method returns an undefined value.

Shows a single setting's current value.



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'app/controllers/crm/settings_controller.rb', line 59

def show
  @setting_key = params[:id]
  @setting = Setting.find_by(var: @setting_key)

  unless @setting
    flash[:alert] = "Setting '#{@setting_key}' not found."
    redirect_to settings_path
    return
  end

  authorize! :read, Setting.permission_for(@setting_key)

  begin
    @setting_value = Setting.public_send(@setting_key)
  rescue Psych::SyntaxError => e
    # Handle YAML parsing errors gracefully
    flash.now[:alert] = "Failed to load setting value: #{e.message}"
    @setting_value = nil
  end
end

#update ⇒ void

This method returns an undefined value.

Validates and persists a setting's new value.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'app/controllers/crm/settings_controller.rb', line 101

def update
  @setting_key = params[:id]
  authorize! :update, Setting.permission_for(@setting_key)

  value = parse_setting_value(params[:setting_value], @setting_key)

  # Validate specific settings before saving
  validation_error = validate_setting_value(@setting_key, value)
  if validation_error
    flash.now[:alert] = validation_error
    @setting_value = params[:setting_value]
    @setting = Setting.find_by(var: @setting_key)
    return render :edit, status: :unprocessable_content
  end

  Setting.public_send("#{@setting_key}=", value)

  redirect_to_return_path_or_default settings_path, notice: 'Setting was successfully updated.'
rescue CanCan::AccessDenied
  redirect_to_return_path_or_default settings_path, alert: 'You are not authorized to update this setting.'
rescue ActiveRecord::RecordInvalid, ActiveModel::ValidationError, ArgumentError, TypeError, Psych::SyntaxError => e
  flash.now[:alert] = "Failed to update setting: #{e.message}"
  @setting_value = params[:setting_value]
  @setting = Setting.find_by(var: @setting_key)
  render :edit, status: :unprocessable_content
end