Class: Github::PullRequests::Comments

Inherits:
API
  • Object
show all
Defined in:
lib/github_api/pull_requests/comments.rb

Constant Summary collapse

VALID_REQUEST_COM_PARAM_NAMES = 
%w[
  body
  commit_id
  path
  position
  in_reply_to
  mime_type
  resource
].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 pull request comment

Inputs

  • :body - Required string

  • :commit_id - Required string - sha of the commit to comment on.

  • :path - Required string - Relative path of the file to comment on.

  • :position - Required number - Line index in the diff to comment on

Examples

github = Github.new
github.pull_requests.comments.create 'user-name','repo-name','request-id',
 "body" => "Nice change",
 "commit_id" => "6dcb09b5b57875f334f61aebed695e2e4193db5e",
 "path" => "file1.txt",
 "position" => 4

Alternative Inputs

Instead of passing commit_id, path, and position you can reply to an existing Pull Request Comment like this

  • :body - Required string

  • :in_reply_to - Required number - comment id to reply to.

Examples

github = Github.new
github.pull_requests.comments.create 'user-name','repo-name','request-id',
  "body" => "Nice change",
  "in_reply_to" => 4



92
93
94
95
96
97
98
99
 
# File 'lib/github_api/pull_requests/comments.rb', line 92

def create(*args)
  arguments(args, :required => [:user, :repo, :request_id]) do
    sift VALID_REQUEST_COM_PARAM_NAMES
  end
  # _validate_reply_to(params)

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

#delete(*args) ⇒ Object

Delete a pull request comment

Examples

github = Github.new
github.pull_requests.comments.delete 'user-name', 'repo-name','comment-id'



125
126
127
128
129
 
# File 'lib/github_api/pull_requests/comments.rb', line 125

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

  delete_request("/repos/#{user}/#{repo}/pulls/comments/#{comment_id}", arguments.params)
end

#edit(*args) ⇒ Object

Edit a pull request comment

Inputs

  • :body - Required string

Examples

github = Github.new
github.pull_requests.comments.edit 'user-name', 'repo-name','comment-id',
  "body" => "Nice change"



111
112
113
114
115
116
117
 
# File 'lib/github_api/pull_requests/comments.rb', line 111

def edit(*args)
  arguments(args, :required => [:user, :repo, :comment_id]) do
    sift VALID_REQUEST_COM_PARAM_NAMES
  end

  patch_request("/repos/#{user}/#{repo}/pulls/comments/#{comment_id}", arguments.params)
end

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

Get a single comment for pull requests

Examples

github = Github.new
github.pull_requests.comments.get 'user-name', 'repo-name', 'comment-id'



57
58
59
60
61
 
# File 'lib/github_api/pull_requests/comments.rb', line 57

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

  get_request("/repos/#{user}/#{repo}/pulls/comments/#{comment_id}", arguments.params)
end

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

List comments on a pull request

Examples

github = Github.new
github.pull_requests.comments.list 'user-name', 'repo-name', request_id: 'id'

List comments in a repository

By default, Review Comments are ordered by ascending ID.

Parameters

  • :sort - Optional string, created or updated

  • :direction - Optional string, asc or desc.

    Ignored with sort parameter.

  • :since - Optional string of a timestamp in ISO 8601

    format: YYYY-MM-DDTHH:MM:SSZ

Examples

github = Github.new
github.pull_requests.comments.list 'user-name', 'repo-name'
github.pull_requests.comments.list 'user-name', 'repo-name' { |comm| ... }



38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/github_api/pull_requests/comments.rb', line 38

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

  response = if (request_id = params.delete('request_id'))
    get_request("/repos/#{user}/#{repo}/pulls/#{request_id}/comments", params)
  else
    get_request("/repos/#{user}/#{repo}/pulls/comments", params)
  end
  return response unless block_given?
  response.each { |el| yield el }
end