Merge branch '60730-service-response' into 'master'

Introduce ServiceResponse to wrap around response

Closes #60730

See merge request gitlab-org/gitlab-ce!27516

2 files changed, 71 insertions, 10 deletions

diff --git a/spec/services/delete_branch_service_spec.rb b/spec/services/delete_branch_service_spec.rb
index 43a70d33d2d..b8064c2cbc1 100644
--- a/spec/services/delete_branch_service_spec.rb
+++ b/spec/services/delete_branch_service_spec.rb
@@ -8,20 +8,24 @@ describe DeleteBranchService do
   let(:user) { create(:user) }
   let(:service) { described_class.new(project, user) }
 
+  shared_examples 'a deleted branch' do |branch_name|
+    it 'removes the branch' do
+      expect(branch_exists?(branch_name)).to be true
+
+      result = service.execute(branch_name)
+
+      expect(result.status).to eq :success
+      expect(branch_exists?(branch_name)).to be false
+    end
+  end
+
   describe '#execute' do
     context 'when user has access to push to repository' do
       before do
         project.add_developer(user)
       end
 
-      it 'removes the branch' do
-        expect(branch_exists?('feature')).to be true
-
-        result = service.execute('feature')
-
-        expect(result[:status]).to eq :success
-        expect(branch_exists?('feature')).to be false
-      end
+      it_behaves_like 'a deleted branch', 'feature'
     end
 
     context 'when user does not have access to push to repository' do
@@ -30,8 +34,8 @@ describe DeleteBranchService do
 
         result = service.execute('feature')
 
-        expect(result[:status]).to eq :error
-        expect(result[:message]).to eq 'You dont have push access to repo'
+        expect(result.status).to eq :error
+        expect(result.message).to eq 'You dont have push access to repo'
         expect(branch_exists?('feature')).to be true
       end
     end
diff --git a/spec/services/service_response_spec.rb b/spec/services/service_response_spec.rb
new file mode 100644
index 00000000000..30bd4d6820b
--- /dev/null
+++ b/spec/services/service_response_spec.rb
@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'fast_spec_helper'
+
+ActiveSupport::Dependencies.autoload_paths << 'app/services'
+
+describe ServiceResponse do
+  describe '.success' do
+    it 'creates a successful response without a message' do
+      expect(described_class.success).to be_success
+    end
+
+    it 'creates a successful response with a message' do
+      response = described_class.success(message: 'Good orange')
+
+      expect(response).to be_success
+      expect(response.message).to eq('Good orange')
+    end
+  end
+
+  describe '.error' do
+    it 'creates a failed response without HTTP status' do
+      response = described_class.error(message: 'Bad apple')
+
+      expect(response).to be_error
+      expect(response.message).to eq('Bad apple')
+    end
+
+    it 'creates a failed response with HTTP status' do
+      response = described_class.error(message: 'Bad apple', http_status: 400)
+
+      expect(response).to be_error
+      expect(response.message).to eq('Bad apple')
+      expect(response.http_status).to eq(400)
+    end
+  end
+
+  describe '#success?' do
+    it 'returns true for a successful response' do
+      expect(described_class.success.success?).to eq(true)
+    end
+
+    it 'returns false for a failed response' do
+      expect(described_class.error(message: 'Bad apple').success?).to eq(false)
+    end
+  end
+
+  describe '#error?' do
+    it 'returns false for a successful response' do
+      expect(described_class.success.error?).to eq(false)
+    end
+
+    it 'returns true for a failed response' do
+      expect(described_class.error(message: 'Bad apple').error?).to eq(true)
+    end
+  end
+end