From e972d0be89981698e09f4ee0090b414fdbcb5247 Mon Sep 17 00:00:00 2001 From: Thorsten Eckel Date: Tue, 27 Oct 2020 15:05:10 +0100 Subject: [PATCH] Follow up - db3f553140ef506f8d31815ec08651187a3a6e4f - Fixes #3215 - Renamed Office365 to Microsoft365. --- .rubocop/todo.rspec.yml | 10 ++-- .rubocop/todo.yml | 14 ++--- .../app/controllers/_channel/email.coffee | 6 +- .../{office365.coffee => microsoft365.coffee} | 60 +++++++++---------- .../app/models/email_address.coffee | 2 +- .../channel/email_account_overview.jst.eco | 4 +- .../app_config.jst.eco | 4 +- .../app/views/microsoft365/index.jst.eco | 12 ++++ .../{office365 => microsoft365}/list.jst.eco | 2 +- .../app/views/office365/index.jst.eco | 12 ---- ...rb => channels_microsoft365_controller.rb} | 20 +++---- ...ap_authentication_migration_cleanup_job.rb | 2 +- app/models/channel/driver/imap.rb | 2 +- ...channels_microsoft365_controller_policy.rb | 3 + .../channels_office365_controller_policy.rb | 3 - config/routes/microsoft365.rb | 12 ++++ config/routes/office365.rb | 12 ---- .../{office365.rb => microsoft365.rb} | 20 +++---- ...office365_spec.rb => microsoft365_spec.rb} | 12 ++-- ...office365_spec.rb => microsoft365_spec.rb} | 24 ++++---- 20 files changed, 118 insertions(+), 118 deletions(-) rename app/assets/javascripts/app/controllers/_channel/{office365.coffee => microsoft365.coffee} (85%) rename app/assets/javascripts/app/views/{office365 => microsoft365}/app_config.jst.eco (87%) create mode 100644 app/assets/javascripts/app/views/microsoft365/index.jst.eco rename app/assets/javascripts/app/views/{office365 => microsoft365}/list.jst.eco (98%) delete mode 100644 app/assets/javascripts/app/views/office365/index.jst.eco rename app/controllers/{channels_office365_controller.rb => channels_microsoft365_controller.rb} (77%) create mode 100644 app/policies/controllers/channels_microsoft365_controller_policy.rb delete mode 100644 app/policies/controllers/channels_office365_controller_policy.rb create mode 100644 config/routes/microsoft365.rb delete mode 100644 config/routes/office365.rb rename lib/external_credential/{office365.rb => microsoft365.rb} (91%) rename spec/lib/external_credential/{office365_spec.rb => microsoft365_spec.rb} (94%) rename spec/requests/integration/{office365_spec.rb => microsoft365_spec.rb} (69%) diff --git a/.rubocop/todo.rspec.yml b/.rubocop/todo.rspec.yml index 43b2234b7..9333c5f17 100644 --- a/.rubocop/todo.rspec.yml +++ b/.rubocop/todo.rspec.yml @@ -43,7 +43,7 @@ RSpec/ContextWording: - 'spec/lib/auth_spec.rb' - 'spec/lib/core_ext/string_spec.rb' - 'spec/lib/external_credential/google_spec.rb' - - 'spec/lib/external_credential/office365_spec.rb' + - 'spec/lib/external_credential/microsoft365_spec.rb' - 'spec/lib/html_sanitizer_spec.rb' - 'spec/lib/import/exchange/folder_spec.rb' - 'spec/lib/import/helper_spec.rb' @@ -145,7 +145,7 @@ RSpec/ContextWording: - 'spec/requests/external_credentials_spec.rb' - 'spec/requests/integration/check_mk_spec.rb' - 'spec/requests/integration/gmail_spec.rb' - - 'spec/requests/integration/office365_spec.rb' + - 'spec/requests/integration/microsoft365_spec.rb' - 'spec/requests/integration/object_manager_attributes_spec.rb' - 'spec/requests/integration/smime_spec.rb' - 'spec/requests/knowledge_base/attachments_spec.rb' @@ -180,7 +180,7 @@ RSpec/ExampleLength: - 'spec/lib/auto_wizard_spec.rb' - 'spec/lib/core_ext/string_spec.rb' - 'spec/lib/external_credential/google_spec.rb' - - 'spec/lib/external_credential/office365_spec.rb' + - 'spec/lib/external_credential/microsoft365_spec.rb' - 'spec/lib/external_sync_spec.rb' - 'spec/lib/import/import_job_backend_examples.rb' - 'spec/lib/import/ldap_spec.rb' @@ -360,7 +360,7 @@ RSpec/LetSetup: - 'spec/jobs/communicate_twitter_job_spec.rb' - 'spec/jobs/ticket_online_notification_seen_job_spec.rb' - 'spec/lib/external_credential/google_spec.rb' - - 'spec/lib/external_credential/office365_spec.rb' + - 'spec/lib/external_credential/microsoft365_spec.rb' - 'spec/lib/secure_mailing/smime_spec.rb' - 'spec/lib/sessions/backend/ticket_overview_list_spec.rb' - 'spec/models/channel/driver/twitter_spec.rb' @@ -619,7 +619,7 @@ RSpec/NestedGroups: - 'spec/lib/core_ext/string_spec.rb' - 'spec/lib/email_address_validation_spec.rb' - 'spec/lib/external_credential/google_spec.rb' - - 'spec/lib/external_credential/office365_spec.rb' + - 'spec/lib/external_credential/microsoft365_spec.rb' - 'spec/lib/html_sanitizer_spec.rb' - 'spec/lib/import/exchange/folder_spec.rb' - 'spec/lib/notification_factory/mailer_spec.rb' diff --git a/.rubocop/todo.yml b/.rubocop/todo.yml index 351639f77..b4afbc8ea 100644 --- a/.rubocop/todo.yml +++ b/.rubocop/todo.yml @@ -26,7 +26,7 @@ Metrics/AbcSize: - 'app/controllers/attachments_controller.rb' - 'app/controllers/channels_email_controller.rb' - 'app/controllers/channels_google_controller.rb' - - 'app/controllers/channels_office365_controller.rb' + - 'app/controllers/channels_microsoft365_controller.rb' - 'app/controllers/channels_sms_controller.rb' - 'app/controllers/channels_telegram_controller.rb' - 'app/controllers/channels_twitter_controller.rb' @@ -275,7 +275,7 @@ Metrics/AbcSize: - 'lib/excel_sheet/ticket.rb' - 'lib/external_credential/facebook.rb' - 'lib/external_credential/google.rb' - - 'lib/external_credential/office365.rb' + - 'lib/external_credential/microsoft365.rb' - 'lib/external_credential/twitter.rb' - 'lib/facebook.rb' - 'lib/fill_db.rb' @@ -458,7 +458,7 @@ Metrics/CyclomaticComplexity: - 'app/controllers/application_controller/renders_models.rb' - 'app/controllers/channels_email_controller.rb' - 'app/controllers/channels_google_controller.rb' - - 'app/controllers/channels_office365_controller.rb' + - 'app/controllers/channels_microsoft365_controller.rb' - 'app/controllers/channels_twitter_controller.rb' - 'app/controllers/concerns/checks_user_attributes_by_current_user_permission.rb' - 'app/controllers/concerns/creates_ticket_articles.rb' @@ -616,7 +616,7 @@ Metrics/CyclomaticComplexity: - 'lib/excel_sheet.rb' - 'lib/external_credential/facebook.rb' - 'lib/external_credential/google.rb' - - 'lib/external_credential/office365.rb' + - 'lib/external_credential/microsoft365.rb' - 'lib/external_credential/twitter.rb' - 'lib/facebook.rb' - 'lib/fill_db.rb' @@ -697,7 +697,7 @@ Metrics/PerceivedComplexity: - 'app/controllers/application_controller/logs_http_access.rb' - 'app/controllers/channels_email_controller.rb' - 'app/controllers/channels_google_controller.rb' - - 'app/controllers/channels_office365_controller.rb' + - 'app/controllers/channels_microsoft365_controller.rb' - 'app/controllers/concerns/creates_ticket_articles.rb' - 'app/controllers/first_steps_controller.rb' - 'app/controllers/form_controller.rb' @@ -842,7 +842,7 @@ Metrics/PerceivedComplexity: - 'lib/excel_sheet.rb' - 'lib/external_credential/facebook.rb' - 'lib/external_credential/google.rb' - - 'lib/external_credential/office365.rb' + - 'lib/external_credential/microsoft365.rb' - 'lib/external_credential/twitter.rb' - 'lib/facebook.rb' - 'lib/fill_db.rb' @@ -940,7 +940,7 @@ Style/OptionalBooleanParameter: - 'lib/core_ext/string.rb' - 'lib/external_credential/facebook.rb' - 'lib/external_credential/google.rb' - - 'lib/external_credential/office365.rb' + - 'lib/external_credential/microsoft365.rb' - 'lib/external_credential/twitter.rb' - 'lib/html_sanitizer.rb' - 'lib/models.rb' diff --git a/app/assets/javascripts/app/controllers/_channel/email.coffee b/app/assets/javascripts/app/controllers/_channel/email.coffee index 2c55b286c..b6718e81c 100644 --- a/app/assets/javascripts/app/controllers/_channel/email.coffee +++ b/app/assets/javascripts/app/controllers/_channel/email.coffee @@ -188,7 +188,7 @@ class App.ChannelEmailAccountOverview extends App.Controller 'click .js-emailAddressDelete': 'emailAddressDelete', 'click .js-editNotificationOutbound': 'editNotificationOutbound' 'click .js-migrateGoogleMail': 'migrateGoogleMail' - 'click .js-migrateOffice365Mail': 'migrateOffice365Mail' + 'click .js-migrateMicrosoft365Mail': 'migrateMicrosoft365Mail' constructor: -> super @@ -386,10 +386,10 @@ class App.ChannelEmailAccountOverview extends App.Controller id = $(e.target).closest('.action').data('id') @navigate "#channels/google/#{id}" - migrateOffice365Mail: (e) => + migrateMicrosoft365Mail: (e) => e.preventDefault() id = $(e.target).closest('.action').data('id') - @navigate "#channels/office365/#{id}" + @navigate "#channels/microsoft365/#{id}" class App.ChannelEmailEdit extends App.ControllerModal buttonClose: true diff --git a/app/assets/javascripts/app/controllers/_channel/office365.coffee b/app/assets/javascripts/app/controllers/_channel/microsoft365.coffee similarity index 85% rename from app/assets/javascripts/app/controllers/_channel/office365.coffee rename to app/assets/javascripts/app/controllers/_channel/microsoft365.coffee index 6525c63fe..4bb97bd69 100644 --- a/app/assets/javascripts/app/controllers/_channel/office365.coffee +++ b/app/assets/javascripts/app/controllers/_channel/microsoft365.coffee @@ -1,10 +1,10 @@ -class App.ChannelOffice365 extends App.ControllerTabs - requiredPermission: 'admin.channel_office365' - header: 'Office 365' +class App.ChannelMicrosoft365 extends App.ControllerTabs + requiredPermission: 'admin.channel_microsoft365' + header: 'Microsoft 365' constructor: -> super - @title 'Office 365', true + @title 'Microsoft 365', true @tabs = [ { @@ -33,7 +33,7 @@ class App.ChannelOffice365 extends App.ControllerTabs @render() class ChannelAccountOverview extends App.ControllerSubContent - requiredPermission: 'admin.channel_office365' + requiredPermission: 'admin.channel_microsoft365' events: 'click .js-new': 'new' 'click .js-delete': 'delete' @@ -56,13 +56,13 @@ class ChannelAccountOverview extends App.ControllerSubContent load: (reset_channel_id = false) => if reset_channel_id @channel_id = undefined - @navigate '#channels/office365' + @navigate '#channels/microsoft365' @startLoading() @ajax( - id: 'office365_index' + id: 'microsoft365_index' type: 'GET' - url: "#{@apiPath}/channels_office365" + url: "#{@apiPath}/channels_microsoft365" processData: true success: (data, status, xhr) => @stopLoading() @@ -73,10 +73,10 @@ class ChannelAccountOverview extends App.ControllerSubContent render: (data) => - # if no office365 app is registered, show intro - external_credential = App.ExternalCredential.findByAttribute('name', 'office365') + # if no microsoft365 app is registered, show intro + external_credential = App.ExternalCredential.findByAttribute('name', 'microsoft365') if !external_credential - @html App.view('office365/index')() + @html App.view('microsoft365/index')() if @channel_id @configApp() return @@ -104,7 +104,7 @@ class ChannelAccountOverview extends App.ControllerSubContent for email_address_id in data.not_used_email_address_ids not_used_email_addresses.push App.EmailAddress.find(email_address_id) - @html App.view('office365/list')( + @html App.view('microsoft365/list')( channels: channels external_credential: external_credential not_used_email_addresses: not_used_email_addresses @@ -129,7 +129,7 @@ class ChannelAccountOverview extends App.ControllerSubContent ) new: (e) -> - window.location.href = "#{@apiPath}/external_credentials/office365/link_account" + window.location.href = "#{@apiPath}/external_credentials/microsoft365/link_account" delete: (e) => e.preventDefault() @@ -138,9 +138,9 @@ class ChannelAccountOverview extends App.ControllerSubContent message: 'Sure?' callback: => @ajax( - id: 'office365_delete' + id: 'microsoft365_delete' type: 'DELETE' - url: "#{@apiPath}/channels_office365" + url: "#{@apiPath}/channels_microsoft365" data: JSON.stringify(id: id) processData: true success: => @@ -153,9 +153,9 @@ class ChannelAccountOverview extends App.ControllerSubContent e.preventDefault() id = $(e.target).closest('.action').data('id') @ajax( - id: 'office365_disable' + id: 'microsoft365_disable' type: 'POST' - url: "#{@apiPath}/channels_office365_disable" + url: "#{@apiPath}/channels_microsoft365_disable" data: JSON.stringify(id: id) processData: true success: => @@ -166,9 +166,9 @@ class ChannelAccountOverview extends App.ControllerSubContent e.preventDefault() id = $(e.target).closest('.action').data('id') @ajax( - id: 'office365_enable' + id: 'microsoft365_enable' type: 'POST' - url: "#{@apiPath}/channels_office365_enable" + url: "#{@apiPath}/channels_microsoft365_enable" data: JSON.stringify(id: id) processData: true success: => @@ -191,9 +191,9 @@ class ChannelAccountOverview extends App.ControllerSubContent e.preventDefault() id = $(e.target).closest('.action').data('id') @ajax( - id: 'office365_rollback_migration' + id: 'microsoft365_rollback_migration' type: 'POST' - url: "#{@apiPath}/channels_office365_rollback_migration" + url: "#{@apiPath}/channels_microsoft365_rollback_migration" data: JSON.stringify(id: id) processData: true success: => @@ -296,7 +296,7 @@ class ChannelInboundEdit extends App.ControllerModal @ajax( id: 'channel_email_inbound' type: 'POST' - url: "#{@apiPath}/channels_office365_inbound/#{@item.id}" + url: "#{@apiPath}/channels_microsoft365_inbound/#{@item.id}" data: JSON.stringify(params) processData: true success: (data, status, xhr) => @@ -351,7 +351,7 @@ class ChannelGroupEdit extends App.ControllerModal @ajax( id: 'channel_email_group' type: 'POST' - url: "#{@apiPath}/channels_office365_group/#{@item.id}" + url: "#{@apiPath}/channels_microsoft365_group/#{@item.id}" data: JSON.stringify(params) processData: true success: (data, status, xhr) => @@ -364,15 +364,15 @@ class ChannelGroupEdit extends App.ControllerModal ) class AppConfig extends App.ControllerModal - head: 'Connect Office 365 App' + head: 'Connect Microsoft 365 App' shown: true button: 'Connect' buttonCancel: true small: true content: -> - @external_credential = App.ExternalCredential.findByAttribute('name', 'office365') - content = $(App.view('office365/app_config')( + @external_credential = App.ExternalCredential.findByAttribute('name', 'microsoft365') + content = $(App.view('microsoft365/app_config')( external_credential: @external_credential callbackUrl: @callbackUrl )) @@ -391,16 +391,16 @@ class AppConfig extends App.ControllerModal # verify app credentials @ajax( - id: 'office365_app_verify' + id: 'microsoft365_app_verify' type: 'POST' - url: "#{@apiPath}/external_credentials/office365/app_verify" + url: "#{@apiPath}/external_credentials/microsoft365/app_verify" data: JSON.stringify(@formParams()) processData: true success: (data, status, xhr) => if data.attributes if !@external_credential @external_credential = new App.ExternalCredential - @external_credential.load(name: 'office365', credentials: data.attributes) + @external_credential.load(name: 'microsoft365', credentials: data.attributes) @external_credential.save( done: => @isChanged = true @@ -413,4 +413,4 @@ class AppConfig extends App.ControllerModal @el.find('.alert').removeClass('hidden').text(data.error || 'Unable to verify App.') ) -App.Config.set('office365', { prio: 5000, name: 'Office 365', parent: '#channels', target: '#channels/office365', controller: App.ChannelOffice365, permission: ['admin.channel_office365'] }, 'NavBarAdmin') +App.Config.set('microsoft365', { prio: 5000, name: 'Microsoft 365', parent: '#channels', target: '#channels/microsoft365', controller: App.ChannelMicrosoft365, permission: ['admin.channel_microsoft365'] }, 'NavBarAdmin') diff --git a/app/assets/javascripts/app/models/email_address.coffee b/app/assets/javascripts/app/models/email_address.coffee index 7409b98bd..a3ac6347f 100644 --- a/app/assets/javascripts/app/models/email_address.coffee +++ b/app/assets/javascripts/app/models/email_address.coffee @@ -18,7 +18,7 @@ class App.EmailAddress extends App.Model if localChannel return channel if channel.area is localChannel.area else - return channel if channel.area is 'Google::Account' || channel.area is 'Office365::Account' || channel.area is 'Email::Account' + return channel if channel.area is 'Google::Account' || channel.area is 'Microsoft365::Account' || channel.area is 'Email::Account' ) @configure_attributes = [ diff --git a/app/assets/javascripts/app/views/channel/email_account_overview.jst.eco b/app/assets/javascripts/app/views/channel/email_account_overview.jst.eco index c1fe4dc33..1265e6ae1 100644 --- a/app/assets/javascripts/app/views/channel/email_account_overview.jst.eco +++ b/app/assets/javascripts/app/views/channel/email_account_overview.jst.eco @@ -63,9 +63,9 @@ <% date_migration = new Date("#{date_migration_string}T00:00:00") %> <% date_now = new Date() %> <% if date_now > date_migration: %> - <%- @T('%s will only allow access via OAuth. Password-based access is no longer supported since %s.', 'Office 365', date_migration_string_local) %>
+ <%- @T('%s will only allow access via OAuth. Password-based access is no longer supported since %s.', 'Microsoft 365', date_migration_string_local) %>
<% else: %> - <%- @T('%s will only allow access via OAuth. Password-based access will no longer be supported on %s.', 'Office 365', date_migration_string_local) %>
+ <%- @T('%s will only allow access via OAuth. Password-based access will no longer be supported on %s.', 'Microsoft 365', date_migration_string_local) %>
<% end %> <% end %> diff --git a/app/assets/javascripts/app/views/office365/app_config.jst.eco b/app/assets/javascripts/app/views/microsoft365/app_config.jst.eco similarity index 87% rename from app/assets/javascripts/app/views/office365/app_config.jst.eco rename to app/assets/javascripts/app/views/microsoft365/app_config.jst.eco index 1c1f565ee..38a54bc88 100644 --- a/app/assets/javascripts/app/views/office365/app_config.jst.eco +++ b/app/assets/javascripts/app/views/microsoft365/app_config.jst.eco @@ -1,9 +1,9 @@

