Class: LabClient::Epics

Inherits:
Common
  • Object
show all
Defined in:
lib/labclient/epics/list.rb,
lib/labclient/epics/show.rb,
lib/labclient/epics/todo.rb,
lib/labclient/epics/create.rb,
lib/labclient/epics/delete.rb,
lib/labclient/epics/update.rb,
lib/labclient/epics/issues/add.rb,
lib/labclient/epics/issues/list.rb,
lib/labclient/epics/issues/remove.rb,
lib/labclient/epics/issues/update.rb

Overview

Specifics

Constant Summary

Constants included from AccessLevel

AccessLevel::HUMAN_ACCESS_LEVELS, AccessLevel::MACHINE_ACCESS_LEVELS

Instance Attribute Summary

Attributes inherited from Common

#client

Instance Method Summary collapse

Methods inherited from Common

#api_methods, #api_methods_help, #format_id, #format_query_id, #format_query_ids, #format_time?, #group_name, #help, #initialize, #inspect, #klass, #protected_query_access_level, #query_access_level, #query_format_time

Methods included from Docs

#demo, #desc, #doc, docs, #example, #group_name, #help, json, #markdown, #navigation, #option, #result, #subtitle, #title

Methods included from AccessLevel

#human_access_level, #human_protected_access_level, #machine_access_level, #machine_protected_access_level

Constructor Details

This class inherits a constructor from LabClient::Common

Instance Method Details

#create(group_id, query) ⇒ Object 



36
37
38
39
40
 
# File 'lib/labclient/epics/create.rb', line 36

def create(group_id, query)
  group_id = format_id(group_id)

  client.request(:post, "groups/#{group_id}/epics", Epic, query)
end

#delete(group_id, epic_id) ⇒ Object 



26
27
28
29
30
31
32
33
 
# File 'lib/labclient/epics/delete.rb', line 26

def delete(group_id, epic_id)
  # DELETE /groups/:id/epics/:epic_iid

  group_id = format_id(group_id)
  epic_id = format_id(epic_id)

  client.request(:delete, "groups/#{group_id}/epics/#{epic_id}")
end

#issue_add(group_id, epic_id, issue_id) ⇒ Object 



27
28
29
30
31
32
33
 
# File 'lib/labclient/epics/issues/add.rb', line 27

def issue_add(group_id, epic_id, issue_id)
  group_id = format_id(group_id)
  epic_id = format_id(epic_id)
  issue_id = format_id(issue_id)

  client.request(:post, "groups/#{group_id}/epics/#{epic_id}/issues/#{issue_id}")
end

#issue_remove(group_id, epic_id, epic_issue_id) ⇒ Object 



27
28
29
30
31
32
33
34
35
 
# File 'lib/labclient/epics/issues/remove.rb', line 27

def issue_remove(group_id, epic_id, epic_issue_id)
  group_id = format_id(group_id)
  epic_id = format_id(epic_id)

  # This is horrible, but has to be the epic_issue_id, not the issue's id or iid
  epic_issue_id = epic_issue_id.epic_issue_id if epic_issue_id.instance_of?(Issue)

  client.request(:delete, "groups/#{group_id}/epics/#{epic_id}/issues/#{epic_issue_id}")
end

#issue_update(group_id, epic_id, epic_issue_id, query) ⇒ Object 



34
35
36
37
38
39
40
41
42
 
# File 'lib/labclient/epics/issues/update.rb', line 34

def issue_update(group_id, epic_id, epic_issue_id, query)
  group_id = format_id(group_id)
  epic_id = format_id(epic_id)

  # This is horrible, but has to be the epic_issue_id, not the issue's id or iid
  epic_issue_id = epic_issue_id.epic_issue_id if epic_issue_id.instance_of?(Issue)

  client.request(:put, "groups/#{group_id}/epics/#{epic_id}/issues/#{epic_issue_id}", nil, query)
end

#issues(group_id, epic_id) ⇒ Object 



31
32
33
34
35
36
 
# File 'lib/labclient/epics/issues/list.rb', line 31

def issues(group_id, epic_id)
  group_id = format_id(group_id)
  epic_id = format_id(epic_id)

  client.request(:get, "groups/#{group_id}/epics/#{epic_id}/issues", Issue)
end

#list(group_id, query = {}) ⇒ Object

rubocop:disable Metrics/AbcSize



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/labclient/epics/list.rb', line 41

def list(group_id, query = {})
  group_id = format_id(group_id)

  query[:created_after] = query[:created_after].to_time.iso8601 if format_time?(query[:created_after])
  query[:created_before] = query[:created_before].to_time.iso8601 if format_time?(query[:created_before])

  query[:updated_after] = query[:updated_after].to_time.iso8601 if format_time?(query[:updated_after])
  query[:updated_before] = query[:updated_before].to_time.iso8601 if format_time?(query[:updated_before])

  client.request(:get, "groups/#{group_id}/epics", Epic, query)
end

#show(group_id, epic_id) ⇒ Object 



20
21
22
23
24
25
26
27
 
# File 'lib/labclient/epics/show.rb', line 20

def show(group_id, epic_id)
  # GET /groups/:id/epics/:epic_iid

  group_id = format_id(group_id)
  epic_id = format_id(epic_id)

  client.request(:get, "groups/#{group_id}/epics/#{epic_id}", Epic)
end

#todo(group_id, epic_id) ⇒ Object 



20
21
22
23
24
25
 
# File 'lib/labclient/epics/todo.rb', line 20

def todo(group_id, epic_id)
  group_id = format_id(group_id)
  epic_id = format_id(epic_id)

  client.request(:post, "groups/#{group_id}/epics/#{epic_id}/todo", Todo)
end

#update(group_id, epic_id, query) ⇒ Object 



45
46
47
48
49
50
 
# File 'lib/labclient/epics/update.rb', line 45

def update(group_id, epic_id, query)
  group_id = format_id(group_id)
  epic_id = format_id(epic_id)

  client.request(:put, "groups/#{group_id}/epics/#{epic_id}", Epic, query)
end