Extracted nuget endpoints into a shareable concern

Extracted common nuget examples into shared examples

lib/api/api.rb

@@ -211,7 +211,7 @@ module API
       mount ::API::ProjectPackages
       mount ::API::GroupPackages
       mount ::API::PackageFiles
-      mount ::API::NugetPackages
+      mount ::API::NugetProjectPackages
       mount ::API::PypiPackages
       mount ::API::ComposerPackages
       mount ::API::ConanProjectPackages

lib/api/concerns/packages/nuget_endpoints.rb

+# frozen_string_literal: true
+#
+# NuGet Package Manager Client API
+#
+# These API endpoints are not consumed directly by users, so there is no documentation for the
+# individual endpoints. They are called by the NuGet package manager client when users run commands
+# like `nuget install` or `nuget push`. The usage of the GitLab NuGet registry is documented here:
+# https://docs.gitlab.com/ee/user/packages/nuget_repository/
+#
+# Technical debt: https://gitlab.com/gitlab-org/gitlab/issues/35798
+module API
+  module Concerns
+    module Packages
+      module NugetEndpoints
+        extend ActiveSupport::Concern
+
+        POSITIVE_INTEGER_REGEX = %r{\A[1-9]\d*\z}.freeze
+        NON_NEGATIVE_INTEGER_REGEX = %r{\A0|[1-9]\d*\z}.freeze
+
+        included do
+          helpers do
+            def find_packages
+              packages = package_finder.execute
+
+              not_found!('Packages') unless packages.exists?
+
+              packages
+            end
+
+            def find_package
+              package = package_finder(package_version: params[:package_version]).execute
+                                                                                 .first
+
+              not_found!('Package') unless package
+
+              package
+            end
+
+            def package_finder(finder_params = {})
+              ::Packages::Nuget::PackageFinder.new(
+                authorized_user_project,
+                **finder_params.merge(package_name: params[:package_name])
+              )
+            end
+          end
+
+          # https://docs.microsoft.com/en-us/nuget/api/service-index
+          desc 'The NuGet Service Index' do
+            detail 'This feature was introduced in GitLab 12.6'
+          end
+
+          route_setting :authentication, deploy_token_allowed: true, job_token_allowed: :basic_auth, basic_auth_personal_access_token: true
+
+          get 'index', format: :json do
+            authorize_read_package!(authorized_user_project)
+            track_package_event('cli_metadata', :nuget, category: 'API::NugetPackages')
+
+            present ::Packages::Nuget::ServiceIndexPresenter.new(authorized_user_project),
+              with: ::API::Entities::Nuget::ServiceIndex
+          end
+
+          # https://docs.microsoft.com/en-us/nuget/api/registration-base-url-resource
+          params do
+            requires :package_name, type: String, desc: 'The NuGet package name', regexp: API::NO_SLASH_URL_PART_REGEX
+          end
+          namespace '/metadata/*package_name' do
+            before do
+              authorize_read_package!(authorized_user_project)
+            end
+
+            desc 'The NuGet Metadata Service - Package name level' do
+              detail 'This feature was introduced in GitLab 12.8'
+            end
+
+            route_setting :authentication, deploy_token_allowed: true, job_token_allowed: :basic_auth, basic_auth_personal_access_token: true
+
+            get 'index', format: :json do
+              present ::Packages::Nuget::PackagesMetadataPresenter.new(find_packages),
+                      with: ::API::Entities::Nuget::PackagesMetadata
+            end
+
+            desc 'The NuGet Metadata Service - Package name and version level' do
+              detail 'This feature was introduced in GitLab 12.8'
+            end
+            params do
+              requires :package_version, type: String, desc: 'The NuGet package version', regexp: API::NO_SLASH_URL_PART_REGEX
+            end
+
+            route_setting :authentication, deploy_token_allowed: true, job_token_allowed: :basic_auth, basic_auth_personal_access_token: true
+
+            get '*package_version', format: :json do
+              present ::Packages::Nuget::PackageMetadataPresenter.new(find_package),
+                      with: ::API::Entities::Nuget::PackageMetadata
+            end
+          end
+
+          # https://docs.microsoft.com/en-us/nuget/api/search-query-service-resource
+          params do
+            requires :q, type: String, desc: 'The search term'
+            optional :skip, type: Integer, desc: 'The number of results to skip', default: 0, regexp: NON_NEGATIVE_INTEGER_REGEX
+            optional :take, type: Integer, desc: 'The number of results to return', default: Kaminari.config.default_per_page, regexp: POSITIVE_INTEGER_REGEX
+            optional :prerelease, type: ::Grape::API::Boolean, desc: 'Include prerelease versions', default: true
+          end
+          namespace '/query' do
+            before do
+              authorize_read_package!(authorized_user_project)
+            end
+
+            desc 'The NuGet Search Service' do
+              detail 'This feature was introduced in GitLab 12.8'
+            end
+
+            route_setting :authentication, deploy_token_allowed: true, job_token_allowed: :basic_auth, basic_auth_personal_access_token: true
+
+            get format: :json do
+              search_options = {
+                include_prerelease_versions: params[:prerelease],
+                per_page: params[:take],
+                padding: params[:skip]
+              }
+              search = ::Packages::Nuget::SearchService
+                .new(authorized_user_project, params[:q], search_options)
+                .execute
+
+              track_package_event('search_package', :nuget, category: 'API::NugetPackages')
+
+              present ::Packages::Nuget::SearchResultsPresenter.new(search),
+                with: ::API::Entities::Nuget::SearchResults
+            end
+          end
+        end
+      end
+    end
+  end
+end

