Class: AsanaService

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

Instance Method Summary collapse

Methods inherited from Service

#activated?, #async_execute, available_services_names, boolean_accessor, #can_test?, #category, create_from_template, #initialize_properties, #issue_tracker?, prop_accessor, #reset_updated_properties, #template?, #test, #updated_properties

Instance Method Details

#check_commit(message, push_msg) ⇒ Object


102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
# File 'app/models/project_services/asana_service.rb', line 102

def check_commit(message, push_msg)
  # matches either:
  # - #1234
  # - https://app.asana.com/0/0/1234
  # optionally preceded with:
  # - fix/ed/es/ing
  # - close/s/d
  # - closing
  issue_finder = /(fix\w*|clos[ei]\w*+)?\W*(?:https:\/\/app\.asana\.com\/\d+\/\d+\/(\d+)|#(\d+))/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::Task.find_by_id(client, taskid)
      task.add_comment(text: "#{push_msg} #{message}")

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

#clientObject


75
76
77
78
79
80
81
# File 'app/models/project_services/asana_service.rb', line 75

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

#descriptionObject


35
36
37
# File 'app/models/project_services/asana_service.rb', line 35

def description
  'Asana - Teamwork without email'
end

#execute(data) ⇒ Object


83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
# File 'app/models/project_services/asana_service.rb', line 83

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.length > 0 && branch_restriction.index(branch).nil?
    return
  end

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

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

#fieldsObject


56
57
58
59
60
61
62
63
64
65
66
67
68
69
# File 'app/models/project_services/asana_service.rb', line 56

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

#helpObject


39
40
41
42
43
44
45
46
47
48
49
50
# File 'app/models/project_services/asana_service.rb', line 39

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:
http://app.asana.com/-/account_api'
end

#supported_eventsObject


71
72
73
# File 'app/models/project_services/asana_service.rb', line 71

def supported_events
  %w(push)
end

#titleObject


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

def title
  'Asana'
end

#to_paramObject


52
53
54
# File 'app/models/project_services/asana_service.rb', line 52

def to_param
  'asana'
end