Expose Group VisibilityLevel as String

Instead of exposing the VisibilityLevel as Integer, expose it as
String `visibility`.

doc/api/groups.md

@@ -27,7 +27,7 @@ GET /groups
     "name": "Foobar Group",
     "path": "foo-bar",
     "description": "An interesting group",
-    "visibility_level": 20,
+    "visibility": "public",
     "lfs_enabled": true,
     "avatar_url": "http://localhost:3000/uploads/group/avatar/1/foo.jpg",
     "web_url": "http://localhost:3000/groups/foo-bar",
@@ -72,9 +72,8 @@ Example response:
     "description": "foo",
     "default_branch": "master",
     "tag_list": [],
-    "public": false,
     "archived": false,
-    "visibility_level": 10,
+    "visibility": "internal",
     "ssh_url_to_repo": "git@gitlab.example.com/html5-boilerplate.git",
     "http_url_to_repo": "http://gitlab.example.com/h5bp/html5-boilerplate.git",
     "web_url": "http://gitlab.example.com/h5bp/html5-boilerplate",
@@ -134,7 +133,7 @@ Example response:
   "name": "Twitter",
   "path": "twitter",
   "description": "Aliquid qui quis dignissimos distinctio ut commodi voluptas est.",
-  "visibility_level": 20,
+  "visibility": "public",
   "avatar_url": null,
   "web_url": "https://gitlab.example.com/groups/twitter",
   "request_access_enabled": false,
@@ -147,9 +146,8 @@ Example response:
       "description": "Voluptas veniam qui et beatae voluptas doloremque explicabo facilis.",
       "default_branch": "master",
       "tag_list": [],
-      "public": true,
       "archived": false,
-      "visibility_level": 20,
+      "visibility": "public",
       "ssh_url_to_repo": "git@gitlab.example.com:twitter/typeahead-js.git",
       "http_url_to_repo": "https://gitlab.example.com/twitter/typeahead-js.git",
       "web_url": "https://gitlab.example.com/twitter/typeahead-js",
@@ -186,9 +184,8 @@ Example response:
       "description": "Aspernatur omnis repudiandae qui voluptatibus eaque.",
       "default_branch": "master",
       "tag_list": [],
-      "public": false,
       "archived": false,
-      "visibility_level": 10,
+      "visibility": "internal",
       "ssh_url_to_repo": "git@gitlab.example.com:twitter/flight.git",
       "http_url_to_repo": "https://gitlab.example.com/twitter/flight.git",
       "web_url": "https://gitlab.example.com/twitter/flight",
@@ -227,9 +224,8 @@ Example response:
       "description": "Velit eveniet provident fugiat saepe eligendi autem.",
       "default_branch": "master",
       "tag_list": [],
-      "public": false,
       "archived": false,
-      "visibility_level": 0,
+      "visibility": "private",
       "ssh_url_to_repo": "git@gitlab.example.com:h5bp/html5-boilerplate.git",
       "http_url_to_repo": "https://gitlab.example.com/h5bp/html5-boilerplate.git",
       "web_url": "https://gitlab.example.com/h5bp/html5-boilerplate",
@@ -306,7 +302,7 @@ Parameters:
 - `description` (optional) - The group's description
 - `membership_lock` (optional, boolean) - Prevent adding new members to project membership within this group
 - `share_with_group_lock` (optional, boolean) - Prevent sharing a project with another group within this group
-- `visibility_level` (optional) - The group's visibility. 0 for private, 10 for internal, 20 for public.
+- `visibility` (optional) - The group's visibility. Can be `private`, `internal`, or `public`.
 - `lfs_enabled` (optional)      - Enable/disable Large File Storage (LFS) for the projects in this group
 - `request_access_enabled` (optional) - Allow users to request member access.
 - `parent_id` (optional) - The parent group id for creating nested group.
@@ -338,7 +334,7 @@ PUT /groups/:id
 | `name` | string | no | The name of the group |
 | `path` | string | no | The path of the group |
 | `description` | string | no | The description of the group |
