Use File.separatorChar in Ruby generator, add comments

Author: xhh

modules/swagger-codegen/src/main/java/com/wordnik/swagger/codegen/languages/RubyClientCodegen.java

@@ -36,7 +36,7 @@ public RubyClientCodegen() {
     moduleName = generateModuleName();
     modelPackage = gemName + "/models";
     apiPackage = gemName + "/api";
-    outputFolder = "generated-code/ruby";
+    outputFolder = "generated-code" + File.separatorChar + "ruby";
     modelTemplateFiles.put("model.mustache", ".rb");
     apiTemplateFiles.put("api.mustache", ".rb");
     templateDir = "ruby";
@@ -69,17 +69,17 @@ public RubyClientCodegen() {
     typeMapping.put("List", "array");
     typeMapping.put("map", "map");
 
-    String baseFolder = "lib/" + gemName;
-    String swaggerFolder = baseFolder + "/swagger";
-    String modelFolder = baseFolder + "/models";
+    String baseFolder = "lib" + File.separatorChar + gemName;
+    String swaggerFolder = baseFolder + File.separatorChar + "swagger";
+    String modelFolder = baseFolder + File.separatorChar + "models";
     supportingFiles.add(new SupportingFile("swagger_client.gemspec.mustache", "", gemName + ".gemspec"));
     supportingFiles.add(new SupportingFile("swagger_client.mustache", "lib", gemName + ".rb"));
     supportingFiles.add(new SupportingFile("monkey.mustache", baseFolder, "monkey.rb"));
     supportingFiles.add(new SupportingFile("swagger.mustache", baseFolder, "swagger.rb"));
-    supportingFiles.add(new SupportingFile("swagger/request.mustache", swaggerFolder, "request.rb"));
-    supportingFiles.add(new SupportingFile("swagger/response.mustache", swaggerFolder, "response.rb"));
-    supportingFiles.add(new SupportingFile("swagger/version.mustache", swaggerFolder, "version.rb"));
-    supportingFiles.add(new SupportingFile("swagger/configuration.mustache", swaggerFolder, "configuration.rb"));
+    supportingFiles.add(new SupportingFile("swagger" + File.separatorChar + "request.mustache", swaggerFolder, "request.rb"));
+    supportingFiles.add(new SupportingFile("swagger" + File.separatorChar + "response.mustache", swaggerFolder, "response.rb"));
+    supportingFiles.add(new SupportingFile("swagger" + File.separatorChar + "version.mustache", swaggerFolder, "version.rb"));
+    supportingFiles.add(new SupportingFile("swagger" + File.separatorChar + "configuration.mustache", swaggerFolder, "configuration.rb"));
     supportingFiles.add(new SupportingFile("base_object.mustache", modelFolder, "base_object.rb"));
   }
 

modules/swagger-codegen/src/main/resources/ruby/swagger/request.mustache

@@ -36,6 +36,7 @@ module {{moduleName}}
         update_params_for_auth!
       end
 
+      # Update hearder and query params based on authentication settings.
       def update_params_for_auth!
         (@auth_names || []).each do |auth_name|
           case auth_name
@@ -50,6 +51,8 @@ module {{moduleName}}
         end
       end
 
+      # Get API key (with prefix if set).
+      # @param [String] param_name the parameter name of API key auth
       def get_api_key_with_prefix(param_name)
         if Swagger.configuration.api_key_prefix[param_name].present?
           "#{Swagger.configuration.api_key_prefix[param_name]} #{Swagger.configuration.api_key[param_name]}"

samples/client/petstore/ruby/lib/swagger_client/swagger/request.rb

@@ -36,6 +36,7 @@ def initialize(http_method, path, attributes={})
         update_params_for_auth!
       end
 
+      # Update hearder and query params based on authentication settings.
       def update_params_for_auth!
         (@auth_names || []).each do |auth_name|
           case auth_name
@@ -49,6 +50,8 @@ def update_params_for_auth!
         end
       end
 
+      # Get API key (with prefix if set).
+      # @param [String] param_name the parameter name of API key auth
       def get_api_key_with_prefix(param_name)
         if Swagger.configuration.api_key_prefix[param_name].present?
           "#{Swagger.configuration.api_key_prefix[param_name]} #{Swagger.configuration.api_key[param_name]}"