Class: Integrations::Campfire

Inherits:
Integration show all
Defined in:
app/models/integrations/campfire.rb

Constant Summary

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::UnknownType

Constants inherited from ApplicationRecord

ApplicationRecord::MAX_PLUCK

Instance Attribute Summary

Attributes included from Importable

#imported, #importing

Class Method Summary collapse

Instance Method Summary collapse

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, #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, field, 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, #supports_data_fields?, #test, #testable?, #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

#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

.supported_eventsObject


54
55
56
# File 'app/models/integrations/campfire.rb', line 54

def self.supported_events
  %w(push)
end

.to_paramObject


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

def self.to_param
  'campfire'
end

Instance Method Details

#descriptionObject


12
13
14
# File 'app/models/integrations/campfire.rb', line 12

def description
  'Send notifications about push events to Campfire chat rooms.'
end

#execute(data) ⇒ Object


58
59
60
61
62
63
# File 'app/models/integrations/campfire.rb', line 58

def execute(data)
  return unless supported_events.include?(data[:object_kind])

  message = build_message(data)
  speak(self.room, message, auth)
end

#fieldsObject


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
# File 'app/models/integrations/campfire.rb', line 25

def fields
  [
    {
      type: 'password',
      name: 'token',
      title: _('Campfire token'),
      help: s_('CampfireService|API authentication token from Campfire.'),
      non_empty_password_title: s_('ProjectService|Enter new token'),
      non_empty_password_help: s_('ProjectService|Leave blank to use your current token.'),
      placeholder: '',
      required: true
    },
    {
      type: 'text',
      name: 'subdomain',
      title: _('Campfire subdomain (optional)'),
      placeholder: '',
      help: s_('CampfireService|The %{code_open}.campfirenow.com%{code_close} subdomain.') % { code_open: '<code>'.html_safe, code_close: '</code>'.html_safe }
    },
    {
      type: 'text',
      name: 'room',
      title: _('Campfire room ID (optional)'),
      placeholder: '123456',
      help: s_('CampfireService|From the end of the room URL.')
    }
  ]
end

#helpObject


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

def help
  docs_link = ActionController::Base.helpers.link_to _('Learn more.'), Rails.application.routes.url_helpers.help_page_url('api/services', anchor: 'campfire'), target: '_blank', rel: 'noopener noreferrer'
  s_('CampfireService|Send notifications about push events to Campfire chat rooms. %{docs_link}').html_safe % { docs_link: docs_link.html_safe }
end

#titleObject


8
9
10
# File 'app/models/integrations/campfire.rb', line 8

def title
  'Campfire'
end