lib/api/nuget_packages.rb → lib/api/nuget_project_packages.rb

@@ -6,15 +6,12 @@
 # called by the NuGet package manager client when users run commands
 # like `nuget install` or `nuget push`.
 module API
-  class NugetPackages < ::API::Base
+  class NugetProjectPackages < ::API::Base
     helpers ::API::Helpers::PackagesManagerClientsHelpers
     helpers ::API::Helpers::Packages::BasicAuthHelpers
 
     feature_category :package_registry
 
-    POSITIVE_INTEGER_REGEX = %r{\A[1-9]\d*\z}.freeze
-    NON_NEGATIVE_INTEGER_REGEX = %r{\A0|[1-9]\d*\z}.freeze
-
     PACKAGE_FILENAME = 'package.nupkg'
 
     default_format :json
@@ -23,38 +20,12 @@ module API
       render_api_error!(e.message, 400)
     end
 
-    helpers do
-      def find_packages
-        packages = package_finder.execute
-
-        not_found!('Packages') unless packages.exists?
-
-        packages
-      end
-
-      def find_package
-        package = package_finder(package_version: params[:package_version]).execute
-                                                                           .first
-
-        not_found!('Package') unless package
-
-        package
-      end
-
-      def package_finder(finder_params = {})
-        ::Packages::Nuget::PackageFinder.new(
-          authorized_user_project,
-          **finder_params.merge(package_name: params[:package_name])
-        )
-      end
-    end
-
     before do
       require_packages_enabled!
     end
 
     params do
-      requires :id, type: String, desc: 'The ID of a project', regexp: POSITIVE_INTEGER_REGEX
+      requires :id, type: String, desc: 'The ID of a project', regexp: ::API::Concerns::Packages::NugetEndpoints::POSITIVE_INTEGER_REGEX
     end
 
     route_setting :authentication, deploy_token_allowed: true, job_token_allowed: :basic_auth, basic_auth_personal_access_token: true
@@ -65,21 +36,7 @@ module API
       end
 
       namespace ':id/packages/nuget' do
-        # https://docs.microsoft.com/en-us/nuget/api/service-index
-        desc 'The NuGet Service Index' do
-          detail 'This feature was introduced in GitLab 12.6'
-        end
-
-        route_setting :authentication, deploy_token_allowed: true, job_token_allowed: :basic_auth, basic_auth_personal_access_token: true
-
-        get 'index', format: :json do
-          authorize_read_package!(authorized_user_project)
-
-          track_package_event('cli_metadata', :nuget)
-
-          present ::Packages::Nuget::ServiceIndexPresenter.new(authorized_user_project),
-            with: ::API::Entities::Nuget::ServiceIndex
-        end
+        include ::API::Concerns::Packages::NugetEndpoints
 
         # https://docs.microsoft.com/en-us/nuget/api/package-publish-resource
         desc 'The NuGet Package Publish endpoint' do
@@ -107,7 +64,7 @@ module API
           package_file = ::Packages::CreatePackageFileService.new(package, file_params)
                                                              .execute
 
-          track_package_event('push_package', :nuget)
+          track_package_event('push_package', :nuget, category: 'API::NugetPackages')
 
           ::Packages::Nuget::ExtractionWorker.perform_async(package_file.id) # rubocop:disable CodeReuse/Worker
 
@@ -128,41 +85,6 @@ module API
           )
         end
 