-| `visibility_level` | integer | no | The visibility level of the group. 0 for private, 10 for internal, 20 for public. |
+| `visibility` | string | no | The visibility level of the group. Can be `private`, `internal`, or `public`. |
 | `lfs_enabled` (optional) | boolean | no | Enable/disable Large File Storage (LFS) for the projects in this group |
 | `request_access_enabled` | boolean | no | Allow users to request member access. |
 
@@ -355,7 +351,7 @@ Example response:
   "name": "Experimental",
   "path": "h5bp",
   "description": "foo",
-  "visibility_level": 10,
+  "visibility": "internal",
   "avatar_url": null,
   "web_url": "http://gitlab.example.com/groups/h5bp",
   "request_access_enabled": false,
@@ -370,7 +366,7 @@ Example response:
       "tag_list": [],
       "public": false,
       "archived": false,
-      "visibility_level": 10,
+      "visibility": "internal",
       "ssh_url_to_repo": "git@gitlab.example.com/html5-boilerplate.git",
       "http_url_to_repo": "http://gitlab.example.com/h5bp/html5-boilerplate.git",
       "web_url": "http://gitlab.example.com/h5bp/html5-boilerplate",

lib/api/entities.rb

@@ -150,7 +150,8 @@ module API
     end
 
     class Group < Grape::Entity
-      expose :id, :name, :path, :description, :visibility_level
+      expose :id, :name, :path, :description
+      expose(:visibility) { |group, _options| Gitlab::VisibilityLevel.string_level(group.visibility_level) }
 
       expose :ldap_cn, :ldap_access
       expose :ldap_group_links,

lib/api/groups.rb

@@ -7,7 +7,7 @@ module API
     helpers do
       params :optional_params do
         optional :description, type: String, desc: 'The description of the group'
-        optional :visibility_level, type: Integer, desc: 'The visibility level of the group'
+        optional :visibility, type: String, values: Gitlab::VisibilityLevel.string_values, desc: 'The visibility of the group'
         optional :lfs_enabled, type: Boolean, desc: 'Enable/disable LFS for the projects in this group'
         optional :request_access_enabled, type: Boolean, desc: 'Allow users to request member access'
         optional :membership_lock, type: Boolean, desc: 'Prevent adding new members to project membership within this group'
@@ -114,7 +114,7 @@ module API
         optional :name, type: String, desc: 'The name of the group'
         optional :path, type: String, desc: 'The path of the group'
         use :optional_params
-        at_least_one_of :name, :path, :description, :visibility_level,
+        at_least_one_of :name, :path, :description, :visibility,
                         :lfs_enabled, :request_access_enabled
       end
       put ':id' do
@@ -148,7 +148,7 @@ module API
       end
       params do
         optional :archived, type: Boolean, default: false, desc: 'Limit by archived status'
-        optional :visibility, type: String, values: %w[public internal private],
+        optional :visibility, type: String, values: Gitlab::VisibilityLevel.string_values,
                               desc: 'Limit by visibility'
         optional :search, type: String, desc: 'Return list of authorized projects matching the search criteria'
         optional :order_by, type: String, values: %w[id name path created_at updated_at last_activity_at],

lib/api/v3/entities.rb

@@ -164,6 +164,30 @@ module API
           Gitlab::UrlBuilder.build(merge_request)
         end
       end
+
+      class Group < Grape::Entity
+        expose :id, :name, :path, :description, :visibility_level
+        expose :lfs_enabled?, as: :lfs_enabled
+        expose :avatar_url
+        expose :web_url
+        expose :request_access_enabled
+        expose :full_name, :full_path
+        expose :parent_id
+
+        expose :statistics, if: :statistics do
+          with_options format_with: -> (value) { value.to_i } do
+            expose :storage_size
+            expose :repository_size
+            expose :lfs_objects_size
+            expose :build_artifacts_size
+          end
+        end
+      end
+
+      class GroupDetail < Group
+        expose :projects, using: Entities::Project
+        expose :shared_projects, using: Entities::Project
+      end
     end
   end
 end

