# encoding: utf-8
module Github
class PullRequests < API
extend AutoloadHelper
autoload_all 'github_api/pull_requests',
:Comments => 'comments'
VALID_REQUEST_PARAM_NAMES = %w[
title
body
base
head
state
issue
commit_message
mime_type
resource
].freeze
VALID_REQUEST_PARAM_VALUES = {
'state' => %w[ open closed ]
}
# Creates new Gists API
def initialize(options = {})
super(options)
end
# Access to PullRequests::Comments API
def comments
@comments ||= ApiFactory.new 'PullRequests::Comments'
end
# List pull requests
#
# = Examples
# github = Github.new :user => 'user-name', :repo => 'repo-name'
# github.pull_requests.list
# github.pull_requests.list { |req| ... }
#
# pull_reqs = Github::PullRequests.new
# pull_reqs.pull_requests.list 'user-name', 'repo-name'
#
def list(user_name, repo_name, params={})
set :user => user_name, :repo => repo_name
assert_presence_of user, repo
normalize! params
filter! VALID_REQUEST_PARAM_NAMES, params
# _merge_mime_type(:pull_request, params)
assert_valid_values(VALID_REQUEST_PARAM_VALUES, params)
response = get_request("/repos/#{user}/#{repo}/pulls", params)
return response unless block_given?
response.each { |el| yield el }
end
alias :all :list
# Get a single pull request
#
# = Examples
# github = Github.new
# github.pull_requests.get 'user-name', 'repo-name', 'number'
#
# pull_reqs = Github::PullRequests.new
# pull_reqs.get 'user-name', 'repo-name', 'number'
#
def get(user_name, repo_name, number, params={})
set :user => user_name, :repo => repo_name
assert_presence_of user, repo, number
normalize! params
get_request("/repos/#{user}/#{repo}/pulls/#{number}", params)
end
alias :find :get
# Create a pull request
#
# = Inputs
# * :title - Required string
# * :body - Optional string
# * :base - Required string - The branch you want your changes pulled into.
# * :head - Required string - The branch where your changes are implemented.
# 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.
# * issue - Required number - Issue number in this repository to turn into a Pull Request.
#
# = 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"
#
# alternatively
#
# github.pull_requests.create 'user-name', 'repo-name',
# "issue" => "5",
# "head" => "octocat:new-feature",
# "base" => "master"
#
def create(user_name, repo_name, params={})
set :user => user_name, :repo => repo_name
assert_presence_of user, repo
normalize! params
filter! VALID_REQUEST_PARAM_NAMES, params
post_request("/repos/#{user}/#{repo}/pulls", params)
end
# Update a pull request
#
# = Inputs
# * :title - Optional string
# * :body - Optional string
# * :state - Optional string - State of this Pull Request. Valid values are open and closed.
#
# = Examples
# github = Github.new :oauth_token => '...'
# github.pull_requests.update 'user-name', 'repo-name', 'number'
# "title" => "Amazing new title",
# "body" => "Update body",
# "state" => "open",
#
def update(user_name, repo_name, number, params={})
set :user => user_name, :repo => repo_name
assert_presence_of user, repo, number
normalize! params
filter! VALID_REQUEST_PARAM_NAMES, params
assert_valid_values(VALID_REQUEST_PARAM_VALUES, params)
patch_request("/repos/#{user}/#{repo}/pulls/#{number}", params)
end
# List commits on a pull request
#
# = Examples
# github = Github.new
# github.pull_requests.commits 'user-name', 'repo-name', 'number'
#
def commits(user_name, repo_name, number, params={})
set :user => user_name, :repo => repo_name
assert_presence_of user, repo, number
normalize! params
response = get_request("/repos/#{user}/#{repo}/pulls/#{number}/commits", params)
return response unless block_given?
response.each { |el| yield el }
end
# List pull requests files
#
# = Examples
# github = Github.new
# github.pull_requests.files 'user-name', 'repo-name', 'number'
#
def files(user_name, repo_name, number, params={})
set :user => user_name, :repo => repo_name
assert_presence_of user, repo, number
normalize! params
response = get_request("/repos/#{user}/#{repo}/pulls/#{number}/files", params)
return response unless block_given?
response.each { |el| yield el }
end
# Check if pull request has been merged
#
# = Examples
# github = Github.new
# github.pull_requests.merged? 'user-name', 'repo-name', 'number'
#
def merged?(user_name, repo_name, number, params={})
set :user => user_name, :repo => repo_name
assert_presence_of user, repo, number
normalize! params
get_request("/repos/#{user}/#{repo}/pulls/#{number}/merge", params)
true
rescue Github::Error::NotFound
false
end
# Merge a pull request(Merge Button)
#
# = Inputs
# :commit_message - Optional string -
# The message that will be used for the merge commit
#
# = Examples
# github = Github.new
# github.pull_requests.merge 'user-name', 'repo-name', 'number'
#
def merge(user_name, repo_name, number, params={})
set :user => user_name, :repo => repo_name
assert_presence_of user, repo, number
normalize! params
filter! VALID_REQUEST_PARAM_NAMES, params
put_request("/repos/#{user}/#{repo}/pulls/#{number}/merge", params)
end
end # PullRequests
end # Github