class Github::Repos::Collaborators

Public Instance Methods

<<(*args)
Alias for: add
add(*args) click to toggle source

Add collaborator

Examples:

github = Github.new
github.collaborators.add 'user', 'repo', 'collaborator'

collaborators = Github::Repos::Collaborators.new
collaborators.add 'user', 'repo', 'collaborator'
# File lib/github_api/repos/collaborators.rb, line 31
def add(*args)
  arguments(args, :required => [:user, :repo, :collaborator])
  params = arguments.params

  put_request("/repos/#{user}/#{repo}/collaborators/#{collaborator}", params)
end
Also aliased as: <<
all(*args)
Alias for: list
collaborator?(*args) click to toggle source

Checks if user is a collaborator for a given repository

Examples:

github = Github.new
github.repos.collaborators.collaborator?('user', 'repo', 'collaborator')

github = Github.new user: 'user-name', repo: 'repo-name'
github.collaborators.collaborator? collaborator: 'collaborator'
# File lib/github_api/repos/collaborators.rb, line 48
def collaborator?(*args)
  arguments(args, :required => [:user, :repo, :collaborator])
  params = arguments.params

  get_request("/repos/#{user}/#{repo}/collaborators/#{collaborator}", params)
  true
rescue Github::Error::NotFound
  false
end
list(*args) { |el| ... } click to toggle source

List collaborators

Examples:

github = Github.new
github.repos.collaborators.list 'user-name', 'repo-name'
github.repos.collaborators.list 'user-name', 'repo-name' { |cbr| .. }
# File lib/github_api/repos/collaborators.rb, line 12
def list(*args)
  arguments(args, :required => [:user, :repo])
  params = arguments.params

  response = get_request("/repos/#{user}/#{repo}/collaborators", params)
  return response unless block_given?
  response.each { |el| yield el }
end
Also aliased as: all
remove(*args) click to toggle source

Removes collaborator

Examples:

github = Github.new
github.repos.collaborators.remove 'user', 'repo', 'collaborator'
# File lib/github_api/repos/collaborators.rb, line 64
def remove(*args)
  arguments(args, :required => [:user, :repo, :collaborator])
  params = arguments.params

  delete_request("/repos/#{user}/#{repo}/collaborators/#{collaborator}", params)
end