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_fork(id, options = {}) ⇒ Gitlab::ObjectifiedHash
Forks a project into the user namespace.
-
#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(id, options = {}) ⇒ Gitlab::ObjectifiedHash
Updates an existing project.
-
#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>
(also: #search_projects)
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.
215 216 217 218 |
# File 'lib/gitlab/client/projects.rb', line 215 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.
143 144 145 |
# File 'lib/gitlab/client/projects.rb', line 143 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.
310 311 312 |
# File 'lib/gitlab/client/projects.rb', line 310 def create_deploy_key(project, title, key) post("/projects/#{project}/keys", body: { title: title, key: key }) end |
#create_fork(id, options = {}) ⇒ Gitlab::ObjectifiedHash
Forks a project into the user namespace.
336 337 338 |
# File 'lib/gitlab/client/projects.rb', line 336 def create_fork(id, ={}) post("/projects/fork/#{id}", body: ) end |
#create_project(name, options = {}) ⇒ Gitlab::ObjectifiedHash
Creates a new project.
89 90 91 92 |
# File 'lib/gitlab/client/projects.rb', line 89 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.
322 323 324 |
# File 'lib/gitlab/client/projects.rb', line 322 def delete_deploy_key(project, id) delete("/projects/#{project}/keys/#{id}") end |
#delete_project(id) ⇒ Gitlab::ObjectifiedHash
Deletes a project.
101 102 103 |
# File 'lib/gitlab/client/projects.rb', line 101 def delete_project(id) delete("/projects/#{id}") end |
#delete_project_hook(project, id) ⇒ Gitlab::ObjectifiedHash
Deletes a hook from project.
247 248 249 |
# File 'lib/gitlab/client/projects.rb', line 247 def delete_project_hook(project, id) delete("/projects/#{project}/hooks/#{id}") end |
#deploy_key(project, id) ⇒ Gitlab::ObjectifiedHash
Gets a single project deploy key.
297 298 299 |
# File 'lib/gitlab/client/projects.rb', line 297 def deploy_key(project, id) get("/projects/#{project}/keys/#{id}") end |
#deploy_keys(project, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Gets a project deploy keys.
285 286 287 |
# File 'lib/gitlab/client/projects.rb', line 285 def deploy_keys(project, ={}) get("/projects/#{project}/keys", query: ) end |
#edit_project(id, options = {}) ⇒ Gitlab::ObjectifiedHash
Updates an existing project.
352 353 354 |
# File 'lib/gitlab/client/projects.rb', line 352 def edit_project(id, ={}) put("/projects/#{id}", query: ) end |
#edit_project_hook(project, id, url, options = {}) ⇒ Gitlab::ObjectifiedHash
Updates a project hook URL.
234 235 236 237 |
# File 'lib/gitlab/client/projects.rb', line 234 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.
157 158 159 |
# File 'lib/gitlab/client/projects.rb', line 157 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
259 260 261 |
# File 'lib/gitlab/client/projects.rb', line 259 def make_forked_from(project, id) post("/projects/#{project}/fork/#{id}") end |
#project(id) ⇒ Gitlab::ObjectifiedHash
Gets information about a project.
49 50 51 |
# File 'lib/gitlab/client/projects.rb', line 49 def project(id) get("/projects/#{id}") end |
#project_events(project, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Gets a list of project events.
64 65 66 |
# File 'lib/gitlab/client/projects.rb', line 64 def project_events(project, ={}) get("/projects/#{project}/events", query: ) end |
#project_hook(project, id) ⇒ Gitlab::ObjectifiedHash
Gets a project hook.
198 199 200 |
# File 'lib/gitlab/client/projects.rb', line 198 def project_hook(project, id) get("/projects/#{project}/hooks/#{id}") end |
#project_hooks(project, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>
Gets a list of project hooks.
185 186 187 |
# File 'lib/gitlab/client/projects.rb', line 185 def project_hooks(project, ={}) get("/projects/#{project}/hooks", query: ) end |
#project_search(query, options = {}) ⇒ Array<Gitlab::ObjectifiedHash> Also known as: search_projects
Search for projects by name.
36 37 38 |
# File 'lib/gitlab/client/projects.rb', line 36 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.
271 272 273 |
# File 'lib/gitlab/client/projects.rb', line 271 def remove_forked(project) delete("/projects/#{project}/fork") end |
#remove_team_member(project, id) ⇒ Gitlab::ObjectifiedHash
Removes a user from project team.
170 171 172 |
# File 'lib/gitlab/client/projects.rb', line 170 def remove_team_member(project, id) delete("/projects/#{project}/members/#{id}") end |
#team_member(project, id) ⇒ Gitlab::ObjectifiedHash
Gets a project team member.
129 130 131 |
# File 'lib/gitlab/client/projects.rb', line 129 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.
117 118 119 |
# File 'lib/gitlab/client/projects.rb', line 117 def team_members(project, ={}) get("/projects/#{project}/members", query: ) end |