Class: Geet::Github::Milestone

Inherits:
Object
  • Object
show all
Extended by:
Helpers::JsonHelper
Defined in:
lib/geet/github/milestone.rb

Constant Summary collapse

STATE_CLOSED = 
'closed'

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Helpers::JsonHelper

parse_iso_8601_timestamp

Constructor Details

#initialize(number, title, due_on, api_interface) ⇒ Milestone

Returns a new instance of Milestone.



18
19
20
21
22
23
24
 
# File 'lib/geet/github/milestone.rb', line 18

def initialize(number, title, due_on, api_interface)
  @number = number
  @title = title
  @due_on = due_on

  @api_interface = api_interface
end

Instance Attribute Details

#due_on ⇒ Object (readonly)

Returns the value of attribute due_on.



8
9
10
 
# File 'lib/geet/github/milestone.rb', line 8

def due_on
  @due_on
end

#number ⇒ Object (readonly)

Returns the value of attribute number.



8
9
10
 
# File 'lib/geet/github/milestone.rb', line 8

def number
  @number
end

#title ⇒ Object (readonly)

Returns the value of attribute title.



8
9
10
 
# File 'lib/geet/github/milestone.rb', line 8

def title
  @title
end

Class Method Details

.close(number, api_interface) ⇒ Object

See docs.github.com/en/free-pro-team@latest/rest/reference/issues#update-a-milestone

This is a convenience method; the underlying operation is a generic update.



74
75
76
77
78
79
 
# File 'lib/geet/github/milestone.rb', line 74

def self.close(number, api_interface, **)
  api_path = "milestones/#{number}"
  request_data = { state: STATE_CLOSED }

  api_interface.send_request(api_path, data: request_data)
end

.create(title, api_interface) ⇒ Object

See developer.github.com/v3/issues/milestones/#create-a-milestone



27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/geet/github/milestone.rb', line 27

def self.create(title, api_interface, **)
  api_path = 'milestones'
  request_data = { title: title }

  response = api_interface.send_request(api_path, data: request_data)

  number = response.fetch('number')
  title = response.fetch('title')
  due_on = nil

  new(number, title, due_on, api_interface)
end

.find(number, api_interface) ⇒ Object

See developer.github.com/v3/issues/milestones/#get-a-single-milestone



42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/geet/github/milestone.rb', line 42

def self.find(number, api_interface, **)
  api_path = "milestones/#{number}"

  response = api_interface.send_request(api_path)

  number = response.fetch('number')
  title = response.fetch('title')
  due_on = parse_iso_8601_timestamp(raw_due_on)

  new(number, title, due_on, api_interface)
end

.list(api_interface) ⇒ Object

See developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository



56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/geet/github/milestone.rb', line 56

def self.list(api_interface, **)
  api_path = 'milestones'

  response = api_interface.send_request(api_path, multipage: true)

  response.map do |milestone_data|
    number = milestone_data.fetch('number')
    title = milestone_data.fetch('title')
    due_on = parse_iso_8601_timestamp(milestone_data.fetch('due_on'))

    new(number, title, due_on, api_interface)
  end
end