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.
-
#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_hook(repo, name, config, options = {}) ⇒ Sawyer::Resource
Create a hook.
-
#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)
Edit a deploy key.
-
#edit_hook(repo, id, name, config, options = {}) ⇒ Sawyer::Resource
Edit a hook.
-
#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.
-
#hook(repo, id, options = {}) ⇒ Sawyer::Resource
Get single hook.
-
#hooks(repo, options = {}) ⇒ Array<Sawyer::Resource>
List repo hooks.
-
#languages(repo, options = {}) ⇒ Array<Sawyer::Resource>
List languages of code in the repo.
-
#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.
-
#remove_hook(repo, id, options = {}) ⇒ Boolean
Delete hook.
-
#repositories(username = 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.
-
#test_hook(repo, id, options = {}) ⇒ Boolean
Test hook.
-
#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
Requires authenticated client.
302 303 304 |
# File 'lib/octokit/client/repositories.rb', line 302 def add_collaborator(repo, collaborator, = {}) boolean_from_response :put, "repos/#{Repository.new(repo)}/collaborators/#{collaborator}", end |
#add_deploy_key(repo, title, key, options = {}) ⇒ Sawyer::Resource
Add deploy key to a repo
Requires authenticated client.
236 237 238 |
# File 'lib/octokit/client/repositories.rb', line 236 def add_deploy_key(repo, title, key, = {}) post "repos/#{Repository.new(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
480 481 482 |
# File 'lib/octokit/client/repositories.rb', line 480 def branch(repo, branch, = {}) get "repos/#{Repository.new(repo)}/branches/#{branch}", end |
#branches(repo, options = {}) ⇒ Array<Sawyer::Resource>
List branches
Requires authenticated client for private repos.
468 469 470 |
# File 'lib/octokit/client/repositories.rb', line 468 def branches(repo, = {}) paginate "repos/#{Repository.new(repo)}/branches", end |
#check_assignee(repo, assignee, options = {}) ⇒ Boolean
Check to see if a particular user is an assignee for a repository.
645 646 647 |
# File 'lib/octokit/client/repositories.rb', line 645 def check_assignee(repo, assignee, = {}) boolean_from_response :get, "repos/#{Repository.new(repo)}/assignees/#{assignee}", end |
#collaborator?(repo, collaborator, options = {}) ⇒ Boolean
Checks if a user is a collaborator for a repo.
Requires authenticated client.
334 335 336 |
# File 'lib/octokit/client/repositories.rb', line 334 def collaborator?(repo, collaborator, ={}) boolean_from_response :get, "repos/#{Repository.new(repo)}/collaborators/#{collaborator}", end |
#collaborators(repo, options = {}) ⇒ Array<Sawyer::Resource> Also known as: collabs
List collaborators
Requires authenticated client for private repos.
285 286 287 |
# File 'lib/octokit/client/repositories.rb', line 285 def collaborators(repo, = {}) paginate "repos/#{Repository.new(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.
371 372 373 374 |
# File 'lib/octokit/client/repositories.rb', line 371 def contributors(repo, anon = nil, = {}) [:anon] = 1 if anon.to_s[/1|true/] paginate "repos/#{Repository.new(repo)}/contributors", end |
#create_hook(repo, name, config, options = {}) ⇒ Sawyer::Resource
Create a hook
Requires authenticated client.
543 544 545 546 |
# File 'lib/octokit/client/repositories.rb', line 543 def create_hook(repo, name, config, = {}) = {:name => name, :config => config, :events => ["push"], :active => true}.merge() post "repos/#{Repository.new(repo)}/hooks", 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 |
# File 'lib/octokit/client/repositories.rb', line 154 def create_repository(name, = {}) organization = .delete :organization .merge! :name => name if organization.nil? post 'user/repos', else post "orgs/#{organization}/repos", end end |
#delete_repository(repo, options = {}) ⇒ Boolean Also known as: delete_repo
Delete repository
Note: If OAuth is used, ‘delete_repo’ scope is required
174 175 176 |
# File 'lib/octokit/client/repositories.rb', line 174 def delete_repository(repo, = {}) boolean_from_response :delete, "repos/#{Repository.new(repo)}", end |
#delete_subscription(repo, options = {}) ⇒ Boolean
Delete a repository subscription
696 697 698 |
# File 'lib/octokit/client/repositories.rb', line 696 def delete_subscription(repo, = {}) boolean_from_response :delete, "repos/#{Repository.new(repo)}/subscription", end |
#deploy_key(repo, id, options = {}) ⇒ Sawyer::Resource
Get a single deploy key for a repo
221 222 223 |
# File 'lib/octokit/client/repositories.rb', line 221 def deploy_key(repo, id, ={}) get "repos/#{Repository.new(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.
208 209 210 |
# File 'lib/octokit/client/repositories.rb', line 208 def deploy_keys(repo, = {}) paginate "repos/#{Repository.new(repo)}/keys", end |
#edit_deploy_key(repo, id, options) ⇒ Sawyer::Resource Also known as: update_deploy_key
Edit a deploy key
253 254 255 |
# File 'lib/octokit/client/repositories.rb', line 253 def edit_deploy_key(repo, id, ) patch "repos/#{Repository.new(repo)}/keys/#{id}", end |
#edit_hook(repo, id, name, config, options = {}) ⇒ Sawyer::Resource
Edit a hook
Requires authenticated client.
586 587 588 589 |
# File 'lib/octokit/client/repositories.rb', line 586 def edit_hook(repo, id, name, config, = {}) = {:name => name, :config => config, :events => ["push"], :active => true}.merge() patch "repos/#{Repository.new(repo)}/hooks/#{id}", end |
#edit_repository(repo, options = {}) ⇒ Sawyer::Resource Also known as: edit, update_repository, update
Edit a repository
44 45 46 47 48 |
# File 'lib/octokit/client/repositories.rb', line 44 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 "repos/#{Repository.new(repo)}/forks", end |
#forks(repo, options = {}) ⇒ Array<Sawyer::Resource> Also known as: network
List forks
Requires authenticated client for private repos.
422 423 424 |
# File 'lib/octokit/client/repositories.rb', line 422 def forks(repo, = {}) paginate "repos/#{Repository.new(repo)}/forks", end |
#hook(repo, id, options = {}) ⇒ Sawyer::Resource
Get single hook
Requires authenticated client.
508 509 510 |
# File 'lib/octokit/client/repositories.rb', line 508 def hook(repo, id, = {}) get "repos/#{Repository.new(repo)}/hooks/#{id}", end |
#hooks(repo, options = {}) ⇒ Array<Sawyer::Resource>
List repo hooks
Requires authenticated client.
494 495 496 |
# File 'lib/octokit/client/repositories.rb', line 494 def hooks(repo, = {}) paginate "repos/#{Repository.new(repo)}/hooks", end |
#languages(repo, options = {}) ⇒ Array<Sawyer::Resource>
List languages of code in the repo.
Requires authenticated client for private repos.
438 439 440 |
# File 'lib/octokit/client/repositories.rb', line 438 def languages(repo, = {}) paginate "repos/#{Repository.new(repo)}/languages", end |
#remove_collaborator(repo, collaborator, options = {}) ⇒ Boolean Also known as: remove_collab
Remove collaborator from repo.
Requires authenticated client.
319 320 321 |
# File 'lib/octokit/client/repositories.rb', line 319 def remove_collaborator(repo, collaborator, = {}) boolean_from_response :delete, "repos/#{Repository.new(repo)}/collaborators/#{collaborator}", end |
#remove_deploy_key(repo, id, options = {}) ⇒ Boolean
Remove deploy key from a repo
Requires authenticated client.
268 269 270 |
# File 'lib/octokit/client/repositories.rb', line 268 def remove_deploy_key(repo, id, = {}) boolean_from_response :delete, "repos/#{Repository.new(repo)}/keys/#{id}", end |
#remove_hook(repo, id, options = {}) ⇒ Boolean
Delete hook
Requires authenticated client.
601 602 603 |
# File 'lib/octokit/client/repositories.rb', line 601 def remove_hook(repo, id, = {}) boolean_from_response :delete, "repos/#{Repository.new(repo)}/hooks/#{id}", end |
#repositories(username = nil, options = {}) ⇒ Array<Sawyer::Resource> Also known as: list_repositories, list_repos, repos
If the username 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 username is not supplied, repositories for the current
authenticated user are returned.
66 67 68 69 70 71 72 |
# File 'lib/octokit/client/repositories.rb', line 66 def repositories(username=nil, = {}) if username.nil? paginate 'user/repos', else paginate "users/#{username}/repos", end end |
#repository(repo, options = {}) ⇒ Sawyer::Resource Also known as: repo
Get a single repository
25 26 27 |
# File 'lib/octokit/client/repositories.rb', line 25 def repository(repo, = {}) get "repos/#{Repository.new(repo)}", end |
#repository?(repo, options = {}) ⇒ Sawyer::Resource
Check if a repository exists
14 15 16 17 18 |
# File 'lib/octokit/client/repositories.rb', line 14 def repository?(repo, = {}) !!repository(repo, ) 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.
632 633 634 |
# File 'lib/octokit/client/repositories.rb', line 632 def repository_assignees(repo, = {}) paginate "repos/#{Repository.new(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.
351 352 353 |
# File 'lib/octokit/client/repositories.rb', line 351 def repository_teams(repo, = {}) paginate "repos/#{Repository.new(repo)}/teams", end |
#set_private(repo, options = {}) ⇒ Sawyer::Resource
Hide a public repository
183 184 185 186 |
# File 'lib/octokit/client/repositories.rb', line 183 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
192 193 194 195 |
# File 'lib/octokit/client/repositories.rb', line 192 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.
388 389 390 |
# File 'lib/octokit/client/repositories.rb', line 388 def stargazers(repo, = {}) paginate "repos/#{Repository.new(repo)}/stargazers", end |
#subscribers(repo, options = {}) ⇒ Array<Sawyer::Resource>
List watchers subscribing to notifications for a repo
656 657 658 |
# File 'lib/octokit/client/repositories.rb', line 656 def subscribers(repo, = {}) paginate "repos/#{Repository.new(repo)}/subscribers", end |
#subscription(repo, options = {}) ⇒ Sawyer::Resource
Get a repository subscription
667 668 669 |
# File 'lib/octokit/client/repositories.rb', line 667 def subscription(repo, = {}) get "repos/#{Repository.new(repo)}/subscription", end |
#tags(repo, options = {}) ⇒ Array<Sawyer::Resource>
List tags
Requires authenticated client for private repos.
453 454 455 |
# File 'lib/octokit/client/repositories.rb', line 453 def (repo, = {}) paginate "repos/#{Repository.new(repo)}/tags", end |
#test_hook(repo, id, options = {}) ⇒ Boolean
Test hook
Requires authenticated client.
615 616 617 |
# File 'lib/octokit/client/repositories.rb', line 615 def test_hook(repo, id, = {}) boolean_from_response :post, "repos/#{Repository.new(repo)}/hooks/#{id}/tests", 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
684 685 686 |
# File 'lib/octokit/client/repositories.rb', line 684 def update_subscription(repo, = {}) put "repos/#{Repository.new(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.
405 406 407 |
# File 'lib/octokit/client/repositories.rb', line 405 def watchers(repo, = {}) paginate "repos/#{Repository.new(repo)}/watchers", end |