Module: OpsAsk::Helpers

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

Instance Method Summary collapse

Instance Method Details

#asks_in_current_sprint ⇒ Object 



122
123
124
 
# File 'lib/opsask/helpers.rb', line 122

def asks_in_current_sprint
  asks_in_sprint current_sprint_num
end

#asks_in_sprint(num) ⇒ Object 



126
127
128
129
130
131
132
133
134
 
# File 'lib/opsask/helpers.rb', line 126

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

#classes_for(jira) ⇒ Object 



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

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

#components ⇒ Object 



408
409
410
 
# File 'lib/opsask/helpers.rb', line 408

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 



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/opsask/helpers.rb', line 364

def create_jira duedate, component, summary, description, assign_to_me, epic, ops_only
  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_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 



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/opsask/helpers.rb', line 218

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 



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

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 



214
215
216
 
# File 'lib/opsask/helpers.rb', line 214

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

#current_sprint_name(sprint = current_sprint) ⇒ Object 



206
207
208
 
# File 'lib/opsask/helpers.rb', line 206

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

#current_sprint_num(sprint = current_sprint) ⇒ Object 



210
211
212
 
# File 'lib/opsask/helpers.rb', line 210

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

#current_sprint_starts(sprint = current_sprint) ⇒ Object 



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

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(really = false, depth = 0) ⇒ Object 



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/opsask/helpers.rb', line 333

def date_for_new_jiras really=false, depth=0
  logger.debug 'date_for_new_jiras really=%s' % really.inspect
  if now.hour < settings.config[:cutoff_hour] || its_the_weekend?
    return today if room_for_new_jiras_for? today, really
  end

  # Remove the two-day limit [OPS-1862]
  n = 0 # days from now
  loop do
    n += 1 # first call n=1, tomorrow
    next_day = today n * one_day
    logger.debug 'date_for_new_jiras next_day=%s' % next_day.inspect
    return next_day if room_for_new_jiras_for? next_day, really
  end
end

#epics ⇒ Object 



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

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 



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/opsask/helpers.rb', line 165

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

#holiday?(date) ⇒ Boolean

Returns:

  • (Boolean) 


319
320
321
322
323
 
# File 'lib/opsask/helpers.rb', line 319

def holiday? date
  date = date.split('-',3).map(&:to_i)
  date = Date.civil *date
  Holidays.on(date, :us).any?
end

#issues_for(date) ⇒ Object 



309
310
311
312
313
 
# File 'lib/opsask/helpers.rb', line 309

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

#issues_for_days(n, start = 0) ⇒ Object 



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

def issues_for_days n, start=0
  now = Time.new.to_date
  last = start + n
  start.upto(last-1).inject({}) do |h,i|
    date = (now + i).strftime('%Y-%m-%d')
    h[date] = jiras_for(date).sort_by do |jira|
      sorting_key_for(jira)
    end.reverse
    h
  end
end

#items_in_current_sprint ⇒ Object 



107
108
109
 
# File 'lib/opsask/helpers.rb', line 107

def items_in_current_sprint
  items_in_sprint current_sprint_num
end

#items_in_sprint(num) ⇒ Object 



111
112
113
114
115
116
117
118
119
120
 
# File 'lib/opsask/helpers.rb', line 111

def items_in_sprint num
  return [] unless logged_in?
  issues = []
  id = get_sprint(num)['id']
  query = normalized_jql("sprint = #{id}", project: 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) 


315
316
317
 
# File 'lib/opsask/helpers.rb', line 315

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

#jira_count_for(date, really = false) ⇒ Object 



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

def jira_count_for date, really=false
  jiras_for(date, really).length
end

#jira_count_for_today(really = false) ⇒ Object 



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

def jira_count_for_today really=false ; jira_count_for(today, really) end

#jira_count_for_tomorrow(really = false) ⇒ Object 



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

def jira_count_for_tomorrow really=false ; jira_count_for(tomorrow, really) end

#jiras_for(date, really = false) ⇒ Object 



260
261
262
263
264
265
266
267
 
# File 'lib/opsask/helpers.rb', line 260

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

#logged_in? ⇒ Boolean

Returns:

  • (Boolean) 


7
8
9
 
# File 'lib/opsask/helpers.rb', line 7

def logged_in?
  !!session[:jira_auth]
end

#name_for_coming_week ⇒ Object 



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

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

#name_for_today(offset = 0) ⇒ Object 



248
249
250
 
# File 'lib/opsask/helpers.rb', line 248

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

#name_for_tomorrow ⇒ Object 



252
253
254
 
# File 'lib/opsask/helpers.rb', line 252

def name_for_tomorrow
  name_for_today(one_day)
end

#no_ops(jiras) ⇒ Object 



11
12
13
14
15
 
# File 'lib/opsask/helpers.rb', line 11

def no_ops jiras
  jiras.reject do |jira|
    jira.fields['labels'].include? 'OpsOnly'
  end
end

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



469
470
471
472
473
474
475
476
477
478
 
# File 'lib/opsask/helpers.rb', line 469

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 



29
30
31
 
# File 'lib/opsask/helpers.rb', line 29

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

#one_day ⇒ Object 



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

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

#ops? ⇒ Boolean

Returns:

  • (Boolean) 


17
18
19
20
21
22
23
 
# File 'lib/opsask/helpers.rb', line 17

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 



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

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 



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

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

#outlier_query(sprint, num) ⇒ Object 



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

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 



277
278
279
 
# File 'lib/opsask/helpers.rb', line 277

def raw_classes_for jira
  [ jira.fields['resolution'].nil? ? 'open' : 'closed' ]
end

#room_for_new_jiras_for?(date, really = false) ⇒ Boolean

Returns:

  • (Boolean) 


325
326
327
328
329
330
331
 
# File 'lib/opsask/helpers.rb', line 325

def room_for_new_jiras_for? date, really=false
  return true  if params[:force]
  return false if params[:full]
  return false if holiday? date
  return true  if ops? && !really
  jira_count_for(date, really) < settings.config[:queue_size]
end

#sorting_key_for(jira) ⇒ Object 



285
286
287
288
289
290
291
 
# File 'lib/opsask/helpers.rb', line 285

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 



161
162
163
 
# File 'lib/opsask/helpers.rb', line 161

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

#sprint_prefix ⇒ Object 



157
158
159
 
# File 'lib/opsask/helpers.rb', line 157

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

#sprints ⇒ Object 



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/opsask/helpers.rb', line 136

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 



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
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/opsask/helpers.rb', line 40

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
    end

    if 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 



424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/opsask/helpers.rb', line 424

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 



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

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

#today?(date) ⇒ Boolean

Returns:

  • (Boolean) 


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

def today? date
  Time.new.to_date.strftime('%Y-%m-%d') == date
end

#todays_date(offset = 0) ⇒ Object 



33
34
35
36
37
38
 
# File 'lib/opsask/helpers.rb', line 33

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 



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

def tomorrow
  today(one_day)
end

#untracked_issues ⇒ Object 



412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/opsask/helpers.rb', line 412

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 



349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/opsask/helpers.rb', line 349

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'],
    nil,
    !!params['jira-ops_only'],
    params['jira-datepicker']
  ]
end