module Gitlab # Projects API class Projects < Grape::API before { authenticate! } resource :projects do # Get a projects list for authenticated user # # Example Request: # GET /projects get do @projects = paginate current_user.projects present @projects, with: Entities::Project end # Get a single project # # Parameters: # id (required) - The ID or code name of a project # Example Request: # GET /projects/:id get ":id" do present user_project, with: Entities::Project end # Create new project # # Parameters: # name (required) - name for new project # code (optional) - code for new project, uses project name if not set # path (optional) - path for new project, uses project name if not set # description (optional) - short project description # default_branch (optional) - 'master' by default # issues_enabled (optional) - enabled by default # wall_enabled (optional) - enabled by default # merge_requests_enabled (optional) - enabled by default # wiki_enabled (optional) - enabled by default # Example Request # POST /projects post do params[:code] ||= params[:name] params[:path] ||= params[:name] attrs = attributes_for_keys [:code, :path, :name, :description, :default_branch, :issues_enabled, :wall_enabled, :merge_requests_enabled, :wiki_enabled] @project = Project.create_by_user(attrs, current_user) if @project.saved? present @project, with: Entities::Project else not_found! end end # Get a project team members # # Parameters: # id (required) - The ID or code name of a project # Example Request: # GET /projects/:id/members get ":id/members" do @members = paginate user_project.users present @members, with: Entities::ProjectMember, project: user_project end # Get a project team members # # Parameters: # id (required) - The ID or code name of a project # user_id (required) - The ID of a user # Example Request: # GET /projects/:id/members/:user_id get ":id/members/:user_id" do @member = user_project.users.find params[:user_id] present @member, with: Entities::ProjectMember, project: user_project end # Add a new project team member # # Parameters: # id (required) - The ID or code name of a project # user_id (required) - The ID of a user # access_level (required) - Project access level # Example Request: # POST /projects/:id/members post ":id/members" do authorize! :admin_project, user_project users_project = user_project.users_projects.new( user_id: params[:user_id], project_access: params[:access_level] ) if users_project.save @member = users_project.user present @member, with: Entities::ProjectMember, project: user_project else not_found! end end # Update project team member # # Parameters: # id (required) - The ID or code name of a project # user_id (required) - The ID of a team member # access_level (required) - Project access level # Example Request: # PUT /projects/:id/members/:user_id put ":id/members/:user_id" do authorize! :admin_project, user_project users_project = user_project.users_projects.find_by_user_id params[:user_id] if users_project.update_attributes(project_access: params[:access_level]) @member = users_project.user present @member, with: Entities::ProjectMember, project: user_project else not_found! end end # Remove a team member from project # # Parameters: # id (required) - The ID or code name of a project # user_id (required) - The ID of a team member # Example Request: # DELETE /projects/:id/members/:user_id delete ":id/members/:user_id" do authorize! :admin_project, user_project users_project = user_project.users_projects.find_by_user_id params[:user_id] users_project.destroy end # Get project hooks # # Parameters: # id (required) - The ID or code name of a project # Example Request: # GET /projects/:id/hooks get ":id/hooks" do authorize! :admin_project, user_project @hooks = paginate user_project.hooks present @hooks, with: Entities::Hook end # Add hook to project # # Parameters: # id (required) - The ID or code name of a project # url (required) - The hook URL # Example Request: # POST /projects/:id/hooks post ":id/hooks" do authorize! :admin_project, user_project @hook = user_project.hooks.new({"url" => params[:url]}) if @hook.save present @hook, with: Entities::Hook else error!({'message' => '404 Not found'}, 404) end end # Delete project hook # # Parameters: # id (required) - The ID or code name of a project # hook_id (required) - The ID of hook to delete # Example Request: # DELETE /projects/:id/hooks delete ":id/hooks" do authorize! :admin_project, user_project @hook = user_project.hooks.find(params[:hook_id]) @hook.destroy nil end # Get a project repository branches # # Parameters: # id (required) - The ID or code name of a project # Example Request: # GET /projects/:id/repository/branches get ":id/repository/branches" do present user_project.repo.heads.sort_by(&:name), with: Entities::RepoObject end # Get a single branch # # Parameters: # id (required) - The ID or code name of a project # branch (required) - The name of the branch # Example Request: # GET /projects/:id/repository/branches/:branch get ":id/repository/branches/:branch" do @branch = user_project.repo.heads.find { |item| item.name == params[:branch] } present @branch, with: Entities::RepoObject end # Get a project repository tags # # Parameters: # id (required) - The ID or code name of a project # Example Request: # GET /projects/:id/repository/tags get ":id/repository/tags" do present user_project.repo.tags.sort_by(&:name).reverse, with: Entities::RepoObject end # Get a project repository commits # # Parameters: # id (required) - The ID or code name of a project # ref_name (optional) - The name of a repository branch or tag # Example Request: # GET /projects/:id/repository/commits get ":id/repository/commits" do authorize! :download_code, user_project page = params[:page] || 0 per_page = params[:per_page] || 20 ref = params[:ref_name] || user_project.try(:default_branch) || 'master' commits = user_project.commits(ref, nil, per_page, page * per_page) present CommitDecorator.decorate(commits), with: Entities::RepoCommit end # Get a project snippet # # Parameters: # id (required) - The ID or code name of a project # snippet_id (required) - The ID of a project snippet # Example Request: # GET /projects/:id/snippets/:snippet_id get ":id/snippets/:snippet_id" do @snippet = user_project.snippets.find(params[:snippet_id]) present @snippet, with: Entities::ProjectSnippet end # Create a new project snippet # # Parameters: # id (required) - The ID or code name of a project # title (required) - The title of a snippet # file_name (required) - The name of a snippet file # lifetime (optional) - The expiration date of a snippet # code (required) - The content of a snippet # Example Request: # POST /projects/:id/snippets post ":id/snippets" do authorize! :write_snippet, user_project attrs = attributes_for_keys [:title, :file_name] attrs[:expires_at] = params[:lifetime] if params[:lifetime].present? attrs[:content] = params[:code] if params[:code].present? @snippet = user_project.snippets.new attrs @snippet.author = current_user if @snippet.save present @snippet, with: Entities::ProjectSnippet else not_found! end end # Update an existing project snippet # # Parameters: # id (required) - The ID or code name of a project # snippet_id (required) - The ID of a project snippet # title (optional) - The title of a snippet # file_name (optional) - The name of a snippet file # lifetime (optional) - The expiration date of a snippet # code (optional) - The content of a snippet # Example Request: # PUT /projects/:id/snippets/:snippet_id put ":id/snippets/:snippet_id" do @snippet = user_project.snippets.find(params[:snippet_id]) authorize! :modify_snippet, @snippet attrs = attributes_for_keys [:title, :file_name] attrs[:expires_at] = params[:lifetime] if params[:lifetime].present? attrs[:content] = params[:code] if params[:code].present? if @snippet.update_attributes attrs present @snippet, with: Entities::ProjectSnippet else not_found! end end # Delete a project snippet # # Parameters: # id (required) - The ID or code name of a project # snippet_id (required) - The ID of a project snippet # Example Request: # DELETE /projects/:id/snippets/:snippet_id delete ":id/snippets/:snippet_id" do @snippet = user_project.snippets.find(params[:snippet_id]) authorize! :modify_snippet, @snippet @snippet.destroy end # Get a raw project snippet # # Parameters: # id (required) - The ID or code name of a project # snippet_id (required) - The ID of a project snippet # Example Request: # GET /projects/:id/snippets/:snippet_id/raw get ":id/snippets/:snippet_id/raw" do @snippet = user_project.snippets.find(params[:snippet_id]) content_type 'text/plain' present @snippet.content end # Get a raw file contents # # Parameters: # id (required) - The ID or code name of a project # sha (required) - The commit or branch name # filepath (required) - The path to the file to display # Example Request: # GET /projects/:id/repository/commits/:sha/blob get ":id/repository/commits/:sha/blob" do authorize! :download_code, user_project ref = params[:sha] commit = user_project.commit ref not_found! "Commit" unless commit tree = Tree.new commit.tree, user_project, ref, params[:filepath] not_found! "File" unless tree.try(:tree) if tree.text? encoding = Gitlab::Encode.detect_encoding(tree.data) content_type encoding ? "text/plain; charset=#{encoding}" : "text/plain" else content_type tree.mime_type end present tree.data end end end end