fix, ruby: Ensure the name passed into the X-Fern-SDK-Name header i…

…s the name of the gem, not the client class (#3073)
fern-api · Feb 28, 2024 · 3f888df · 3f888df
1 parent 4f69eee
commit 3f888df
Show file tree

Hide file tree

Showing 119 changed files with 620 additions and 366 deletions.
diff --git a/generators/ruby/codegen/src/ast/classes/ClassReference.ts b/generators/ruby/codegen/src/ast/classes/ClassReference.ts
@@ -666,7 +666,7 @@ export class ClassReferenceFactory {
             map: (mt: MapType) =>
                 new HashReference({
                     keyType: this.fromTypeReference(mt.keyType),
-                    valueType: this.fromTypeReference(mt.keyType)
+                    valueType: this.fromTypeReference(mt.valueType)
                 }),
             // Optional types in Ruby look the same except they're defaulted to nil in signatures.
             optional: (tr: TypeReference) => this.fromTypeReference(tr),

diff --git a/generators/ruby/sdk/CHANGELOG.md b/generators/ruby/sdk/CHANGELOG.md
@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## [0.3.0] - 2024-02-27
+
+- Fix: Ensure the name passed into the 'X-Fern-SDK-Name' header is the name of the gem, not the client class
+
+- Fix: If an envvar is specified as a fallback for an auth header, the SDK will now mark that parameter as optional to allow fallback to actually happen
+
+- Fix: Generated yardoc now appropriately reflects the typehint of the value type in maps
+
 ## [0.2.0] - 2024-02-20
 
 - Improvement: Ruby enum construct now leverages class constants instead of hashes to support better autocomplete

diff --git a/generators/ruby/sdk/VERSION b/generators/ruby/sdk/VERSION
@@ -1 +1 @@
-0.2.0
+0.3.0
diff --git a/generators/ruby/sdk/src/AbstractionUtilities.ts b/generators/ruby/sdk/src/AbstractionUtilities.ts
@@ -553,7 +553,7 @@ function generateRequestClientInitializer(
     isAsync: boolean,
     sdkConfig: SdkConfig,
     classReference: ClassReference,
-    clientName: string,
+    gemName: string,
     sdkVersion: string | undefined,
     headersGenerator: HeadersGenerator,
     environmentCr: ClassReference | undefined,
@@ -564,7 +564,7 @@ function generateRequestClientInitializer(
     const allHeaders = new Map([
         // SDK Default Headers
         [`"${sdkConfig.platformHeaders.language}"`, "Ruby"],
-        [`"${sdkConfig.platformHeaders.sdkName}"`, clientName]
+        [`"${sdkConfig.platformHeaders.sdkName}"`, gemName]
     ]);
     if (sdkVersion !== undefined) {
         allHeaders.set(`"${sdkConfig.platformHeaders.sdkVersion}"`, sdkVersion);
@@ -783,7 +783,7 @@ function generateRequestClientInitializer(
 
 export function generateRequestClients(
     sdkConfig: SdkConfig,
-    clientName: string,
+    gemName: string,
     sdkVersion: string | undefined,
     headersGenerator: HeadersGenerator,
     environmentCr: ClassReference | undefined,
@@ -820,7 +820,7 @@ export function generateRequestClients(
             false,
             sdkConfig,
             clientClassReference,
-            clientName,
+            gemName,
             sdkVersion,
             headersGenerator,
             environmentCr,
@@ -843,7 +843,7 @@ export function generateRequestClients(
             true,
             sdkConfig,
             asyncClientClassReference,
-            clientName,
+            gemName,
             sdkVersion,
             headersGenerator,
             environmentCr,

diff --git a/generators/ruby/sdk/src/ClientsGenerator.ts b/generators/ruby/sdk/src/ClientsGenerator.ts
@@ -117,7 +117,7 @@ export class ClientsGenerator {
         });
         const [syncClientClass, asyncClientClass] = generateRequestClients(
             this.intermediateRepresentation.sdkConfig,
-            this.clientName,
+            this.gemName,
             this.sdkVersion,
             this.headersGenerator,
             environmentClass?.classReference,
@@ -214,7 +214,6 @@ export class ClientsGenerator {
             services: Map<ServiceId, HttpService>,
             subpackages: Map<SubpackageId, Subpackage>,
             clientName: string,
-            gemName: string,
             crf: ClassReferenceFactory,
             irBasePath: string,
             generatedClasses: Map<TypeId, Class_>,
@@ -251,7 +250,6 @@ export class ClientsGenerator {
                                     services,
                                     subpackages,
                                     clientName,
-                                    gemName,
                                     crf,
                                     irBasePath,
                                     generatedClasses,
@@ -298,7 +296,6 @@ export class ClientsGenerator {
                 this.services,
                 this.subpackages,
                 this.clientName,
-                this.gemName,
                 this.crf,
                 this.irBasePath,
                 this.generatedClasses,

diff --git a/generators/ruby/sdk/src/utils/HeadersGenerator.ts b/generators/ruby/sdk/src/utils/HeadersGenerator.ts
@@ -71,26 +71,26 @@ export class HeadersGenerator {
                     new Parameter({
                         name: bas.token.snakeCase.safeName,
                         type: StringClassReference,
-                        isOptional: !this.isAuthRequired
+                        isOptional: bas.tokenEnvVar !== undefined || !this.isAuthRequired
                     })
                 ],
                 basic: (bas: BasicAuthScheme) => [
                     new Parameter({
                         name: bas.username.snakeCase.safeName,
                         type: StringClassReference,
-                        isOptional: !this.isAuthRequired
+                        isOptional: bas.usernameEnvVar !== undefined || !this.isAuthRequired
                     }),
                     new Parameter({
                         name: bas.password.snakeCase.safeName,
                         type: StringClassReference,
-                        isOptional: !this.isAuthRequired
+                        isOptional: bas.passwordEnvVar !== undefined || !this.isAuthRequired
                     })
                 ],
                 header: (has: HeaderAuthScheme) => [
                     new Parameter({
                         name: has.name.name.snakeCase.safeName,
                         type: StringClassReference,
-                        isOptional: !this.isAuthRequired
+                        isOptional: has.headerEnvVar !== undefined || !this.isAuthRequired
                     })
                 ],
                 _other: () => {
@@ -121,27 +121,30 @@ export class HeadersGenerator {
                     new Property({
                         name: bas.token.snakeCase.safeName,
                         type: StringClassReference,
-                        isOptional: isOptionalOverride ?? this.isAuthRequired,
+                        // If you've overridden optionality, use that, otherwise:
+                        //     If there's an envvar it should be optional
+                        //     If there's not an envvar then check if auth is required
+                        isOptional: isOptionalOverride ?? (bas.tokenEnvVar !== undefined || !this.isAuthRequired),
                         wireValue: "Authorization"
                     })
                 ],
                 basic: (bas: BasicAuthScheme) => [
                     new Property({
                         name: bas.username.snakeCase.safeName,
                         type: StringClassReference,
-                        isOptional: isOptionalOverride ?? this.isAuthRequired
+                        isOptional: isOptionalOverride ?? (bas.usernameEnvVar !== undefined || !this.isAuthRequired)
                     }),
                     new Property({
                         name: bas.password.snakeCase.safeName,
                         type: StringClassReference,
-                        isOptional: isOptionalOverride ?? this.isAuthRequired
+                        isOptional: isOptionalOverride ?? (bas.passwordEnvVar !== undefined || !this.isAuthRequired)
                     })
                 ],
                 header: (has: HeaderAuthScheme) => [
                     new Property({
                         name: has.name.name.snakeCase.safeName,
                         type: StringClassReference,
-                        isOptional: isOptionalOverride ?? this.isAuthRequired,
+                        isOptional: isOptionalOverride ?? (has.headerEnvVar !== undefined || !this.isAuthRequired),
                         wireValue: has.name.wireValue
                     })
                 ],

diff --git a/generators/ruby/sdk/src/utils/TypeUtilities.ts b/generators/ruby/sdk/src/utils/TypeUtilities.ts
@@ -15,6 +15,6 @@ export function isTypeOptional(typeReference: TypeReference): boolean {
         named: () => false,
         primitive: () => false,
         _other: () => false,
-        unknown: () => false
+        unknown: () => true
     });
 }
diff --git a/...-model/exhaustive/lib/seed_exhaustive_client/types/object/types/object_with_map_of_map.rb b/...-model/exhaustive/lib/seed_exhaustive_client/types/object/types/object_with_map_of_map.rb
diff --git a/...el/exhaustive/lib/seed_exhaustive_client/types/object/types/object_with_optional_field.rb b/...el/exhaustive/lib/seed_exhaustive_client/types/object/types/object_with_optional_field.rb
diff --git a/seed/ruby-model/object/lib/seed_object_client/types/type.rb b/seed/ruby-model/object/lib/seed_object_client/types/type.rb
diff --git a/seed/ruby-model/trace/lib/seed_trace_client/commons/types/binary_tree_value.rb b/seed/ruby-model/trace/lib/seed_trace_client/commons/types/binary_tree_value.rb
diff --git a/seed/ruby-model/trace/lib/seed_trace_client/commons/types/doubly_linked_list_value.rb b/seed/ruby-model/trace/lib/seed_trace_client/commons/types/doubly_linked_list_value.rb
diff --git a/seed/ruby-model/trace/lib/seed_trace_client/commons/types/singly_linked_list_value.rb b/seed/ruby-model/trace/lib/seed_trace_client/commons/types/singly_linked_list_value.rb
diff --git a/seed/ruby-model/trace/lib/seed_trace_client/problem/types/create_problem_request.rb b/seed/ruby-model/trace/lib/seed_trace_client/problem/types/create_problem_request.rb
diff --git a/...uby-model/trace/lib/seed_trace_client/problem/types/get_default_starter_files_response.rb b/...uby-model/trace/lib/seed_trace_client/problem/types/get_default_starter_files_response.rb