several sdk fixes

fern-api · Feb 2, 2024 · 27d97c9 · 27d97c9
1 parent f58f17b
commit 27d97c9
Show file tree

Hide file tree

Showing 195 changed files with 737 additions and 639 deletions.
diff --git a/generators/ruby/codegen/src/ast/Parameter.ts b/generators/ruby/codegen/src/ast/Parameter.ts
@@ -1,3 +1,4 @@
+import { Argument } from "./Argument";
 import { ClassReference, NilValue } from "./classes/ClassReference";
 import { AstNode } from "./core/AstNode";
 import { Import } from "./Import";
@@ -58,4 +59,13 @@ export class Parameter extends AstNode {
         this.type.forEach((cr) => (imports = new Set([...imports, ...cr.getImports()])));
         return imports;
     }
+
+    public toArgument(value: Variable | string): Argument {
+        return new Argument({
+            name: this.name,
+            type: this.type,
+            value,
+            isNamed: this.isNamed
+        });
+    }
 }
diff --git a/generators/ruby/codegen/src/ast/Yardoc.ts b/generators/ruby/codegen/src/ast/Yardoc.ts
@@ -79,7 +79,7 @@ export class Yardoc extends AstNode {
             this.addText({ stringContent: parameter.name, templateString: "# @param %s [Hash] ", startingTabSpaces });
             this.addText({
                 stringContent:
-                    parameter.documentation ??
+                    parameter.documentation?.replaceAll("\n", "") ??
                     `Request of type ${parameter.type.map((param) => param.typeHint).join(", ")}, as a Hash`,
                 appendToLastString: true
             });
@@ -99,15 +99,15 @@ export class Yardoc extends AstNode {
     private writeParameterAsClass(parameter: Parameter, startingTabSpaces: number): void {
         if (parameter.isBlock) {
             this.addText({ stringContent: parameter.name, templateString: "# @yield", startingTabSpaces });
-            this.addText({ stringContent: parameter.documentation, appendToLastString: true });
+            this.addText({ stringContent: parameter.documentation?.replaceAll("\n", ""), appendToLastString: true });
         } else {
             this.addText({ stringContent: parameter.name, templateString: "# @param %s", startingTabSpaces });
             this.addText({
                 stringContent: parameter.type.map((param) => param.typeHint).join(", "),
                 templateString: " [%s] ",
                 appendToLastString: true
             });
-            this.addText({ stringContent: parameter.documentation, appendToLastString: true });
+            this.addText({ stringContent: parameter.documentation?.replaceAll("\n", ""), appendToLastString: true });
         }
     }
 
@@ -121,9 +121,11 @@ export class Yardoc extends AstNode {
                         ? this.reference.type.typeHint
                         : this.reference.type;
                 const documentation =
-                    this.reference.type instanceof Property ? this.reference.type.documentation : undefined;
+                    this.reference.type instanceof Property
+                        ? this.reference.type.documentation?.replaceAll("\n", "")
+                        : undefined;
                 this.addText({ stringContent: typeName, templateString: "# @type [%s] ", startingTabSpaces });
-                this.addText({ stringContent: documentation, appendToLastString: true });
+                this.addText({ stringContent: documentation?.replaceAll("\n", ""), appendToLastString: true });
             } else {
                 this.reference.parameters.forEach((parameter) => {
                     if (parameter.describeAsHashInYardoc) {

diff --git a/generators/ruby/codegen/src/ast/classes/Class_.ts b/generators/ruby/codegen/src/ast/classes/Class_.ts
@@ -58,7 +58,8 @@ export class Class_ extends AstNode {
                         isAssignment: true,
                         yardoc
                     });
-                })
+                }),
+                invocationName: "new"
             });
             functions = [this.initializer, ...functions];
         } else if (initializerOverride !== undefined) {

diff --git a/generators/ruby/codegen/src/ast/functions/FunctionInvocation.ts b/generators/ruby/codegen/src/ast/functions/FunctionInvocation.ts
@@ -75,7 +75,11 @@ export class FunctionInvocation extends AstNode {
             templateString: this.optionalSafeCall ? "%s&." : "%s.",
             startingTabSpaces
         });
