Module: Octokit::Client::Repositories

Included in:
Octokit::Client
Defined in:
lib/octokit/client/repositories.rb

Instance Method Summary collapse

Instance Method Details

#add_collaborator(repo, collaborator, options = {}) ⇒ Object Also known as: add_collab 



84
85
86
 
# File 'lib/octokit/client/repositories.rb', line 84

def add_collaborator(repo, collaborator, options={})
  put "/repos/#{Repository.new repo}/collaborators/#{collaborator}", options, 3
end

#add_deploy_key(repo, title, key, options = {}) ⇒ Object 



71
72
73
 
# File 'lib/octokit/client/repositories.rb', line 71

def add_deploy_key(repo, title, key, options={})
  post "/repos/#{Repository.new repo}/keys", options.merge(:title => title, :key => key), 3
end

#branches(repo, options = {}) ⇒ Object 



127
128
129
 
# File 'lib/octokit/client/repositories.rb', line 127

def branches(repo, options={})
  get "/repos/#{Repository.new repo}/branches", options, 3
end

#collaborators(repo, options = {}) ⇒ Object Also known as: collabs 



79
80
81
 
# File 'lib/octokit/client/repositories.rb', line 79

def collaborators(repo, options={})
  get "/repos/#{Repository.new repo}/collaborators", options, 3
end

#contributors(repo, anon = false, options = {}) ⇒ Object Also known as: contribs 



105
106
107
 
# File 'lib/octokit/client/repositories.rb', line 105

def contributors(repo, anon=false, options={})
  get "/repos/#{Repository.new repo}/contributors", options.merge(:anon => anon), 3
end

#create_repository(name, options = {}) ⇒ Object Also known as: create_repo, create 



45
46
47
48
49
50
51
52
53
54
 
# File 'lib/octokit/client/repositories.rb', line 45

def create_repository(name, options={})
  organization = options.delete :organization
  options.merge! :name => name

  if organization.nil?
    post '/user/repos', options, 3
  else
    post "/orgs/#{organization}/repos", options, 3
  end
end

#deploy_keys(repo, options = {}) ⇒ Object Also known as: list_deploy_keys 



66
67
68
 
# File 'lib/octokit/client/repositories.rb', line 66

def deploy_keys(repo, options={})
  get "/repos/#{Repository.new repo}/keys", options, 3
end

#edit_repository(repo, options = {}) ⇒ Object Also known as: edit, update_repository, update 



15
16
17
 
# File 'lib/octokit/client/repositories.rb', line 15

def edit_repository(repo, options={})
  patch "/repos/#{Repository.new repo}", options, 3
end

#fork(repo, options = {}) ⇒ Object 



41
42
43
 
# File 'lib/octokit/client/repositories.rb', line 41

def fork(repo, options={})
  post "/repos/#{Repository.new repo}/forks", options, 3
end

#forks(repo, options = {}) ⇒ Object Also known as: network 



114
115
116
 
# File 'lib/octokit/client/repositories.rb', line 114

def forks(repo, options={})
  get "/repos/#{Repository.new repo}/forks", options, 3
end

#languages(repo, options = {}) ⇒ Object 



119
120
121
 
# File 'lib/octokit/client/repositories.rb', line 119

def languages(repo, options={})
  get "/repos/#{Repository.new repo}/languages", options, 3
end

#pushable(options = {}) ⇒ Object 



94
95
96
97
 
# File 'lib/octokit/client/repositories.rb', line 94

def pushable(options={})
  # There isn't a matching method in V3 of the api
  get("/api/v2/json/repos/pushable", options, 2)['repositories']
end

#remove_collaborator(repo, collaborator, options = {}) ⇒ Object Also known as: remove_collab 



89
90
91
 
# File 'lib/octokit/client/repositories.rb', line 89

def remove_collaborator(repo, collaborator, options={})
  delete "/repos/#{Repository.new repo}/collaborators/#{collaborator}", options, 3
end

#remove_deploy_key(repo, id, options = {}) ⇒ Object 



75
76
77
 
# File 'lib/octokit/client/repositories.rb', line 75

def remove_deploy_key(repo, id, options={})
  delete "/repos/#{Repository.new repo}/keys/#{id}", options, 3
end

#repositories(username = nil, options = {}) ⇒ Object Also known as: list_repositories, list_repos, repos 



22
23
24
25
26
27
28
 
# File 'lib/octokit/client/repositories.rb', line 22

def repositories(username=nil, options={})
  if username.nil?
    get '/user/repos', options, 3
  else
    get "/users/#{username}/repos", options, 3
  end
end

#repository(repo, options = {}) ⇒ Object Also known as: repo 



10
11
12
 
# File 'lib/octokit/client/repositories.rb', line 10

def repository(repo, options={})
  get "/repos/#{Repository.new repo}", options, 3
end

#repository_issue_events(repo, options = {}) ⇒ Array Also known as: repo_issue_events

Get all Issue Events for a given Repository

Examples:

Get all Issue Events for Octokit

Octokit.repository_issue_events("pengwynn/octokit")

Parameters:

  • repo (String, Repository, Hash) —

    A GitHub repository

Returns:

  • (Array) —

    Array of all Issue Events for this Repository

See Also:



139
140
141
 
# File 'lib/octokit/client/repositories.rb', line 139

def repository_issue_events(repo, options={})
  get "/repos/#{Repository.new repo}/issues/events", options, 3
end

#repository_teams(repo, options = {}) ⇒ Object Also known as: repo_teams, teams 



99
100
101
 
# File 'lib/octokit/client/repositories.rb', line 99

def repository_teams(repo, options={})
  get "/repos/#{Repository.new repo}/teams", options, 3
end

#search_repositories(q, options = {}) ⇒ Object Also known as: search_repos 



4
5
6
7
 
# File 'lib/octokit/client/repositories.rb', line 4

def search_repositories(q, options={})
  # Depreciated 
  get("/api/v2/json/repos/search/#{q}", options, 2)['repositories']
end

#set_private(repo, options = {}) ⇒ Object 



58
59
60
 
# File 'lib/octokit/client/repositories.rb', line 58

def set_private(repo, options={})
  update_repository repo, options.merge({ :public => false })
end

#set_public(repo, options = {}) ⇒ Object 



62
63
64
 
# File 'lib/octokit/client/repositories.rb', line 62

def set_public(repo, options={})
  update_repository repo, options.merge({ :public => true })
end

#tags(repo, options = {}) ⇒ Object 



123
124
125
 
# File 'lib/octokit/client/repositories.rb', line 123

def tags(repo, options={})
  get "/repos/#{Repository.new repo}/tags", options, 3
end

#unwatch(repo, options = {}) ⇒ Object 



37
38
39
 
# File 'lib/octokit/client/repositories.rb', line 37

def unwatch(repo, options={})
  delete "/user/watched/#{Repository.new repo}", options, 3
end

#watch(repo, options = {}) ⇒ Object 



33
34
35
 
# File 'lib/octokit/client/repositories.rb', line 33

def watch(repo, options={})
  put "/user/watched/#{Repository.new repo}", options, 3
end

#watchers(repo, options = {}) ⇒ Object 



110
111
112
 
# File 'lib/octokit/client/repositories.rb', line 110

def watchers(repo, options={})
  get "/repos/#{Repository.new repo}/watchers", options, 3
end