Module: OpsAsk::Helpers

Included in:
App
Defined in:
lib/opsask/helpers.rb

Instance Method Summary collapse

Instance Method Details

#asks_in_current_sprint ⇒ Object 



110
111
112
 
# File 'lib/opsask/helpers.rb', line 110

def asks_in_current_sprint
  asks_in_sprint current_sprint_num
end

#asks_in_sprint(num) ⇒ Object 



114
115
116
117
118
119
120
121
122
 
# File 'lib/opsask/helpers.rb', line 114

def asks_in_sprint num
  return [] unless logged_in?
  issues = []
  query = normalized_jql("labels in (#{sprint_label_prefix}#{num})", nil)
  @jira_client.Issue.jql(query, max_results: 500).each do |i|
    issues << i.attrs
  end
  return issues
end

#classes_for(jira) ⇒ Object 



269
270
271
 
# File 'lib/opsask/helpers.rb', line 269

def classes_for jira
  raw_classes_for(jira).join(' ')
end

#components ⇒ Object 



378
379
380
 
# File 'lib/opsask/helpers.rb', line 378

def components
  return @project.components.map(&:name).select { |c| c =~ /^Ops/ }
end

#create_jira(duedate, component, summary, description, assign_to_me, epic, ops_only) ⇒ Object 



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/opsask/helpers.rb', line 332

def create_jira duedate, component, summary, description, assign_to_me, epic, ops_only
  epic       = 'INF-3091' if epic.nil? # OpsAsk default epic
  assignee   = assign_to_me ? @me : settings.config[:assignee]
  components = []
  components = [ { name: component } ] unless component
  labels     = [ 'OpsAsk', current_sprint_name ].compact
  labels    << 'OpsOnly' if ops_only
  labels    << settings.config[:require_label] if settings.config[:require_label]
  data       = {
    fields: {
      project: { key: settings.config[:project_key] },
      issuetype: { name: settings.config[:issue_type] },
      versions: [ { name: settings.config[:version] } ],
      duedate: duedate,
      summary: summary,
      description: description,
      components: components,
      assignee: { name: assignee },
      reporter: { name: @me },
      labels: labels,
      customfield_10002: 1, # Story Points = 1
      # customfield_10350: epic,
      customfield_10040: { id: '-1' } # Release Priority = None
    }
  }

  url = "#{settings.config[:jira_url]}/rest/api/latest/issue"
  curl_request = Curl::Easy.http_post(url, data.to_json) do |curl|
    curl.headers['Accept'] = 'application/json'
    curl.headers['Content-Type'] = 'application/json'
    curl.http_auth_types = :basic
    curl.username = settings.config[:jira_user]
    curl.password = settings.config[:jira_pass]
    curl.verbose  = true
  end

  raw_response = curl_request.body_str
  begin
    response = JSON::parse raw_response
  rescue
    $stderr.puts "Failed to parse response from JIRA: #{raw_response}"
    return nil
  end
  return response
end

#current_sprint(keys = [ 'sprintsData', 'sprints', 0 ]) ⇒ Object 



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/opsask/helpers.rb', line 206

def current_sprint keys=[ 'sprintsData', 'sprints', 0 ]
  url = "#{settings.config[:jira_url]}/rest/greenhopper/1.0/xboard/work/allData.json?rapidViewId=#{settings.config[:agile_board]}"
  curl_request = Curl::Easy.http_get(url) do |curl|
    curl.headers['Accept'] = 'application/json'
    curl.headers['Content-Type'] = 'application/json'
    curl.http_auth_types = :basic
    curl.username = settings.config[:jira_user]
    curl.password = settings.config[:jira_pass]
    curl.verbose  = true
  end

  raw_response = curl_request.body_str
  begin
    data = JSON::parse(raw_response)
    keys.each { |k| data = data[k] }
    return data unless data.nil?
  rescue
    $stderr.puts "Failed to parse response from JIRA: #{raw_response}"
  end
  get_sprint(nil, sprints.last['id'])
end

#current_sprint_ends(sprint = current_sprint) ⇒ Object 



187
188
189
190
191
192
 
# File 'lib/opsask/helpers.rb', line 187

