Package io.swagger.codegen.v3.generators.ruby

Class RubyClientCodegen

java.lang.Object

io.swagger.codegen.v3.generators.DefaultCodegenConfig

io.swagger.codegen.v3.generators.ruby.RubyClientCodegen

All Implemented Interfaces:

io.swagger.codegen.v3.CodegenConfig

public class RubyClientCodegen
extends DefaultCodegenConfig

Field Summary

Fields

Modifier and Type	Field	Description
protected String	apiDocPath
protected static int	emptyMethodNameCounter
static String	GEM_AUTHOR
static String	GEM_AUTHOR_EMAIL
static String	GEM_DESCRIPTION
static String	GEM_HOMEPAGE
static String	GEM_LICENSE
static String	GEM_NAME
static String	GEM_REQUIRED_RUBY_VERSION
static String	GEM_SUMMARY
static String	GEM_VERSION
protected String	gemAuthor
protected String	gemAuthorEmail
protected String	gemDescription
protected String	gemHomepage
protected String	gemLicense
protected String	gemName
protected String	gemRequiredRubyVersion
protected String	gemSummary
protected String	gemVersion
protected String	libFolder
protected String	modelDocPath
static String	MODULE_NAME
protected String	moduleName
protected String	specFolder

Fields inherited from class io.swagger.codegen.v3.generators.DefaultCodegenConfig

additionalProperties, allowUnicodeIdentifiers, apiDocTemplateFiles, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, commonTemplateDir, configFiles, customTemplateDir, DEFAULT_CONTENT_TYPE, DEFAULT_TEMPLATE_DIR, defaultIncludes, embeddedTemplateDir, ensureUniqueParams, fileSuffix, gitRepoBaseURL, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, ignoreImportMapping, importMapping, inputSpec, inputURL, instantiationTypes, IS_NULLABLE_FALSE, IS_NULLABLE_TRUE, languageArguments, languageSpecificPrimitives, library, modelDocTemplateFiles, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, openAPI, outputFolder, releaseNote, removeOperationIdPrefix, REQUEST_BODY_NAME, reservedWords, reservedWordsMappings, skipOverwrite, sortParamsByRequiredFlag, specialCharReplacements, supportedLibraries, supportingFiles, supportsInheritance, supportsMixins, templateDir, templateEngine, templateVersion, testPackage, typeAliases, typeMapping, unflattenedOpenAPI, useOas2, vendorExtensions

Constructor Summary

Constructors

Constructor	Description
RubyClientCodegen()

Method Summary

