scaffolding to ship out ruby snippets (#637)

fern/apis/fdr/definition/__package__.yml

@@ -12,7 +12,7 @@ service:
       docs: Get snippet by endpoint method and path
       display-name: Get snippet for endpoint
       availability: pre-release
-      audiences: 
+      audiences:
         - external
         - fiddle
       method: POST
@@ -86,7 +86,7 @@ service:
       display-name: Load all snippets
       method: POST
       availability: pre-release
-      audiences: 
+      audiences:
         - external
         - fiddle
       request:
@@ -217,6 +217,7 @@ types:
       typescript: TypeScriptSDK
       python: PythonSDK
       go: GoSDK
+      ruby: RubySDK
       java: JavaSDK
 
   TypeScriptSDK:
@@ -234,6 +235,11 @@ types:
       githubRepo: string
       version: string
 
+  RubySDK:
+    properties:
+      gem: string
+      version: string
+
   JavaSDK:
     properties:
       group:
@@ -243,48 +249,54 @@ types:
         type: string
         docs: The artifact (e.g. `stripe-java`)
       version: string
-  
+
   ####### Load Snippets #######
 
   SnippetsPage:
     properties:
       next:
         type: optional<integer>
         docs: If present, pass this into the `page` query parameter to load the next page.
-      snippets:  
+      snippets:
         type: map<EndpointPath, SnippetsByEndpointMethod>
-        docs: | 
+        docs: |
           The snippets are returned as a map of endpoint path (e.g. `/api/users`) 
-          to a map of endpoint method (e.g. `POST`) to snippets. 
-  
-  SnippetsByEndpointMethod: 
+          to a map of endpoint method (e.g. `POST`) to snippets.
+
+  SnippetsByEndpointMethod:
     type: map<EndpointMethod, list<Snippet>>
 
-  Snippet: 
-    union: 
+  Snippet:
+    union:
       typescript: TypeScriptSnippet
       python: PythonSnippet
       java: JavaSnippet
       go: GoSnippet
-
-  TypeScriptSnippet: 
-    properties: 
+      ruby: RubySnippet
+
+  TypeScriptSnippet:
+    properties:
       sdk: TypeScriptSDK
       client: string
-  
-  PythonSnippet: 
-    properties: 
+
+  PythonSnippet:
+    properties:
       sdk: PythonSDK
       async_client: string
       sync_client: string
-  
-  GoSnippet: 
-    properties: 
+
+  GoSnippet:
+    properties:
       sdk: GoSDK
       client: string
-
-  JavaSnippet: 
-    properties: 
+
+  RubySnippet:
+    properties:
+      sdk: RubySDK
+      client: string
+
+  JavaSnippet:
+    properties:
       sdk: JavaSDK
       async_client: string
       sync_client: string

fern/apis/fdr/definition/api/v1/read/endpoint.yml

@@ -119,18 +119,18 @@ types:
         type: StreamConditionResponse
         docs: |
           A response that can either be streaming or REST
-  
+
   FileDownloadResponseBodyShape:
     properties:
       contentType: optional<string>
 
   StreamResponseV2:
     properties:
-      terminator: 
+      terminator:
         type: optional<string>
-        docs: | 
+        docs: |
           The terminator for each message. For example, for OpenAPI 
-          the terminator is [DATA]. 
+          the terminator is [DATA].
       shape: JsonBodyShape
 
   StreamConditionResponse:
@@ -197,6 +197,7 @@ types:
       pythonSdk: optional<PythonSnippet>
       typescriptSdk: optional<TypescriptSnippet>
       goSdk: optional<GoSnippet>
+      rubySdk: optional<RubySnippet>
 
   CustomCodeSample:
     docs: Hand-written code samples
@@ -224,6 +225,7 @@ types:
       - typescript
       - ts # alias to typescript
       - go
+      - ruby
 
   ExampleEndpointRequest:
     union:
@@ -270,3 +272,11 @@ types:
         docs: |
           The client code that is generated by the fern compiler
       install: optional<string>
+
+  RubySnippet:
+    properties:
+      client:
+        type: string
+        docs: |
+          The client code that is generated by the fern compiler
+      install: optional<string>

fern/apis/fdr/definition/api/v1/register/__package__.yml

@@ -69,6 +69,7 @@ types:
       pythonSdk: optional<PythonPackage>
       goSdk: optional<GoModule>
       javaSdk: optional<JavaCoordinate>
+      rubySdk: optional<RubyGem>
 
   TypescriptPackage:
     properties:
@@ -86,6 +87,10 @@ types:
     properties:
       coordinate: string
 
+  RubyGem:
+    properties:
+      gem: string
+
   ApiDefinitionPackage:
     properties:
       endpoints: list<endpoint.EndpointDefinition>

fern/apis/fdr/definition/snippets-factory.yml

@@ -41,6 +41,7 @@ types:
       python: PythonSDKSnippetCreate
       go: GoSDKSnippetsCreate
       java: JavaSDKSnippetsCreate
+      ruby: RubySDKSnippetsCreate
 
   TypescriptSDKSnippetsCreate:
     properties:
@@ -57,6 +58,11 @@ types:
       sdk: snippets.GoSDK
       snippets: list<SingleGoSnippetCreate>
 
+  RubySDKSnippetsCreate:
+    properties:
+      sdk: snippets.RubySDK
+      snippets: list<SingleRubySnippetCreate>
+
   JavaSDKSnippetsCreate:
     properties:
       sdk: snippets.JavaSDK
@@ -79,6 +85,11 @@ types:
       endpoint: snippets.EndpointIdentifier
       snippet: GoSnippetCode
 
+  SingleRubySnippetCreate:
+    properties:
+      endpoint: snippets.EndpointIdentifier
+      snippet: RubySnippetCode
+
   SingleJavaSnippetCreate:
     properties:
       endpoint: snippets.EndpointIdentifier
@@ -99,6 +110,10 @@ types:
     properties:
       client: string
 
+  RubySnippetCode:
+    properties:
+      client: string
+
   JavaSnippetCode:
     properties:
       async_client: string

packages/fdr-sdk/src/converters/db/convertAPIDefinitionToDb.ts

@@ -517,11 +517,16 @@ function transformCodeExamples({
         endpointMethod: endpointDefinition.method,
         endpointPath: getEndpointPathAsString(endpointDefinition),
     });
+    const maybeRubySnippet = snippets.getRubyCodeSnippetForEndpoint({
+        endpointMethod: endpointDefinition.method,
+        endpointPath: getEndpointPathAsString(endpointDefinition),
+    });
     return {
         nodeAxios: "",
         pythonSdk: maybePythonSnippet,
         typescriptSdk: maybeTypescriptSnippet,
         goSdk: maybeGoSnippet,
+        rubySdk: maybeRubySnippet,
     };
 }
 

