Module: Gitlab::Client::Projects
- Included in:
- Gitlab::Client
- Defined in:
- lib/gitlab/client/projects.rb
Overview
Defines methods related to projects.
Instance Method Summary collapse
-
#add_project_hook(project, url, options = {}) ⇒ Gitlab::ObjectifiedHash
Adds a new hook to the project.
-
#add_team_member(project, id, access_level) ⇒ Gitlab::ObjectifiedHash
Adds a user to project team.
-
#create_deploy_key(project, title, key) ⇒ Gitlab::ObjectifiedHash
Creates a new deploy key.
-
#create_project(name, options = {}) ⇒ Gitlab::ObjectifiedHash
Creates a new project.
-
#delete_deploy_key(project, id) ⇒ Gitlab::ObjectifiedHash
Deletes a deploy key from project.
-
#delete_project(id) ⇒ Gitlab::ObjectifiedHash
Deletes a project.
-
#delete_project_hook(project, id) ⇒ Gitlab::ObjectifiedHash
Deletes a hook from project.
-
#deploy_key(project, id) ⇒ Gitlab::ObjectifiedHash
Gets a single project deploy key.
-
#deploy_keys(project, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Gets a project deploy keys.
-
#edit_project_hook(project, id, url, options = {}) ⇒ Gitlab::ObjectifiedHash
Updates a project hook URL.
-
#edit_team_member(project, id, access_level) ⇒ Array<Gitlab::ObjectifiedHash>
Updates a team member’s project access level.
-
#make_forked_from(project, id) ⇒ Gitlab::ObjectifiedHash
Mark this project as forked from the other.
-
#project(id) ⇒ Gitlab::ObjectifiedHash
Gets information about a project.
-
#project_events(project, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Gets a list of project events.
-
#project_hook(project, id) ⇒ Gitlab::ObjectifiedHash
Gets a project hook.
-
#project_hooks(project, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Gets a list of project hooks.
-
#project_search(query, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Search for projects by name.
-
#projects(options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Gets a list of projects owned by the authenticated user.
-
#remove_forked(project) ⇒ Gitlab::ObjectifiedHash
Remove a forked_from relationship for a project.
-
#remove_team_member(project, id) ⇒ Gitlab::ObjectifiedHash
Removes a user from project team.
-
#team_member(project, id) ⇒ Gitlab::ObjectifiedHash
Gets a project team member.
-
#team_members(project, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Gets a list of project team members.
Instance Method Details
#add_project_hook(project, url, options = {}) ⇒ Gitlab::ObjectifiedHash
Adds a new hook to the project.
214 215 216 217 |
# File 'lib/gitlab/client/projects.rb', line 214 def add_project_hook(project, url, ={}) body = {:url => url}.merge() post("/projects/#{project}/hooks", :body => body) end |
#add_team_member(project, id, access_level) ⇒ Gitlab::ObjectifiedHash
Adds a user to project team.
142 143 144 |
# File 'lib/gitlab/client/projects.rb', line 142 def add_team_member(project, id, access_level) post("/projects/#{project}/members", :body => {:user_id => id, :access_level => access_level}) end |
#create_deploy_key(project, title, key) ⇒ Gitlab::ObjectifiedHash
Creates a new deploy key.
309 310 311 |
# File 'lib/gitlab/client/projects.rb', line 309 def create_deploy_key(project, title, key) post("/projects/#{project}/keys", body: {title: title, key: key}) end |
#create_project(name, options = {}) ⇒ Gitlab::ObjectifiedHash
Creates a new project.
88 89 90 91 |
# File 'lib/gitlab/client/projects.rb', line 88 def create_project(name, ={}) url = [:user_id] ? "/projects/user/#{[:user_id]}" : "/projects" post(url, :body => {:name => name}.merge()) end |
#delete_deploy_key(project, id) ⇒ Gitlab::ObjectifiedHash
Deletes a deploy key from project.
321 322 323 |
# File 'lib/gitlab/client/projects.rb', line 321 def delete_deploy_key(project, id) delete("/projects/#{project}/keys/#{id}") end |
#delete_project(id) ⇒ Gitlab::ObjectifiedHash
Deletes a project.
100 101 102 |
# File 'lib/gitlab/client/projects.rb', line 100 def delete_project(id) delete("/projects/#{id}") end |
#delete_project_hook(project, id) ⇒ Gitlab::ObjectifiedHash
Deletes a hook from project.
246 247 248 |
# File 'lib/gitlab/client/projects.rb', line 246 def delete_project_hook(project, id) delete("/projects/#{project}/hooks/#{id}") end |
#deploy_key(project, id) ⇒ Gitlab::ObjectifiedHash
Gets a single project deploy key.
296 297 298 |
# File 'lib/gitlab/client/projects.rb', line 296 def deploy_key(project, id) get("/projects/#{project}/keys/#{id}") end |
#deploy_keys(project, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Gets a project deploy keys.
284 285 286 |
# File 'lib/gitlab/client/projects.rb', line 284 def deploy_keys(project, ={}) get("/projects/#{project}/keys", :query => ) end |
#edit_project_hook(project, id, url, options = {}) ⇒ Gitlab::ObjectifiedHash
Updates a project hook URL.
233 234 235 236 |
# File 'lib/gitlab/client/projects.rb', line 233 def edit_project_hook(project, id, url, ={}) body = {:url => url}.merge() put("/projects/#{project}/hooks/#{id}", :body => body) end |
#edit_team_member(project, id, access_level) ⇒ Array<Gitlab::ObjectifiedHash>
Updates a team member’s project access level.
156 157 158 |
# File 'lib/gitlab/client/projects.rb', line 156 def edit_team_member(project, id, access_level) put("/projects/#{project}/members/#{id}", :body => {:access_level => access_level}) end |
#make_forked_from(project, id) ⇒ Gitlab::ObjectifiedHash
Mark this project as forked from the other
258 259 260 |
# File 'lib/gitlab/client/projects.rb', line 258 def make_forked_from(project, id) post("/projects/#{project}/fork/#{id}") end |
#project(id) ⇒ Gitlab::ObjectifiedHash
Gets information about a project.
48 49 50 |
# File 'lib/gitlab/client/projects.rb', line 48 def project(id) get("/projects/#{id}") end |
#project_events(project, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Gets a list of project events.
63 64 65 |
# File 'lib/gitlab/client/projects.rb', line 63 def project_events(project, ={}) get("/projects/#{project}/events", :query => ) end |
#project_hook(project, id) ⇒ Gitlab::ObjectifiedHash
Gets a project hook.
197 198 199 |
# File 'lib/gitlab/client/projects.rb', line 197 def project_hook(project, id) get("/projects/#{project}/hooks/#{id}") end |
#project_hooks(project, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Gets a list of project hooks.
184 185 186 |
# File 'lib/gitlab/client/projects.rb', line 184 def project_hooks(project, ={}) get("/projects/#{project}/hooks", :query => ) end |
#project_search(query, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Search for projects by name
35 36 37 |
# File 'lib/gitlab/client/projects.rb', line 35 def project_search(query, ={}) get("/projects/search/#{query}", :query => ) end |
#projects(options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Gets a list of projects owned by the authenticated user.
15 16 17 18 19 20 21 |
# File 'lib/gitlab/client/projects.rb', line 15 def projects(={}) if ([:scope]) get("/projects/#{[:scope]}", :query => ) else get("/projects", :query => ) end end |
#remove_forked(project) ⇒ Gitlab::ObjectifiedHash
Remove a forked_from relationship for a project.
270 271 272 |
# File 'lib/gitlab/client/projects.rb', line 270 def remove_forked(project) delete("/projects/#{project}/fork") end |
#remove_team_member(project, id) ⇒ Gitlab::ObjectifiedHash
Removes a user from project team.
169 170 171 |
# File 'lib/gitlab/client/projects.rb', line 169 def remove_team_member(project, id) delete("/projects/#{project}/members/#{id}") end |
#team_member(project, id) ⇒ Gitlab::ObjectifiedHash
Gets a project team member.
128 129 130 |
# File 'lib/gitlab/client/projects.rb', line 128 def team_member(project, id) get("/projects/#{project}/members/#{id}") end |
#team_members(project, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Gets a list of project team members.
116 117 118 |
# File 'lib/gitlab/client/projects.rb', line 116 def team_members(project, ={}) get("/projects/#{project}/members", :query => ) end |