BigW Consortium Gitlab

members.rb 5.18 KB
Newer Older
1 2
module API
  class Members < Grape::API
3 4
    include PaginationParams

5 6 7 8 9
    before { authenticate! }

    helpers ::API::Helpers::MembersHelpers

    %w[group project].each do |source_type|
10 11 12
      params do
        requires :id, type: String, desc: "The #{source_type} ID"
      end
13
      resource source_type.pluralize do
14 15 16 17 18
        desc 'Gets a list of group or project members viewable by the authenticated user.' do
          success Entities::Member
        end
        params do
          optional :query, type: String, desc: 'A query string to search for members'
19
          use :pagination
20
        end
21 22 23
        get ":id/members" do
          source = find_source(source_type, params[:id])

24 25
          users = source.users
          users = users.merge(User.search(params[:query])) if params[:query]
26

27
          present paginate(users), with: Entities::Member, source: source
28 29
        end

30 31 32 33 34 35
        desc 'Gets a member of a group or project.' do
          success Entities::Member
        end
        params do
          requires :user_id, type: Integer, desc: 'The user ID of the member'
        end
36 37 38 39 40 41 42 43 44
        get ":id/members/:user_id" do
          source = find_source(source_type, params[:id])

          members = source.members
          member = members.find_by!(user_id: params[:user_id])

          present member.user, with: Entities::Member, member: member
        end

45 46 47 48 49 50 51 52
        desc 'Adds a member to a group or project.' do
          success Entities::Member
        end
        params do
          requires :user_id, type: Integer, desc: 'The user ID of the new member'
          requires :access_level, type: Integer, desc: 'A valid access level (defaults: `30`, developer access level)'
          optional :expires_at, type: DateTime, desc: 'Date string in the format YEAR-MONTH-DAY'
        end
53 54 55 56 57
        post ":id/members" do
          source = find_source(source_type, params[:id])
          authorize_admin_source!(source_type, source)

          member = source.members.find_by(user_id: params[:user_id])
58

59 60 61 62 63
          # We need this explicit check because `source.add_user` doesn't
          # currently return the member created so it would return 201 even if
          # the member already existed...
          # The `source_type == 'group'` check is to ensure back-compatibility
          # but 409 behavior should be used for both project and group members in 9.0!
64 65 66
          conflict!('Member already exists') if source_type == 'group' && member

          unless member
67
            member = source.add_user(params[:user_id], params[:access_level], current_user: current_user, expires_at: params[:expires_at])
68 69
          end

70
          if member.persisted? && member.valid?
71 72
            present member.user, with: Entities::Member, member: member
          else
73 74 75 76
            # This is to ensure back-compatibility but 400 behavior should be used
            # for all validation errors in 9.0!
            render_api_error!('Access level is not known', 422) if member.errors.key?(:access_level)
            render_validation_error!(member)
77 78 79
          end
        end

80 81 82 83 84 85 86 87
        desc 'Updates a member of a group or project.' do
          success Entities::Member
        end
        params do
          requires :user_id, type: Integer, desc: 'The user ID of the new member'
          requires :access_level, type: Integer, desc: 'A valid access level'
          optional :expires_at, type: DateTime, desc: 'Date string in the format YEAR-MONTH-DAY'
        end
88 89 90 91 92
        put ":id/members/:user_id" do
          source = find_source(source_type, params[:id])
          authorize_admin_source!(source_type, source)

          member = source.members.find_by!(user_id: params[:user_id])
93
          attrs = attributes_for_keys [:access_level, :expires_at]
94

95
          if member.update_attributes(attrs)
96 97
            present member.user, with: Entities::Member, member: member
          else
98 99 100
            # This is to ensure back-compatibility but 400 behavior should be used
            # for all validation errors in 9.0!
            render_api_error!('Access level is not known', 422) if member.errors.key?(:access_level)
101 102 103 104
            render_validation_error!(member)
          end
        end

105 106 107 108
        desc 'Removes a user from a group or project.'
        params do
          requires :user_id, type: Integer, desc: 'The user ID of the member'
        end
109 110 111
        delete ":id/members/:user_id" do
          source = find_source(source_type, params[:id])

112 113 114 115 116 117 118 119 120 121 122 123 124
          # This is to ensure back-compatibility but find_by! should be used
          # in that casse in 9.0!
          member = source.members.find_by(user_id: params[:user_id])

          # This is to ensure back-compatibility but this should be removed in
          # favor of find_by! in 9.0!
          not_found!("Member: user_id:#{params[:user_id]}") if source_type == 'group' && member.nil?

          # This is to ensure back-compatibility but 204 behavior should be used
          # for all DELETE endpoints in 9.0!
          if member.nil?
            { message: "Access revoked", id: params[:user_id].to_i }
          else
125
            ::Members::DestroyService.new(source, current_user, declared_params).execute
126

127 128
            present member.user, with: Entities::Member, member: member
          end
129 130 131 132 133
        end
      end
    end
  end
end