lib/api/v3/groups.rb

@@ -6,13 +6,20 @@ module API
       before { authenticate! }
 
       helpers do
+        params :optional_params do
+          optional :description, type: String, desc: 'The description of the group'
+          optional :visibility_level, type: Integer, desc: 'The visibility level of the group'
+          optional :lfs_enabled, type: Boolean, desc: 'Enable/disable LFS for the projects in this group'
+          optional :request_access_enabled, type: Boolean, desc: 'Allow users to request member access'
+        end
+
         params :statistics_params do
           optional :statistics, type: Boolean, default: false, desc: 'Include project statistics'
         end
 
         def present_groups(groups, options = {})
           options = options.reverse_merge(
-            with: ::API::Entities::Group,
+            with: Entities::Group,
             current_user: current_user,
           )
 
@@ -22,8 +29,36 @@ module API
       end
 
       resource :groups do
+        desc 'Get a groups list' do
+          success Entities::Group
+        end
+        params do
+          use :statistics_params
+          optional :skip_groups, type: Array[Integer], desc: 'Array of group ids to exclude from list'
+          optional :all_available, type: Boolean, desc: 'Show all group that you have access to'
+          optional :search, type: String, desc: 'Search for a specific group'
+          optional :order_by, type: String, values: %w[name path], default: 'name', desc: 'Order by name or path'
+          optional :sort, type: String, values: %w[asc desc], default: 'asc', desc: 'Sort by asc (ascending) or desc (descending)'
+          use :pagination
+        end
+        get do
+          groups = if current_user.admin
+                     Group.all
+                   elsif params[:all_available]
+                     GroupsFinder.new.execute(current_user)
+                   else
+                     current_user.groups
+                   end
+
+          groups = groups.search(params[:search]) if params[:search].present?
+          groups = groups.where.not(id: params[:skip_groups]) if params[:skip_groups].present?
+          groups = groups.reorder(params[:order_by] => params[:sort])
+
+          present_groups groups, statistics: params[:statistics] && current_user.is_admin?
+        end
+
         desc 'Get list of owned groups for authenticated user' do
-          success ::API::Entities::Group
+          success Entities::Group
         end
         params do
           use :pagination
@@ -32,6 +67,114 @@ module API
         get '/owned' do
           present_groups current_user.owned_groups, statistics: params[:statistics]
         end
