Merge branch 'fj-move-raw-url-to-snippet-entity' into 'master'

Move snippet raw_url to base entity

See merge request gitlab-org/gitlab!29776

changelogs/unreleased/fj-move-raw-url-to-snippet-entity.yml

+---
+title: Move snippet raw_url attribute to base entity
+merge_request: 29776
+author:
+type: fixed

doc/api/project_snippets.md

@@ -60,7 +60,9 @@ Parameters:
   },
   "updated_at": "2012-06-28T10:52:04Z",
   "created_at": "2012-06-28T10:52:04Z",
-  "web_url": "http://example.com/example/example/snippets/1"
+  "project_id": 1,
+  "web_url": "http://example.com/example/example/snippets/1",
+  "raw_url": "http://example.com/example/example/snippets/1/raw"
 }
 ```
 

doc/api/snippets.md

@@ -47,13 +47,13 @@ Example response:
             "username": "user0",
             "state": "active",
             "avatar_url": "https://www.gravatar.com/avatar/52e4ce24a915fb7e51e1ad3b57f4b00a?s=80&d=identicon",
-            "web_url": "http://localhost:3000/user0"
+            "web_url": "http://example.com/user0"
         },
         "updated_at": "2018-09-18T01:12:26.383Z",
         "created_at": "2018-09-18T01:12:26.383Z",
         "project_id": null,
-        "web_url": "http://localhost:3000/snippets/42",
-        "raw_url": "http://localhost:3000/snippets/42/raw"
+        "web_url": "http://example.com/snippets/42",
+        "raw_url": "http://example.com/snippets/42/raw"
     },
     {
         "id": 41,
@@ -67,13 +67,13 @@ Example response:
             "username": "user0",
             "state": "active",
             "avatar_url": "https://www.gravatar.com/avatar/52e4ce24a915fb7e51e1ad3b57f4b00a?s=80&d=identicon",
-            "web_url": "http://localhost:3000/user0"
+            "web_url": "http://example.com/user0"
         },
         "updated_at": "2018-09-18T01:12:26.360Z",
         "created_at": "2018-09-18T01:12:26.360Z",
-        "project_id": null,
-        "web_url": "http://localhost:3000/snippets/41",
-        "raw_url": "http://localhost:3000/snippets/41/raw"
+        "project_id": 1,
+        "web_url": "http://example.com/gitlab-org/gitlab-test/snippets/41",
+        "raw_url": "http://example.com/gitlab-org/gitlab-test/snippets/41/raw"
     }
 ]
 ```
@@ -118,7 +118,9 @@ Example response:
   "expires_at": null,
   "updated_at": "2012-06-28T10:52:04Z",
   "created_at": "2012-06-28T10:52:04Z",
+  "project_id": null,
   "web_url": "http://example.com/snippets/1",
+  "raw_url": "http://example.com/snippets/1/raw"
 }
 ```
 
@@ -199,7 +201,9 @@ Example response:
   "expires_at": null,
   "updated_at": "2012-06-28T10:52:04Z",
   "created_at": "2012-06-28T10:52:04Z",
+  "project_id": null,
   "web_url": "http://example.com/snippets/1",
+  "raw_url": "http://example.com/snippets/1/raw"
 }
 ```
 
@@ -255,7 +259,9 @@ Example response:
   "expires_at": null,
   "updated_at": "2012-06-28T10:52:04Z",
   "created_at": "2012-06-28T10:52:04Z",
+  "project_id": null,
   "web_url": "http://example.com/snippets/1",