def current_sprint_ends sprint=current_sprint
  if ends = sprint['endDate']
    ends = DateTime.strptime(ends, '%d/%b/%y %l:%M %p')
    ends.strftime('%Y/%m/%d')
  end
end

#current_sprint_id(sprint = current_sprint) ⇒ Object 



202
203
204
 
# File 'lib/opsask/helpers.rb', line 202

def current_sprint_id sprint=current_sprint
  sprint.nil? ? nil : sprint['id']
end

#current_sprint_name(sprint = current_sprint) ⇒ Object 



194
195
196
 
# File 'lib/opsask/helpers.rb', line 194

def current_sprint_name sprint=current_sprint
  sprint.nil? ? nil : sprint['name'].gsub(/\s+/, '')
end

#current_sprint_num(sprint = current_sprint) ⇒ Object 



198
199
200
 
# File 'lib/opsask/helpers.rb', line 198

def current_sprint_num sprint=current_sprint
  sprint.nil? ? nil : sprint['name'].gsub(/\D+/, '')
end

#current_sprint_starts(sprint = current_sprint) ⇒ Object 



180
181
182
183
184
185
 
# File 'lib/opsask/helpers.rb', line 180

def current_sprint_starts sprint=current_sprint
  if starts = sprint['startDate']
    starts = DateTime.strptime(starts, '%d/%b/%y %l:%M %p')
    starts.strftime('%Y/%m/%d')
  end
end

#date_for_new_jiras ⇒ Object 



296
297
298
299
300
301
302
303
304
 
# File 'lib/opsask/helpers.rb', line 296

def date_for_new_jiras
  if now.hour < settings.config[:cutoff_hour] || its_the_weekend?
    return today if room_for_new_jiras_for? today
    return tomorrow if room_for_new_jiras_for? tomorrow
  else
    return tomorrow if room_for_new_jiras_for? tomorrow
  end
  return nil
end

#epic(key) ⇒ Object 



439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'lib/opsask/helpers.rb', line 439

def epic key
  url = "#{settings.config[:jira_url]}/rest/api/latest/issue/#{key}"
  curl_request = Curl::Easy.http_get(url) do |curl|
    curl.headers['Accept'] = 'application/json'
    curl.headers['Content-Type'] = 'application/json'
    curl.http_auth_types = :basic
    curl.username = settings.config[:jira_user]
    curl.password = settings.config[:jira_pass]
    curl.verbose  = true
  end

  raw_response = curl_request.body_str
  begin
    response = JSON::parse raw_response
  rescue
    $stderr.puts "Failed to parse response from JIRA: #{raw_response}"
    return nil
  end
  return {
    'key' => response['key'],
    'name' => response['fields']['customfield_10351'] || response['fields']['summary']
  }
end

#epics ⇒ Object 



407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
 
# File 'lib/opsask/helpers.rb', line 407

def epics
  data = {
    jql: normalized_jql("type = Epic"),
    startAt: 0,
    maxResults: 1000
  }

  url = "#{settings.config[:jira_url]}/rest/api/latest/search"
  curl_request = Curl::Easy.http_post(url, data.to_json) do |curl|
    curl.headers['Accept'] = 'application/json'
    curl.headers['Content-Type'] = 'application/json'
    curl.http_auth_types = :basic
    curl.username = settings.config[:jira_user]
    curl.password = settings.config[:jira_pass]
    curl.verbose  = true
  end

  raw_response = curl_request.body_str
  begin
    response = JSON::parse raw_response
  rescue
    $stderr.puts "Failed to parse response from JIRA: #{raw_response}"
    return nil
  end
  return response['issues'].map do |epic|
    {
      'key' => epic['key'],
      'name' => epic['fields']['customfield_10351'] || epic['fields']['summary']
    }
  end
end

#get_sprint(num, id = nil) ⇒ Object 



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/opsask/helpers.rb', line 153