- <%- @T('The tutorial on how to manage a %s is hosted on our online documentation %l.', 'Office 365 App', 'https://admin-docs.zammad.org/en/latest/channels/office365.html') %> + <%- @T('The tutorial on how to manage a %s is hosted on our online documentation %l.', 'Microsoft 365 App', 'https://admin-docs.zammad.org/en/latest/channels/microsoft365.html') %>

-

<%- @T('Enter your %s App Keys', 'Office 365') %>

+

<%- @T('Enter your %s App Keys', 'Microsoft 365') %>

diff --git a/app/assets/javascripts/app/views/microsoft365/index.jst.eco b/app/assets/javascripts/app/views/microsoft365/index.jst.eco new file mode 100644 index 000000000..b84e9918b --- /dev/null +++ b/app/assets/javascripts/app/views/microsoft365/index.jst.eco @@ -0,0 +1,12 @@ +
+
+

<%- @T('Microsoft 365') %> <%- @T('Accounts') %>

+
+
+ +
+
+

<%- @T('You can connect %s with Zammad. You need to connect your Zammad with %s first.', 'Microsoft 365 Accounts', 'Microsoft 365') %>

+
<%- @T('Connect Microsoft 365 App') %>
+
+
diff --git a/app/assets/javascripts/app/views/office365/list.jst.eco b/app/assets/javascripts/app/views/microsoft365/list.jst.eco similarity index 98% rename from app/assets/javascripts/app/views/office365/list.jst.eco rename to app/assets/javascripts/app/views/microsoft365/list.jst.eco index cf59cc286..3d3680719 100644 --- a/app/assets/javascripts/app/views/office365/list.jst.eco +++ b/app/assets/javascripts/app/views/microsoft365/list.jst.eco @@ -1,6 +1,6 @@
-

