### Home Classes Methods

### In Files

- lib/github_api/pull_requests.rb

### Parent

Github::API

### Namespace

- CLASS Github::PullRequests::Comments

### Methods

- #all
- #comments
- #commits
- #create
- #files
- #find
- #get
- #list
- #merge
- #merged?
- #update

### Class/Module Index

Quicksearch

- Github
- Github::API
- Github::Activity
- Github::Activity::Events
- Github::Activity::Notifications
- Github::Activity::Starring
- Github::Activity::Watching
- Github::ApiFactory
- Github::Arguments
- Github::Authorization
- Github::Authorizations
- Github::AutoloadHelper
- Github::Client
- Github::Configuration
- Github::Connection
- Github::Constants
- Github::CoreExt
- Github::CoreExt::OrderedHash
- Github::Descendants
- Github::Emojis
- Github::Error
- Github::Error::BadRequest
- Github::Error::ClientError
- Github::Error::Forbidden
- Github::Error::GithubError
- Github::Error::InternalServerError
- Github::Error::InvalidOptions
- Github::Error::NotAcceptable
- Github::Error::NotFound
- Github::Error::RequiredParams
- Github::Error::ServiceError
- Github::Error::ServiceUnavailable
- Github::Error::Unauthorized
- Github::Error::UnknownValue
- Github::Error::UnprocessableEntity
- Github::Error::Validations
- Github::Gists
- Github::Gists::Comments
- Github::GitData
- Github::GitData::Blobs
- Github::GitData::Commits
- Github::GitData::References
- Github::GitData::Tags
- Github::GitData::Trees
- Github::Gitignore
- Github::Issues
- Github::Issues::Assignees
- Github::Issues::Comments
- Github::Issues::Events
- Github::Issues::Labels
- Github::Issues::Milestones
- Github::Jsonable
- Github::Markdown
- Github::Meta
- Github::MimeType
- Github::Normalizer
- Github::Orgs
- Github::Orgs::Members
- Github::Orgs::Teams
- Github::PageIterator
- Github::PageLinks
- Github::PagedRequest
- Github::Pagination
- Github::ParameterFilter
- Github::ParamsHash
- Github::PullRequests
- Github::PullRequests::Comments
- Github::RateLimit
- Github::Repos
- Github::Repos::Collaborators
- Github::Repos::Comments
- Github::Repos::Commits
- Github::Repos::Contents
- Github::Repos::Downloads
- Github::Repos::Forks
- Github::Repos::Hooks
- Github::Repos::Keys
- Github::Repos::Merging
- Github::Repos::PubSubHubbub
- Github::Repos::Statistics
- Github::Repos::Statuses
- Github::Request
- Github::Request::BasicAuth
- Github::Request::Jsonize
- Github::Request::OAuth2
- Github::Resource
- Github::Response
- Github::Response::Header
- Github::Response::Jsonize
- Github::Response::Mashify
- Github::Response::RaiseError
- Github::Response::Xmlize
- Github::ResponseWrapper
- Github::S3Uploader
- Github::Say
- Github::Scopes
- Github::Search
- Github::Users
- Github::Users::Emails
- Github::Users::Followers
- Github::Users::Keys
- Github::Utils
- Github::Utils::Url
- Github::VERSION
- Github::Validations
- Github::Validations::Format
- Github::Validations::Presence
- Github::Validations::Required
- Github::Validations::Token
- Hash

No matching classes.

# Github::PullRequests

### Constants

VALID_REQUEST_PARAM_NAMES
VALID_REQUEST_PARAM_VALUES

### Public Instance Methods

all(*args) click to toggle source
Alias for: list
comments(options={}, &block) click to toggle source

Access to PullRequests::Comments API

    # File lib/github_api/pull_requests.rb, line 26
    def comments(options={}, &block)
      @comments ||= ApiFactory.new('PullRequests::Comments', current_options.merge(options), &block)
    end

commits(*args) click to toggle source

List commits on a pull request

# Examples

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

    # File lib/github_api/pull_requests.rb, line 134
    def commits(*args)
      arguments(args, :required => [:user, :repo, :number])

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

create(*args) click to toggle source

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"

    # File lib/github_api/pull_requests.rb, line 97
    def create(*args)
      arguments(args, :required => [:user, :repo]) do
        sift VALID_REQUEST_PARAM_NAMES
      end

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

files(*args) click to toggle source

List pull requests files

# Examples

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

    # File lib/github_api/pull_requests.rb, line 149
    def files(*args)
      arguments(args, :required => [:user, :repo, :number])

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

find(*args) click to toggle source
Alias for: get
get(*args) click to toggle source

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'

    # File lib/github_api/pull_requests.rb, line 61
    def get(*args)
      arguments(args, :required => [:user, :repo, :number])

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

Also aliased as: find
list(*args) click to toggle source

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'

    # File lib/github_api/pull_requests.rb, line 40
    def list(*args)
      arguments(args, :required => [:user, :repo]) do
        sift VALID_REQUEST_PARAM_NAMES
        assert_values VALID_REQUEST_PARAM_VALUES
      end

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

Also aliased as: all
merge(*args) click to toggle source

Merge a pull request(Merge Button)

# Inputs

    <tt>:commit_message</tt> - 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'

    # File lib/github_api/pull_requests.rb, line 183
    def merge(*args)
      arguments(args, :required => [:user, :repo, :number]) do
        sift VALID_REQUEST_PARAM_NAMES
      end

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

merged?(*args) click to toggle source

Check if pull request has been merged

# Examples

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

    # File lib/github_api/pull_requests.rb, line 164
    def merged?(*args)
      arguments(args, :required => [:user, :repo, :number])

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

update(*args) click to toggle source

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",

    # File lib/github_api/pull_requests.rb, line 119
    def update(*args)
      arguments(args, :required => [:user, :repo, :number]) do
        sift VALID_REQUEST_PARAM_NAMES
        assert_values VALID_REQUEST_PARAM_VALUES
      end

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

[Validate]

Generated with the Darkfish Rdoc Generator 2.