Class: Integrations::Pivotaltracker

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

Constant Summary collapse

API_ENDPOINT = 
'https://www.pivotaltracker.com/services/v5/source_commits'

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

#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

.supported_events ⇒ Object 



40
41
42
 
# File 'app/models/integrations/pivotaltracker.rb', line 40

def self.supported_events
  %w[push]
end

.to_param ⇒ Object 



36
37
38
 
# File 'app/models/integrations/pivotaltracker.rb', line 36

def self.to_param
  'pivotaltracker'
end

Instance Method Details

#description ⇒ Object 



27
28
29
 
# File 'app/models/integrations/pivotaltracker.rb', line 27

def description
  s_('PivotalTrackerService|Add commit messages as comments to Pivotal Tracker stories.')
end

#execute(data) ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'app/models/integrations/pivotaltracker.rb', line 44

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

  data[:commits].each do |commit|
    message = {
      'source_commit' => {
        'commit_id' => commit[:id],
        'author' => commit[:author][:name],
        'url' => commit[:url],
        'message' => commit[:message]
      }
    }
    Gitlab::HTTP.post(
      API_ENDPOINT,
      body: Gitlab::Json.dump(message),
      headers: {
        'Content-Type' => 'application/json',
        'X-TrackerToken' => token
      }
    )
  end
end

#help ⇒ Object 



31
32
33
34
 
# File 'app/models/integrations/pivotaltracker.rb', line 31

def help
  docs_link = ActionController::Base.helpers.link_to _('Learn more.'), Rails.application.routes.url_helpers.help_page_url('user/project/integrations/pivotal_tracker'), target: '_blank', rel: 'noopener noreferrer'
  s_('Add commit messages as comments to Pivotal Tracker stories. %{docs_link}').html_safe % { docs_link: docs_link.html_safe }
end

#title ⇒ Object 



23
24
25
 
# File 'app/models/integrations/pivotaltracker.rb', line 23

def title
  'Pivotal Tracker'
end