Class: Admin::OauthCredentialsController

Inherits:
CrmController show all
Defined in:
app/controllers/admin/oauth_credentials_controller.rb

Overview

Admin dashboard for outbound OAuth 2.0 credentials.

Every third-party API integration (Zoom, Basecamp, YouTube, Pinterest,
Microsoft Ads) stores its tokens in the one oauth_credentials table, so this screen is
driven uniformly off OauthCredential — it lists each provider's live
status and offers connect / disconnect / force-refresh.

See Also:

Constant Summary collapse

PROVIDERS =

Provider registry — display metadata, the OAuth service class, and the
standalone connect route. Zoom connects through the employee Devise /
OmniAuth login, so it has no standalone connect path here.

{
  'pinterest'     => { label: 'Pinterest Ads', service: Pinterest::OauthService,    connect: :pinterest_oauth_authorize_path },
  'microsoft_ads' => { label: 'Microsoft Ads', service: MicrosoftAds::OauthService, connect: :microsoft_ads_oauth_authorize_path },
  'youtube'       => { label: 'YouTube',       service: YouTube::OauthService,      connect: :youtube_oauth_authorize_path },
  'basecamp'      => { label: 'Basecamp',      service: Basecamp::OauthService,     connect: :basecamp_oauth_authorize_path },
  'zoom'          => { label: 'Zoom',          service: Zoom::OauthService,         connect: nil }
}.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

#destroy ⇒ Object

DELETE /admin/oauth_credentials/:id — disconnect (remove the credential).



48
49
50
51
52
53
54
 
# File 'app/controllers/admin/oauth_credentials_controller.rb', line 48

def destroy
  credential = OauthCredential.find(params.expect(:id))
  label = provider_label(credential.provider)
  credential.destroy!
  flash[:success] = "#{label} disconnected."
  redirect_to admin_oauth_credentials_path
end

#index ⇒ void

This method returns an undefined value.

GET /admin/oauth_credentials — every stored credential grouped by provider.



29
30
31
32
 
# File 'app/controllers/admin/oauth_credentials_controller.rb', line 29

def index
  @providers   = PROVIDERS
  @credentials = OauthCredential.includes({ account: :party }, { owner: :party }).order(:provider, :account_id)
end

#refresh ⇒ Object

POST /admin/oauth_credentials/:id/refresh — force a token refresh.



35
36
37
38
39
40
41
42
43
44
45
 
# File 'app/controllers/admin/oauth_credentials_controller.rb', line 35

def refresh
  credential = OauthCredential.find(params.expect(:id))
  service_for(credential).refresh!
  flash[:success] = "#{provider_label(credential.provider)} token refreshed."
rescue StandardError => e
  # Keep raw provider/exception detail in the log, not in a user-facing flash.
  Rails.logger.error("[Admin::OauthCredentialsController] token refresh failed: #{e.class} — #{e.message}")
  flash[:error] = 'Token refresh failed — see the application log for details.'
ensure
  redirect_to admin_oauth_credentials_path
end