Modifier and Type	Method	Description
String	apiDocFileFolder()
String	apiFileFolder()
String	apiTestFileFolder()
String	escapeQuotationMark(String input)	Escape single and/or double quote to avoid code injection
String	escapeReservedWord(String name)	Return the escaped name of the reserved word
String	escapeUnsafeCharacters(String input)	override with any special text escaping logic to handle unsafe characters so as to avoid code injection
io.swagger.codegen.v3.CodegenOperation	fromOperation(String path, String httpMethod, io.swagger.v3.oas.models.Operation operation, Map<String,io.swagger.v3.oas.models.media.Schema> definitions, io.swagger.v3.oas.models.OpenAPI openAPI)	Convert Swagger Operation object to Codegen Operation object
String	getDefaultTemplateDir()
String	getHelp()
String	getName()
String	getSchemaType(io.swagger.v3.oas.models.media.Schema schema)	returns the swagger type for the property
io.swagger.codegen.v3.CodegenType	getTag()
String	getTypeDeclaration(io.swagger.v3.oas.models.media.Schema schema)	Output the type declaration of the property
String	modelDocFileFolder()
String	modelFileFolder()
String	modelTestFileFolder()
Map<String,Object>	postProcessModels(Map<String,Object> objs)
void	processOpts()
void	setGemAuthor(String gemAuthor)
void	setGemAuthorEmail(String gemAuthorEmail)
void	setGemDescription(String gemDescription)
void	setGemHomepage(String gemHomepage)
void	setGemLicense(String gemLicense)
void	setGemName(String gemName)
void	setGemRequiredRubyVersion(String gemRequiredRubyVersion)
void	setGemSummary(String gemSummary)
void	setGemVersion(String gemVersion)
void	setModuleName(String moduleName)
void	setParameterExampleValue(io.swagger.codegen.v3.CodegenParameter p)	Return the example value of the parameter.
boolean	shouldOverwrite(String filename)
String	toApiDocFilename(String name)	Return the file name of the Api Documentation
String	toApiFilename(String name)	Return the file name of the Api Test
String	toApiImport(String name)	Return the fully-qualified "Api" name for import
String	toApiName(String name)	Output the API (class) name (capitalized) ending with "Api" Return DefaultApi if name is empty
String	toApiTestFilename(String name)	Return the file name of the Api Test
String	toDefaultValue(io.swagger.v3.oas.models.media.Schema schema)	Return the default value of the property
String	toEnumName(io.swagger.codegen.v3.CodegenProperty property)	Return the Enum name (e.g.
String	toEnumValue(String value, String datatype)	Return the enum value in the language specified format e.g.
String	toEnumVarName(String name, String datatype)	Return the sanitized variable name for enum
String	toModelDocFilename(String name)	Return the capitalized file name of the model documentation
String	toModelFilename(String name)	Return the capitalized file name of the model
String	toModelName(String name)	Output the proper model name (capitalized).
String	toModelTestFilename(String name)	Return the capitalized file name of the model test
String	toOperationId(String operationId)	Return the operation ID (method name)
String	toParamName(String name)	Return the parameter name by removing invalid characters and proper escaping if it's a reserved word.
String	toVarName(String name)	Return the variable name by removing invalid characters and proper escaping if it's a reserved word.

Methods inherited from class io.swagger.codegen.v3.generators.DefaultCodegenConfig

addAdditionPropertiesToCodeGenModel, addCodegenContentParameters, addConsumesInfo, addHandlebarHelpers, addImport, additionalProperties, addOperationImports, addOperationToGroup, addOption, addOption, addParameters, addParentContainer, addProducesInfo, addProperties, addRegularExpressionDelimiter, addSwitch, addVars, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFilename, apiTestTemplateFiles, buildLibraryCliOption, camelize, camelize, cliOptions, configFiles, configureDataForTestTemplate, configuresParameterForMediaType, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, copyFirstAllOfProperties, customTemplateDir, dashize, defaultIgnoreImportMappingOption, defaultIncludes, detectParent, embeddedTemplateDir, ensureUniqueParameters, escapeText, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fixUpParentAndInterfaces, fromModel, fromModel, fromOperation, fromParameter, fromProperty, fromRequestBody, fromResponse, fromSecurity, generateExamplePath, getAlias, getArgumentsLocation, getCollectionFormat, getCommonTemplateDir, getConsumesInfo, getContentType, getGitRepoBaseURL, getGitRepoId, getGitUserId, getHideGenerationTimestamp, getHttpUserAgent, getIgnoreFilePathOverride, getIgnoreImportMapping, getInnerEnumAllowableValues, getInputSpec, getInputURL, getLanguageArguments, getLibrary, getOpenAPI, getOptionValue, getOrGenerateOperationId, getOutputDir, getParameterFromRef, getParentName, getProducesInfo, getReleaseNote, getSchemaFromBody, getSchemaFromParameter, getSchemaFromResponse, getSchemaHandler, getSortParamsByRequiredFlag, getSymbolName, getTemplateDir, getTemplateEngine, getTemplateVersion, getterAndSetterCapitalize, getTypeDeclaration, hasSchemaProperties, hasTrueAdditionalProperties, importMapping, initialCaps, instantiationTypes, isDataTypeBinary, isDataTypeFile, isFileTypeSchema, isObjectSchema, isPrimivite, isPropertyInnerMostEnum, isRemoveOperationIdPrefix, isReservedWord, isSkipOverwrite, languageSpecificPrimitives, modelDocTemplateFiles, modelPackage, modelTemplateFiles, modelTestTemplateFiles, needsUnflattenedSpec, needToImport, outputFolder, postProcessAllCodegenModels, postProcessAllModels, postProcessModelProperty, postProcessModelsEnum, postProcessOperations, postProcessOperationsWithModels, postProcessParameter, postProcessSupportingFileData, preprocessOpenAPI, processCompiler, processMapSchema, processModelEnums, processOpenAPI, processPropertySchemaContainerTypes, processPropertySchemaTypes, readLanguageArguments, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, setAllowUnicodeIdentifiers, setApiPackage, setCommonTemplateDir, setEnsureUniqueParams, setGitRepoBaseURL, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setIgnoreImportMapping, setInputSpec, setInputURL, setLanguageArguments, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterJson, setParameterNullable, setReleaseNote, setRemoveOperationIdPrefix, setReservedWords, setReservedWordsLowerCase, setSchemaProperties, setSkipOverwrite, setSortParamsByRequiredFlag, setTemplateDir, setTemplateEngine, setTemplateVersion, setUnflattenedOpenAPI, setUseOas2, snakeCase, supportedLibraries, supportingFiles, templateDir, testPackage, toApiVarName, toBooleanGetter, toDefaultValueWithParam, toEnumDefaultValue, toExamples, toExampleValue, toGetter, toInstantiationType, toModelImport, toRegularExpression, toSetter, typeMapping, underscore, updateCodegenModelEnumVars, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updatePropertyForArray, updatePropertyForMap, vendorExtensions, writeOptional, writeOptional, writePropertyBack

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.swagger.codegen.v3.CodegenConfig

checkAliasModel, getCodeName, getPriority, isPrivileged

Field Detail

GEM_NAME

public static final String GEM_NAME

See Also:

Constant Field Values

MODULE_NAME

public static final String MODULE_NAME

See Also:

Constant Field Values

GEM_VERSION

public static final String GEM_VERSION

See Also:

Constant Field Values

GEM_LICENSE

public static final String GEM_LICENSE

See Also:

Constant Field Values

GEM_REQUIRED_RUBY_VERSION

public static final String GEM_REQUIRED_RUBY_VERSION

See Also:

Constant Field Values

GEM_HOMEPAGE

public static final String GEM_HOMEPAGE

See Also:

Constant Field Values

GEM_SUMMARY

public static final String GEM_SUMMARY

See Also:

Constant Field Values

GEM_DESCRIPTION

public static final String GEM_DESCRIPTION

See Also:

Constant Field Values

GEM_AUTHOR

public static final String GEM_AUTHOR

See Also:

Constant Field Values

GEM_AUTHOR_EMAIL

public static final String GEM_AUTHOR_EMAIL

See Also:

Constant Field Values

gemName

protected String gemName

moduleName

protected String moduleName

gemVersion

protected String gemVersion

specFolder

protected String specFolder

libFolder

protected String libFolder

gemLicense

protected String gemLicense

gemRequiredRubyVersion

protected String gemRequiredRubyVersion

gemHomepage

protected String gemHomepage

gemSummary

protected String gemSummary

gemDescription

protected String gemDescription

gemAuthor

protected String gemAuthor

gemAuthorEmail

protected String gemAuthorEmail

apiDocPath

protected String apiDocPath

modelDocPath

protected String modelDocPath

emptyMethodNameCounter

protected static int emptyMethodNameCounter

Constructor Detail

RubyClientCodegen

public RubyClientCodegen()

Method Detail

processOpts

public void processOpts()

Specified by:

processOpts in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

processOpts in class DefaultCodegenConfig

fromOperation

public io.swagger.codegen.v3.CodegenOperation fromOperation(String path,
                                                            String httpMethod,
                                                            io.swagger.v3.oas.models.Operation operation,
                                                            Map<String,io.swagger.v3.oas.models.media.Schema> definitions,
                                                            io.swagger.v3.oas.models.OpenAPI openAPI)

Description copied from class: DefaultCodegenConfig

Convert Swagger Operation object to Codegen Operation object

Specified by:

fromOperation in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

fromOperation in class DefaultCodegenConfig

Parameters:

path - the path of the operation

httpMethod - HTTP method

operation - Swagger operation object

definitions - a map of schemas

openAPI - a OpenAPI object representing the spec

Returns:

Codegen Operation object

getTag

public io.swagger.codegen.v3.CodegenType getTag()

getName

public String getName()

getHelp

public String getHelp()

escapeReservedWord

public String escapeReservedWord(String name)

Description copied from class: DefaultCodegenConfig

Return the escaped name of the reserved word

Specified by:

escapeReservedWord in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

escapeReservedWord in class DefaultCodegenConfig

Parameters:

name - the name to be escaped

Returns:

the escaped reserved word throws Runtime exception as reserved word is not allowed (default behavior)

apiFileFolder

public String apiFileFolder()

Specified by:

apiFileFolder in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

apiFileFolder in class DefaultCodegenConfig

modelFileFolder

public String modelFileFolder()

Specified by:

modelFileFolder in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

modelFileFolder in class DefaultCodegenConfig

apiTestFileFolder

public String apiTestFileFolder()

Specified by:

apiTestFileFolder in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

apiTestFileFolder in class DefaultCodegenConfig

modelTestFileFolder

public String modelTestFileFolder()

Specified by:

modelTestFileFolder in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

modelTestFileFolder in class DefaultCodegenConfig

apiDocFileFolder

public String apiDocFileFolder()

Specified by:

apiDocFileFolder in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

apiDocFileFolder in class DefaultCodegenConfig

modelDocFileFolder

public String modelDocFileFolder()

Specified by:

modelDocFileFolder in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

modelDocFileFolder in class DefaultCodegenConfig

getTypeDeclaration

public String getTypeDeclaration(io.swagger.v3.oas.models.media.Schema schema)

Description copied from class: DefaultCodegenConfig

Output the type declaration of the property

Specified by:

getTypeDeclaration in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

getTypeDeclaration in class DefaultCodegenConfig

Parameters:

schema - Schema Property object

Returns:

a string presentation of the property type

toDefaultValue

public String toDefaultValue(io.swagger.v3.oas.models.media.Schema schema)

Description copied from class: DefaultCodegenConfig

Return the default value of the property

Overrides:

toDefaultValue in class DefaultCodegenConfig

Parameters:

schema - Schema property object

Returns:

string presentation of the default value of the property

getSchemaType

public String getSchemaType(io.swagger.v3.oas.models.media.Schema schema)

Description copied from class: DefaultCodegenConfig

returns the swagger type for the property

Overrides:

getSchemaType in class DefaultCodegenConfig

Parameters:

schema - Schema property object

Returns:

string presentation of the type

toVarName

public String toVarName(String name)

Description copied from class: DefaultCodegenConfig

Return the variable name by removing invalid characters and proper escaping if it's a reserved word.

Overrides:

toVarName in class DefaultCodegenConfig

Parameters:

name - the variable name

Returns:

the sanitized variable name

toParamName

public String toParamName(String name)

Description copied from class: DefaultCodegenConfig

Return the parameter name by removing invalid characters and proper escaping if it's a reserved word.

Specified by:

toParamName in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

toParamName in class DefaultCodegenConfig

Parameters:

name - Codegen property object

Returns:

the sanitized parameter name

toModelName

public String toModelName(String name)

Description copied from class: DefaultCodegenConfig

Output the proper model name (capitalized). In case the name belongs to the TypeSystem it won't be renamed.

Specified by:

toModelName in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

toModelName in class DefaultCodegenConfig

Parameters:

name - the name of the model

Returns:

capitalized model name

toModelFilename

public String toModelFilename(String name)

Description copied from class: DefaultCodegenConfig

Return the capitalized file name of the model

Specified by:

toModelFilename in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

toModelFilename in class DefaultCodegenConfig

Parameters:

name - the model name

Returns:

the file name of the model

toModelDocFilename

public String toModelDocFilename(String name)

Description copied from class: DefaultCodegenConfig

Return the capitalized file name of the model documentation

Specified by:

toModelDocFilename in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

toModelDocFilename in class DefaultCodegenConfig

Parameters:

name - the model name

Returns:

the file name of the model

toApiFilename

public String toApiFilename(String name)

Description copied from class: DefaultCodegenConfig

Return the file name of the Api Test

Specified by:

toApiFilename in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

toApiFilename in class DefaultCodegenConfig

Parameters:

name - the file name of the Api

Returns:

the file name of the Api

toApiDocFilename

public String toApiDocFilename(String name)

Description copied from class: DefaultCodegenConfig

Return the file name of the Api Documentation

Specified by:

toApiDocFilename in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

toApiDocFilename in class DefaultCodegenConfig

Parameters:

name - the file name of the Api

Returns:

the file name of the Api

toApiTestFilename

public String toApiTestFilename(String name)

Description copied from class: DefaultCodegenConfig

Return the file name of the Api Test

Specified by:

toApiTestFilename in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

toApiTestFilename in class DefaultCodegenConfig

Parameters:

name - the file name of the Api

Returns:

the file name of the Api

toModelTestFilename

public String toModelTestFilename(String name)

Description copied from class: DefaultCodegenConfig

Return the capitalized file name of the model test

Specified by:

toModelTestFilename in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

toModelTestFilename in class DefaultCodegenConfig

Parameters:

name - the model name

Returns:

the file name of the model

toApiName

public String toApiName(String name)

Description copied from class: DefaultCodegenConfig

Output the API (class) name (capitalized) ending with "Api" Return DefaultApi if name is empty

Specified by:

toApiName in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

toApiName in class DefaultCodegenConfig

Parameters:

name - the name of the Api

Returns:

capitalized Api name ending with "Api"

toEnumValue

public String toEnumValue(String value,
                          String datatype)

Description copied from class: DefaultCodegenConfig

Return the enum value in the language specified format e.g. status becomes "status"

Overrides:

toEnumValue in class DefaultCodegenConfig

Parameters:

value - enum variable name

datatype - data type

Returns:

the sanitized value for enum

toEnumVarName

public String toEnumVarName(String name,
                            String datatype)

Description copied from class: DefaultCodegenConfig

Return the sanitized variable name for enum

Overrides:

toEnumVarName in class DefaultCodegenConfig

Parameters:

name - enum variable name

datatype - data type

Returns:

the sanitized variable name for enum

toEnumName

public String toEnumName(io.swagger.codegen.v3.CodegenProperty property)

Description copied from class: DefaultCodegenConfig

Return the Enum name (e.g. StatusEnum given 'status')

Overrides:

toEnumName in class DefaultCodegenConfig

Parameters:

property - Codegen property

Returns:

the Enum name

postProcessModels

public Map<String,Object> postProcessModels(Map<String,Object> objs)

Specified by:

postProcessModels in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

postProcessModels in class DefaultCodegenConfig

toOperationId

public String toOperationId(String operationId)

Description copied from class: DefaultCodegenConfig

Return the operation ID (method name)

Overrides:

toOperationId in class DefaultCodegenConfig

Parameters:

operationId - operation ID

Returns:

the sanitized method name

toApiImport

public String toApiImport(String name)

Description copied from class: DefaultCodegenConfig

Return the fully-qualified "Api" name for import

Specified by:

toApiImport in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

toApiImport in class DefaultCodegenConfig

Parameters:

name - the name of the "Api"

Returns:

the fully-qualified "Api" name for import

setParameterExampleValue

public void setParameterExampleValue(io.swagger.codegen.v3.CodegenParameter p)

Description copied from class: DefaultCodegenConfig

Return the example value of the parameter.

Overrides:

setParameterExampleValue in class DefaultCodegenConfig

Parameters:

p - Swagger property object

setGemName

public void setGemName(String gemName)

setModuleName

public void setModuleName(String moduleName)

setGemVersion

public void setGemVersion(String gemVersion)

setGemDescription

public void setGemDescription(String gemDescription)

setGemSummary

public void setGemSummary(String gemSummary)

setGemLicense

public void setGemLicense(String gemLicense)

setGemRequiredRubyVersion

public void setGemRequiredRubyVersion(String gemRequiredRubyVersion)

setGemHomepage

public void setGemHomepage(String gemHomepage)

setGemAuthor

public void setGemAuthor(String gemAuthor)

setGemAuthorEmail

public void setGemAuthorEmail(String gemAuthorEmail)

shouldOverwrite

public boolean shouldOverwrite(String filename)

Specified by:

shouldOverwrite in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

shouldOverwrite in class DefaultCodegenConfig

getDefaultTemplateDir

public String getDefaultTemplateDir()

Specified by:

getDefaultTemplateDir in class DefaultCodegenConfig

escapeQuotationMark

public String escapeQuotationMark(String input)

Description copied from class: DefaultCodegenConfig

Escape single and/or double quote to avoid code injection

Specified by:

escapeQuotationMark in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

escapeQuotationMark in class DefaultCodegenConfig

Parameters:

input - String to be cleaned up

Returns:

string with quotation mark removed or escaped

escapeUnsafeCharacters

public String escapeUnsafeCharacters(String input)

Description copied from class: DefaultCodegenConfig

override with any special text escaping logic to handle unsafe characters so as to avoid code injection

Specified by:

escapeUnsafeCharacters in interface io.swagger.codegen.v3.CodegenConfig

Overrides:

escapeUnsafeCharacters in class DefaultCodegenConfig

Parameters:

input - String to be cleaned up

Returns:

string with unsafe characters removed or escaped