Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from http://rubydoc.info/github/piotrmurach/github/master/Github/Client/PullRequests below:

PullRequests – Documentation for piotrmurach/github (master) – RubyDoc.info

Inherits:

API

• Object
• API
• Github::Client::PullRequests

show all

Defined in:

lib/github_api/client/pull_requests.rb

Classes: Comments, Reviews

PREVIEW_MEDIA =

'application/vnd.github.polaris-preview+json'.freeze

MimeType::MEDIA_LOOKUP

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

#current_options

• #commits(*args) ⇒ Object

  List commits on a pull request.

• #create(*args) ⇒ Object

  Create a pull request.

• #files(*args) ⇒ Object

  List pull requests files.

• #get(*args) ⇒ Object (also: #find)

  Get a single pull request.

• #list(*args) ⇒ Object (also: #all)

  List pull requests.

• #merge(*args) ⇒ Object

  Merge a pull request(Merge Button).

• #merged?(*args) ⇒ Boolean

  Check if pull request has been merged.

• #update(*args) ⇒ Object

  Update a pull request.

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

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

#ratelimit, #ratelimit_remaining, #ratelimit_reset

#lookup_media, #parse

#auth_code, #authenticated?, #authentication, #authorize_url, #basic_authed?, #client, #get_token

This class inherits a constructor from Github::API

This class handles dynamic methods through the method_missing method in the class Github::API

List commits on a pull request

128
129
130
131
132
133
134

# File 'lib/github_api/client/pull_requests.rb', line 128

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 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.

89
90
91
92
93
94

# File 'lib/github_api/client/pull_requests.rb', line 89

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

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

143
144
145
146
147
148
149

# File 'lib/github_api/client/pull_requests.rb', line 143

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 a single pull request

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

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

46
47
48
49
50

# File 'lib/github_api/client/pull_requests.rb', line 46

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

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

27
28
29
30
31
32
33
34

# File 'lib/github_api/client/pull_requests.rb', line 27

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 a pull request(Merge Button)

187
188
189
190
191
192
193

# File 'lib/github_api/client/pull_requests.rb', line 187

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

Check if pull request has been merged

158
159
160
161
162
163
164
165

# File 'lib/github_api/client/pull_requests.rb', line 158

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

115
116
117
118
119

# File 'lib/github_api/client/pull_requests.rb', line 115

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

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

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4