-        this.addText({ stringContent: this.baseFunction?.name, startingTabSpaces, appendToLastString: true });
+        this.addText({
+            stringContent: this.baseFunction?.invocationName ?? this.baseFunction?.name,
+            startingTabSpaces,
+            appendToLastString: true
+        });
         this.addText({ stringContent: this.writeArgmuments(), appendToLastString: true });
         this.writeBlock(startingTabSpaces);
     }

diff --git a/generators/ruby/codegen/src/ast/functions/Function_.ts b/generators/ruby/codegen/src/ast/functions/Function_.ts
@@ -16,6 +16,7 @@ export declare namespace Function_ {
         returnValue?: ClassReference | ClassReference[];
         flattenedProperties?: Map<TypeId, ObjectProperty[]>;
         crf?: ClassReferenceFactory;
+        invocationName?: string;
     }
 }
 export class Function_ extends AstNode {
@@ -29,6 +30,8 @@ export class Function_ extends AstNode {
     public isStatic: boolean;
     public yardoc: Yardoc;
 
+    public invocationName: string | undefined;
+
     constructor({
         name,
         functionBody,
@@ -38,6 +41,7 @@ export class Function_ extends AstNode {
         isAsync = false,
         isStatic = false,
         returnValue,
+        invocationName,
         ...rest
     }: Function_.Init) {
         super(rest);
@@ -47,6 +51,7 @@ export class Function_ extends AstNode {
         this.functionBody = functionBody;
         this.isAsync = isAsync;
         this.isStatic = isStatic;
+        this.invocationName = invocationName;
 
         this.yardoc = new Yardoc({
             reference: { name: "docString", parameters, returnValue: this.returnValue },

diff --git a/generators/ruby/codegen/src/ast/gem/Gemspec.ts b/generators/ruby/codegen/src/ast/gem/Gemspec.ts
@@ -27,7 +27,7 @@ export class Gemspec extends FunctionInvocation {
             globalDependencies.push(
                 ...[
                     new ExternalDependency({ packageName: "mini_mime", specifier: "~>", version: "1.1" }),
-                    new ExternalDependency({ packageName: "farady-multipart", specifier: "~>", version: "1.0" })
+                    new ExternalDependency({ packageName: "faraday-multipart", specifier: "~>", version: "1.0" })
                 ]
             );
         }
@@ -53,6 +53,18 @@ export class Gemspec extends FunctionInvocation {
                     isAssignment: true
                 })
             );
+        } else {
+            // Allow for people to use the gemconfig if no version is found
+            gemBlock.push(
+                new Expression({
+                    leftSide: "spec.version",
+                    rightSide: new ClassReference({
+                        name: `${clientName}::Gemconfig::VERSION`,
+                        import_: new Import({ from: "lib/gemconfig" })
+                    }),
+                    isAssignment: true
+                })
+            );
         }
 
         super({

diff --git a/generators/ruby/codegen/src/utils/RubyUtilities.ts b/generators/ruby/codegen/src/utils/RubyUtilities.ts
@@ -40,6 +40,10 @@ export function getLocationFromFernFilepath(fernFilepath: FernFilepath): string
     return [...fernFilepath.allParts.map((pathPart) => pathPart.snakeCase.safeName)].join("/");
 }
 
+export function getBreadcrumbsFromFilepath(fernFilepath: FernFilepath): string[] {
+    return fernFilepath.allParts.map((pathPart) => pathPart.pascalCase.safeName);
+}
+
 export function generateGemspec(
     clientName: string,
     gemName: string,
@@ -71,6 +75,7 @@ export function generateGemConfig(clientName: string): GeneratedRubyFile {
         child: new Module_({
             name: "Gemconfig",
             child: [
+                new Expression({ leftSide: "VERSION", rightSide: '""', isAssignment: true }),
                 new Expression({ leftSide: "AUTHORS", rightSide: '[""].freeze', isAssignment: true }),
                 new Expression({ leftSide: "EMAIL", rightSide: '""', isAssignment: true }),
                 new Expression({ leftSide: "SUMMARY", rightSide: '""', isAssignment: true }),

diff --git a/generators/ruby/sdk/src/AbstractionUtilities.ts b/generators/ruby/sdk/src/AbstractionUtilities.ts
@@ -12,6 +12,7 @@ import {
     Function_,
     GeneratedRubyFile,
     GenericClassReference,
+    getBreadcrumbsFromFilepath,
     getLocationForServiceDeclaration,
     getLocationFromFernFilepath,
     HashInstance,
@@ -170,6 +171,9 @@ export function generateRootPackage(
     });
     const clientClass = new Class_({
         classReference,
+        properties: syncSubpackages.map(
+            (sp) => new Property({ name: snakeCase(sp.classReference.name), type: sp.classReference })
+        ),
         functions: rootService
             ? generateEndpoints(
                   crf,
@@ -187,13 +191,14 @@ export function generateRootPackage(
         includeInitializer: false,
         initializerOverride: new Function_({
             name: "initialize",
+            invocationName: "new",
             functionBody: [
                 new Expression({
                     leftSide: requestClientVariable,
                     rightSide: new FunctionInvocation({
                         onObject: requestClient.classReference,
                         baseFunction: requestClient.initializer,
-                        arguments_: requestClient.properties.map((prop) => prop.toArgument(prop.name, true))
+                        arguments_: requestClient.initializer?.parameters.map((param) => param.toArgument(param.name))
                     }),
                     isAssignment: true
                 }),
@@ -214,7 +219,8 @@ export function generateRootPackage(
                     });
                 })
             ],
-            parameters: requestClient.initializer?.parameters
+            parameters: requestClient.initializer?.parameters,
+            returnValue: classReference
         })
     });
 
@@ -224,11 +230,15 @@ export function generateRootPackage(
         type: asyncRequestClient.classReference,
         variableType: VariableType.LOCAL
     });
+    const asyncClassReference = new ClassReference({
+        name: "AsyncClient",
+        import_: new Import({ from: gemName, isExternal: false })
+    });
     const asyncClientClass = new Class_({
-        classReference: new ClassReference({
-            name: "AsyncClient",
-            import_: new Import({ from: gemName, isExternal: false })
-        }),
+        classReference: asyncClassReference,
+        properties: asyncSubpackages.map(
+            (sp) => new Property({ name: snakeCase(sp.classReference.name), type: sp.classReference })
+        ),
         functions: rootService
             ? generateEndpoints(
                   crf,
@@ -246,6 +256,7 @@ export function generateRootPackage(
         includeInitializer: false,
         initializerOverride: new Function_({
             name: "initialize",
+            invocationName: "new",
             functionBody: [
                 new Expression({
                     leftSide: asyncRequestClientVariable,
@@ -273,7 +284,8 @@ export function generateRootPackage(
                     });
                 })
             ],
-            parameters: asyncRequestClient.initializer?.parameters
+            parameters: asyncRequestClient.initializer?.parameters,
+            returnValue: asyncClassReference
         })
     });
 
@@ -303,18 +315,22 @@ export function generateSubpackage(
     asyncSubpackages: Class_[] = []
 ): ClientClassPair {
     const location = getLocationFromFernFilepath(package_.fernFilepath) + "client";
+    const moduleBreadcrumbs = getBreadcrumbsFromFilepath(package_.fernFilepath);
 
     // Add Client class
     const requestClientProperty = new Property({ name: "request_client", type: requestClientCr });
+    const syncClassReference = new ClassReference({
+        name: "Client",
+        import_: new Import({ from: location, isExternal: false }),
+        moduleBreadcrumbs
+    });
     const syncClientClass = new Class_({
-        classReference: new ClassReference({
-            name: "Client",
-            import_: new Import({ from: location, isExternal: false })
-        }),
+        classReference: syncClassReference,
         properties: [requestClientProperty],
         includeInitializer: false,
         initializerOverride: new Function_({
             name: "initialize",
+            invocationName: "new",
             // Initialize each subpackage
             functionBody: subpackages.map((sp) => {
                 const subpackageClassVariable = new Variable({
@@ -337,21 +353,25 @@ export function generateSubpackage(
                     isAssignment: true
                 });
             }),
-            parameters: [new Parameter({ name: "client", type: requestClientCr })]
+            parameters: [new Parameter({ name: "client", type: requestClientCr })],
+            returnValue: syncClassReference
         })
     });
 
     // Add Async Client class
     const asyncRequestClientProperty = new Property({ name: "request_client", type: asyncRequestClientCr });
+    const asyncClassReference = new ClassReference({
+        name: "AsyncClient",
+        import_: new Import({ from: location, isExternal: false }),
+        moduleBreadcrumbs
+    });
     const asyncClientClass = new Class_({
-        classReference: new ClassReference({
-            name: "AsyncClient",
-            import_: new Import({ from: location, isExternal: false })
-        }),
+        classReference: asyncClassReference,
         properties: [new Property({ name: "client", type: asyncRequestClientCr })],
         includeInitializer: false,
         initializerOverride: new Function_({
             name: "initialize",
+            invocationName: "new",
             // Initialize each subpackage
             functionBody: asyncSubpackages.map((sp) => {
                 const subpackageClassVariable = new Variable({
@@ -374,7 +394,8 @@ export function generateSubpackage(
                     isAssignment: true
                 });
             }),
-            parameters: [new Parameter({ name: "client", type: asyncRequestClientCr })]
+            parameters: [new Parameter({ name: "client", type: asyncRequestClientCr })],
+            returnValue: asyncClassReference
         })
     });
 
@@ -394,14 +415,16 @@ export function generateService(
 ): ClientClassPair {
     const serviceName = service.name.fernFilepath.file?.pascalCase.safeName ?? "";
     const import_ = new Import({ from: getLocationForServiceDeclaration(service.name), isExternal: false });
+    const moduleBreadcrumbs = getBreadcrumbsFromFilepath(service.name.fernFilepath);
 
     // Add Client class
     const serviceBasePath = generateRubyPathTemplate(service.pathParameters, service.basePath);
     const requestClientProperty = new Property({ name: "request_client", type: requestClientCr });
     const syncClientClass = new Class_({
         classReference: new ClassReference({
             name: `${serviceName}Client`,
-            import_
+            import_,
+            moduleBreadcrumbs
         }),
         properties: [requestClientProperty],
         includeInitializer: true,
@@ -424,7 +447,8 @@ export function generateService(
     const asyncClientClass = new Class_({
         classReference: new ClassReference({
             name: `Async${serviceName}Client`,
-            import_
+            import_,
+            moduleBreadcrumbs
         }),
         properties: [asyncRequestClientProperty],
         includeInitializer: true,
@@ -657,6 +681,7 @@ function generateRequestClientInitializer(
 
     return new Function_({
         name: "initialize",
+        invocationName: "new",
         parameters: [
             ...functionParams,
             // Select sample of the request overrides object properties

diff --git a/seed/ruby-sdk/alias/lib/gemconfig.rb b/seed/ruby-sdk/alias/lib/gemconfig.rb
diff --git a/seed/ruby-sdk/alias/lib/seed_alias_client.rb b/seed/ruby-sdk/alias/lib/seed_alias_client.rb
diff --git a/seed/ruby-sdk/alias/seed_alias_client.gemspec b/seed/ruby-sdk/alias/seed_alias_client.gemspec
diff --git a/seed/ruby-sdk/api-wide-base-path/lib/gemconfig.rb b/seed/ruby-sdk/api-wide-base-path/lib/gemconfig.rb