Class: Github::Client::Issues::Milestones

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

Constant Summary collapse

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

:nodoc:

%w[
  title
  state
  description
  due_on
].freeze

Constants included from MimeType

MimeType::MEDIA_LOOKUP

Constants included from Github::Constants

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

Instance Attribute Summary

Attributes inherited from API

#current_options

Instance Method Summary collapse

Methods inherited from API

after_callbacks, after_request, #api_methods_in, #arguments, before_callbacks, before_request, clear_request_methods!, #execute, extend_with_actions, extra_methods, #extract_basic_auth, extract_class_name, #filter_callbacks, inherited, #initialize, internal_methods, method_added, #method_missing, #module_methods_in, namespace, request_methods, root!, #run_callbacks, #set, #yield_or_eval

Methods included from Github::ClassMethods

#configuration, #configure, #require_all

Methods included from RateLimit

#ratelimit, #ratelimit_remaining, #ratelimit_reset

Methods included from Request::Verbs

#delete_request, #get_request, #head_request, #options_request, #patch_request, #post_request, #put_request

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

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"

Parameters:


92
93
94
95
96
97
98
99
# File 'lib/github_api/client/issues/milestones.rb', line 92

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

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

#delete(*args) ⇒ Object

Delete a milestone

Examples:

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

138
139
140
141
142
# File 'lib/github_api/client/issues/milestones.rb', line 138

def delete(*args)
  arguments(args, required: [:user, :repo, :number])

  delete_request("/repos/#{arguments.user}/#{arguments.repo}/milestones/#{arguments.number}", arguments.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-number'
github.issues.milestones.get
  user: 'user-name',
  repo: 'repo-name',
  number: 'milestone-number'

64
65
66
67
68
# File 'lib/github_api/client/issues/milestones.rb', line 64

def get(*args)
  arguments(args, required: [:user, :repo, :number])

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

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

List milestones for a repository

Examples:

github = Github.new user: 'user-name', repo: 'repo-name'
github.issues.milestones.list
github.issues.milestones.list state: 'open', sort: 'due_date',
  direction: 'asc'

Parameters:


39
40
41
42
43
44
45
46
47
48
# File 'lib/github_api/client/issues/milestones.rb', line 39

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

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

#update(*args) ⇒ Object

Update a milestone

Examples:

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

Parameters:


123
124
125
126
127
128
129
# File 'lib/github_api/client/issues/milestones.rb', line 123

def update(*args)
  arguments(args, required: [:user, :repo, :number]) do
    permit VALID_MILESTONE_INPUTS
  end

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