def get_sprint num, id=nil
  unless sprint_id = id
    sprint = sprints.select { |s| s['name'] == "#{sprint_prefix} #{num}" }
    sprint_id = sprint.first['id']
  end
  url = "#{settings.config[:jira_url]}/rest/greenhopper/1.0/rapid/charts/sprintreport?rapidViewId=#{settings.config[:agile_board]}&sprintId=#{sprint_id}"
  curl_request = Curl::Easy.http_get(url) do |curl|
    curl.headers['Accept'] = 'application/json'
    curl.headers['Content-Type'] = 'application/json'
    curl.http_auth_types = :basic
    curl.username = settings.config[:jira_user]
    curl.password = settings.config[:jira_pass]
    curl.verbose  = true
  end

  raw_response = curl_request.body_str
  begin
    data = JSON::parse(raw_response)
    contents = data.delete('contents')
    data = data.delete('sprint')
    return data.merge(contents)
  rescue
    $stderr.puts "Failed to parse response from JIRA: #{raw_response}"
  end
  return {}
end

#issues_for(date) ⇒ Object 



281
282
283
284
285
 
# File 'lib/opsask/helpers.rb', line 281

def issues_for date
  jiras_for(date).sort_by do |jira|
    sorting_key_for(jira)
  end.reverse
end

#items_in_current_sprint ⇒ Object 



95
96
97
 
# File 'lib/opsask/helpers.rb', line 95

def items_in_current_sprint
  items_in_sprint current_sprint_num
end

#items_in_sprint(num) ⇒ Object 



99
100
101
102
103
104
105
106
107
108
 
# File 'lib/opsask/helpers.rb', line 99

def items_in_sprint num
  return [] unless logged_in?
  issues = []
  id = get_sprint(num)['id']
  query = normalized_jql("sprint = #{id}", nil)
  @jira_client.Issue.jql(query, max_results: 500).each do |i|
    issues << i.attrs
  end
  return issues
end

#its_the_weekend? ⇒ Boolean

Returns:

  • (Boolean) 


287
288
289
 
# File 'lib/opsask/helpers.rb', line 287

def its_the_weekend?
  now.saturday? || now.sunday?
end

#jira_count_for(date) ⇒ Object 



256
257
258
 
# File 'lib/opsask/helpers.rb', line 256

def jira_count_for date
  jiras_for(date).length
end

#jira_count_for_today ⇒ Object 



260
 
# File 'lib/opsask/helpers.rb', line 260

def jira_count_for_today ; jira_count_for(today) end

#jira_count_for_tomorrow ⇒ Object 



262
 
# File 'lib/opsask/helpers.rb', line 262

def jira_count_for_tomorrow ; jira_count_for(tomorrow) end

#jiras_for(date) ⇒ Object 



248
249
250
251
252
253
254
 
# File 'lib/opsask/helpers.rb', line 248

def jiras_for date
  return [] unless logged_in?
  unless ops?
    return @jira_client.Issue.jql normalized_jql("due = #{date} and type != Change and labels in (OpsAsk) and labels not in (OpsOnly)"), max_results: 100
  end
  return @jira_client.Issue.jql normalized_jql("due = #{date} and labels in (OpsAsk) and type != Change"), max_results: 100
end

#logged_in? ⇒ Boolean

Returns:

  • (Boolean) 


3
4
5
 
# File 'lib/opsask/helpers.rb', line 3

def logged_in?
  !!session[:jira_auth]
end

#name_for_coming_week ⇒ Object 



244
245
246
 
# File 'lib/opsask/helpers.rb', line 244

def name_for_coming_week
  todays_date.strftime 'Week of %-d %b'
end

#name_for_today(offset = 0) ⇒ Object 



236
237
238
 
# File 'lib/opsask/helpers.rb', line 236

def name_for_today offset=0
  todays_date(offset).strftime '%A %-d %b'
end

#name_for_tomorrow ⇒ Object 



240
241
242
 
# File 'lib/opsask/helpers.rb', line 240

def name_for_tomorrow
  name_for_today(one_day)
end

#normalized_jql(query, project = , require_label = , ignore_label = ) ⇒ Object 



463
464
465
466
467
468
469
470
471
472
 
# File 'lib/opsask/helpers.rb', line 463

def normalized_jql query, \
  project=settings.config[:project_name], \
  require_label=settings.config[:require_label],
  ignore_label=settings.config[:ignore_label]
