Class: Github::Repos::Collaborators

Inherits:
API
  • Object
show all
Defined in:
lib/github_api/repos/collaborators.rb

Constant Summary

Constants included from Github::Request

Github::Request::METHODS, Github::Request::METHODS_WITH_BODIES

Constants included from Connection

Connection::ALLOWED_OPTIONS

Constants included from Constants

Constants::ACCEPT, Constants::ACCEPTED_OAUTH_SCOPES, Constants::ACCEPT_CHARSET, Constants::CACHE_CONTROL, Constants::CONTENT_LENGTH, Constants::CONTENT_TYPE, Constants::DATE, Constants::ETAG, Constants::HEADER_LAST, Constants::HEADER_LINK, Constants::HEADER_NEXT, Constants::LOCATION, Constants::META_FIRST, Constants::META_LAST, Constants::META_NEXT, Constants::META_PREV, Constants::META_REL, Constants::OAUTH_SCOPES, Constants::PARAM_PAGE, Constants::PARAM_PER_PAGE, Constants::PARAM_START_PAGE, Constants::RATELIMIT_LIMIT, Constants::RATELIMIT_REMAINING, Constants::SERVER, Constants::USER_AGENT

Constants included from MimeType

MimeType::MEDIA_LOOKUP

Instance Attribute Summary

Attributes inherited from API

#current_options

Attributes included from Authorization

#scopes

Instance Method Summary collapse

Methods inherited from API

#api_methods_in, #append_arguments, #arguments, inherited, #initialize, #method_missing, #process_basic_auth, #set, #setup, #with, #yield_or_eval

Methods included from Github::RateLimit

#ratelimit, #ratelimit_remaining

Methods included from Github::Request

#delete_request, #get_request, #patch_request, #post_request, #put_request, #request

Methods included from Connection

#caching?, #clear_cache, #connection, #default_middleware, #default_options, #stack

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

#add(*args) ⇒ Object Also known as: <<

Add collaborator

Examples:

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

collaborators = Github::Repos::Collaborators.new
collaborators.add 'user', 'repo', 'collaborator'



32
33
34
35
36
37
 
# File 'lib/github_api/repos/collaborators.rb', line 32

def add(*args)
  arguments(args, :required => [:user, :repo, :collaborator])
  params = arguments.params

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

#collaborator?(*args) ⇒ Boolean

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'

Returns:

  • (Boolean) 


49
50
51
52
53
54
55
56
57
 
# File 'lib/github_api/repos/collaborators.rb', line 49

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) ⇒ Object Also known as: all

List collaborators

Examples:

github = Github.new
github.repos.collaborators.list 'user-name', 'repo-name'
github.repos.collaborators.list 'user-name', 'repo-name' { |cbr| .. }



13
14
15
16
17
18
19
20
 
# File 'lib/github_api/repos/collaborators.rb', line 13

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

#remove(*args) ⇒ Object

Removes collaborator

Examples:

github = Github.new
github.repos.collaborators.remove 'user', 'repo', 'collaborator'



65
66
67
68
69
70
 
# File 'lib/github_api/repos/collaborators.rb', line 65

def remove(*args)
  arguments(args, :required => [:user, :repo, :collaborator])
  params = arguments.params

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