Merge branch 'license-templates-and-api-12804' into 'master'

License templates when creating/editing a LICENSE file

Closes #12804

See merge request !3660

3 files changed, 71 insertions, 0 deletions

diff --git a/lib/api/api.rb b/lib/api/api.rb
index 7d65145176b..cc1004f8005 100644
--- a/lib/api/api.rb
+++ b/lib/api/api.rb
@@ -57,5 +57,6 @@ module API
     mount Builds
     mount Variables
     mount Runners
+    mount Licenses
   end
 end
diff --git a/lib/api/entities.rb b/lib/api/entities.rb
index 60b9f5e0ece..716ca6f7ed9 100644
--- a/lib/api/entities.rb
+++ b/lib/api/entities.rb
@@ -439,5 +439,17 @@ module API
     class Variable < Grape::Entity
       expose :key, :value
     end
+
+    class RepoLicense < Grape::Entity
+      expose :key, :name, :nickname
+      expose :featured, as: :popular
+      expose :url, as: :html_url
+      expose(:source_url) { |license| license.meta['source'] }
+      expose(:description) { |license| license.meta['description'] }
+      expose(:conditions) { |license| license.meta['conditions'] }
+      expose(:permissions) { |license| license.meta['permissions'] }
+      expose(:limitations) { |license| license.meta['limitations'] }
+      expose :content
+    end
   end
 end
diff --git a/lib/api/licenses.rb b/lib/api/licenses.rb
new file mode 100644
index 00000000000..187d2c04703
--- /dev/null
+++ b/lib/api/licenses.rb
@@ -0,0 +1,58 @@
+module API
+  # Licenses API
+  class Licenses < Grape::API
+    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
+
+    # Get the list of the available license templates
+    #
+    # Parameters:
+    #   popular - Filter licenses to only the popular ones
+    #
+    # Example Request:
+    #   GET /licenses
+    #   GET /licenses?popular=1
+    get 'licenses' do
+      options = {
+        featured: params[:popular].present? ? true : nil
+      }
+      present Licensee::License.all(options), with: Entities::RepoLicense
+    end
+
+    # Get text for specific license
+    #
+    # Parameters:
+    #   key (required) - The key of a license
+    #   project        - Copyrighted project name
+    #   fullname       - Full name of copyright holder
+    #
+    # Example Request:
+    #   GET /licenses/mit
+    #
+    get 'licenses/:key', requirements: { key: /[\w\.-]+/ } do
+      required_attributes! [:key]
+
+      not_found!('License') unless Licensee::License.find(params[:key])
+
+      # We create a fresh Licensee::License object since we'll modify its
+      # content in place below.
+      license = Licensee::License.new(params[:key])
+
+      license.content.gsub!(YEAR_TEMPLATE_REGEX, Time.now.year.to_s)
+      license.content.gsub!(PROJECT_TEMPLATE_REGEX, params[:project]) if params[:project].present?
+
+      fullname = params[:fullname].presence || current_user.try(:name)
+      license.content.gsub!(FULLNAME_TEMPLATE_REGEX, fullname) if fullname
+
+      present license, with: Entities::RepoLicense
+    end
+  end
+end