+  "raw_url": "http://example.com/snippets/1/raw"
 }
 ```
 
@@ -318,15 +324,16 @@ Example response:
             "name": "Libby Rolfson",
             "state": "active",
             "username": "elton_wehner",
-            "web_url": "http://localhost:3000/elton_wehner"
+            "web_url": "http://example.com/elton_wehner"
         },
         "created_at": "2016-11-25T16:53:34.504Z",
         "file_name": "oconnerrice.rb",
         "id": 49,
-        "raw_url": "http://localhost:3000/snippets/49/raw",
         "title": "Ratione cupiditate et laborum temporibus.",
         "updated_at": "2016-11-25T16:53:34.504Z",
-        "web_url": "http://localhost:3000/snippets/49"
+        "project_id": null,
+        "web_url": "http://example.com/snippets/49",
+        "raw_url": "http://example.com/snippets/49/raw"
     },
     {
         "author": {
@@ -335,15 +342,16 @@ Example response:
             "name": "Llewellyn Flatley",
             "state": "active",
             "username": "adaline",
-            "web_url": "http://localhost:3000/adaline"
+            "web_url": "http://example.com/adaline"
         },
         "created_at": "2016-11-25T16:53:34.479Z",
         "file_name": "muellershields.rb",
         "id": 48,
-        "raw_url": "http://localhost:3000/snippets/48/raw",
         "title": "Minus similique nesciunt vel fugiat qui ullam sunt.",
         "updated_at": "2016-11-25T16:53:34.479Z",
-        "web_url": "http://localhost:3000/snippets/48",
+        "project_id": null,
+        "web_url": "http://example.com/snippets/48",
+        "raw_url": "http://example.com/snippets/49/raw",
         "visibility": "public"
     }
 ]

lib/api/entities/personal_snippet.rb

@@ -3,9 +3,6 @@
 module API
   module Entities
     class PersonalSnippet < Snippet
-      expose :raw_url do |snippet|
-        Gitlab::UrlBuilder.build(snippet, raw: true)
-      end
     end
   end
 end

lib/api/entities/snippet.rb

@@ -10,6 +10,9 @@ module API
       expose :web_url do |snippet|
         Gitlab::UrlBuilder.build(snippet)
       end
+      expose :raw_url do |snippet|
+        Gitlab::UrlBuilder.build(snippet, raw: true)
+      end
       expose :ssh_url_to_repo, :http_url_to_repo, if: ->(snippet) { snippet.versioned_enabled_for?(options[:current_user]) }
     end
   end

spec/fixtures/api/schemas/public_api/v4/snippets.json

@@ -10,6 +10,7 @@
       "description": { "type": ["string", "null"] },
       "visibility": { "type": "string" },
       "web_url": { "type": "string" },
+      "raw_url": { "type": "string" },
       "created_at": { "type": "date" },
       "updated_at": { "type": "date" },
       "author": {
@@ -27,7 +28,7 @@
     },
     "required": [
       "id", "title", "file_name", "description", "web_url",
-      "created_at", "updated_at", "author"
+      "created_at", "updated_at", "author", "raw_url"
     ],
     "additionalProperties": false
   }

spec/lib/api/entities/snippet_spec.rb

+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe ::API::Entities::Snippet do
+  let_it_be(:user) { create(:user) }
+  let_it_be(:personal_snippet) { create(:personal_snippet, :repository, author: user ) }
+  let_it_be(:project_snippet) { create(:project_snippet, :repository, author: user) }
+
+  let(:entity) { described_class.new(snippet) }
+
+  subject { entity.as_json }
+
+  shared_examples 'common attributes' do
+    it { expect(subject[:id]).to eq snippet.id }
+    it { expect(subject[:title]).to eq snippet.title }
+    it { expect(subject[:description]).to eq snippet.description }
+    it { expect(subject[:updated_at]).to eq snippet.updated_at }
+    it { expect(subject[:created_at]).to eq snippet.created_at }
+    it { expect(subject[:project_id]).to eq snippet.project_id }
+    it { expect(subject[:visibility]).to eq snippet.visibility }
+    it { expect(subject[:file_name]).to eq snippet.file_name }
+    it { expect(subject).to include(:author) }
+
+    describe 'ssh_url_to_repo' do
+      it 'returns attribute' do
+        expect(subject[:ssh_url_to_repo]).to eq snippet.ssh_url_to_repo
+      end
+
+      context 'when feature flag :version_snippets is disabled' do
+        it 'does not include attribute' do
+          stub_feature_flags(version_snippets: false)
+
+          expect(subject).not_to include(:ssh_url_to_repo)
+        end
+      end
+
+      context 'when repository does not exist' do
+        it 'does not include attribute' do
+          allow(snippet).to receive(:repository_exists?).and_return(false)
+
+          expect(subject).not_to include(:ssh_url_to_repo)
+        end
+      end
+    end
+
+    describe 'http_url_to_repo' do
+      it 'returns attribute' do
+        expect(subject[:http_url_to_repo]).to eq snippet.http_url_to_repo
+      end
+
+      context 'when feature flag :version_snippets is disabled' do
+        it 'does not include attribute' do
+          stub_feature_flags(version_snippets: false)
+
+          expect(subject).not_to include(:http_url_to_repo)
+        end
+      end
+
+      context 'when repository does not exist' do
+        it 'does not include attribute' do
+          allow(snippet).to receive(:repository_exists?).and_return(false)
+
+          expect(subject).not_to include(:http_url_to_repo)
+        end
+      end
+    end
+  end
+
+  context 'with PersonalSnippet' do
+    let(:snippet) { personal_snippet }
+
+    it_behaves_like 'common attributes'
+
+    it 'returns snippet web_url attribute' do
+      expect(subject[:web_url]).to match("/snippets/#{snippet.id}")
+    end
+
+    it 'returns snippet raw_url attribute' do
+      expect(subject[:raw_url]).to match("/snippets/#{snippet.id}/raw")
+    end
+  end
+
+  context 'with ProjectSnippet' do
+    let(:snippet) { project_snippet }
+
+    it_behaves_like 'common attributes'
+
+    it 'returns snippet web_url attribute' do
+      expect(subject[:web_url]).to match("#{snippet.project.full_path}/snippets/#{snippet.id}")
+    end
+
+    it 'returns snippet raw_url attribute' do
+      expect(subject[:raw_url]).to match("#{snippet.project.full_path}/snippets/#{snippet.id}/raw")
+    end
+  end
+end