Module: Octokit::Client::Issues
- Included in:
- Octokit::Client
- Defined in:
- lib/octokit/client/issues.rb
Overview
Methods for the Issues API
Instance Method Summary collapse
-
#add_comment(repo, number, comment, options = {}) ⇒ Sawyer::Resource
Add a comment to an issue.
-
#close_issue(repo, number, options = {}) ⇒ Sawyer::Resource
Close an issue.
-
#create_issue(repo, title, body, options = {}) ⇒ Sawyer::Resource
(also: #open_issue)
Create an issue for a repository.
-
#delete_comment(repo, number, options = {}) ⇒ Boolean
Delete a single comment.
-
#issue(repo, number, options = {}) ⇒ Sawyer::Resource
Get a single issue from a repository.
-
#issue_comment(repo, number, options = {}) ⇒ Sawyer::Resource
Get a single comment attached to an issue.
-
#issue_comments(repo, number, options = {}) ⇒ Array<Sawyer::Resource>
Get all comments attached to an issue.
-
#issues_comments(repo, options = {}) ⇒ Array<Sawyer::Resource>
Get all comments attached to issues for the repository.
-
#list_issues(repository = nil, options = {}) ⇒ Array<Sawyer::Resource>
(also: #issues)
List issues for the authenticated user or repository.
-
#org_issues(org, options = {}) ⇒ Array<Sawyer::Resource>
List all issues for a given organization for the authenticated user.
-
#reopen_issue(repo, number, options = {}) ⇒ Sawyer::Resource
Reopen an issue.
-
#update_comment(repo, number, comment, options = {}) ⇒ Sawyer::Resource
Update a single comment on an issue.
-
#update_issue(repo, number, title, body, options = {}) ⇒ Sawyer::Resource
Update an issue.
-
#user_issues(options = {}) ⇒ Array<Sawyer::Resource>
List all issues across owned and member repositories for the authenticated user.
Instance Method Details
#add_comment(repo, number, comment, options = {}) ⇒ Sawyer::Resource
Add a comment to an issue
225 226 227 |
# File 'lib/octokit/client/issues.rb', line 225 def add_comment(repo, number, comment, = {}) post "#{Repository.path repo}/issues/#{number}/comments", .merge({:body => comment}) end |
#close_issue(repo, number, options = {}) ⇒ Sawyer::Resource
Close an issue
124 125 126 |
# File 'lib/octokit/client/issues.rb', line 124 def close_issue(repo, number, = {}) patch "#{Repository.path repo}/issues/#{number}", .merge({:state => "closed"}) end |
#create_issue(repo, title, body, options = {}) ⇒ Sawyer::Resource Also known as: open_issue
Create an issue for a repository
89 90 91 92 93 94 95 96 97 |
# File 'lib/octokit/client/issues.rb', line 89 def create_issue(repo, title, body, = {}) [:labels] = case [:labels] when String [:labels].split(",").map(&:strip) when Array [:labels] end post "#{Repository.path repo}/issues", .merge({:title => title, :body => body}) end |
#delete_comment(repo, number, options = {}) ⇒ Boolean
Delete a single comment
250 251 252 |
# File 'lib/octokit/client/issues.rb', line 250 def delete_comment(repo, number, = {}) boolean_from_response :delete, "#{Repository.path repo}/issues/comments/#{number}", end |
#issue(repo, number, options = {}) ⇒ Sawyer::Resource
Get a single issue from a repository
108 109 110 |
# File 'lib/octokit/client/issues.rb', line 108 def issue(repo, number, = {}) get "#{Repository.path repo}/issues/#{number}", end |
#issue_comment(repo, number, options = {}) ⇒ Sawyer::Resource
Get a single comment attached to an issue
212 213 214 |
# File 'lib/octokit/client/issues.rb', line 212 def issue_comment(repo, number, = {}) paginate "#{Repository.path repo}/issues/comments/#{number}", end |
#issue_comments(repo, number, options = {}) ⇒ Array<Sawyer::Resource>
Get all comments attached to an issue
200 201 202 |
# File 'lib/octokit/client/issues.rb', line 200 def issue_comments(repo, number, = {}) paginate "#{Repository.path repo}/issues/#{number}/comments", end |
#issues_comments(repo, options = {}) ⇒ Array<Sawyer::Resource>
Get all comments attached to issues for the repository
By default, Issue Comments are ordered by ascending ID.
188 189 190 |
# File 'lib/octokit/client/issues.rb', line 188 def issues_comments(repo, = {}) paginate "#{Repository.path repo}/issues/comments", end |
#list_issues(repository = nil, options = {}) ⇒ Array<Sawyer::Resource> Also known as: issues
List issues for the authenticated user or repository
30 31 32 |
# File 'lib/octokit/client/issues.rb', line 30 def list_issues(repository = nil, = {}) paginate "#{Repository.new(repository).path}/issues", end |
#org_issues(org, options = {}) ⇒ Array<Sawyer::Resource>
List all issues for a given organization for the authenticated user
72 73 74 |
# File 'lib/octokit/client/issues.rb', line 72 def org_issues(org, = {}) paginate "#{Organization.path org}/issues", end |
#reopen_issue(repo, number, options = {}) ⇒ Sawyer::Resource
Reopen an issue
140 141 142 |
# File 'lib/octokit/client/issues.rb', line 140 def reopen_issue(repo, number, = {}) patch "#{Repository.path repo}/issues/#{number}", .merge({:state => "open"}) end |
#update_comment(repo, number, comment, options = {}) ⇒ Sawyer::Resource
Update a single comment on an issue
238 239 240 |
# File 'lib/octokit/client/issues.rb', line 238 def update_comment(repo, number, comment, = {}) patch "#{Repository.path repo}/issues/comments/#{number}", .merge({:body => comment}) end |
#update_issue(repo, number, title, body, options = {}) ⇒ Sawyer::Resource
Update an issue
159 160 161 |
# File 'lib/octokit/client/issues.rb', line 159 def update_issue(repo, number, title, body, = {}) patch "#{Repository.path repo}/issues/#{number}", .merge({:title => title, :body => body}) end |
#user_issues(options = {}) ⇒ Array<Sawyer::Resource>
List all issues across owned and member repositories for the authenticated user
51 52 53 |
# File 'lib/octokit/client/issues.rb', line 51 def user_issues( = {}) paginate 'user/issues', end |