Class: Github::Issues::Milestones

Inherits:
API
  • Object
show all
Defined in:
lib/github_api/issues/milestones.rb

Constant Summary collapse

VALID_MILESTONE_OPTIONS = 
{
 'state' => %w[ open closed ],
 'sort'  => %w[ due_date completeness ],
 'direction' => %w[ desc asc ]
}.freeze
VALID_MILESTONE_INPUTS =

:nodoc:

%w[
  title
  state
  description
  due_on
].freeze

Constants included from Request

Request::METHODS, Request::METHODS_WITH_BODIES

Constants included from Connection

Connection::ALLOWED_OPTIONS

Constants included from Constants

Constants::ACCEPT, Constants::ACCEPTED_OAUTH_SCOPES, Constants::ACCEPT_CHARSET, Constants::CACHE_CONTROL, Constants::CONTENT_LENGTH, Constants::CONTENT_TYPE, Constants::DATE, Constants::ETAG, Constants::HEADER_LAST, Constants::HEADER_LINK, Constants::HEADER_NEXT, Constants::LOCATION, Constants::META_FIRST, Constants::META_LAST, Constants::META_NEXT, Constants::META_PREV, Constants::META_REL, Constants::OAUTH_SCOPES, Constants::PARAM_PAGE, Constants::PARAM_PER_PAGE, Constants::PARAM_START_PAGE, Constants::RATELIMIT_LIMIT, Constants::RATELIMIT_REMAINING, Constants::SERVER, Constants::USER_AGENT

Constants included from MimeType

MimeType::MEDIA_LOOKUP

Instance Attribute Summary

Attributes inherited from API

#current_options

Attributes included from Authorization

#scopes

Instance Method Summary collapse

Methods inherited from API

#api_methods_in, #append_arguments, #arguments, inherited, #initialize, #method_missing, #process_basic_auth, #set, #setup, #with, #yield_or_eval

Methods included from RateLimit

#ratelimit, #ratelimit_remaining

Methods included from Request

#delete_request, #get_request, #patch_request, #post_request, #put_request, #request

Methods included from Connection

#caching?, #clear_cache, #connection, #default_middleware, #default_options, #stack

Methods included from MimeType

#lookup_media, #parse

Methods included from Authorization

#auth_code, #authenticated?, #authentication, #authorize_url, #basic_authed?, #client, #get_token

Constructor Details

This class inherits a constructor from Github::API

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Github::API

Instance Method Details

#create(*args) ⇒ Object

Create a milestone

Inputs

<tt>:title</tt> - Required string
<tt>:state</tt> - Optional string - <tt>open</tt> or <tt>closed</tt>
<tt>:description</tt> - Optional string
<tt>:due_on</tt> - Optional string - ISO 8601 time

Examples

github = Github.new :user => 'user-name', :repo => 'repo-name'
github.issues.milestones.create :title => 'hello-world',
  :state => "open or closed",
  :description => "String",
  :due_on => "Time"



77
78
79
80
81
82
83
84
 
# File 'lib/github_api/issues/milestones.rb', line 77

def create(*args)
  arguments(args, :required => [:user, :repo]) do
    sift VALID_MILESTONE_INPUTS
    assert_required %w[ title ]
  end

  post_request("/repos/#{user}/#{repo}/milestones", arguments.params)
end

#delete(*args) ⇒ Object

Delete a milestone

Examples

github = Github.new
github.issues.milestones.delete 'user-name', 'repo-name', 'milestone-id'



117
118
119
120
121
122
 
# File 'lib/github_api/issues/milestones.rb', line 117

def delete(*args)
  arguments(args, :required => [:user, :repo, :milestone_id])
  params = arguments.params

  delete_request("/repos/#{user}/#{repo}/milestones/#{milestone_id}", params)
end

#get(*args) ⇒ Object Also known as: find

Get a single milestone

Examples

github = Github.new
github.issues.milestones.get 'user-name', 'repo-name', 'milestone-id'



54
55
56
57
58
59
 
# File 'lib/github_api/issues/milestones.rb', line 54

def get(*args)
  arguments(args, :required => [:user, :repo, :milestone_id])
  params = arguments.params

  get_request("/repos/#{user}/#{repo}/milestones/#{milestone_id}", params)
end

#list(*args) ⇒ Object Also known as: all

List milestones for a repository

Parameters

:state - open, closed, default: open :sort - due_date, completeness, default: due_date :direction - asc, desc, default: desc

Examples

github = Github.new user: 'user-name', repo: 'repo-name'
github.issues.milestones.list

or

github.issues.milestones.list state: 'open', sort: 'due_date',
  direction: 'asc'



35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/github_api/issues/milestones.rb', line 35

def list(*args)
  arguments(args, :required => [:user, :repo]) do
    sift VALID_MILESTONE_OPTIONS.keys
    assert_values VALID_MILESTONE_OPTIONS
  end
  params = arguments.params

  response = get_request("/repos/#{user}/#{repo}/milestones", params)
  return response unless block_given?
  response.each { |el| yield el }
end

#update(*args) ⇒ Object

Update a milestone

Inputs

<tt>:title</tt> - Required string
<tt>:state</tt> - Optional string - <tt>open</tt> or <tt>closed</tt>
<tt>:description</tt> - Optional string
<tt>:due_on</tt> - Optional string - ISO 8601 time

Examples

github = Github.new
github.issues.milestones.update 'user-name', 'repo-name', 'milestone-id',
  :title => 'hello-world',
  :state => "open or closed",
  :description => "String",
  :due_on => "Time"



102
103
104
105
106
107
108
109
 
# File 'lib/github_api/issues/milestones.rb', line 102

def update(*args)
  arguments(args, :required => [:user, :repo, :milestone_id]) do
    sift VALID_MILESTONE_INPUTS
  end
  params = arguments.params

  patch_request("/repos/#{user}/#{repo}/milestones/#{milestone_id}", params)
end