-        params do
-          requires :package_name, type: String, desc: 'The NuGet package name', regexp: API::NO_SLASH_URL_PART_REGEX
-        end
-        namespace '/metadata/*package_name' do
-          before do
-            authorize_read_package!(authorized_user_project)
-          end
-
-          # https://docs.microsoft.com/en-us/nuget/api/registration-base-url-resource
-          desc 'The NuGet Metadata Service - Package name level' do
-            detail 'This feature was introduced in GitLab 12.8'
-          end
-
-          route_setting :authentication, deploy_token_allowed: true, job_token_allowed: :basic_auth, basic_auth_personal_access_token: true
-
-          get 'index', format: :json do
-            present ::Packages::Nuget::PackagesMetadataPresenter.new(find_packages),
-                    with: ::API::Entities::Nuget::PackagesMetadata
-          end
-
-          desc 'The NuGet Metadata Service - Package name and version level' do
-            detail 'This feature was introduced in GitLab 12.8'
-          end
-          params do
-            requires :package_version, type: String, desc: 'The NuGet package version', regexp: API::NO_SLASH_URL_PART_REGEX
-          end
-
-          route_setting :authentication, deploy_token_allowed: true, job_token_allowed: :basic_auth, basic_auth_personal_access_token: true
-
-          get '*package_version', format: :json do
-            present ::Packages::Nuget::PackageMetadataPresenter.new(find_package),
-                    with: ::API::Entities::Nuget::PackageMetadata
-          end
-        end
-
         # https://docs.microsoft.com/en-us/nuget/api/package-base-address-resource
         params do
           requires :package_name, type: String, desc: 'The NuGet package name', regexp: API::NO_SLASH_URL_PART_REGEX
@@ -200,47 +122,12 @@ module API
 
             not_found!('Package') unless package_file
 
-            track_package_event('pull_package', :nuget)
+            track_package_event('pull_package', :nuget, category: 'API::NugetPackages')
 
             # nuget and dotnet don't support 302 Moved status codes, supports_direct_download has to be set to false
             present_carrierwave_file!(package_file.file, supports_direct_download: false)
           end
         end
-
-        params do
-          requires :q, type: String, desc: 'The search term'
-          optional :skip, type: Integer, desc: 'The number of results to skip', default: 0, regexp: NON_NEGATIVE_INTEGER_REGEX
-          optional :take, type: Integer, desc: 'The number of results to return', default: Kaminari.config.default_per_page, regexp: POSITIVE_INTEGER_REGEX
-          optional :prerelease, type: Boolean, desc: 'Include prerelease versions', default: true
-        end
-        namespace '/query' do
-          before do
-            authorize_read_package!(authorized_user_project)
-          end
-
-          # https://docs.microsoft.com/en-us/nuget/api/search-query-service-resource
-          desc 'The NuGet Search Service' do
-            detail 'This feature was introduced in GitLab 12.8'
-          end
-
-          route_setting :authentication, deploy_token_allowed: true, job_token_allowed: :basic_auth, basic_auth_personal_access_token: true
-
-          get format: :json do
-            search_options = {
-              include_prerelease_versions: params[:prerelease],
-              per_page: params[:take],
-              padding: params[:skip]
-            }
-            search = Packages::Nuget::SearchService
-              .new(authorized_user_project, params[:q], search_options)
-              .execute
-
-            track_package_event('search_package', :nuget)
-
-            present ::Packages::Nuget::SearchResultsPresenter.new(search),
-              with: ::API::Entities::Nuget::SearchResults
-          end
-        end
       end
     end
   end

spec/support/shared_examples/requests/api/nuget_packages_shared_examples.rb

@@ -26,7 +26,7 @@ RSpec.shared_examples 'process nuget service index request' do |user_type, statu
 
     it_behaves_like 'returning response status', status
 
-    it_behaves_like 'a package tracking event', described_class.name, 'cli_metadata'
+    it_behaves_like 'a package tracking event', 'API::NugetPackages', 'cli_metadata'
 
     it 'returns a valid json response' do
       subject
@@ -169,7 +169,7 @@ RSpec.shared_examples 'process nuget upload' do |user_type, status, add_member =
       context 'with correct params' do
         it_behaves_like 'package workhorse uploads'
         it_behaves_like 'creates nuget package files'
-        it_behaves_like 'a package tracking event', described_class.name, 'push_package'
+        it_behaves_like 'a package tracking event', 'API::NugetPackages', 'push_package'
       end
     end
 
@@ -286,7 +286,7 @@ RSpec.shared_examples 'process nuget download content request' do |user_type, st
 
     it_behaves_like 'returning response status', status
 
-    it_behaves_like 'a package tracking event', described_class.name, 'pull_package'
+    it_behaves_like 'a package tracking event', 'API::NugetPackages', 'pull_package'
 
     it 'returns a valid package archive' do
       subject
@@ -336,7 +336,7 @@ RSpec.shared_examples 'process nuget search request' do |user_type, status, add_
 
     it_behaves_like 'returns a valid json search response', status, 4, [1, 5, 5, 1]
 
-    it_behaves_like 'a package tracking event', described_class.name, 'search_package'
+    it_behaves_like 'a package tracking event', 'API::NugetPackages', 'search_package'
 
     context 'with skip set to 2' do
       let(:skip) { 2 }