<%- @T('Office 365') %> <%- @T('Accounts') %>

+

<%- @T('Microsoft 365') %> <%- @T('Accounts') %>

diff --git a/app/assets/javascripts/app/views/office365/index.jst.eco b/app/assets/javascripts/app/views/office365/index.jst.eco deleted file mode 100644 index 105e5292e..000000000 --- a/app/assets/javascripts/app/views/office365/index.jst.eco +++ /dev/null @@ -1,12 +0,0 @@ -
-
-

<%- @T('Office 365') %> <%- @T('Accounts') %>

-
-
- -
-
-

<%- @T('You can connect %s with Zammad. You need to connect your Zammad with %s first.', 'Office 365 Accounts', 'Office 365') %>

-
<%- @T('Connect Office 365 App') %>
-
-
diff --git a/app/controllers/channels_office365_controller.rb b/app/controllers/channels_microsoft365_controller.rb similarity index 77% rename from app/controllers/channels_office365_controller.rb rename to app/controllers/channels_microsoft365_controller.rb index 1e3ce45e0..8fd589d61 100644 --- a/app/controllers/channels_office365_controller.rb +++ b/app/controllers/channels_microsoft365_controller.rb @@ -1,6 +1,6 @@ # Copyright (C) 2012-2016 Zammad Foundation, http://zammad-foundation.org/ -class ChannelsOffice365Controller < ApplicationController +class ChannelsMicrosoft365Controller < ApplicationController prepend_before_action -> { authentication_check && authorize! } def index @@ -8,13 +8,13 @@ class ChannelsOffice365Controller < ApplicationController assets = {} external_credential_ids = [] - ExternalCredential.where(name: 'office365').each do |external_credential| + ExternalCredential.where(name: 'microsoft365').each do |external_credential| assets = external_credential.assets(assets) external_credential_ids.push external_credential.id end channel_ids = [] - Channel.where(area: 'Office365::Account').order(:id).each do |channel| + Channel.where(area: 'Microsoft365::Account').order(:id).each do |channel| assets = channel.assets(assets) channel_ids.push channel.id end @@ -34,26 +34,26 @@ class ChannelsOffice365Controller < ApplicationController not_used_email_address_ids: not_used_email_address_ids, channel_ids: channel_ids, external_credential_ids: external_credential_ids, - callback_url: ExternalCredential.callback_url('office365'), + callback_url: ExternalCredential.callback_url('microsoft365'), } end def enable - channel = Channel.find_by(id: params[:id], area: 'Office365::Account') + channel = Channel.find_by(id: params[:id], area: 'Microsoft365::Account') channel.active = true channel.save! render json: {} end def disable - channel = Channel.find_by(id: params[:id], area: 'Office365::Account') + channel = Channel.find_by(id: params[:id], area: 'Microsoft365::Account') channel.active = false channel.save! render json: {} end def destroy - channel = Channel.find_by(id: params[:id], area: 'Office365::Account') + channel = Channel.find_by(id: params[:id], area: 'Microsoft365::Account') email = EmailAddress.find_by(channel_id: channel.id) email.destroy! channel.destroy! @@ -61,14 +61,14 @@ class ChannelsOffice365Controller < ApplicationController end def group - channel = Channel.find_by(id: params[:id], area: 'Office365::Account') + channel = Channel.find_by(id: params[:id], area: 'Microsoft365::Account') channel.group_id = params[:group_id] channel.save! render json: {} end def inbound - channel = Channel.find_by(id: params[:id], area: 'Office365::Account') + channel = Channel.find_by(id: params[:id], area: 'Microsoft365::Account') %w[folder keep_on_server].each do |key| channel.options[:inbound][:options][key] = params[:options][key] end @@ -90,7 +90,7 @@ class ChannelsOffice365Controller < ApplicationController end def rollback_migration - channel = Channel.find_by(id: params[:id], area: 'Office365::Account') + channel = Channel.find_by(id: params[:id], area: 'Microsoft365::Account') raise 'Failed to find backup on channel!' if !channel.options[:backup_imap_classic] channel.update!(channel.options[:backup_imap_classic][:attributes]) diff --git a/app/jobs/imap_authentication_migration_cleanup_job.rb b/app/jobs/imap_authentication_migration_cleanup_job.rb index 012da6395..7200abee3 100644 --- a/app/jobs/imap_authentication_migration_cleanup_job.rb +++ b/app/jobs/imap_authentication_migration_cleanup_job.rb @@ -2,7 +2,7 @@ class ImapAuthenticationMigrationCleanupJob < ApplicationJob include HasActiveJobLock def perform - Channel.where(area: ['Google::Account', 'Office365::Account']).find_each do |channel| + Channel.where(area: ['Google::Account', 'Microsoft365::Account']).find_each do |channel| next if channel.options.blank? next if channel.options[:backup_imap_classic].blank? next if channel.options[:backup_imap_classic][:migrated_at] > 7.days.ago diff --git a/app/models/channel/driver/imap.rb b/app/models/channel/driver/imap.rb index c834e404f..ab0afbe6c 100644 --- a/app/models/channel/driver/imap.rb +++ b/app/models/channel/driver/imap.rb @@ -361,7 +361,7 @@ returns # @return [HashString>] def self.parse_rfc822_headers(string) array = string - .gsub("\r\n\t", ' ') # Some servers (e.g. office365) may put attribute value on a separate line and tab it + .gsub("\r\n\t", ' ') # Some servers (e.g. microsoft365) may put attribute value on a separate line and tab it .lines(chomp: true) .map { |line| line.split(/:\s*/, 2).map(&:strip) } diff --git a/app/policies/controllers/channels_microsoft365_controller_policy.rb b/app/policies/controllers/channels_microsoft365_controller_policy.rb new file mode 100644 index 000000000..4a0f2e845 --- /dev/null +++ b/app/policies/controllers/channels_microsoft365_controller_policy.rb @@ -0,0 +1,3 @@ +class Controllers::ChannelsMicrosoft365ControllerPolicy < Controllers::ApplicationControllerPolicy + default_permit!('admin.channel_microsoft365') +end diff --git a/app/policies/controllers/channels_office365_controller_policy.rb b/app/policies/controllers/channels_office365_controller_policy.rb deleted file mode 100644 index 1f372dcb9..000000000 --- a/app/policies/controllers/channels_office365_controller_policy.rb +++ /dev/null @@ -1,3 +0,0 @@ -class Controllers::ChannelsOffice365ControllerPolicy < Controllers::ApplicationControllerPolicy - default_permit!('admin.channel_office365') -end diff --git a/config/routes/microsoft365.rb b/config/routes/microsoft365.rb new file mode 100644 index 000000000..c17bbb76d --- /dev/null +++ b/config/routes/microsoft365.rb @@ -0,0 +1,12 @@ +Zammad::Application.routes.draw do + api_path = Rails.configuration.api_path + + match api_path + '/channels_microsoft365', to: 'channels_microsoft365#index', via: :get + match api_path + '/channels_microsoft365_disable', to: 'channels_microsoft365#disable', via: :post + match api_path + '/channels_microsoft365_enable', to: 'channels_microsoft365#enable', via: :post + match api_path + '/channels_microsoft365', to: 'channels_microsoft365#destroy', via: :delete + match api_path + '/channels_microsoft365_group/:id', to: 'channels_microsoft365#group', via: :post + match api_path + '/channels_microsoft365_inbound/:id', to: 'channels_microsoft365#inbound', via: :post + match api_path + '/channels_microsoft365_rollback_migration', to: 'channels_microsoft365#rollback_migration', via: :post + +end diff --git a/config/routes/office365.rb b/config/routes/office365.rb deleted file mode 100644 index eeb6895dd..000000000 --- a/config/routes/office365.rb +++ /dev/null @@ -1,12 +0,0 @@ -Zammad::Application.routes.draw do - api_path = Rails.configuration.api_path - - match api_path + '/channels_office365', to: 'channels_office365#index', via: :get - match api_path + '/channels_office365_disable', to: 'channels_office365#disable', via: :post - match api_path + '/channels_office365_enable', to: 'channels_office365#enable', via: :post - match api_path + '/channels_office365', to: 'channels_office365#destroy', via: :delete - match api_path + '/channels_office365_group/:id', to: 'channels_office365#group', via: :post - match api_path + '/channels_office365_inbound/:id', to: 'channels_office365#inbound', via: :post - match api_path + '/channels_office365_rollback_migration', to: 'channels_office365#rollback_migration', via: :post - -end diff --git a/lib/external_credential/office365.rb b/lib/external_credential/microsoft365.rb similarity index 91% rename from lib/external_credential/office365.rb rename to lib/external_credential/microsoft365.rb index 35583689e..f95d129ca 100644 --- a/lib/external_credential/office365.rb +++ b/lib/external_credential/microsoft365.rb @@ -1,4 +1,4 @@ -class ExternalCredential::Office365 +class ExternalCredential::Microsoft365 def self.app_verify(params) request_account_to_link(params, false) @@ -6,8 +6,8 @@ class ExternalCredential::Office365 end def self.request_account_to_link(credentials = {}, app_required = true) - external_credential = ExternalCredential.find_by(name: 'office365') - raise Exceptions::UnprocessableEntity, 'No Office365 app configured!' if !external_credential && app_required + external_credential = ExternalCredential.find_by(name: 'microsoft365') + raise Exceptions::UnprocessableEntity, 'No Microsoft365 app configured!' if !external_credential && app_required if external_credential if credentials[:client_id].blank? @@ -29,8 +29,8 @@ class ExternalCredential::Office365 end def self.link_account(_request_token, params) - external_credential = ExternalCredential.find_by(name: 'office365') - raise Exceptions::UnprocessableEntity, 'No office365 app configured!' if !external_credential + external_credential = ExternalCredential.find_by(name: 'microsoft365') + raise Exceptions::UnprocessableEntity, 'No Microsoft365 app configured!' if !external_credential raise Exceptions::UnprocessableEntity, 'No code for session found!' if !params[:code] response = authorize_tokens(external_credential.credentials[:client_id], external_credential.credentials[:client_secret], params[:code]) @@ -74,7 +74,7 @@ class ExternalCredential::Office365 }, }, auth: response.merge( - provider: 'office365', + provider: 'microsoft365', type: 'XOAUTH2', client_id: external_credential.credentials[:client_id], client_secret: external_credential.credentials[:client_secret], @@ -98,7 +98,7 @@ class ExternalCredential::Office365 } migrate_channel.update( - area: 'Office365::Account', + area: 'Microsoft365::Account', options: channel_options.merge(backup_imap_classic: backup), last_log_in: nil, last_log_out: nil, @@ -122,7 +122,7 @@ class ExternalCredential::Office365 # create channel channel = Channel.create!( - area: 'Office365::Account', + area: 'Microsoft365::Account', group_id: Group.first.id, options: channel_options, active: false, @@ -148,7 +148,7 @@ class ExternalCredential::Office365 params = { 'client_id' => client_id, - 'redirect_uri' => ExternalCredential.callback_url('office365'), + 'redirect_uri' => ExternalCredential.callback_url('microsoft365'), 'scope' => scope, 'response_type' => 'code', 'access_type' => 'offline', @@ -170,7 +170,7 @@ class ExternalCredential::Office365 'code' => authorization_code, 'grant_type' => 'authorization_code', 'client_id' => client_id, - 'redirect_uri' => ExternalCredential.callback_url('office365'), + 'redirect_uri' => ExternalCredential.callback_url('microsoft365'), } uri = URI::HTTPS.build( diff --git a/spec/lib/external_credential/office365_spec.rb b/spec/lib/external_credential/microsoft365_spec.rb similarity index 94% rename from spec/lib/external_credential/office365_spec.rb rename to spec/lib/external_credential/microsoft365_spec.rb index f99de3b3f..514084ccf 100644 --- a/spec/lib/external_credential/office365_spec.rb +++ b/spec/lib/external_credential/microsoft365_spec.rb @@ -1,9 +1,9 @@ require 'rails_helper' -RSpec.describe ExternalCredential::Office365 do +RSpec.describe ExternalCredential::Microsoft365 do let(:token_url) { 'https://login.microsoftonline.com/common/oauth2/v2.0/token' } - let(:authorize_url) { "https://login.microsoftonline.com/common/oauth2/v2.0/authorize?access_type=offline&client_id=#{client_id}&prompt=consent&redirect_uri=http%3A%2F%2Fzammad.example.com%2Fapi%2Fv1%2Fexternal_credentials%2Foffice365%2Fcallback&response_type=code&scope=https%3A%2F%2Foutlook.office.com%2FIMAP.AccessAsUser.All+https%3A%2F%2Foutlook.office.com%2FSMTP.Send+offline_access+openid+profile+email" } + let(:authorize_url) { "https://login.microsoftonline.com/common/oauth2/v2.0/authorize?access_type=offline&client_id=#{client_id}&prompt=consent&redirect_uri=http%3A%2F%2Fzammad.example.com%2Fapi%2Fv1%2Fexternal_credentials%2Fmicrosoft365%2Fcallback&response_type=code&scope=https%3A%2F%2Foutlook.office.com%2FIMAP.AccessAsUser.All+https%3A%2F%2Foutlook.office.com%2FSMTP.Send+offline_access+openid+profile+email" } let(:id_token) { 'eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6ImtnMkxZczJUMENUaklmajRydDZKSXluZW4zOCJ9.eyJhdWQiOiIyMTk4NTFhYS0wMDAwLTRhNDctMTExMS0zMmQwNzAyZTAxMjM0IiwiaXNzIjoiaHR0cHM6Ly9sb2dpbi5taWNyb3NvZnRvbmxpbmUuY29tLzM2YTlhYjU1LWZpZmEtMjAyMC04YTc4LTkwcnM0NTRkYmNmZDJkL3YyLjAiLCJpYXQiOjEzMDE1NTE4MzUsIm5iZiI6MTMwMTU1MTgzNSwiZXhwIjoxNjAxNTU5NzQ0LCJuYW1lIjoiRXhhbXBsZSBVc2VyIiwib2lkIjoiMTExYWIyMTQtMTJzNy00M2NnLThiMTItM2ozM2UydDBjYXUyIiwicHJlZmVycmVkX3VzZXJuYW1lIjoidGVzdEBleGFtcGxlLmNvbSIsImVtYWlsIjoidGVzdEBleGFtcGxlLmNvbSIsInJoIjoiMC40MjM0LWZmZnNmZGdkaGRLZUpEU1hiejlMYXBSbUNHZGdmZ2RmZ0kwZHkwSEF1QlhaSEFNYy4iLCJzdWIiOiJYY0VlcmVyQkVnX0EzNWJlc2ZkczNMTElXNjU1NFQtUy0ycGRnZ2R1Z3c1NDNXT2xJIiwidGlkIjoiMzZhOWFiNTUtZmlmYS0yMDIwLThhNzgtOTByczQ1NGRiY2ZkMmQiLCJ1dGkiOiJEU0dGZ3Nhc2RkZmdqdGpyMzV3cWVlIiwidmVyIjoiMi4wIn0=.l0nglq4rIlkR29DFK3PQFQTjE-VeHdgLmcnXwGvT8Z-QBaQjeTAcoMrVpr0WdL6SRYiyn2YuqPnxey6N0IQdlmvTMBv0X_dng_y4CiQ8ABdZrQK0VSRWZViboJgW5iBvJYFcMmVoilHChueCzTBnS1Wp2KhirS2ymUkPHS6AB98K0tzOEYciR2eJsJ2JOdo-82oOW4w6tbbqMvzT3DzsxqPQRGe2hUbNqo6gcwJLqq4t0bNf5XiYThw1sv4IivERmqW_pfybXEseKyZGd4NnJ6WwwOgTz5tkoLwls_YeDZVcp_Fpw9XR7J0UlyPqLtoUEjVihdyrJjAbdtHFKdOjrw' } let(:access_token) { '000.0000lvC3gAbjs8CYoKitfqM5LBS5N13374MCg6pNpZ28mxO2HuZvg0000_rsW00aACmFEto1BJeGDuu0000vmV6Esqv78iec-FbEe842ZevQtOOemQyQXjhMs62K1E6g3ehDLPRp6j4vtpSKSb6I-3MuDPfdzdqI23hM0' } @@ -18,7 +18,7 @@ RSpec.describe ExternalCredential::Office365 do let(:authorization_code) { '567' } let(:email_address) { 'test@example.com' } - let(:provider) { 'office365' } + let(:provider) { 'microsoft365' } let(:token_ttl) { 3599 } let!(:token_response_payload) do @@ -277,8 +277,8 @@ RSpec.describe ExternalCredential::Office365 do describe '.request_account_to_link' do it 'generates authorize_url from credentials' do - office365 = create(:external_credential, name: provider, credentials: { client_id: client_id, client_secret: client_secret } ) - request = described_class.request_account_to_link(office365.credentials) + microsoft365 = create(:external_credential, name: provider, credentials: { client_id: client_id, client_secret: client_secret } ) + request = described_class.request_account_to_link(microsoft365.credentials) expect(request[:authorize_url]).to eq(authorize_url) end @@ -296,7 +296,7 @@ RSpec.describe ExternalCredential::Office365 do context 'missing credentials' do let(:credentials) { nil } let(:app_required) { true } - let(:exception_message) { 'No Office365 app configured!' } + let(:exception_message) { 'No Microsoft365 app configured!' } include_examples 'failed attempt' end diff --git a/spec/requests/integration/office365_spec.rb b/spec/requests/integration/microsoft365_spec.rb similarity index 69% rename from spec/requests/integration/office365_spec.rb rename to spec/requests/integration/microsoft365_spec.rb index 714bb1187..fc1bc8877 100644 --- a/spec/requests/integration/office365_spec.rb +++ b/spec/requests/integration/microsoft365_spec.rb @@ -1,8 +1,8 @@ require 'rails_helper' -RSpec.describe 'Office365 XOAUTH2' do # rubocop:disable RSpec/DescribeClass +RSpec.describe 'Microsoft365 XOAUTH2' do # rubocop:disable RSpec/DescribeClass let(:channel) do create(:channel, - area: 'Office365::Account', + area: 'Microsoft365::Account', options: { 'inbound' => { 'adapter' => 'imap', @@ -10,7 +10,7 @@ RSpec.describe 'Office365 XOAUTH2' do # rubocop:disable RSpec/DescribeClass 'auth_type' => 'XOAUTH2', 'host' => 'outlook.office365.com', 'ssl' => true, - 'user' => ENV['OFFICE365_USER'], + 'user' => ENV['MICROSOFT365_USER'], 'folder' => '', 'keep_on_server' => false, } @@ -21,28 +21,28 @@ RSpec.describe 'Office365 XOAUTH2' do # rubocop:disable RSpec/DescribeClass 'host' => 'smtp.office365.com', 'domain' => 'office365.com', 'port' => 587, - 'user' => ENV['OFFICE365_USER'], + 'user' => ENV['MICROSOFT365_USER'], 'authentication' => 'xoauth2', } }, 'auth' => { 'type' => 'XOAUTH2', - 'provider' => 'office365', + 'provider' => 'microsoft365', 'access_token' => 'xxx', 'expires_in' => 3599, - 'refresh_token' => ENV['OFFICE365_REFRESH_TOKEN'], + 'refresh_token' => ENV['MICROSOFT365_REFRESH_TOKEN'], 'scope' => 'https://outlook.office.com/IMAP.AccessAsUser.All https://outlook.office.com/SMTP.Send offline_access openid profile email', 'token_type' => 'Bearer', 'id_token' => 'xxx', 'created_at' => 30.days.ago, - 'client_id' => ENV['OFFICE365_CLIENT_ID'], - 'client_secret' => ENV['OFFICE365_CLIENT_SECRET'], + 'client_id' => ENV['MICROSOFT365_CLIENT_ID'], + 'client_secret' => ENV['MICROSOFT365_CLIENT_SECRET'], } }) end before do - required_envs = %w[OFFICE365_REFRESH_TOKEN OFFICE365_CLIENT_ID OFFICE365_CLIENT_SECRET OFFICE365_USER] + required_envs = %w[MICROSOFT365_REFRESH_TOKEN MICROSOFT365_CLIENT_ID MICROSOFT365_CLIENT_SECRET MICROSOFT365_USER] required_envs.each do |key| skip("NOTICE: Missing environment variable #{key} for test! (Please fill up: #{required_envs.join(' && ')})") if ENV[key].blank? end @@ -57,12 +57,12 @@ RSpec.describe 'Office365 XOAUTH2' do # rubocop:disable RSpec/DescribeClass context 'outbound' do it 'succeeds' do - result = EmailHelper::Probe.outbound(channel.options[:outbound], ENV['OFFICE365_USER'], "test office365 oauth unittest #{Random.new_seed}") + result = EmailHelper::Probe.outbound(channel.options[:outbound], ENV['MICROSOFT365_USER'], "test microsoft365 oauth unittest #{Random.new_seed}") expect(result[:result]).to eq('ok') end end - context 'when non-Office365 channels are present' do + context 'when non-Microsoft365 channels are present' do let!(:email_address) { create(:email_address, channel: create(:channel, area: 'Some::Other')) } @@ -71,7 +71,7 @@ RSpec.describe 'Office365 XOAUTH2' do # rubocop:disable RSpec/DescribeClass end it "doesn't remove email address assignments" do - expect { Channel.where(area: 'Office365::Account').find_each {} }.not_to change { email_address.reload.channel_id } + expect { Channel.where(area: 'Microsoft365::Account').find_each {} }.not_to change { email_address.reload.channel_id } end end end