Remove deprecated templates endpoints in V422818-licence-gitignore-and-yml-endpoints-removal

3 files changed, 162 insertions, 56 deletions

diff --git a/lib/api/api.rb b/lib/api/api.rb
index 7ec089b9c29..06346ae822a 100644
--- a/lib/api/api.rb
+++ b/lib/api/api.rb
@@ -11,6 +11,7 @@ module API
       mount ::API::V3::MergeRequests
       mount ::API::V3::Projects
       mount ::API::V3::ProjectSnippets
+      mount ::API::V3::Templates
     end
 
     before { allow_access_with_scope :api }
diff --git a/lib/api/templates.rb b/lib/api/templates.rb
index e23f99256a5..8a2d66efd89 100644
--- a/lib/api/templates.rb
+++ b/lib/api/templates.rb
@@ -24,7 +24,6 @@ module API
       /[\<\{\[]
         (fullname|name\sof\s(author|copyright\sowner))
       [\>\}\]]/xi.freeze
-    DEPRECATION_MESSAGE = ' This endpoint is deprecated and will be removed in GitLab 9.0.'.freeze
 
     helpers do
       def parsed_license_template
@@ -46,74 +45,58 @@ module API
       end
     end
 
-    { "licenses" => :deprecated, "templates/licenses" => :ok }.each do |route, status|
-      desc 'Get the list of the available license template' do
-        detailed_desc = 'This feature was introduced in GitLab 8.7.'
-        detailed_desc << DEPRECATION_MESSAGE unless status == :ok
-        detail detailed_desc
-        success Entities::RepoLicense
-      end
-      params do
-        optional :popular, type: Boolean, desc: 'If passed, returns only popular licenses'
-      end
-      get route do
-        options = {
-          featured: declared(params).popular.present? ? true : nil
-        }
-        present Licensee::License.all(options), with: Entities::RepoLicense
-      end
+    desc 'Get the list of the available license template' do
+      detail 'This feature was introduced in GitLab 8.7.'
+      success ::API::Entities::RepoLicense
+    end
+    params do
+      optional :popular, type: Boolean, desc: 'If passed, returns only popular licenses'
+    end
+    get "templates/licenses" do
+      options = {
+        featured: declared(params).popular.present? ? true : nil
+      }
+      present Licensee::License.all(options), with: ::API::Entities::RepoLicense
     end
 
-    { "licenses/:name" => :deprecated, "templates/licenses/:name" => :ok }.each do |route, status|
-      desc 'Get the text for a specific license' do
-        detailed_desc = 'This feature was introduced in GitLab 8.7.'
-        detailed_desc << DEPRECATION_MESSAGE unless status == :ok
-        detail detailed_desc
-        success Entities::RepoLicense
-      end
-      params do
-        requires :name, type: String, desc: 'The name of the template'
-      end
-      get route, requirements: { name: /[\w\.-]+/ } do
-        not_found!('License') unless Licensee::License.find(declared(params).name)
+    desc 'Get the text for a specific license' do
+      detail 'This feature was introduced in GitLab 8.7.'
+      success ::API::Entities::RepoLicense
+    end
+    params do
+      requires :name, type: String, desc: 'The name of the template'
+    end
+    get "templates/licenses/:name", requirements: { name: /[\w\.-]+/ } do
+      not_found!('License') unless Licensee::License.find(declared(params).name)
 
-        template = parsed_license_template
+      template = parsed_license_template
 
-        present template, with: Entities::RepoLicense
-      end
+      present template, with: ::API::Entities::RepoLicense
     end
 
     GLOBAL_TEMPLATE_TYPES.each do |template_type, properties|
       klass = properties[:klass]
       gitlab_version = properties[:gitlab_version]
 
-      { template_type => :deprecated, "templates/#{template_type}" => :ok }.each do |route, status|
-        desc 'Get the list of the available template' do
-          detailed_desc = "This feature was introduced in GitLab #{gitlab_version}."
-          detailed_desc << DEPRECATION_MESSAGE unless status == :ok
-          detail detailed_desc
-          success Entities::TemplatesList
-        end
-        get route do
-          present klass.all, with: Entities::TemplatesList
-        end
+      desc 'Get the list of the available template' do
+        detail "This feature was introduced in GitLab #{gitlab_version}."
+        success Entities::TemplatesList
+      end
+      get "templates/#{template_type}" do
+        present klass.all, with: Entities::TemplatesList
       end
 
-      { "#{template_type}/:name" => :deprecated, "templates/#{template_type}/:name" => :ok }.each do |route, status|
-        desc 'Get the text for a specific template present in local filesystem' do
-          detailed_desc = "This feature was introduced in GitLab #{gitlab_version}."
-          detailed_desc << DEPRECATION_MESSAGE unless status == :ok
-          detail detailed_desc
-          success Entities::Template
-        end
-        params do
-          requires :name, type: String, desc: 'The name of the template'
-        end
-        get route do
-          new_template = klass.find(declared(params).name)
+      desc 'Get the text for a specific template present in local filesystem' do
+        detail "This feature was introduced in GitLab #{gitlab_version}."
+        success Entities::Template
+      end
+      params do
+        requires :name, type: String, desc: 'The name of the template'
+      end
+      get "templates/#{template_type}/:name" do
+        new_template = klass.find(declared(params).name)
 