# ...
  query += %Q| and project = #{project}| if project
  query += %Q| and labels = #{require_label}| if require_label
  query += %Q| and (labels != #{ignore_label} OR labels is empty)| if ignore_label
  return query
end

#now ⇒ Object 



19
20
21
 
# File 'lib/opsask/helpers.rb', line 19

def now
  Time.now # + 3 * one_day # DEBUG
end

#one_day ⇒ Object 



15
16
17
 
# File 'lib/opsask/helpers.rb', line 15

def one_day
  1 * 24 * 60 * 60 # Day * Hour * Minute * Second = Seconds / Day
end

#ops? ⇒ Boolean

Returns:

  • (Boolean) 


7
8
9
10
11
12
13
 
# File 'lib/opsask/helpers.rb', line 7

def ops?
  return false unless logged_in?
  @myself['groups']['items'].each do |i|
    return true if i['name'] == settings.config[:ops_group]
  end
  return false
end

#outlier_issues(sprint, num) ⇒ Object 



86
87
88
89
90
91
92
93
 
# File 'lib/opsask/helpers.rb', line 86

def outlier_issues sprint, num
  return [] unless logged_in?
  issues = []
  @jira_client.Issue.jql(outlier_query(sprint, num), max_results: 500).each do |i|
    issues << i.attrs
  end
  return issues
end

#outlier_link(sprint, num) ⇒ Object 



82
83
84
 
# File 'lib/opsask/helpers.rb', line 82

def outlier_link sprint, num
  "#{settings.config[:jira_url]}/issues/?jql=#{URI::escape outlier_query(sprint, num)}"
end

#outlier_query(sprint, num) ⇒ Object 



76
77
78
79
80
 
# File 'lib/opsask/helpers.rb', line 76

def outlier_query sprint, num
  starts = current_sprint_starts sprint
  ends   = current_sprint_ends sprint
  normalized_jql("(sprint != #{sprint['id']} or sprint is empty) and (labels != \"#{sprint_label_prefix}#{num}\" OR labels is empty) and resolved >= \"#{starts}\" and resolved <= \"#{ends}\"")
end

#raw_classes_for(jira) ⇒ Object 



264
265
266
267
 
# File 'lib/opsask/helpers.rb', line 264

def raw_classes_for jira
  classes = [ jira.fields['resolution'].nil? ? 'open' : 'closed' ]
  classes << jira.fields['assignee']['name'].downcase.gsub(/\W+/, '')
end

#room_for_new_jiras? ⇒ Boolean

Returns:

  • (Boolean) 


306
307
308
309
 
# File 'lib/opsask/helpers.rb', line 306

def room_for_new_jiras?
  return true if ops?
  !date_for_new_jiras.nil?
end

#room_for_new_jiras_for?(date) ⇒ Boolean

Returns:

  • (Boolean) 


291
292
293
294
 
# File 'lib/opsask/helpers.rb', line 291

def room_for_new_jiras_for? date
  return true if ops?
  jira_count_for(date) < settings.config[:queue_size]
end

#sorting_key_for(jira) ⇒ Object 



273
274
275
276
277
278
279
 
# File 'lib/opsask/helpers.rb', line 273

def sorting_key_for jira
  rcs = raw_classes_for(jira)
  idx = 1
  idx = 2 if rcs.include? 'denimcores'
  idx = 0 if rcs.include? 'closed'
  return "#{idx}-#{jira.key}"
end

#sprint_label_prefix ⇒ Object 



149
150
151
 
# File 'lib/opsask/helpers.rb', line 149

def sprint_label_prefix
  sprint_prefix.gsub(/\s+/, '')
end

#sprint_prefix ⇒ Object 



145
146
147
 
# File 'lib/opsask/helpers.rb', line 145

def sprint_prefix
  settings.config[:sprint_prefix] ||= 'Sprint'
end

#sprints ⇒ Object 



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/opsask/helpers.rb', line 124

def sprints
  url = "#{settings.config[:jira_url]}/rest/greenhopper/1.0/sprintquery/#{settings.config[:agile_board]}"
  curl_request = Curl::Easy.http_get(url) do |curl|
    curl.headers['Accept'] = 'application/json'
    curl.headers['Content-Type'] = 'application/json'
    curl.http_auth_types = :basic
    curl.username = settings.config[:jira_user]
    curl.password = settings.config[:jira_pass]
    curl.verbose  = true
  end

  raw_response = curl_request.body_str
  begin
    data = JSON::parse(raw_response)
    return data['sprints']
  rescue
    $stderr.puts "Failed to parse response from JIRA: #{raw_response}"
  end
  return nil
end

#stats_for(issues, resolved_link, unresolved_link, unsized_link) ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/opsask/helpers.rb', line 30

def stats_for issues, resolved_link, unresolved_link, unsized_link
  return {} unless logged_in?
  return {} unless issues

  unsized_issues, resolved_issues, unresolved_issues = [], [], []

  issues.map! do |i|
    key = i['key']
    status = i['fields']['status']['name']
    resolution = i['fields']['resolution']['name'] rescue nil
    points = i['fields']['customfield_10002'].to_i

    issue = {
      key: key,
      status: status,
      resolution: resolution,
      points: points
    }

    if i['fields']['customfield_10002'].nil?
      unsized_issues << issue
    elsif resolution.nil?
      unresolved_issues << issue
    else
      resolved_issues << issue
    end
  end

  {
    resolved: {
      number: resolved_issues.size,
      points: resolved_issues.map { |i| i[:points] }.reduce(0, :+),
      link: resolved_link
    },
    unresolved: {
      number: unresolved_issues.size,
      points: unresolved_issues.map { |i| i[:points] }.reduce(0, :+),
      link: unresolved_link
    },
    unsized: {
      number: unsized_issues.size,
      link: unsized_link
    }
  }
end

#straggling_issues ⇒ Object 



394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/opsask/helpers.rb', line 394

def straggling_issues
  return [] unless logged_in?
  constraints = [
    "due < #{today}",
    "labels in (OpsAsk)",
    "resolution = unresolved",
    "assignee != denimcores"
  ].join(' and ')
  @jira_client.Issue.jql(normalized_jql(constraints), max_results: 100).sort_by do |jira|
    sorting_key_for(jira)
  end.reverse
end

#today(offset = 0) ⇒ Object 



228
229
230
 
# File 'lib/opsask/helpers.rb', line 228

def today offset=0
  todays_date(offset).strftime '%Y-%m-%d'
end

#todays_date(offset = 0) ⇒ Object 



23
24
25
26
27
28
 
# File 'lib/opsask/helpers.rb', line 23

def todays_date offset=0
  date  = now + offset
  date += one_day if date.saturday?
  date += one_day if date.sunday?
  return date
end

#tomorrow ⇒ Object 



232
233
234
 
# File 'lib/opsask/helpers.rb', line 232

def tomorrow
  today(one_day)
end

#untracked_issues ⇒ Object 



382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/opsask/helpers.rb', line 382

def untracked_issues
  return [] unless logged_in?
  constraints = [
    "due < #{today}",
    "resolution = unresolved",
    "assignee = denimcores"
  ].join(' and ')
  @jira_client.Issue.jql(normalized_jql(constraints), max_results: 100).sort_by do |jira|
    sorting_key_for(jira)
  end.reverse
end

#validate_jira_params ⇒ Object 



318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/opsask/helpers.rb', line 318

def validate_jira_params
  flash[:error] = []
  flash[:error] << 'Summary is required' if params['jira-summary'].empty?
  redirect '/' unless flash[:error].empty?
  return [
    params['jira-component'],
    params['jira-summary'],
    params['jira-description'],
    !!params['jira-assign_to_me'],
    params['jira-epic'],
    !!params['jira-ops_only']
  ]
end

#validate_room_for_new_jiras ⇒ Object 



311
312
313
314
315
316
 
# File 'lib/opsask/helpers.rb', line 311

def validate_room_for_new_jiras
  duedate = date_for_new_jiras
  return duedate unless duedate.nil?
  flash[:error] = [ "Sorry, there's is no room for new JIRAs" ]
  redirect '/'
end