Class: AsanaService

Inherits:
Service show all
Defined in:
app/models/project_services/asana_service.rb

Constant Summary

Constants inherited from Service

Service::DEV_SERVICE_NAMES, Service::SERVICE_NAMES

Instance Attribute Summary

Attributes included from Importable

#imported, #importing

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Service

#activated?, #api_field_names, #async_execute, available_services_names, available_services_types, boolean_accessor, build_from_integration, #can_test?, #category, #configurable_event_actions, #configurable_events, default_integration, dev_services_names, #editable?, #event_channel_names, event_description, #event_field, event_names, #event_names, find_or_create_templates, find_or_initialize_all, find_or_initialize_integration, #global_fields, #initialize_properties, instance_exists_for?, #issue_tracker?, #json_fields, #operating?, prop_accessor, #reset_updated_properties, services_names, services_types, #show_active_box?, supported_event_actions, #supported_events, #supports_data_fields?, #test, #to_data_fields_hash, #to_param, #to_service_hash, #updated_properties

Methods included from ProjectServicesLoggable

#build_message, #log_error, #log_info, #logger

Methods inherited from ApplicationRecord

at_most, id_in, id_not_in, iid_in, pluck_primary_key, primary_key_in, safe_ensure_unique, safe_find_or_create_by, safe_find_or_create_by!, underscore, without_order

Class Method Details

.supported_eventsObject


50
51
52
# File 'app/models/project_services/asana_service.rb', line 50

def self.supported_events
  %w(push)
end

.to_paramObject


30
31
32
# File 'app/models/project_services/asana_service.rb', line 30

def self.to_param
  'asana'
end

Instance Method Details

#check_commit(message, push_msg) ⇒ Object


81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
# File 'app/models/project_services/asana_service.rb', line 81

def check_commit(message, push_msg)
  # matches either:
  # - #1234
  # - https://app.asana.com/0/{project_gid}/{task_gid}
  # optionally preceded with:
  # - fix/ed/es/ing
  # - close/s/d
  # - closing
  issue_finder = %r{(fix\w*|clos[ei]\w*+)?\W*(?:https://app\.asana\.com/\d+/\w+/(\w+)|#(\w+))}i

  message.scan(issue_finder).each do |tuple|
    # tuple will be
    # [ 'fix', 'id_from_url', 'id_from_pound' ]
    taskid = tuple[2] || tuple[1]

    begin
      task = Asana::Resources::Task.find_by_id(client, taskid)
      task.add_comment(text: "#{push_msg} #{message}")

      if tuple[0]
        task.update(completed: true)
      end
    rescue => e
      log_error(e.message)
      next
    end
  end
end

#clientObject


54
55
56
57
58
59
60
# File 'app/models/project_services/asana_service.rb', line 54

def client
  @_client ||= begin
    Asana::Client.new do |c|
      c.authentication :access_token, api_key
    end
  end
end

#descriptionObject


13
14
15
# File 'app/models/project_services/asana_service.rb', line 13

def description
  s_('AsanaService|Asana - Teamwork without email')
end

#execute(data) ⇒ Object


62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
# File 'app/models/project_services/asana_service.rb', line 62

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

  # check the branch restriction is poplulated and branch is not included
  branch = Gitlab::Git.ref_name(data[:ref])
  branch_restriction = restrict_to_branch.to_s
  if branch_restriction.present? && branch_restriction.index(branch).nil?
    return
  end

  user = data[:user_name]
  project_name = project.full_name

  data[:commits].each do |commit|
    push_msg = s_("AsanaService|%{user} pushed to branch %{branch} of %{project_name} ( %{commit_url} ):") % { user: user, branch: branch, project_name: project_name, commit_url: commit[:url] }
    check_commit(commit[:message], push_msg)
  end
end

#fieldsObject


34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
# File 'app/models/project_services/asana_service.rb', line 34

def fields
  [
    {
      type: 'text',
      name: 'api_key',
      placeholder: s_('AsanaService|User Personal Access Token. User must have access to task, all comments will be attributed to this user.'),
      required: true
    },
    {
      type: 'text',
      name: 'restrict_to_branch',
      placeholder: s_('AsanaService|Comma-separated list of branches which will be automatically inspected. Leave blank to include all branches.')
    }
  ]
end

#helpObject


17
18
19
20
21
22
23
24
25
26
27
28
# File 'app/models/project_services/asana_service.rb', line 17

def help
  'This service adds commit messages as comments to Asana tasks.
Once enabled, commit messages are checked for Asana task URLs
(for example, `https://app.asana.com/0/123456/987654`) or task IDs
starting with # (for example, `#987654`). Every task ID found will
get the commit comment added to it.

You can also close a task with a message containing: `fix #123456`.

You can create a Personal Access Token here:
https://app.asana.com/0/developer-console'
end

#titleObject


9
10
11
# File 'app/models/project_services/asana_service.rb', line 9

def title
  'Asana'
end