+
+        desc 'Create a group. Available only for users who can create groups.' do
+          success Entities::Group
+        end
+        params do
+          requires :name, type: String, desc: 'The name of the group'
+          requires :path, type: String, desc: 'The path of the group'
+          optional :parent_id, type: Integer, desc: 'The parent group id for creating nested group'
+          use :optional_params
+        end
+        post do
+          authorize! :create_group
+
+          group = ::Groups::CreateService.new(current_user, declared_params(include_missing: false)).execute
+
+          if group.persisted?
+            present group, with: Entities::Group, current_user: current_user
+          else
+            render_api_error!("Failed to save group #{group.errors.messages}", 400)
+          end
+        end
+      end
+
+      params do
+        requires :id, type: String, desc: 'The ID of a group'
+      end
+      resource :groups do
+        desc 'Update a group. Available only for users who can administrate groups.' do
+          success Entities::Group
+        end
+        params do
+          optional :name, type: String, desc: 'The name of the group'
+          optional :path, type: String, desc: 'The path of the group'
+          use :optional_params
+          at_least_one_of :name, :path, :description, :visibility_level,
+                          :lfs_enabled, :request_access_enabled
+        end
+        put ':id' do
+          group = find_group!(params[:id])
+          authorize! :admin_group, group
+
+          if ::Groups::UpdateService.new(group, current_user, declared_params(include_missing: false)).execute
+            present group, with: Entities::GroupDetail, current_user: current_user
+          else
+            render_validation_error!(group)
+          end
+        end
+
+        desc 'Get a single group, with containing projects.' do
+          success Entities::GroupDetail
+        end
+        get ":id" do
+          group = find_group!(params[:id])
+          present group, with: Entities::GroupDetail, current_user: current_user
+        end
+
+        desc 'Remove a group.'
+        delete ":id" do
+          group = find_group!(params[:id])
+          authorize! :admin_group, group
+          present ::Groups::DestroyService.new(group, current_user).execute, with: Entities::GroupDetail, current_user: current_user
+        end
+
+        desc 'Get a list of projects in this group.' do
+          success Entities::Project
+        end
+        params do
+          optional :archived, type: Boolean, default: false, desc: 'Limit by archived status'
+          optional :visibility, type: String, values: %w[public internal private],
+                                desc: 'Limit by visibility'
+          optional :search, type: String, desc: 'Return list of authorized projects matching the search criteria'
+          optional :order_by, type: String, values: %w[id name path created_at updated_at last_activity_at],
+                              default: 'created_at', desc: 'Return projects ordered by field'
+          optional :sort, type: String, values: %w[asc desc], default: 'desc',
+                          desc: 'Return projects sorted in ascending and descending order'
+          optional :simple, type: Boolean, default: false,
+                            desc: 'Return only the ID, URL, name, and path of each project'
+          optional :owned, type: Boolean, default: false, desc: 'Limit by owned by authenticated user'
+          optional :starred, type: Boolean, default: false, desc: 'Limit by starred status'
+
+          use :pagination
+        end
+        get ":id/projects" do
+          group = find_group!(params[:id])
+          projects = GroupProjectsFinder.new(group).execute(current_user)
+          projects = filter_projects(projects)
+          entity = params[:simple] ? ::API::Entities::BasicProjectDetails : Entities::Project
+          present paginate(projects), with: entity, current_user: current_user
+        end
+
+        desc 'Transfer a project to the group namespace. Available only for admin.' do
+          success Entities::GroupDetail
+        end
+        params do
+          requires :project_id, type: String, desc: 'The ID or path of the project'
+        end
+        post ":id/projects/:project_id" do
+          authenticated_as_admin!
+          group = find_group!(params[:id])
+          project = find_project!(params[:project_id])
+          result = ::Projects::TransferService.new(project, current_user).execute(group)
+
+          if result
+            present group, with: Entities::GroupDetail, current_user: current_user
+          else
+            render_api_error!("Failed to transfer project #{project.errors.messages}", 400)
+          end
+        end
       end
     end
   end

spec/requests/api/groups_spec.rb

@@ -190,7 +190,7 @@ describe API::Groups, api: true  do
         expect(json_response['name']).to eq(group1.name)
         expect(json_response['path']).to eq(group1.path)
         expect(json_response['description']).to eq(group1.description)
-        expect(json_response['visibility_level']).to eq(group1.visibility_level)
+        expect(json_response['visibility']).to eq(Gitlab::VisibilityLevel.string_level(group1.visibility_level))
         expect(json_response['avatar_url']).to eq(group1.avatar_url)
         expect(json_response['web_url']).to eq(group1.web_url)
         expect(json_response['request_access_enabled']).to eq(group1.request_access_enabled)
@@ -309,7 +309,7 @@ describe API::Groups, api: true  do
         expect(json_response.length).to eq(2)
         project_names = json_response.map { |proj| proj['name'] }
         expect(project_names).to match_array([project1.name, project3.name])
-        expect(json_response.first['visibility_level']).to be_present
+        expect(json_response.first['visibility']).to be_present
       end
 
       it "returns the group's projects with simple representation" do
@@ -320,7 +320,7 @@ describe API::Groups, api: true  do
         expect(json_response.length).to eq(2)
         project_names = json_response.map { |proj| proj['name'] }
         expect(project_names).to match_array([project1.name, project3.name])
-        expect(json_response.first['visibility_level']).not_to be_present
+        expect(json_response.first['visibility']).not_to be_present
       end
 
       it 'filters the groups projects' do