Module: Octokit::Client::Repositories
- Included in:
- Octokit::Client
- Defined in:
- lib/octokit/client/repositories.rb
Overview
Methods for the Repositories API
Instance Method Summary collapse
-
#add_collaborator(repo, collaborator, options = {}) ⇒ Boolean
(also: #add_collab)
Add collaborator to repo.
-
#add_deploy_key(repo, title, key, options = {}) ⇒ Sawyer::Resource
Add deploy key to a repo.
-
#all_repositories(options = {}) ⇒ Array<Sawyer::Resource>
List all repositories.
-
#branch(repo, branch, options = {}) ⇒ Sawyer::Resource
(also: #get_branch)
Get a single branch from a repository.
-
#branch_protection(repo, branch, options = {}) ⇒ Sawyer::Resource?
Get branch protection summary.
-
#branches(repo, options = {}) ⇒ Array<Sawyer::Resource>
List branches.
-
#check_assignee(repo, assignee, options = {}) ⇒ Boolean
Check to see if a particular user is an assignee for a repository.
-
#collaborator?(repo, collaborator, options = {}) ⇒ Boolean
Checks if a user is a collaborator for a repo.
-
#collaborators(repo, options = {}) ⇒ Array<Sawyer::Resource>
(also: #collabs)
List collaborators.
-
#contributors(repo, anon = nil, options = {}) ⇒ Array<Sawyer::Resource>
(also: #contribs)
List contributors to a repo.
-
#create_repository(name, options = {}) ⇒ Sawyer::Resource
(also: #create_repo, #create)
Create a repository for a user or organization.
-
#delete_repository(repo, options = {}) ⇒ Boolean
(also: #delete_repo)
Delete repository.
-
#delete_subscription(repo, options = {}) ⇒ Boolean
Delete a repository subscription.
-
#deploy_key(repo, id, options = {}) ⇒ Sawyer::Resource
Get a single deploy key for a repo.
-
#deploy_keys(repo, options = {}) ⇒ Array<Sawyer::Resource>
(also: #list_deploy_keys)
Get deploy keys on a repo.
-
#edit_deploy_key(repo, id, options) ⇒ Sawyer::Resource
(also: #update_deploy_key)
deprecated
Deprecated.
This method is no longer supported in the API
-
#edit_repository(repo, options = {}) ⇒ Sawyer::Resource
(also: #edit, #update_repository, #update)
Edit a repository.
-
#fork(repo, options = {}) ⇒ Sawyer::Resource
Fork a repository.
-
#forks(repo, options = {}) ⇒ Array<Sawyer::Resource>
(also: #network)
List forks.
-
#languages(repo, options = {}) ⇒ Array<Sawyer::Resource>
List languages of code in the repo.
-
#protect_branch(repo, branch, required_status_checks = {}, options = {}) ⇒ Sawyer::Resource
Lock a single branch from a repository.
-
#remove_collaborator(repo, collaborator, options = {}) ⇒ Boolean
(also: #remove_collab)
Remove collaborator from repo.
-
#remove_deploy_key(repo, id, options = {}) ⇒ Boolean
Remove deploy key from a repo.
-
#repositories(user = nil, options = {}) ⇒ Array<Sawyer::Resource>
(also: #list_repositories, #list_repos, #repos)
List user repositories.
-
#repository(repo, options = {}) ⇒ Sawyer::Resource
(also: #repo)
Get a single repository.
-
#repository?(repo, options = {}) ⇒ Sawyer::Resource
Check if a repository exists.
-
#repository_assignees(repo, options = {}) ⇒ Array<Sawyer::Resource>
(also: #repo_assignees)
List users available for assigning to issues.
-
#repository_teams(repo, options = {}) ⇒ Array<Sawyer::Resource>
(also: #repo_teams, #teams)
List teams for a repo.
-
#set_private(repo, options = {}) ⇒ Sawyer::Resource
Hide a public repository.
-
#set_public(repo, options = {}) ⇒ Sawyer::Resource
Unhide a private repository.
-
#star(repo, options = {}) ⇒ Boolean
Star a repository.
-
#stargazers(repo, options = {}) ⇒ Array<Sawyer::Resource>
List stargazers of a repo.
-
#subscribers(repo, options = {}) ⇒ Array<Sawyer::Resource>
List watchers subscribing to notifications for a repo.
-
#subscription(repo, options = {}) ⇒ Sawyer::Resource
Get a repository subscription.
-
#tags(repo, options = {}) ⇒ Array<Sawyer::Resource>
List tags.
-
#unprotect_branch(repo, branch, options = {}) ⇒ Sawyer::Resource
Unlock a single branch from a repository.
-
#unstar(repo, options = {}) ⇒ Boolean
Unstar a repository.
-
#unwatch(repo, options = {}) ⇒ Boolean
deprecated
Deprecated.
Use #unstar instead
-
#update_subscription(repo, options = {}) ⇒ Sawyer::Resource
Update repository subscription.
-
#watch(repo, options = {}) ⇒ Boolean
deprecated
Deprecated.
Use #star instead
-
#watchers(repo, options = {}) ⇒ Array<Sawyer::Resource>
deprecated
Deprecated.
Use #stargazers instead
Instance Method Details
#add_collaborator(repo, collaborator, options = {}) ⇒ Boolean Also known as: add_collab
Add collaborator to repo
This can also be used to update the permission of an existing collaborator
Requires authenticated client.
313 314 315 |
# File 'lib/octokit/client/repositories.rb', line 313 def add_collaborator(repo, collaborator, = {}) boolean_from_response :put, "#{Repository.path repo}/collaborators/#{collaborator}", end |
#add_deploy_key(repo, title, key, options = {}) ⇒ Sawyer::Resource
Add deploy key to a repo
Requires authenticated client.
237 238 239 |
# File 'lib/octokit/client/repositories.rb', line 237 def add_deploy_key(repo, title, key, = {}) post "#{Repository.path repo}/keys", .merge(:title => title, :key => key) end |
#all_repositories(options = {}) ⇒ Array<Sawyer::Resource>
List all repositories
This provides a dump of every repository, in the order that they were created.
88 89 90 |
# File 'lib/octokit/client/repositories.rb', line 88 def all_repositories( = {}) paginate 'repositories', end |
#branch(repo, branch, options = {}) ⇒ Sawyer::Resource Also known as: get_branch
Get a single branch from a repository
491 492 493 |
# File 'lib/octokit/client/repositories.rb', line 491 def branch(repo, branch, = {}) get "#{Repository.path repo}/branches/#{branch}", end |
#branch_protection(repo, branch, options = {}) ⇒ Sawyer::Resource?
Get branch protection summary
524 525 526 527 528 529 530 531 |
# File 'lib/octokit/client/repositories.rb', line 524 def branch_protection(repo, branch, = {}) opts = ensure_api_media_type(:branch_protection, ) begin get "#{Repository.path repo}/branches/#{branch}/protection", opts rescue Octokit::BranchNotProtected nil end end |
#branches(repo, options = {}) ⇒ Array<Sawyer::Resource>
List branches
Requires authenticated client for private repos.
479 480 481 |
# File 'lib/octokit/client/repositories.rb', line 479 def branches(repo, = {}) paginate "#{Repository.path repo}/branches", end |
#check_assignee(repo, assignee, options = {}) ⇒ Boolean
Check to see if a particular user is an assignee for a repository.
574 575 576 |
# File 'lib/octokit/client/repositories.rb', line 574 def check_assignee(repo, assignee, = {}) boolean_from_response :get, "#{Repository.path repo}/assignees/#{assignee}", end |
#collaborator?(repo, collaborator, options = {}) ⇒ Boolean
Checks if a user is a collaborator for a repo.
Requires authenticated client.
345 346 347 |
# File 'lib/octokit/client/repositories.rb', line 345 def collaborator?(repo, collaborator, ={}) boolean_from_response :get, "#{Repository.path repo}/collaborators/#{collaborator}", end |
#collaborators(repo, options = {}) ⇒ Array<Sawyer::Resource> Also known as: collabs
List collaborators
Requires authenticated client for private repos.
288 289 290 |
# File 'lib/octokit/client/repositories.rb', line 288 def collaborators(repo, = {}) paginate "#{Repository.path repo}/collaborators", end |
#contributors(repo, anon = nil, options = {}) ⇒ Array<Sawyer::Resource> Also known as: contribs
List contributors to a repo
Requires authenticated client for private repos.
382 383 384 385 |
# File 'lib/octokit/client/repositories.rb', line 382 def contributors(repo, anon = nil, = {}) [:anon] = 1 if anon.to_s[/1|true/] paginate "#{Repository.path repo}/contributors", end |
#create_repository(name, options = {}) ⇒ Sawyer::Resource Also known as: create_repo, create
Create a repository for a user or organization
154 155 156 157 158 159 160 161 162 163 164 |
# File 'lib/octokit/client/repositories.rb', line 154 def create_repository(name, = {}) opts = .dup organization = opts.delete :organization opts.merge! :name => name if organization.nil? post 'user/repos', opts else post "#{Organization.path organization}/repos", opts end end |
#delete_repository(repo, options = {}) ⇒ Boolean Also known as: delete_repo
Delete repository
Note: If OAuth is used, ‘delete_repo’ scope is required
175 176 177 |
# File 'lib/octokit/client/repositories.rb', line 175 def delete_repository(repo, = {}) boolean_from_response :delete, Repository.path(repo), end |
#delete_subscription(repo, options = {}) ⇒ Boolean
Delete a repository subscription
625 626 627 |
# File 'lib/octokit/client/repositories.rb', line 625 def delete_subscription(repo, = {}) boolean_from_response :delete, "#{Repository.path repo}/subscription", end |
#deploy_key(repo, id, options = {}) ⇒ Sawyer::Resource
Get a single deploy key for a repo
222 223 224 |
# File 'lib/octokit/client/repositories.rb', line 222 def deploy_key(repo, id, ={}) get "#{Repository.path repo}/keys/#{id}", end |
#deploy_keys(repo, options = {}) ⇒ Array<Sawyer::Resource> Also known as: list_deploy_keys
Get deploy keys on a repo
Requires authenticated client.
209 210 211 |
# File 'lib/octokit/client/repositories.rb', line 209 def deploy_keys(repo, = {}) paginate "#{Repository.path repo}/keys", end |
#edit_deploy_key(repo, id, options) ⇒ Sawyer::Resource Also known as: update_deploy_key
This method is no longer supported in the API
Edit a deploy key
256 257 258 |
# File 'lib/octokit/client/repositories.rb', line 256 def edit_deploy_key(repo, id, ) patch "#{Repository.path repo}/keys/#{id}", end |
#edit_repository(repo, options = {}) ⇒ Sawyer::Resource Also known as: edit, update_repository, update
Edit a repository
47 48 49 50 51 |
# File 'lib/octokit/client/repositories.rb', line 47 def edit_repository(repo, = {}) repo = Repository.new(repo) [:name] ||= repo.name patch "repos/#{repo}", end |
#fork(repo, options = {}) ⇒ Sawyer::Resource
Fork a repository
135 136 137 |
# File 'lib/octokit/client/repositories.rb', line 135 def fork(repo, = {}) post "#{Repository.path repo}/forks", end |
#forks(repo, options = {}) ⇒ Array<Sawyer::Resource> Also known as: network
List forks
Requires authenticated client for private repos.
433 434 435 |
# File 'lib/octokit/client/repositories.rb', line 433 def forks(repo, = {}) paginate "#{Repository.path repo}/forks", end |
#languages(repo, options = {}) ⇒ Array<Sawyer::Resource>
List languages of code in the repo.
Requires authenticated client for private repos.
449 450 451 |
# File 'lib/octokit/client/repositories.rb', line 449 def languages(repo, = {}) paginate "#{Repository.path repo}/languages", end |
#protect_branch(repo, branch, required_status_checks = {}, options = {}) ⇒ Sawyer::Resource
Lock a single branch from a repository
Requires authenticated client
507 508 509 510 511 512 513 |
# File 'lib/octokit/client/repositories.rb', line 507 def protect_branch(repo, branch, required_status_checks = {}, = {}) required_status_checks[:restrictions] ||= nil required_status_checks[:required_status_checks] ||= nil = ensure_api_media_type(:branch_protection, .merge(required_status_checks)) put "#{Repository.path repo}/branches/#{branch}/protection", end |
#remove_collaborator(repo, collaborator, options = {}) ⇒ Boolean Also known as: remove_collab
Remove collaborator from repo.
Requires authenticated client.
330 331 332 |
# File 'lib/octokit/client/repositories.rb', line 330 def remove_collaborator(repo, collaborator, = {}) boolean_from_response :delete, "#{Repository.path repo}/collaborators/#{collaborator}", end |
#remove_deploy_key(repo, id, options = {}) ⇒ Boolean
Remove deploy key from a repo
Requires authenticated client.
271 272 273 |
# File 'lib/octokit/client/repositories.rb', line 271 def remove_deploy_key(repo, id, = {}) boolean_from_response :delete, "#{Repository.path repo}/keys/#{id}", end |
#repositories(user = nil, options = {}) ⇒ Array<Sawyer::Resource> Also known as: list_repositories, list_repos, repos
If the user provided is a GitHub organization, only the organization’s public repositories will be listed. For retrieving organization repositories the Organizations#organization_repositories method should be used instead.
List user repositories
If user is not supplied, repositories for the current
authenticated user are returned.
70 71 72 |
# File 'lib/octokit/client/repositories.rb', line 70 def repositories(user=nil, = {}) paginate "#{User.path user}/repos", end |
#repository(repo, options = {}) ⇒ Sawyer::Resource Also known as: repo
Get a single repository
28 29 30 |
# File 'lib/octokit/client/repositories.rb', line 28 def repository(repo, = {}) get Repository.path(repo), end |
#repository?(repo, options = {}) ⇒ Sawyer::Resource
Check if a repository exists
14 15 16 17 18 19 20 |
# File 'lib/octokit/client/repositories.rb', line 14 def repository?(repo, = {}) !!repository(repo, ) rescue Octokit::InvalidRepository false rescue Octokit::NotFound false end |
#repository_assignees(repo, options = {}) ⇒ Array<Sawyer::Resource> Also known as: repo_assignees
List users available for assigning to issues.
Requires authenticated client for private repos.
561 562 563 |
# File 'lib/octokit/client/repositories.rb', line 561 def repository_assignees(repo, = {}) paginate "#{Repository.path repo}/assignees", end |
#repository_teams(repo, options = {}) ⇒ Array<Sawyer::Resource> Also known as: repo_teams, teams
List teams for a repo
Requires authenticated client that is an owner or collaborator of the repo.
362 363 364 |
# File 'lib/octokit/client/repositories.rb', line 362 def repository_teams(repo, = {}) paginate "#{Repository.path repo}/teams", end |
#set_private(repo, options = {}) ⇒ Sawyer::Resource
Hide a public repository
184 185 186 187 |
# File 'lib/octokit/client/repositories.rb', line 184 def set_private(repo, = {}) # GitHub Api for setting private updated to use private attr, rather than public update_repository repo, .merge({ :private => true }) end |
#set_public(repo, options = {}) ⇒ Sawyer::Resource
Unhide a private repository
193 194 195 196 |
# File 'lib/octokit/client/repositories.rb', line 193 def set_public(repo, = {}) # GitHub Api for setting private updated to use private attr, rather than public update_repository repo, .merge({ :private => false }) end |
#star(repo, options = {}) ⇒ Boolean
Star a repository
97 98 99 |
# File 'lib/octokit/client/repositories.rb', line 97 def star(repo, = {}) boolean_from_response :put, "user/starred/#{Repository.new(repo)}", end |
#stargazers(repo, options = {}) ⇒ Array<Sawyer::Resource>
List stargazers of a repo
Requires authenticated client for private repos.
399 400 401 |
# File 'lib/octokit/client/repositories.rb', line 399 def stargazers(repo, = {}) paginate "#{Repository.path repo}/stargazers", end |
#subscribers(repo, options = {}) ⇒ Array<Sawyer::Resource>
List watchers subscribing to notifications for a repo
585 586 587 |
# File 'lib/octokit/client/repositories.rb', line 585 def subscribers(repo, = {}) paginate "#{Repository.path repo}/subscribers", end |
#subscription(repo, options = {}) ⇒ Sawyer::Resource
Get a repository subscription
596 597 598 |
# File 'lib/octokit/client/repositories.rb', line 596 def subscription(repo, = {}) get "#{Repository.path repo}/subscription", end |
#tags(repo, options = {}) ⇒ Array<Sawyer::Resource>
List tags
Requires authenticated client for private repos.
464 465 466 |
# File 'lib/octokit/client/repositories.rb', line 464 def (repo, = {}) paginate "#{Repository.path repo}/tags", end |
#unprotect_branch(repo, branch, options = {}) ⇒ Sawyer::Resource
Unlock a single branch from a repository
Requires authenticated client
543 544 545 546 |
# File 'lib/octokit/client/repositories.rb', line 543 def unprotect_branch(repo, branch, = {}) = ensure_api_media_type(:branch_protection, ) delete "#{Repository.path repo}/branches/#{branch}/protection", end |
#unstar(repo, options = {}) ⇒ Boolean
Unstar a repository
106 107 108 |
# File 'lib/octokit/client/repositories.rb', line 106 def unstar(repo, = {}) boolean_from_response :delete, "user/starred/#{Repository.new(repo)}", end |
#unwatch(repo, options = {}) ⇒ Boolean
Use #unstar instead
Unwatch a repository
126 127 128 |
# File 'lib/octokit/client/repositories.rb', line 126 def unwatch(repo, = {}) boolean_from_response :delete, "user/watched/#{Repository.new(repo)}", end |
#update_subscription(repo, options = {}) ⇒ Sawyer::Resource
Update repository subscription
613 614 615 |
# File 'lib/octokit/client/repositories.rb', line 613 def update_subscription(repo, = {}) put "#{Repository.path repo}/subscription", end |
#watch(repo, options = {}) ⇒ Boolean
Use #star instead
Watch a repository
116 117 118 |
# File 'lib/octokit/client/repositories.rb', line 116 def watch(repo, = {}) boolean_from_response :put, "user/watched/#{Repository.new(repo)}", end |
#watchers(repo, options = {}) ⇒ Array<Sawyer::Resource>
Use #stargazers instead
List watchers of repo.
Requires authenticated client for private repos.
416 417 418 |
# File 'lib/octokit/client/repositories.rb', line 416 def watchers(repo, = {}) paginate "#{Repository.path repo}/watchers", end |