-          render_response(template_type, new_template)
-        end
+        render_response(template_type, new_template)
       end
     end
   end
diff --git a/lib/api/v3/templates.rb b/lib/api/v3/templates.rb
new file mode 100644
index 00000000000..4c577a8d2b7
--- /dev/null
+++ b/lib/api/v3/templates.rb
@@ -0,0 +1,122 @@
+module API
+  module V3
+    class Templates < Grape::API
+      GLOBAL_TEMPLATE_TYPES = {
+        gitignores: {
+          klass: Gitlab::Template::GitignoreTemplate,
+          gitlab_version: 8.8
+        },
+        gitlab_ci_ymls: {
+          klass: Gitlab::Template::GitlabCiYmlTemplate,
+          gitlab_version: 8.9
+        },
+        dockerfiles: {
+          klass: Gitlab::Template::DockerfileTemplate,
+          gitlab_version: 8.15
+        }
+      }.freeze
+      PROJECT_TEMPLATE_REGEX =
+        /[\<\{\[]
+          (project|description|
+          one\sline\s.+\swhat\sit\sdoes\.) # matching the start and end is enough here
+        [\>\}\]]/xi.freeze
+      YEAR_TEMPLATE_REGEX = /[<{\[](year|yyyy)[>}\]]/i.freeze
+      FULLNAME_TEMPLATE_REGEX =
+        /[\<\{\[]
+          (fullname|name\sof\s(author|copyright\sowner))
+        [\>\}\]]/xi.freeze
+      DEPRECATION_MESSAGE = ' This endpoint is deprecated and has been removed in V4.'.freeze
+
+      helpers do
+        def parsed_license_template
+          # We create a fresh Licensee::License object since we'll modify its
+          # content in place below.
+          template = Licensee::License.new(params[:name])
+
+          template.content.gsub!(YEAR_TEMPLATE_REGEX, Time.now.year.to_s)
+          template.content.gsub!(PROJECT_TEMPLATE_REGEX, params[:project]) if params[:project].present?
+
+          fullname = params[:fullname].presence || current_user.try(:name)
+          template.content.gsub!(FULLNAME_TEMPLATE_REGEX, fullname) if fullname
+          template
+        end
+
+        def render_response(template_type, template)
+          not_found!(template_type.to_s.singularize) unless template
+          present template, with: ::API::Entities::Template
+        end
+      end
+
+      { "licenses" => :deprecated, "templates/licenses" => :ok }.each do |route, status|
+        desc 'Get the list of the available license template' do
+          detailed_desc = 'This feature was introduced in GitLab 8.7.'
+          detailed_desc << DEPRECATION_MESSAGE unless status == :ok
+          detail detailed_desc
+          success ::API::Entities::RepoLicense
+        end
+        params do
+          optional :popular, type: Boolean, desc: 'If passed, returns only popular licenses'
+        end
+        get route do
+          options = {
+            featured: declared(params).popular.present? ? true : nil
+          }
+          present Licensee::License.all(options), with: ::API::Entities::RepoLicense
+        end
+      end
+
+      { "licenses/:name" => :deprecated, "templates/licenses/:name" => :ok }.each do |route, status|
+        desc 'Get the text for a specific license' do
+          detailed_desc = 'This feature was introduced in GitLab 8.7.'
+          detailed_desc << DEPRECATION_MESSAGE unless status == :ok
+          detail detailed_desc
+          success ::API::Entities::RepoLicense
+        end
+        params do
+          requires :name, type: String, desc: 'The name of the template'
+        end
+        get route, requirements: { name: /[\w\.-]+/ } do
+          not_found!('License') unless Licensee::License.find(declared(params).name)
+
+          template = parsed_license_template
+
+          present template, with: ::API::Entities::RepoLicense
+        end
+      end
+
+      GLOBAL_TEMPLATE_TYPES.each do |template_type, properties|
+        klass = properties[:klass]
+        gitlab_version = properties[:gitlab_version]
+
+        { template_type => :deprecated, "templates/#{template_type}" => :ok }.each do |route, status|
+          desc 'Get the list of the available template' do
+            detailed_desc = "This feature was introduced in GitLab #{gitlab_version}."
+            detailed_desc << DEPRECATION_MESSAGE unless status == :ok
+            detail detailed_desc
+            success ::API::Entities::TemplatesList
+          end
+          get route do
+            present klass.all, with: ::API::Entities::TemplatesList
+          end
+        end
+
+        { "#{template_type}/:name" => :deprecated, "templates/#{template_type}/:name" => :ok }.each do |route, status|
+          desc 'Get the text for a specific template present in local filesystem' do
+            detailed_desc = "This feature was introduced in GitLab #{gitlab_version}."
+            detailed_desc << DEPRECATION_MESSAGE unless status == :ok
+            detail detailed_desc
+            success ::API::Entities::Template
+          end
+          params do
+            requires :name, type: String, desc: 'The name of the template'
+          end
+          get route do
+            new_template = klass.find(declared(params).name)
+
+            render_response(template_type, new_template)
+          end
+        end
+      end
+    end
+  end
+end