Merge branch '15886-composer-skeleton' into 'master'

Adds PHP Composer API skeleton

See merge request gitlab-org/gitlab!29643

ee/lib/api/composer_packages.rb

+# frozen_string_literal: true
+
+# PHP composer support (https://getcomposer.org/)
+module API
+  class ComposerPackages < Grape::API
+    helpers ::API::Helpers::PackagesManagerClientsHelpers
+    helpers ::API::Helpers::RelatedResourcesHelpers
+    helpers ::API::Helpers::Packages::BasicAuthHelpers
+    include ::API::Helpers::Packages::BasicAuthHelpers::Constants
+
+    content_type :json, 'application/json'
+    default_format :json
+
+    COMPOSER_ENDPOINT_REQUIREMENTS = {
+      package_name: API::NO_SLASH_URL_PART_REGEX
+    }.freeze
+
+    default_format :json
+
+    rescue_from ArgumentError do |e|
+      render_api_error!(e.message, 400)
+    end
+
+    rescue_from ActiveRecord::RecordInvalid do |e|
+      render_api_error!(e.message, 400)
+    end
+
+    before do
+      require_packages_enabled!
+    end
+
+    params do
+      requires :id, type: String, desc: 'The ID of a group'
+    end
+
+    resource :group, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
+      before do
+        unless ::Feature.enabled?(:composer_packages, user_group)
+          not_found!
+        end
+
+        authorize_packages_feature!(user_group)
+      end
+
+      desc 'Composer packages endpoint at group level'
+
+      route_setting :authentication, job_token_allowed: true
+
+      get ':id/-/packages/composer/packages' do
+      end
+
+      desc 'Composer packages endpoint at group level for packages list'
+
+      params do
+        requires :sha, type: String, desc: 'Shasum of current json'
+      end
+
+      route_setting :authentication, job_token_allowed: true
+
+      get ':id/-/packages/composer/p/:sha' do
+      end
+
+      desc 'Composer packages endpoint at group level for package versions metadata'
+
+      route_setting :authentication, job_token_allowed: true
+
+      get ':id/-/packages/composer/*package_name', requirements: COMPOSER_ENDPOINT_REQUIREMENTS, file_path: true do
+      end
+    end
+
+    params do
+      requires :id, type: Integer, desc: 'The ID of a project'
+    end
+
+    resource :projects, requirements: API::NAMESPACE_OR_PROJECT_REQUIREMENTS do
+      before do
+        unless ::Feature.enabled?(:composer_packages, authorized_user_project)
+          not_found!
+        end
+
+        authorize_packages_feature!(authorized_user_project)
+      end
+
+      desc 'Composer packages endpoint for registering packages'
+
+      params do
+        optional :branch, type: String, desc: 'The name of the branch'
+        optional :tag, type: String, desc: 'The name of the tag'
+      end
+
+      namespace ':id/packages/composer' do
+        post do
+          authorize_create_package!(authorized_user_project)
+
+          created!
+        end
+      end
+    end
+  end
+end

ee/lib/ee/api/api.rb

@@ -34,6 +34,7 @@ module EE
         mount ::API::ProjectPushRule
         mount ::API::NugetPackages
         mount ::API::PypiPackages
+        mount ::API::ComposerPackages
         mount ::API::ConanPackages
         mount ::API::MavenPackages
         mount ::API::NpmPackages

ee/spec/support/shared_examples/requests/api/composer_packages_shared_examples.rb

+# frozen_string_literal: true
+
+RSpec.shared_examples 'process Composer api request' do |user_type, status, add_member = true|
+  context "for user type #{user_type}" do
+    before do
+      group.send("add_#{user_type}", user) if add_member && user_type != :anonymous
+      project.send("add_#{user_type}", user) if add_member && user_type != :anonymous
+    end
+
+    it_behaves_like 'returning response status', status
+  end
+end
+
+RSpec.shared_examples 'rejects Composer access with unknown group id' do
+  context 'with an unknown group' do
+    let(:group) { double(id: non_existing_record_id) }
+
+    context 'as anonymous' do
+      it_behaves_like 'process Composer api request', :anonymous, :not_found
+    end
+
+    context 'as authenticated user' do
+      subject { get api(url), headers: build_basic_auth_header(user.username, personal_access_token.token) }
+
+      it_behaves_like 'process Composer api request', :anonymous, :not_found
+    end
+  end
+end
+
+RSpec.shared_examples 'rejects Composer packages access with packages features disabled' do
+  context 'with packages features disabled' do
+    before do
+      stub_licensed_features(packages: false)
+    end
+
+    it_behaves_like 'process Composer api request', :anonymous, :forbidden
+  end
+end
+
+RSpec.shared_examples 'rejects Composer access with unknown project id' do
+  context 'with an unknown project' do
+    let(:project) { double(id: non_existing_record_id) }
+
+    context 'as anonymous' do
+      it_behaves_like 'process PyPi api request', :anonymous, :unauthorized
+    end
+
+    context 'as authenticated user' do
+      subject { get api(url), headers: build_basic_auth_header(user.username, personal_access_token.token) }
+
+      it_behaves_like 'process PyPi api request', :anonymous, :not_found
+    end
+  end
+end