BigW Consortium Gitlab

members.rb 5.15 KB
Newer Older
1 2 3 4 5 6 7
module API
  class Members < Grape::API
    before { authenticate! }

    helpers ::API::Helpers::MembersHelpers

    %w[group project].each do |source_type|
8 9 10
      params do
        requires :id, type: String, desc: "The #{source_type} ID"
      end
11
      resource source_type.pluralize do
12 13 14 15 16 17
        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'
        end
18 19 20
        get ":id/members" do
          source = find_source(source_type, params[:id])

21 22 23
          users = source.users
          users = users.merge(User.search(params[:query])) if params[:query]
          users = paginate(users)
24

25
          present users, with: Entities::Member, source: source
26 27
        end

28 29 30 31 32 33
        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
34 35 36 37 38 39 40 41 42
        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

43 44 45 46 47 48 49 50
        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
51 52 53 54 55
        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])
56

57 58 59 60 61
          # 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!
62 63 64
          conflict!('Member already exists') if source_type == 'group' && member

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

68
          if member.persisted? && member.valid?
69 70
            present member.user, with: Entities::Member, member: member
          else
71 72 73 74
            # 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)
75 76 77
          end
        end

78 79 80 81 82 83 84 85
        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
86 87 88 89 90
        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])
91
          attrs = attributes_for_keys [:access_level, :expires_at]
92

93
          if member.update_attributes(attrs)
94 95
            present member.user, with: Entities::Member, member: member
          else
96 97 98
            # 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)
99 100 101 102
            render_validation_error!(member)
          end
        end

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

110 111 112 113 114 115 116 117 118 119 120 121 122
          # 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
123
            ::Members::DestroyService.new(source, current_user, declared(params)).execute
124

125 126
            present member.user, with: Entities::Member, member: member
          end
127 128 129 130 131
        end
      end
    end
  end
end