packages/fdr-sdk/src/converters/db/snippets/SDKSnippetHolder.ts

@@ -5,6 +5,7 @@ export interface SnippetsConfigWithSdkId {
     pythonSdk?: APIV1Write.PythonPackage & { sdkId: string };
     goSdk?: APIV1Write.GoModule & { sdkId: string };
     javaSdk?: APIV1Write.JavaCoordinate & { sdkId: string };
+    rubySdk?: APIV1Write.RubyGem & { sdkId: string };
 }
 
 export interface SdkSnippetHolderArgs {
@@ -96,4 +97,29 @@ export class SDKSnippetHolder {
             client: snippetsForEndpoint[0]?.client,
         };
     }
+
+    public getRubyCodeSnippetForEndpoint({
+        endpointPath,
+        endpointMethod,
+    }: {
+        endpointPath: string;
+        endpointMethod: FdrAPI.EndpointMethod;
+    }): APIV1Read.RubySnippet | undefined {
+        if (this.snippetsConfigWithSdkId.rubySdk == null) {
+            return undefined;
+        }
+        const sdkId = this.snippetsConfigWithSdkId.rubySdk.sdkId;
+        const snippetsForEndpoint = this.snippetsBySdkId[sdkId]?.[endpointPath]?.[endpointMethod];
+        // if no snippets for this endpoint or multiple snippets just return undefined
+        if (snippetsForEndpoint == null || snippetsForEndpoint.length > 1) {
+            return undefined;
+        }
+        if (snippetsForEndpoint[0]?.type !== "ruby") {
+            return undefined;
+        }
+        return {
+            install: undefined, // TODO: add install snippet
+            client: snippetsForEndpoint[0]?.client,
+        };
+    }
 }

servers/fdr/package.json

@@ -68,6 +68,8 @@
     "db:migrate:dev": "dotenv -e .env.dev -- prisma migrate deploy",
     "db:migrate:local": "dotenv -e .env.local -- prisma migrate dev",
     "db:migrate:prod": "dotenv -e .env.prod -- prisma migrate deploy",
+    "db:up:local": "docker-compose -f docker-compose.local.yml up -d",
+    "db:down:local": "docker-compose -f docker-compose.local.yml down -d",
     "dev": "tsx src/server.ts --watch",
     "devjs": "node --experimental-specifier-resolution=node dist/server.js",
     "clean": "rm -rf ./dist && tsc --build --clean",

servers/fdr/prisma/migrations/20240411162630_add_ruby_snippets/migration.sql

@@ -0,0 +1,2 @@
+-- AlterEnum
+ALTER TYPE "Language" ADD VALUE 'RUBY';

servers/fdr/prisma/schema.prisma

@@ -113,4 +113,5 @@ enum Language {
   PYTHON
   GO
   JAVA
+  RUBY
 }