Merge pull request #1468 from apinf/feature/add-setting-for-sdk

brylie · web-flow · commit 8eba61f3a47c · 2016-09-01T14:41:18.000+03:00
Add a setting for SDK download
diff --git a/.gitignore b/.gitignore
@@ -13,3 +13,4 @@ node_modules/
 packages
 node_modules
 npm-debug.log
+.eslintrc.json
diff --git a/documentation/client/codegenerator/autoform.js b/documentation/client/codegenerator/autoform.js
@@ -1,7 +1,9 @@
 import { HTTP } from 'meteor/http';
 
+import _ from 'lodash';
+
 AutoForm.addHooks('downloadSDK', {
-  onSubmit: function (formValues, updateDoc, instance) {
+  onSubmit (formValues, updateDoc, instance) {
     // Prevent form from submitting
     this.event.preventDefault();
 
@@ -14,7 +16,13 @@ AutoForm.addHooks('downloadSDK', {
     // Find mask of the language for url
     const parameter = instance.urlParameters[index];
 
-    const host = 'https://generator.swagger.io';
+    // Get host of code generator server
+    let host = instance.codegenServer;
+
+    // Delete last forward slash if it exists
+    if (_.endsWith(host, '/')) {
+      host = host.slice(0, -1);
+    }
 
     // Create URL to send request
     const url = host + '/api/gen/clients/' + parameter;
@@ -24,31 +32,35 @@ AutoForm.addHooks('downloadSDK', {
 
     // Create POST options
     const options = {
-      'swaggerUrl': pathToFile
+      'swaggerUrl': pathToFile,
     };
 
     // Start spinner when send request
     instance.callRequest.set(true);
 
     // Send POST request
     HTTP.post(url, { data: options }, function (error, result) {
-      // Get information from Swagger API response
-      let response = JSON.parse(result.content);
-
-      if (result.statusCode === 200) {
-        // Hide modal
-        Modal.hide('sdkCodeGeneratorModal');
-
-        // Go to link and download file
-        window.location.href = response.link;
+      // If url is incorrect
+      if (result === undefined) {
+        FlashMessages.sendError(TAPi18n.__('sdkCodeGeneratorModal_errorTextInvalidHost'));
       } else {
-        $('button').removeAttr('disabled');
+        // Get information from Swagger API response
+        const response = JSON.parse(result.content);
+
+        if (result.statusCode === 200) {
+          // Hide modal
+          Modal.hide('sdkCodeGeneratorModal');
 
-        // Otherwise show an error message
-        FlashMessages.sendError(TAPi18n.__('sdkCodeGeneratorModal_errorText'));
+          // Go to link and download file
+          window.location.href = response.link;
+        } else {
+          // Otherwise show an error message
+          FlashMessages.sendError(TAPi18n.__('sdkCodeGeneratorModal_errorText'));
+        }
       }
+      $('button').removeAttr('disabled');
       // Finish spinner
       instance.callRequest.set(false);
     });
-  }
+  },
 });
diff --git a/documentation/client/codegenerator/codegenerator.js b/documentation/client/codegenerator/codegenerator.js
@@ -98,11 +98,11 @@ Template.sdkCodeGeneratorModal.helpers({
 
     // Create object with instance varaibles
     return {
-      'apiBackend': instance.data.apiBackend,
-      'callRequest': instance.callRequest,
-      'documentationFileURL': instance.documentationFileURL,
-      'languageList': instance.languageList,
-      'urlParameters': instance.urlParameters
+      codegenServer: instance.data.host,
+      callRequest: instance.callRequest,
+      documentationFileURL: instance.documentationFileURL,
+      languageList: instance.languageList,
+      urlParameters: instance.urlParameters
     };
   }
 });
diff --git a/documentation/client/view/documentation.html b/documentation/client/view/documentation.html
@@ -10,7 +10,8 @@
           </button>
         {{/if}}
 
-         {{#if documentationExists }}
+      {{#if Template.subscriptionsReady }}
+        {{#if codegenServerExists }}
             <button 
               id="sdk-code-generator" 
               class="btn btn-info btn-xs pull-right"
@@ -19,7 +20,7 @@
                 {{_ "documentation_sdkGenerateButton" }}
             </button>
         {{/if}}
-
+      {{/if}}
       <h2 class="panel-title clearfix">
         {{_ "documentation_Title" }}
       </h2>
@@ -61,18 +62,18 @@ <h2 class="panel-title">{{_ "documentation_Link_Title" }}</h2>
           <h2 class="panel-title">{{_ "documentation_Viewer_Title" }}</h2>
         </div>
         <div class="panel-body">
-          {{ # if Template.subscriptionsReady }}
-            {{ # if documentationExists }}
+          {{#if Template.subscriptionsReady }}
+            {{#if documentationExists }}
               <iframe src="/swagger/index.html?url={{uploadedDocumentationLink}}" width="100%" id="documentation"></iframe>
             {{ else }}
             <i>
               {{_ "documentation_No_Swagger_Message" }}
-              {{ # if apiBackend.currentUserCanEdit }}
+              {{#if apiBackend.currentUserCanEdit }}
               {{_ "documentation_No_Swagger_Manager_Message" }}
-              {{ / if}}
+              {{/if}}
             </i>
-            {{ / if}}
-          {{ / if }}
+            {{/if}}
+          {{/if }}
         </div>
       </div>
     </div>
diff --git a/documentation/client/view/documentation.js b/documentation/client/view/documentation.js
@@ -1,11 +1,10 @@
 import { DocumentationFiles } from '/documentation/collection/collection';
 
-Template.documentation.onCreated(function(){
+Template.documentation.onCreated(function () {
   const instance = this;
 
   // Run subscription in autorun
   instance.autorun(() => {
-
     // Get current documentation file Id
     const documentationFileId = Template.currentData().apiBackend.documentationFileId;
 
@@ -14,15 +13,17 @@ Template.documentation.onCreated(function(){
       instance.subscribe('singleDocumentationFile', documentationFileId);
     }
   });
+
+  // Subscribe to code generator settings
+  instance.subscribe('singleSetting', 'sdkCodeGenerator');
 });
 
 Template.documentation.onRendered(function () {
   $('[data-toggle="popover"]').popover();
 });
 
 Template.documentation.helpers({
-  uploadedDocumentationLink: function() {
-
+  uploadedDocumentationLink () {
     const currentDocumentationFileId = this.apiBackend.documentationFileId;
 
     // Convert to Mongo ObjectID
@@ -37,36 +38,58 @@ Template.documentation.helpers({
       const currentDocumentationFileId = currentDocumentationFile._id;
 
       // Get documentation file URL
-      return Meteor.absoluteUrl().slice(0, -1) + DocumentationFiles.baseURL + "/id/" + currentDocumentationFileId;
+      return Meteor.absoluteUrl().slice(0, -1) + DocumentationFiles.baseURL + '/id/' + currentDocumentationFileId;
     }
   },
-  documentationLink: function() {
+  documentationLink () {
     // get documentation link
     const documentationLink = this.apiBackend.documentation_link;
     // check if exists
     if (documentationLink) {
-      return documentationLink
+      return documentationLink;
     }
   },
-  documentationExists: function () {
+  documentationExists () {
     const currentApiBackend = this.apiBackend;
     if (currentApiBackend.documentationFileId) {
       return true;
     }
+  },
+  codegenServerExists () {
+    // Get template instance
+    const instance = Template.instance();
+
+    // Get documentation file
+    const apiDocumentation = this.apiBackend.documentationFileId;
+
+    // Get settings
+    const settings = Settings.findOne();
+
+    // Check documentation exists, generator is enabled and host setting exists
+    if (settings && apiDocumentation && settings.sdkCodeGenerator.host && settings.sdkCodeGenerator.enabled) {
+      // Get code generator host
+      instance.codegenServer = settings.sdkCodeGenerator.host;
+
+      // Generator is enabled and has host setting, return true
+      return true;
+    }
   }
+
 });
 
 Template.documentation.events({
   'click #manage-api-documentation' (event, instance) {
     // Get reference to API backend
-    const apiBackend = instance.data.apiBackend
+    const apiBackend = instance.data.apiBackend;
     // Show the manage API documentation form
-    Modal.show('manageApiDocumentationModal', { apiBackend })
+    Modal.show('manageApiDocumentationModal', { apiBackend });
   },
   'click #sdk-code-generator' (event, instance) {
     // Get reference to API backend
     const apiBackend = instance.data.apiBackend;
+    // Get reference to Code Generator host
+    const host = instance.codegenServer;
     // Show the SDK Code generator form
-    Modal.show('sdkCodeGeneratorModal', { apiBackend });
+    Modal.show('sdkCodeGeneratorModal', { apiBackend, host });
   }
 });
diff --git a/lib/i18n/en.i18n.json b/lib/i18n/en.i18n.json
@@ -422,6 +422,7 @@
     }
   },
   "sdkCodeGeneratorModal_errorText": "Your file is not supported by the generator. Please upload the correct file",
+  "sdkCodeGeneratorModal_errorTextInvalidHost": "Code Generator server is incorrect. Please report to administrator about this problem.",
   "sdkCodeGeneratorModal_Title": "Generate SDK file",
   "searchField_button": "Search",
   "searchField_placeholder": "Search...",
@@ -438,6 +439,7 @@
   "settings_save": "Save",
   "settings_apiUmbrella": "API Umbrella",
   "settings_elasticsearch": "Elasticsearch",
+  "settings_sdkCode_generator": "SDK Code Generator",
   "settingsWizard_APIDocumentation_Editor": "Api Documentation Editor",
   "settingsWizard_APIUmbrella_settings": "Settings for API Umbrella",
   "settingsWizard_Finish": "Finish",
diff --git a/settings/client/settings.html b/settings/client/settings.html
@@ -2,7 +2,7 @@
   <div class="container">
     <div class="row" id="champion-messages">
       <div class="col-md-3 settings-menu">
-        {{ > settingsMenu }}
+        {{> settingsMenu }}
       </div>
       {{#autoForm collection="Settings" doc=editDoc id="settings" type=formType}}
       <div class="col-md-6 settings-fields">
@@ -17,6 +17,17 @@
             {{/if}}
           </div>
         </div>
+        <div class="panel panel-default">
+          <div class="panel-heading">
+              <span class="panel-title">{{_ "settings_sdkCode_generator"}}</span>
+              <span class="pull-right">{{> afQuickField name='sdkCodeGenerator.enabled'}}</span>
+          </div>
+          <div class="panel-body">
+              {{#if afFieldValueIs name="sdkCodeGenerator.enabled" value=true}}
+                  {{> afQuickField name='sdkCodeGenerator.host'}}
+              {{/if}}
+          </div>
+        </div>
         <div class="panel panel-default">
           <div class="panel-heading">
             <span class="panel-title">{{_ "settings_mail"}}</span>
diff --git a/settings/collection/index.js b/settings/collection/index.js
@@ -155,6 +155,32 @@ Schemas.SettingsSchema = new SimpleSchema({
   initialSetupComplete: {
     type: Boolean,
     optional: true
+  },
+  sdkCodeGenerator: {
+    type: Object,
+    optional: true
+  },
+  "sdkCodeGenerator.enabled": {
+    type: Boolean,
+    optional: true
+  },
+  "sdkCodeGenerator.host": {
+    type: String,
+    regEx: SimpleSchema.RegEx.Url,
+    label: "Host",
+    optional: true,
+    autoform: {
+      placeholder: 'https://generator.example.com/'
+    },
+    custom: function () {
+      let sdkCodeGeneratorEnabled = this.field("sdkCodeGenerator.enabled").value;
+      let sdkCodeGeneratorHost = this.value;
+
+      // Require code generator host if sdkCodeGenerator.enabled is checked
+      if (sdkCodeGeneratorEnabled === true && !sdkCodeGeneratorHost) {
+        return "required";
+      }
+    }
   }
 });
 
