Class: Integrations::Confluence

Inherits:
BaseThirdPartyWiki show all
Defined in:
app/models/integrations/confluence.rb

Constant Summary collapse

VALID_SCHEME_MATCH =
%r{\Ahttps?\Z}
VALID_HOST_MATCH =
%r{\A.+\.atlassian\.net\Z}
VALID_PATH_MATCH =
%r{\A/wiki(/|\Z)}

Constants inherited from Integration

Integration::BASE_CLASSES, Integration::DEV_INTEGRATION_NAMES, Integration::INTEGRATION_NAMES, Integration::PROJECT_SPECIFIC_INTEGRATION_NAMES, Integration::SECTION_TYPE_CONFIGURATION, Integration::SECTION_TYPE_CONNECTION, Integration::SECTION_TYPE_TRIGGER, Integration::SNOWPLOW_EVENT_ACTION, Integration::SNOWPLOW_EVENT_LABEL, Integration::UnknownType

Constants inherited from ApplicationRecord

ApplicationRecord::MAX_PLUCK

Constants included from ResetOnUnionError

ResetOnUnionError::MAX_RESET_PERIOD

Instance Attribute Summary

Attributes included from Importable

#imported, #importing

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseThirdPartyWiki

supported_events

Methods inherited from Integration

#activate_disabled_reason, #activated?, #api_field_names, #async_execute, #attributes, available_integration_names, available_integration_types, boolean_accessor, build_from_integration, #category, #chat?, #ci?, #configurable_events, create_from_active_default_integrations, default_integration, #default_test_event, default_test_event, dev_integration_names, #dup, #editable?, #event_channel_names, event_description, event_names, #event_names, #execute, field, #fields, fields, find_or_initialize_all_non_project_specific, find_or_initialize_non_project_specific_integration, #form_fields, #group_level?, #inheritable?, inherited_descendants_from_self_or_ancestors_from, #initialize_properties, instance_exists_for?, #instance_level?, integration_name_to_model, integration_name_to_type, integration_names, #json_fields, #operating?, #parent, #project_level?, project_specific_integration_names, prop_accessor, #properties=, #reencrypt_properties, #reset_updated_properties, #secret_fields, #sections, #show_active_box?, supported_events, #supported_events, #supports_data_fields?, #test, #to_database_hash, #to_param, #updated_properties

Methods included from Gitlab::Utils::Override

#extended, extensions, #included, #method_added, #override, #prepended, #queue_verification, verify!

Methods included from ResetSecretFields

#exposing_secrets_fields

Methods included from Loggable

#build_message, #log_error, #log_exception, #log_info, #logger

Methods inherited from ApplicationRecord

cached_column_list, #create_or_load_association, declarative_enum, default_select_columns, id_in, id_not_in, iid_in, pluck_primary_key, primary_key_in, #readable_by?, safe_ensure_unique, safe_find_or_create_by, safe_find_or_create_by!, #to_ability_name, underscore, where_exists, where_not_exists, with_fast_read_statement_timeout, without_order

Methods included from SensitiveSerializableHash

#serializable_hash

Class Method Details

.to_paramObject



21
22
23
# File 'app/models/integrations/confluence.rb', line 21

def self.to_param
  'confluence'
end

Instance Method Details

#avatar_urlObject



17
18
19
# File 'app/models/integrations/confluence.rb', line 17

def avatar_url
  ActionController::Base.helpers.image_path('confluence.svg')
end

#descriptionObject



29
30
31
# File 'app/models/integrations/confluence.rb', line 29

def description
  s_('ConfluenceService|Link to a Confluence Workspace from the sidebar.')
end

#helpObject



33
34
35
36
37
38
39
40
41
42
43
44
45
46
# File 'app/models/integrations/confluence.rb', line 33

def help
  return unless project&.wiki_enabled?

  if activated?
    wiki_url = project.wiki.web_url

    s_(
      'ConfluenceService|Your GitLab wiki is still available at %{wiki_link}. To re-enable the link to the GitLab wiki, disable this integration.' %
      { wiki_link: ActionController::Base.helpers.link_to(wiki_url, wiki_url) }
    ).html_safe
  else
    s_('ConfluenceService|Link to a Confluence Workspace from the sidebar. Enabling this integration replaces the "Wiki" sidebar link with a link to the Confluence Workspace. The GitLab wiki is still available at the original URL.').html_safe
  end
end

#testable?Boolean

Returns:

  • (Boolean)


48
49
50
# File 'app/models/integrations/confluence.rb', line 48

def testable?
  false
end

#titleObject



25
26
27
# File 'app/models/integrations/confluence.rb', line 25

def title
  s_('ConfluenceService|Confluence Workspace')
end