From 1db1896ed2375481d53f74f7900d259fe068ef64 Mon Sep 17 00:00:00 2001 From: Kamil Trzcinski Date: Fri, 18 Nov 2016 16:16:45 +0100 Subject: Rename mattermost_command to mattermost_slash_commands --- app/models/project.rb | 2 +- .../project_services/mattermost_command_service.rb | 56 ------------ .../mattermost_slash_commands_service.rb | 56 ++++++++++++ app/models/service.rb | 2 +- spec/lib/gitlab/import_export/all_models.yml | 2 +- .../mattermost_command_service_spec.rb | 99 ---------------------- .../mattermost_slash_commands_service_spec.rb | 99 ++++++++++++++++++++++ spec/models/project_spec.rb | 2 +- spec/requests/api/services_spec.rb | 12 +-- 9 files changed, 165 insertions(+), 165 deletions(-) delete mode 100644 app/models/project_services/mattermost_command_service.rb create mode 100644 app/models/project_services/mattermost_slash_commands_service.rb delete mode 100644 spec/models/project_services/mattermost_command_service_spec.rb create mode 100644 spec/models/project_services/mattermost_slash_commands_service_spec.rb diff --git a/app/models/project.rb b/app/models/project.rb index e6ae91f259d..34b44f90f1c 100644 --- a/app/models/project.rb +++ b/app/models/project.rb @@ -92,7 +92,7 @@ class Project < ActiveRecord::Base has_one :assembla_service, dependent: :destroy has_one :asana_service, dependent: :destroy has_one :gemnasium_service, dependent: :destroy - has_one :mattermost_command_service, dependent: :destroy + has_one :mattermost_slash_commands_service, dependent: :destroy has_one :slack_service, dependent: :destroy has_one :buildkite_service, dependent: :destroy has_one :bamboo_service, dependent: :destroy diff --git a/app/models/project_services/mattermost_command_service.rb b/app/models/project_services/mattermost_command_service.rb deleted file mode 100644 index 058b323ff20..00000000000 --- a/app/models/project_services/mattermost_command_service.rb +++ /dev/null @@ -1,56 +0,0 @@ -class MattermostCommandService < ChatService - include TriggersHelper - - prop_accessor :token - - def can_test? - false - end - - def title - 'Mattermost Command' - end - - def description - "Perform common operations on GitLab in Mattermost" - end - - def to_param - 'mattermost_command' - end - - def help - "This service allows you to use slash commands with your Mattermost installation.
- To setup this Service you need to create a new Slash commands in your Mattermost integration panel.
-
- Create integration with URL #{service_trigger_url(self)} and enter the token below." - end - - def fields - [ - { type: 'text', name: 'token', placeholder: '' } - ] - end - - def trigger(params) - return nil unless valid_token?(params[:token]) - - user = find_chat_user(params) - unless user - url = authorize_chat_name_url(params) - return Mattermost::Presenter.authorize_chat_name(url) - end - - Gitlab::ChatCommands::Command.new(project, user, params).execute - end - - private - - def find_chat_user(params) - ChatNames::FindUserService.new(self, params).execute - end - - def authorize_chat_name_url(params) - ChatNames::AuthorizeUserService.new(self, params).execute - end -end diff --git a/app/models/project_services/mattermost_slash_commands_service.rb b/app/models/project_services/mattermost_slash_commands_service.rb new file mode 100644 index 00000000000..67902329593 --- /dev/null +++ b/app/models/project_services/mattermost_slash_commands_service.rb @@ -0,0 +1,56 @@ +class MattermostSlashCommandsService < ChatService + include TriggersHelper + + prop_accessor :token + + def can_test? + false + end + + def title + 'Mattermost Command' + end + + def description + "Perform common operations on GitLab in Mattermost" + end + + def to_param + 'mattermost_slash_commands' + end + + def help + "This service allows you to use slash commands with your Mattermost installation.
+ To setup this Service you need to create a new Slash commands in your Mattermost integration panel.
+
+ Create integration with URL #{service_trigger_url(self)} and enter the token below." + end + + def fields + [ + { type: 'text', name: 'token', placeholder: '' } + ] + end + + def trigger(params) + return nil unless valid_token?(params[:token]) + + user = find_chat_user(params) + unless user + url = authorize_chat_name_url(params) + return Mattermost::Presenter.authorize_chat_name(url) + end + + Gitlab::ChatCommands::Command.new(project, user, params).execute + end + + private + + def find_chat_user(params) + ChatNames::FindUserService.new(self, params).execute + end + + def authorize_chat_name_url(params) + ChatNames::AuthorizeUserService.new(self, params).execute + end +end diff --git a/app/models/service.rb b/app/models/service.rb index 7ca44ced20e..edd6b5329f3 100644 --- a/app/models/service.rb +++ b/app/models/service.rb @@ -213,7 +213,7 @@ class Service < ActiveRecord::Base hipchat irker jira - mattermost_command + mattermost_slash_commands pipelines_email pivotaltracker pushover diff --git a/spec/lib/gitlab/import_export/all_models.yml b/spec/lib/gitlab/import_export/all_models.yml index bc837299b9e..fe3c39e38db 100644 --- a/spec/lib/gitlab/import_export/all_models.yml +++ b/spec/lib/gitlab/import_export/all_models.yml @@ -128,7 +128,7 @@ project: - emails_on_push_service - builds_email_service - pipelines_email_service -- mattermost_command_service +- mattermost_slash_commands_service - irker_service - pivotaltracker_service - hipchat_service diff --git a/spec/models/project_services/mattermost_command_service_spec.rb b/spec/models/project_services/mattermost_command_service_spec.rb deleted file mode 100644 index 21bf1d35e3f..00000000000 --- a/spec/models/project_services/mattermost_command_service_spec.rb +++ /dev/null @@ -1,99 +0,0 @@ -require 'spec_helper' - -describe MattermostCommandService, models: true do - describe "Associations" do - it { is_expected.to respond_to :token } - end - - describe '#valid_token?' do - subject { described_class.new } - - context 'when the token is empty' do - it 'is false' do - expect(subject.valid_token?('wer')).to be_falsey - end - end - - context 'when there is a token' do - before do - subject.token = '123' - end - - it 'accepts equal tokens' do - expect(subject.valid_token?('123')).to be_truthy - end - end - end - - describe '#trigger' do - subject { described_class.new } - - context 'no token is passed' do - let(:params) { Hash.new } - - it 'returns nil' do - expect(subject.trigger(params)).to be_nil - end - end - - context 'with a token passed' do - let(:project) { create(:empty_project) } - let(:params) { { token: 'token' } } - - before do - allow(subject).to receive(:token).and_return('token') - end - - context 'no user can be found' do - context 'when no url can be generated' do - it 'responds with the authorize url' do - response = subject.trigger(params) - - expect(response[:response_type]).to eq :ephemeral - expect(response[:text]).to start_with ":sweat_smile: Couldn't identify you" - end - end - - context 'when an auth url can be generated' do - let(:params) do - { - team_domain: 'http://domain.tld', - team_id: 'T3423423', - user_id: 'U234234', - user_name: 'mepmep', - token: 'token' - } - end - - let(:service) do - project.create_mattermost_command_service( - properties: { token: 'token' } - ) - end - - it 'generates the url' do - response = service.trigger(params) - - expect(response[:text]).to start_with(':wave: Hi there!') - end - end - end - - context 'when the user is authenticated' do - let!(:chat_name) { create(:chat_name, service: service) } - let(:service) do - project.create_mattermost_command_service( - properties: { token: 'token' } - ) - end - let(:params) { { token: 'token', team_id: chat_name.team_id, user_id: chat_name.chat_id } } - - it 'triggers the command' do - expect_any_instance_of(Gitlab::ChatCommands::Command).to receive(:execute) - - service.trigger(params) - end - end - end - end -end diff --git a/spec/models/project_services/mattermost_slash_commands_service_spec.rb b/spec/models/project_services/mattermost_slash_commands_service_spec.rb new file mode 100644 index 00000000000..4a1037e950b --- /dev/null +++ b/spec/models/project_services/mattermost_slash_commands_service_spec.rb @@ -0,0 +1,99 @@ +require 'spec_helper' + +describe MattermostSlashCommandsService, models: true do + describe "Associations" do + it { is_expected.to respond_to :token } + end + + describe '#valid_token?' do + subject { described_class.new } + + context 'when the token is empty' do + it 'is false' do + expect(subject.valid_token?('wer')).to be_falsey + end + end + + context 'when there is a token' do + before do + subject.token = '123' + end + + it 'accepts equal tokens' do + expect(subject.valid_token?('123')).to be_truthy + end + end + end + + describe '#trigger' do + subject { described_class.new } + + context 'no token is passed' do + let(:params) { Hash.new } + + it 'returns nil' do + expect(subject.trigger(params)).to be_nil + end + end + + context 'with a token passed' do + let(:project) { create(:empty_project) } + let(:params) { { token: 'token' } } + + before do + allow(subject).to receive(:token).and_return('token') + end + + context 'no user can be found' do + context 'when no url can be generated' do + it 'responds with the authorize url' do + response = subject.trigger(params) + + expect(response[:response_type]).to eq :ephemeral + expect(response[:text]).to start_with ":sweat_smile: Couldn't identify you" + end + end + + context 'when an auth url can be generated' do + let(:params) do + { + team_domain: 'http://domain.tld', + team_id: 'T3423423', + user_id: 'U234234', + user_name: 'mepmep', + token: 'token' + } + end + + let(:service) do + project.create_mattermost_slash_commands_service( + properties: { token: 'token' } + ) + end + + it 'generates the url' do + response = service.trigger(params) + + expect(response[:text]).to start_with(':wave: Hi there!') + end + end + end + + context 'when the user is authenticated' do + let!(:chat_name) { create(:chat_name, service: service) } + let(:service) do + project.create_mattermost_slash_commands_service( + properties: { token: 'token' } + ) + end + let(:params) { { token: 'token', team_id: chat_name.team_id, user_id: chat_name.chat_id } } + + it 'triggers the command' do + expect_any_instance_of(Gitlab::ChatCommands::Command).to receive(:execute) + + service.trigger(params) + end + end + end + end +end diff --git a/spec/models/project_spec.rb b/spec/models/project_spec.rb index 1972a8bb3f4..42589858ab1 100644 --- a/spec/models/project_spec.rb +++ b/spec/models/project_spec.rb @@ -36,7 +36,7 @@ describe Project, models: true do it { is_expected.to have_one(:hipchat_service).dependent(:destroy) } it { is_expected.to have_one(:flowdock_service).dependent(:destroy) } it { is_expected.to have_one(:assembla_service).dependent(:destroy) } - it { is_expected.to have_one(:mattermost_command_service).dependent(:destroy) } + it { is_expected.to have_one(:mattermost_slash_commands_service).dependent(:destroy) } it { is_expected.to have_one(:gemnasium_service).dependent(:destroy) } it { is_expected.to have_one(:buildkite_service).dependent(:destroy) } it { is_expected.to have_one(:bamboo_service).dependent(:destroy) } diff --git a/spec/requests/api/services_spec.rb b/spec/requests/api/services_spec.rb index 782d76db318..ce9c96ace21 100644 --- a/spec/requests/api/services_spec.rb +++ b/spec/requests/api/services_spec.rb @@ -91,7 +91,7 @@ describe API::API, api: true do describe 'POST /projects/:id/services/:slug/trigger' do let!(:project) { create(:empty_project) } - let(:service_name) { 'mattermost_command' } + let(:service_name) { 'mattermost_slash_commands' } context 'no service is available' do it 'returns a not found message' do @@ -107,14 +107,14 @@ describe API::API, api: true do context 'the service is not active' do let!(:inactive_service) do - project.create_mattermost_command_service( + project.create_mattermost_slash_commands_service( active: false, properties: { token: 'token' } ) end it 'when the service is inactive' do - post api("/projects/#{project.id}/services/mattermost_command/trigger") + post api("/projects/#{project.id}/services/mattermost_slash_commands/trigger") expect(response).to have_http_status(404) end @@ -122,14 +122,14 @@ describe API::API, api: true do context 'the service is active' do let!(:active_service) do - project.create_mattermost_command_service( + project.create_mattermost_slash_commands_service( active: true, properties: { token: 'token' } ) end it 'retusn status 200' do - post api("/projects/#{project.id}/services/mattermost_command/trigger"), params + post api("/projects/#{project.id}/services/mattermost_slash_commands/trigger"), params expect(response).to have_http_status(200) end @@ -137,7 +137,7 @@ describe API::API, api: true do context 'when the project can not be found' do it 'returns a generic 404' do - post api("/projects/404/services/mattermost_command/trigger"), params + post api("/projects/404/services/mattermost_slash_commands/trigger"), params expect(response).to have_http_status(404) expect(json_response["message"]).to eq("404 Service Not Found") -- cgit v1.2.1