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 



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

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

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



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

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 



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

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

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



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

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

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



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

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

#create_hook(repo, name, config, options = {}) ⇒ Object 



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

def create_hook(repo, name, config, options={})
  options = {:name => name, :config => config, :events => ["push"], :active => true}.merge(options)
  post "/repos/#{Repository.new repo}/hooks", options, 3
end

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



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

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 



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

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

#edit_hook(repo, id, name, config, options = {}) ⇒ Object 



143
144
145
146
 
# File 'lib/octokit/client/repositories.rb', line 143

def edit_hook(repo, id, name, config, options={})
  options = {:name => name, :config => config, :events => ["push"], :active => true}.merge(options)
  patch "/repos/#{Repository.new repo}/hooks/#{id}", options, 3
end

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



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

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

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



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

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

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



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

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

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



134
135
136
 
# File 'lib/octokit/client/repositories.rb', line 134

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

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



130
131
132
 
# File 'lib/octokit/client/repositories.rb', line 130

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

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



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

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

#pushable(options = {}) ⇒ Object 



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

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 



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

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

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



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

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

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



148
149
150
 
# File 'lib/octokit/client/repositories.rb', line 148

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

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



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

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 



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

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:



164
165
166
 
# File 'lib/octokit/client/repositories.rb', line 164

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 



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

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
 
# File 'lib/octokit/client/repositories.rb', line 4

def search_repositories(q, options={})
  get("/legacy/repos/search/#{q}", options, 3)['repositories']
end

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



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

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

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



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

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

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



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

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

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



152
153
154
 
# File 'lib/octokit/client/repositories.rb', line 152

def test_hook(repo, id, options={})
  post "/repos/#{Repository.new repo}/hooks/#{id}/test", options, 3
end

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



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

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

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



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

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

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



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

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