Class: Github::Client::PullRequests::Reviews

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

Constant Summary collapse

PREVIEW_MEDIA =

:nodoc:

"application/vnd.github.black-cat-preview+json".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!, #disable_redirects, #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, require_all, #respond_to?, root!, #run_callbacks, #set, #yield_or_eval

Methods included from Request::Verbs

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

Methods included from RateLimit

#ratelimit, #ratelimit_remaining, #ratelimit_reset

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

#comments(*args) ⇒ Object

List comments on a pull request review

Examples:

github = Github.new
github.pull_requests.revieiws.comments 'user-name', 'repo-name', 'number', 'review-id'

146
147
148
149
150
151
152
153
154
155
# File 'lib/github_api/client/pull_requests/reviews.rb', line 146

def comments(*args)
  arguments(args, required: [:user, :repo, :number, :id])
  params = arguments.params

  params["accept"] ||= PREVIEW_MEDIA

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

#create(*args) ⇒ Object

Create a pull request review

Examples:

github = Github.new
github.pull_requests.reviews.create 'user-name', 'repo-name', 'number',
  body: "Nice change",
  event: "APPROVE",
  comments: [
    {
      path: 'path/to/file/commented/on',
      position: 10,
      body:     'This looks good.'
    }
  ]

Parameters:


86
87
88
89
90
91
92
93
# File 'lib/github_api/client/pull_requests/reviews.rb', line 86

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

  params             = arguments.params
  params["accept"] ||= PREVIEW_MEDIA

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

#dismiss(*args) ⇒ Object

Examples:

github = Github.new oauth_token: '...'
github.pull_requests.reviews.dismiss 'user-name', 'repo-name', 'number', 'review-id'
  message: "I can't get to this right now."

Parameters:

  • params (Hash)

    a customizable set of options


130
131
132
133
134
135
136
137
# File 'lib/github_api/client/pull_requests/reviews.rb', line 130

def dismiss(*args)
  arguments(args, required: [:user, :repo, :number, :id])
  params = arguments.params

  params["accept"] ||= PREVIEW_MEDIA

  put_request("/repos/#{arguments.user}/#{arguments.repo}/pulls/#{arguments.number}/reviews/#{arguments.id}/dismissals", params)
end

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

Get a single review for pull requests

Examples:

github = Github.new
github.pull_requests.reviews.get 'user-name', 'repo-name', 'number', 'id'
github.pull_requests.reviews.get
  user: 'user-name',
  repo: 'repo-name',
  number: 1,
  id: 80

49
50
51
52
53
54
55
56
# File 'lib/github_api/client/pull_requests/reviews.rb', line 49

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

  params             = arguments.params
  params["accept"] ||= PREVIEW_MEDIA

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

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

List reviews on a pull request

List pull request reviews in a repository

Examples:

github = Github.new
github.pull_requests.reviews.list 'user-name', 'repo-name', number: 'pull-request-number'
github = Github.new
github.pull_requests.reviews.list 'user-name', 'repo-name', number: 'pull-request-number'
github.pull_requests.reviews.list 'user-name', 'repo-name', number: 'pull-request-number' { |comm| ... }

23
24
25
26
27
28
29
30
31
32
# File 'lib/github_api/client/pull_requests/reviews.rb', line 23

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

  params["accept"] ||= PREVIEW_MEDIA

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

#update(*args) ⇒ Object

Update a pull request review

Examples:

github = Github.new oauth_token: '...'
github.pull_requests.reviews.update 'user-name', 'repo-name', 'number', 'review-id'
  body: "Update body",
  event: "APPROVE"

Parameters:


112
113
114
115
116
117
118
119
# File 'lib/github_api/client/pull_requests/reviews.rb', line 112

def update(*args)
  arguments(args, required: [:user, :repo, :number, :id])
  params = arguments.params

  params["accept"] ||= PREVIEW_MEDIA

  post_request("/repos/#{arguments.user}/#{arguments.repo}/pulls/#{arguments.number}/reviews/#{arguments.id}/events", params)
end