Merge pull request #2715 from weseek/imprv/rename-smtp-setting

Imprv/rename smtp setting

src/client/js/components/Admin/App/SmtpSetting.jsx

@@ -41,8 +41,8 @@ function SmtpSetting(props) {
     const { t, adminAppContainer } = props;
 
     try {
-      await adminAppContainer.updateMailSettingHandler();
-      toastSuccess(t('toaster.update_successed', { target: t('admin:app_setting.mail_settings') }));
+      await adminAppContainer.updateSmtpSettingHandler();
+      toastSuccess(t('toaster.update_successed', { target: t('admin:app_setting.smtp_settings') }));
     }
     catch (err) {
       toastError(err);
@@ -54,7 +54,7 @@ function SmtpSetting(props) {
     const { t, adminAppContainer } = props;
 
     try {
-      const mailSettingParams = await adminAppContainer.initializeMailSettingHandler();
+      const mailSettingParams = await adminAppContainer.initializeSmtpSettingHandler();
       toastSuccess(t('toaster.initialize_successed', { target: t('admin:app_setting.smtp_settings') }));
       // convert values to '' if value is null for overwriting values of inputs with refs
       hostInput.current.value = mailSettingParams.smtpHost || '';

src/client/js/services/AdminAppContainer.js

@@ -38,11 +38,6 @@ export default class AdminAppContainer extends Container {
       isEnabledPlugins: true,
     };
 
-    this.updateAppSettingHandler = this.updateAppSettingHandler.bind(this);
-    this.updateSiteUrlSettingHandler = this.updateSiteUrlSettingHandler.bind(this);
-    this.updateMailSettingHandler = this.updateMailSettingHandler.bind(this);
-    this.updateAwsSettingHandler = this.updateAwsSettingHandler.bind(this);
-    this.updatePluginSettingHandler = this.updatePluginSettingHandler.bind(this);
   }
 
   /**
@@ -254,12 +249,12 @@ export default class AdminAppContainer extends Container {
   }
 
   /**
-   * Update mail setting
+   * Update smtp setting
    * @memberOf AdminAppContainer
    * @return {Array} Appearance
    */
-  async updateMailSettingHandler() {
-    const response = await this.appContainer.apiv3.put('/app-settings/mail-setting', {
+  async updateSmtpSettingHandler() {
+    const response = await this.appContainer.apiv3.put('/app-settings/smtp-setting', {
       smtpHost: this.state.smtpHost,
       smtpPort: this.state.smtpPort,
       smtpUser: this.state.smtpUser,
@@ -284,12 +279,12 @@ export default class AdminAppContainer extends Container {
   }
 
   /**
-   * Initialize mail setting
+   * Initialize smtp setting
    * @memberOf AdminAppContainer
    * @return {Array} Appearance
    */
-  async initializeMailSettingHandler() {
-    const response = await this.appContainer.apiv3.delete('/app-settings/mail-setting', {});
+  async initializeSmtpSettingHandler() {
+    const response = await this.appContainer.apiv3.delete('/app-settings/smtp-setting', {});
     const {
       mailSettingParams,
     } = response.data;

src/server/routes/apiv3/app-settings.js

@@ -57,8 +57,8 @@ const ErrorV3 = require('../../models/vo/error-apiv3');
  *          fromAddress:
  *            type: string
  *            description: e-mail address used as from address of mail which sent from GROWI app
- *      MailSettingParams:
- *        description: MailSettingParams
+ *      SmtpSettingParams:
+ *        description: SmtpSettingParams
  *        type: object
  *        properties:
  *          smtpHost:
@@ -132,7 +132,7 @@ module.exports = (crowi) => {
     fromAddress: [
       body('fromAddress').trim().if(value => value !== '').isEmail(),
     ],
-    mailSetting: [
+    smtpSetting: [
       body('smtpHost').trim(),
       body('smtpPort').trim().isPort(),
       body('smtpUser').trim(),
@@ -408,27 +408,27 @@ module.exports = (crowi) => {
   /**
    * @swagger
    *
-   *    /app-settings/mail-setting:
+   *    /app-settings/smtp-setting:
    *      put:
    *        tags: [AppSettings]
-   *        operationId: updateAppSettingMailSetting
-   *        summary: /app-settings/mail-setting
-   *        description: Update mail setting
+   *        operationId: updateAppSettingSmtpSetting
+   *        summary: /app-settings/smtp-setting
+   *        description: Update smtp setting
    *        requestBody:
    *          required: true
    *          content:
    *            application/json:
    *              schema:
-   *                $ref: '#/components/schemas/MailSettingParams'
+   *                $ref: '#/components/schemas/SmtpSettingParams'
    *        responses:
    *          200:
-   *            description: Succeeded to update mail setting
+   *            description: Succeeded to update smtp setting
    *            content:
    *              application/json:
    *                schema:
-   *                  $ref: '#/components/schemas/MailSettingParams'
+   *                  $ref: '#/components/schemas/SmtpSettingParams'
    */
-  router.put('/mail-setting', loginRequiredStrictly, adminRequired, csrf, validator.mailSetting, apiV3FormValidator, async(req, res) => {
+  router.put('/smtp-setting', loginRequiredStrictly, adminRequired, csrf, validator.smtpSetting, apiV3FormValidator, async(req, res) => {
     try {
       await validateMailSetting(req);
     }
@@ -452,9 +452,9 @@ module.exports = (crowi) => {
       return res.apiv3({ mailSettingParams });
     }
     catch (err) {
-      const msg = 'Error occurred in updating mail setting';
+      const msg = 'Error occurred in updating smtp setting';
       logger.error('Error', err);
-      return res.apiv3Err(new ErrorV3(msg, 'update-mailSetting-failed'));
+      return res.apiv3Err(new ErrorV3(msg, 'update-smtpSetting-failed'));
     }
   });
 
@@ -502,27 +502,21 @@ module.exports = (crowi) => {
   /**
    * @swagger
    *
-   *    /app-settings/mail-setting:
+   *    /app-settings/smtp-setting:
    *      delete:
    *        tags: [AppSettings]
-   *        operationId: deleteAppSettingMailSetting
-   *        summary: /app-settings/mail-setting
-   *        description: delete mail setting
-   *        requestBody:
-   *          required: true
-   *          content:
-   *            application/json:
-   *              schema:
-   *                $ref: '#/components/schemas/MailSettingParams'
+   *        operationId: deleteAppSettingSmtpSetting
+   *        summary: /app-settings/smtp-setting
+   *        description: delete smtp setting
    *        responses:
    *          200:
-   *            description: Succeeded to delete mail setting
+   *            description: Succeeded to delete smtp setting
    *            content:
    *              application/json:
    *                schema:
-   *                  $ref: '#/components/schemas/MailSettingParams'
+   *                  $ref: '#/components/schemas/SmtpSettingParams'
    */
-  router.delete('/mail-setting', loginRequiredStrictly, adminRequired, csrf, async(req, res) => {
+  router.delete('/smtp-setting', loginRequiredStrictly, adminRequired, csrf, async(req, res) => {
     const requestMailSettingParams = {
       'mail:smtpHost': null,
       'mail:smtpPort': null,
@@ -534,9 +528,9 @@ module.exports = (crowi) => {
       return res.apiv3({ mailSettingParams });
     }
     catch (err) {
-      const msg = 'Error occurred in initializing mail setting';
+      const msg = 'Error occurred in initializing stmp setting';
       logger.error('Error', err);
-      return res.apiv3Err(new ErrorV3(msg, 'initialize-mailSetting-failed'));
+      return res.apiv3Err(new ErrorV3(msg, 'initialize-smtpSetting-failed'));
     }
   });