Class: Github::Client::PullRequests

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

Defined Under Namespace

Classes: Comments

Constant Summary collapse

PREVIEW_MEDIA =

:nodoc:

'application/vnd.github.polaris-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!, #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

#commits(*args) ⇒ Object

List commits on a pull request

Examples:

github = Github.new
github.pull_requests.commits 'user-name', 'repo-name', 'number'

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

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

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

#create(*args) ⇒ Object

Create a pull request

@note: head and base can be either a sha or a branch name. Typically you would namespace head with a user like this: username:branch.

Alternative Input You can also create a Pull Request from an existing Issue by passing an Issue number instead of title and body.

Examples:

github = Github.new oauth_token: '...'
github.pull_requests.create 'user-name', 'repo-name',
  title: "Amazing new feature",
  body: "Please pull this in!",
  head: "octocat:new-feature",
  base: "master"
github.pull_requests.create 'user-name', 'repo-name',
  issue: "5",
  head: "octocat:new-feature",
  base: "master"

Parameters:


85
86
87
88
89
90
# File 'lib/github_api/client/pull_requests.rb', line 85

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

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

#files(*args) ⇒ Object

List pull requests files

Examples:

github = Github.new
github.pull_requests.files 'user-name', 'repo-name', 'number'

139
140
141
142
143
144
145
# File 'lib/github_api/client/pull_requests.rb', line 139

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

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

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

Get a single pull request

Examples

github = Github.new
github.pull_requests.get 'user-name', 'repo-name', 'number'

pulls = Github::PullRequests.new
pulls.get 'user-name', 'repo-name', 'number'

42
43
44
45
46
# File 'lib/github_api/client/pull_requests.rb', line 42

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

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

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

List pull requests

Examples:

github = Github.new user: 'user-name', repo: 'repo-name'
github.pull_requests.list
github.pull_requests.list { |req| ... }
pulls = Github::PullRequests.new
pulls.pull_requests.list 'user-name', 'repo-name'

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

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

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

#merge(*args) ⇒ Object

Merge a pull request(Merge Button)

Examples:

github = Github.new
github.pull_requests.merge 'user-name', 'repo-name', 'number'

Parameters:


182
183
184
185
186
187
188
# File 'lib/github_api/client/pull_requests.rb', line 182

def merge(*args)
  arguments(args, required: [:user, :repo, :number])
  params = arguments.params
  params['accept'] ||= PREVIEW_MEDIA

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

#merged?(*args) ⇒ Boolean

Check if pull request has been merged

Examples:

github = Github.new
github.pull_requests.merged? 'user-name', 'repo-name', 'number'

Returns:

  • (Boolean)

154
155
156
157
158
159
160
161
# File 'lib/github_api/client/pull_requests.rb', line 154

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

  get_request("/repos/#{arguments.user}/#{arguments.repo}/pulls/#{arguments.number}/merge", arguments.params)
  true
rescue Github::Error::NotFound
  false
end

#update(*args) ⇒ Object

Update a pull request

Examples:

github = Github.new oauth_token: '...'
github.pull_requests.update 'user-name', 'repo-name', 'number'
  title: "Amazing new title",
  body: "Update body",
  state: "open"

Parameters:


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

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

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