@voxgig/sdkgen 0.43.0 → 0.45.0

package/project/.sdk/src/cmp/py/TestEntity_py.ts

@@ -7,7 +7,12 @@ import {
 
 import {
   KIT,
+  Model,
+  ModelEntity,
+  ModelEntityFlow,
+  ModelEntityFlowStep,
   getModelPath,
+  nom,
 } from '@voxgig/apidef'
 
 
@@ -18,34 +23,47 @@ import {
   each,
   buildIdNames,
   getMatchEntries,
+  isAuthActive,
 } from '@voxgig/sdkgen'
 
 
-type OpGen = (ctx: GenCtx, step: any, index: any) => void
-
+// See TestEntity_ts.ts for the GenCtx/OpGen contract.
 type GenCtx = {
-  model: any
-  entity: any
-  flow: any
+  model: Model
+  entity: ModelEntity
+  flow: ModelEntityFlow
   PROJUPPER: string
 }
 
+type OpGen = (ctx: GenCtx, step: ModelEntityFlowStep, index: number) => void
+
 
 const TestEntity = cmp(function TestEntity(props: any) {
   const ctx$ = props.ctx$
-  const model = ctx$.model
+  const model: Model = ctx$.model
 
   const target = props.target
-  const entity = props.entity
+  const entity: ModelEntity = props.entity
 
-  const basicflow = getModelPath(model, `main.${KIT}.flow.Basic${entity.Name}Flow`)
-  const dobasic = basicflow && true === basicflow.active
+  const basicflow: ModelEntityFlow | undefined =
+    getModelPath(model, `main.${KIT}.flow.Basic${nom(entity, 'Name')}Flow`)
 
-  if (!dobasic) {
+  // No flow or flow inactive — nothing to generate. The narrowed-form
+  // check (rather than `if (!dobasic)`) is what lets TS know `basicflow`
+  // is non-null in the rest of the cmp body.
+  if (null == basicflow || true !== basicflow.active) {
     return
   }
 
-  const PROJUPPER = model.const.Name.toUpperCase().replace(/[^A-Z_]/g, '_')
+  const PROJUPPER = nom(model.const, 'Name').toUpperCase().replace(/[^A-Z_]/g, '_')
+
+  const authActive = isAuthActive(model)
+  const apikeyEnvEntry = authActive
+    ? `\n        "${PROJUPPER}_APIKEY": "NONE",`
+    : ''
+  const apikeyLiveField = authActive
+    ? `\n                "apikey": env.get("${PROJUPPER}_APIKEY"),`
+    : ''
 
   const idnames = buildIdNames(entity, basicflow)
   const idnamesStr = idnames.map(n => `"${n}"`).join(', ')
@@ -147,8 +165,7 @@ def _${entity.name}_basic_setup(extra):
     Content(`    env = runner.env_override({
         "${PROJUPPER}_TEST_${entity.name.toUpperCase().replace(/[^A-Z_]/g, '_')}_ENTID": idmap,
         "${PROJUPPER}_TEST_LIVE": "FALSE",
-        "${PROJUPPER}_TEST_EXPLAIN": "FALSE",
-        "${PROJUPPER}_APIKEY": "NONE",
+        "${PROJUPPER}_TEST_EXPLAIN": "FALSE",${apikeyEnvEntry}
     })
 
     idmap_resolved = helpers.to_map(
@@ -167,8 +184,7 @@ def _${entity.name}_basic_setup(extra):
     Content(`
     if env.get("${PROJUPPER}_TEST_LIVE") == "TRUE":
         merged_opts = vs.merge([
-            {
-                "apikey": env.get("${PROJUPPER}_APIKEY"),
+            {${apikeyLiveField}
             },
             extra or {},
         ])
@@ -189,9 +205,9 @@ def _${entity.name}_basic_setup(extra):
 
 const generateCreate: OpGen = (ctx, step, index) => {
   const { entity, flow } = ctx
-  const ref = step.input?.ref ?? entity.name + '_ref01'
-  const entvar = step.input?.entvar ?? ref + '_ent'
-  const datavar = step.input?.datavar ?? (ref + '_data' + (step.input?.suffix ?? ''))
+  const ref = step.input.ref ?? entity.name + '_ref01'
+  const entvar = step.input.entvar ?? ref + '_ent'
+  const datavar = step.input.datavar ?? (ref + '_data' + (step.input.suffix ?? ''))
 
   const priorSteps = Object.values(flow.step).slice(0, Number(index)) as any[]
   const needsEnt = !priorSteps.some((s: any) =>
@@ -199,8 +215,8 @@ const generateCreate: OpGen = (ctx, step, index) => {
 
   const hasDatvar = priorSteps.some((s: any) => {
     if ('create' === s.op) {
-      const priorRef = s.input?.ref ?? entity.name + '_ref01'
-      const priorDatvar = s.input?.datavar ?? (priorRef + '_data' + (s.input?.suffix ?? ''))
+      const priorRef = s.input.ref ?? entity.name + '_ref01'
+      const priorDatvar = s.input.datavar ?? (priorRef + '_data' + (s.input.suffix ?? ''))
       return priorDatvar === datavar
     }
     return false
@@ -229,22 +245,27 @@ const generateCreate: OpGen = (ctx, step, index) => {
 `)
   }
 
+  const hasEntIdC = null != ctx.entity.id
+
   Content(`
         ${datavar}_result, err = ${entvar}.create(${datavar}, None)
         assert err is None
         ${datavar} = helpers.to_map(${datavar}_result)
         assert ${datavar} is not None
-        assert ${datavar}["id"] is not None
 `)
+  if (hasEntIdC) {
+    Content(`        assert ${datavar}["id"] is not None
+`)
+  }
 }
 
 
 const generateList: OpGen = (ctx, step, index) => {
   const { entity, flow } = ctx
-  const ref = step.input?.ref ?? entity.name + '_ref01'
-  const entvar = step.input?.entvar ?? ref + '_ent'
-  const matchvar = step.input?.matchvar ?? (ref + '_match' + (step.input?.suffix ?? ''))
-  const listvar = step.input?.listvar ?? (ref + '_list' + (step.input?.suffix ?? ''))
+  const ref = step.input.ref ?? entity.name + '_ref01'
+  const entvar = step.input.entvar ?? ref + '_ent'
+  const matchvar = step.input.matchvar ?? (ref + '_match' + (step.input.suffix ?? ''))
+  const listvar = step.input.listvar ?? (ref + '_list' + (step.input.suffix ?? ''))
 
   const priorSteps = Object.values(flow.step).slice(0, Number(index)) as any[]
   const needsEnt = !priorSteps.some((s: any) =>
@@ -284,7 +305,7 @@ const generateList: OpGen = (ctx, step, index) => {
     for (const validator of step.valid) {
       const validRef = validator.def?.ref
       const hasRefData = validRef && allSteps.some((s: any) => 'create' === s.op &&
-        ((s.input?.ref ?? entity.name + '_ref01') === validRef))
+        ((s.input.ref ?? entity.name + '_ref01') === validRef))
 
       if ('ItemExists' === validator.apply && hasRefData) {
         const refDataVar = validRef + '_data'
@@ -310,17 +331,19 @@ const generateList: OpGen = (ctx, step, index) => {
 
 const generateUpdate: OpGen = (ctx, step, index) => {
   const { entity, flow } = ctx
-  const ref = step.input?.ref ?? entity.name + '_ref01'
-  const entvar = step.input?.entvar ?? ref + '_ent'
-  const datavar = step.input?.datavar ?? (ref + '_data' + (step.input?.suffix ?? ''))
-  const resdatavar = step.input?.resdatavar ?? (ref + '_resdata' + (step.input?.suffix ?? ''))
-  const markdefvar = step.input?.markdefvar ?? (ref + '_markdef' + (step.input?.suffix ?? ''))
-  const srcdatavar = step.input?.srcdatavar ?? (ref + '_data' + (step.input?.suffix ?? ''))
+  const ref = step.input.ref ?? entity.name + '_ref01'
+  const entvar = step.input.entvar ?? ref + '_ent'
+  const datavar = step.input.datavar ?? (ref + '_data' + (step.input.suffix ?? ''))
+  const resdatavar = step.input.resdatavar ?? (ref + '_resdata' + (step.input.suffix ?? ''))
+  const markdefvar = step.input.markdefvar ?? (ref + '_markdef' + (step.input.suffix ?? ''))
+  const srcdatavar = step.input.srcdatavar ?? (ref + '_data' + (step.input.suffix ?? ''))
 
   const priorSteps = Object.values(flow.step).slice(0, Number(index)) as any[]
   const needsEnt = !priorSteps.some((s: any) =>
     ['create', 'list', 'load', 'update', 'remove'].includes(s.op))
 
+  const hasEntIdU = null != entity.id
+
   Content(`        # UPDATE
 `)
   if (needsEnt) {
@@ -328,8 +351,11 @@ const generateUpdate: OpGen = (ctx, step, index) => {
 `)
   }
   Content(`        ${datavar}_up = {
-            "id": ${srcdatavar}["id"],
 `)
+  if (hasEntIdU) {
+    Content(`            "id": ${srcdatavar}["id"],
+`)
+  }
 
   if (step.data) {
     const dataEntries = Object.entries(step.data).filter(([k]: any) => k !== 'id' && !k.endsWith('$'))
@@ -344,7 +370,7 @@ const generateUpdate: OpGen = (ctx, step, index) => {
 
   if (step.spec) {
     for (const spec of step.spec) {
-      if ('TextFieldMark' === spec.apply && null != step.input?.textfield) {
+      if ('TextFieldMark' === spec.apply && null != step.input.textfield) {
         const fieldname = step.input.textfield
         const fieldvalue = spec.def?.mark ?? `Mark01-${ref}`
         Content(`
@@ -361,12 +387,15 @@ const generateUpdate: OpGen = (ctx, step, index) => {
         assert err is None
         ${resdatavar} = helpers.to_map(${resdatavar}_result)
         assert ${resdatavar} is not None
-        assert ${resdatavar}["id"] == ${datavar}_up["id"]
 `)
+  if (hasEntIdU) {
+    Content(`        assert ${resdatavar}["id"] == ${datavar}_up["id"]
+`)
+  }
 
   if (step.spec) {
     for (const spec of step.spec) {
-      if ('TextFieldMark' === spec.apply && null != step.input?.textfield) {
+      if ('TextFieldMark' === spec.apply && null != step.input.textfield) {
         Content(`        assert ${resdatavar}[${markdefvar}_name] == ${markdefvar}_value
 `)
       }
@@ -377,11 +406,11 @@ const generateUpdate: OpGen = (ctx, step, index) => {
 
 const generateLoad: OpGen = (ctx, step, index) => {
   const { entity, flow } = ctx
-  const ref = step.input?.ref ?? entity.name + '_ref01'
-  const entvar = step.input?.entvar ?? ref + '_ent'
-  const matchvar = step.input?.matchvar ?? (ref + '_match' + (step.input?.suffix ?? ''))
-  const datavar = step.input?.datavar ?? (ref + '_data' + (step.input?.suffix ?? ''))
-  const srcdatavar = step.input?.srcdatavar ?? (ref + '_data' + (step.input?.suffix ?? ''))
+  const ref = step.input.ref ?? entity.name + '_ref01'
+  const entvar = step.input.entvar ?? ref + '_ent'
+  const matchvar = step.input.matchvar ?? (ref + '_match' + (step.input.suffix ?? ''))
+  const datavar = step.input.datavar ?? (ref + '_data' + (step.input.suffix ?? ''))
+  const srcdatavar = step.input.srcdatavar ?? (ref + '_data' + (step.input.suffix ?? ''))
 
   const priorSteps = Object.values(flow.step).slice(0, Number(index)) as any[]
   const hasEntVar = priorSteps.some((s: any) =>
@@ -392,20 +421,22 @@ const generateLoad: OpGen = (ctx, step, index) => {
   const hasSrcData = (!flowHasCreate && srcdatavar === (preambleRef + '_data')) ||
     priorSteps.some((s: any) => {
       if ('create' === s.op) {
-        const priorRef = s.input?.ref ?? entity.name + '_ref01'
-        const priorDatvar = s.input?.datavar ?? (priorRef + '_data' + (s.input?.suffix ?? ''))
+        const priorRef = s.input.ref ?? entity.name + '_ref01'
+        const priorDatvar = s.input.datavar ?? (priorRef + '_data' + (s.input.suffix ?? ''))
         return priorDatvar === srcdatavar
       }
       return false
     })
 
+  const hasEntId = null != entity.id
+
   Content(`        # LOAD
 `)
   if (!hasEntVar) {
     Content(`        ${entvar} = client.${entity.Name}(None)
 `)
   }
-  if (!hasSrcData) {
+  if (!hasSrcData && hasEntId) {
     Content(`        ${srcdatavar}_raw = vs.items(helpers.to_map(
             vs.getpath(setup["data"], "existing.${entity.name}")))
         ${srcdatavar} = None
@@ -413,7 +444,8 @@ const generateLoad: OpGen = (ctx, step, index) => {
             ${srcdatavar} = helpers.to_map(${srcdatavar}_raw[0][1])
 `)
   }
-  Content(`        ${matchvar} = {
+  if (hasEntId) {
+    Content(`        ${matchvar} = {
             "id": ${srcdatavar}["id"],
         }
         ${datavar}_loaded, err = ${entvar}.load(${matchvar}, None)
@@ -422,32 +454,50 @@ const generateLoad: OpGen = (ctx, step, index) => {
         assert ${datavar}_load_result is not None
         assert ${datavar}_load_result["id"] == ${srcdatavar}["id"]
 `)
+  }
+  else {
+    Content(`        ${matchvar} = {}
+        ${datavar}_loaded, err = ${entvar}.load(${matchvar}, None)
+        assert err is None
+        assert ${datavar}_loaded is not None
+`)
+  }
 }
 
 
 const generateRemove: OpGen = (ctx, step, index) => {
   const { entity, flow } = ctx
-  const ref = step.input?.ref ?? entity.name + '_ref01'
-  const entvar = step.input?.entvar ?? ref + '_ent'
-  const matchvar = step.input?.matchvar ?? (ref + '_match' + (step.input?.suffix ?? ''))
-  const srcdatavar = step.input?.srcdatavar ?? (ref + '_data')
+  const ref = step.input.ref ?? entity.name + '_ref01'
+  const entvar = step.input.entvar ?? ref + '_ent'
+  const matchvar = step.input.matchvar ?? (ref + '_match' + (step.input.suffix ?? ''))
+  const srcdatavar = step.input.srcdatavar ?? (ref + '_data')
 
   const priorSteps = Object.values(flow.step).slice(0, Number(index)) as any[]
   const needsEnt = !priorSteps.some((s: any) =>
     ['create', 'list', 'load', 'update', 'remove'].includes(s.op))
 
+  const hasEntIdR = null != entity.id
+
   Content(`        # REMOVE
 `)
   if (needsEnt) {
     Content(`        ${entvar} = client.${entity.Name}(None)
 `)
   }
-  Content(`        ${matchvar} = {
+  if (hasEntIdR) {
+    Content(`        ${matchvar} = {
             "id": ${srcdatavar}["id"],
         }
         _, err = ${entvar}.remove(${matchvar}, None)
         assert err is None
 `)
+  }
+  else {
+    Content(`        ${matchvar} = {}
+        _, err = ${entvar}.remove(${matchvar}, None)
+        assert err is None
+`)
+  }
 }
 
 

package/project/.sdk/src/cmp/rb/Config_rb.ts

@@ -9,6 +9,7 @@ import {
   Line,
   cmp,
   each,
+  isAuthActive,
 } from '@voxgig/sdkgen'
 
 
@@ -37,12 +38,19 @@ const Config = cmp(async function Config(props: any) {
 
   const headers = getModelPath(model, `main.${KIT}.config.headers`) || {}
 
+  const authActive = isAuthActive(model)
   let authPrefix = ''
   try { authPrefix = getModelPath(model, `main.${KIT}.config.auth.prefix`) } catch (_e) { }
 
   let baseUrl = ''
   try { baseUrl = getModelPath(model, `main.${KIT}.info.servers.0.url`) } catch (_e) { }
 
+  const authBlock = authActive
+    ? `        "auth" => {
+          "prefix" => "${authPrefix}",
+        },\n`
+    : ''
+
   File({ name: 'config.' + target.ext }, () => {
 
     Content(`# ${model.const.Name} SDK configuration
@@ -65,10 +73,7 @@ module ${model.const.Name}Config
     Content(`      },
       "options" => {
         "base" => "${baseUrl}",
-        "auth" => {
-          "prefix" => "${authPrefix}",
-        },
-        "headers" => ${formatRubyHash(headers, 4)},
+${authBlock}        "headers" => ${formatRubyHash(headers, 4)},
         "entity" => {
 `)
 

package/project/.sdk/src/cmp/rb/Gitignore_rb.ts

@@ -0,0 +1,38 @@
+
+import {
+  Content,
+  File,
+  cmp,
+} from '@voxgig/sdkgen'
+
+
+const Gitignore = cmp(async function Gitignore(_props: any) {
+  File({ name: '.gitignore' }, () => {
+    Content(`# Bundler / gem build artifacts
+*.gem
+.bundle/
+vendor/bundle/
+pkg/
+
+# Test / coverage
+coverage/
+.rspec_status
+
+# Documentation
+.yardoc/
+_yardoc/
+doc/
+rdoc/
+
+# IDE / OS
+.idea/
+.vscode/
+.DS_Store
+`)
+  })
+})
+
+
+export {
+  Gitignore
+}

package/project/.sdk/src/cmp/rb/Main_rb.ts

@@ -20,6 +20,7 @@ import {
 
 import { Package } from './Package_rb'
 import { Config } from './Config_rb'
+import { Gitignore } from './Gitignore_rb'
 import { MainEntity } from './MainEntity_rb'
 
 
@@ -33,6 +34,8 @@ const Main = cmp(async function Main(props: any) {
 
   Package({ target })
 
+  Gitignore({})
+
   // Copy tm/rb files with replacements
   Copy({
     from: 'tm/' + target.name,

package/project/.sdk/src/cmp/rb/ReadmeEntity_rb.ts

@@ -0,0 +1,138 @@
+
+import { cmp, each, Content } from '@voxgig/sdkgen'
+
+import {
+  KIT,
+  getModelPath,
+} from '@voxgig/apidef'
+
+
+// Operation method spelling differs between Go and other languages — Go
+// uses PascalCase methods with explicit ctrl arg, others use lowercase
+// methods with optional ctrl. The op descriptions are language-agnostic.
+const OP_DESC: Record<string, { method: string, desc: string }> = {
+  load:   { method: 'load(match)',   desc: 'Load a single entity by match criteria.' },
+  list:   { method: 'list(match)',   desc: 'List entities matching the criteria.' },
+  create: { method: 'create(data)',  desc: 'Create a new entity with the given data.' },
+  update: { method: 'update(data)',  desc: 'Update an existing entity.' },
+  remove: { method: 'remove(match)', desc: 'Remove the matching entity.' },
+}
+
+
+const ReadmeEntity = cmp(function ReadmeEntity(props: any) {
+  const { target } = props
+  const { model } = props.ctx$
+
+  const entity = getModelPath(model, `main.${KIT}.entity`)
+
+  const publishedEntities = each(entity)
+    .filter((entity: any) => entity.active !== false)
+
+  if (0 === publishedEntities.length) {
+    return
+  }
+
+  Content(`
+
+## Entities
+
+`)
+
+  publishedEntities.map((entity: any) => {
+    const opnames = Object.keys(entity.op || {})
+    const fields = entity.fields || []
+
+    Content(`
+### ${entity.Name}
+
+`)
+
+    if (entity.short) {
+      Content(`${entity.short}
+
+`)
+    }
+
+    Content(`Create an instance: \`const ${entity.name} = client.${entity.Name}()\`
+
+`)
+
+    if (opnames.length > 0) {
+      Content(`#### Operations
+
+| Method | Description |
+| --- | --- |
+`)
+      opnames.map((opname: string) => {
+        const info = OP_DESC[opname]
+        if (info) {
+          Content(`| \`${info.method}\` | ${info.desc} |
+`)
+        }
+      })
+
+      Content(`
+`)
+    }
+
+    if (fields.length > 0) {
+      Content(`#### Fields
+
+| Field | Type | Description |
+| --- | --- | --- |
+`)
+
+      each(fields, (field: any) => {
+        const desc = field.short || ''
+        Content(`| \`${field.name}\` | \`${field.type || 'any'}\` | ${desc} |
+`)
+      })
+
+      Content(`
+`)
+    }
+
+    if (opnames.includes('load')) {
+      Content(`#### Example: Load
+
+\`\`\`ts
+const ${entity.name} = await client.${entity.Name}().load({ id: '${entity.name}_id' })
+\`\`\`
+
+`)
+    }
+
+    if (opnames.includes('list')) {
+      Content(`#### Example: List
+
+\`\`\`ts
+const ${entity.name}s = await client.${entity.Name}().list()
+\`\`\`
+
+`)
+    }
+
+    if (opnames.includes('create')) {
+      Content(`#### Example: Create
+
+\`\`\`ts
+const ${entity.name} = await client.${entity.Name}().create({
+`)
+      each(fields, (field: any) => {
+        if ('id' !== field.name && field.req) {
+          Content(`  ${field.name}: /* ${field.type || 'value'} */,
+`)
+        }
+      })
+      Content(`})
+\`\`\`
+
+`)
+    }
+  })
+})
+
+
+export {
+  ReadmeEntity
+}

package/project/.sdk/src/cmp/rb/ReadmeHowto_rb.ts

@@ -1,10 +1,14 @@
 
-import { cmp, Content } from '@voxgig/sdkgen'
+import { cmp, Content, isAuthActive } from '@voxgig/sdkgen'
 
 
 const ReadmeHowto = cmp(function ReadmeHowto(props: any) {
   const { target, ctx$: { model } } = props
 
+  const apikeyEnvLine = isAuthActive(model)
+    ? `\n${model.NAME}_APIKEY=<your-key>`
+    : ''
+
   Content(`### Make a direct HTTP request
 
 For endpoints not covered by entity methods:
@@ -78,8 +82,7 @@ client = ${model.const.Name}SDK.new({
 Create a \`.env.local\` file at the project root:
 
 \`\`\`
-${model.NAME}_TEST_LIVE=TRUE
-${model.NAME}_APIKEY=<your-key>
+${model.NAME}_TEST_LIVE=TRUE${apikeyEnvLine}
 \`\`\`
 
 Then run:

package/project/.sdk/src/cmp/rb/ReadmeIntro_rb.ts

@@ -0,0 +1,18 @@
+
+import { cmp, Content } from '@voxgig/sdkgen'
+
+
+const ReadmeIntro = cmp(function ReadmeIntro(props: any) {
+  const { target, ctx$: { model } } = props
+
+  Content(`# ${model.Name} ${target.title} SDK
+
+The ${target.title} SDK for the ${model.Name} API. Provides an entity-oriented interface using idiomatic Ruby conventions.
+
+`)
+})
+
+
+export {
+  ReadmeIntro
+}

package/project/.sdk/src/cmp/rb/ReadmeModel_rb.ts

@@ -1,5 +1,5 @@
 
-import { cmp, each, Content } from '@voxgig/sdkgen'
+import { cmp, each, Content, isAuthActive } from '@voxgig/sdkgen'
 
 import {
   KIT,
@@ -13,6 +13,10 @@ const ReadmeModel = cmp(function ReadmeModel(props: any) {
   const entity = getModelPath(model, `main.${KIT}.entity`)
   const entityList = each(entity).filter((e: any) => e.active !== false)
 
+  const apikeyOptionRow = isAuthActive(model)
+    ? '| `apikey` | `String` | API key for authentication. |\n'
+    : ''
+
   Content(`### ${model.const.Name}SDK
 
 \`\`\`ruby
@@ -24,8 +28,7 @@ Creates a new SDK client.
 
 | Option | Type | Description |
 | --- | --- | --- |
-| \`apikey\` | \`String\` | API key for authentication. |
-| \`base\` | \`String\` | Base URL of the API server. |
+${apikeyOptionRow}| \`base\` | \`String\` | Base URL of the API server. |
 | \`prefix\` | \`String\` | URL path prefix prepended to all requests. |
 | \`suffix\` | \`String\` | URL path suffix appended to all requests. |
 | \`feature\` | \`Hash\` | Feature activation flags. |

package/project/.sdk/src/cmp/rb/ReadmeOptions_rb.ts

@@ -0,0 +1,58 @@
+
+import { cmp, each, Content } from '@voxgig/sdkgen'
+
+
+const ReadmeOptions = cmp(function ReadmeOptions(props: any) {
+  const { target } = props
+  const { model } = props.ctx$
+
+  const publishedOptions = each(target.options).filter((option: any) => option.publish)
+  if (0 === publishedOptions.length) {
+    return
+  }
+
+  Content(`
+
+## Options
+
+Pass options when creating a client instance:
+
+`)
+
+  Content(`\`\`\`ruby
+client = ${model.Name}SDK.new({
+`)
+
+  publishedOptions.map((option: any) => {
+    if ('apikey' === option.name) {
+      Content(`  "${option.name}" => ENV["${model.NAME}_APIKEY"],
+`)
+    }
+    else {
+      Content(`  # "${option.name}" => ${option.kind === 'string' ? '"..."' : '...'},
+`)
+    }
+  })
+
+  Content(`})
+\`\`\`
+
+`)
+
+  Content(`| Option | Type | Description |
+| --- | --- | --- |
+`)
+
+  publishedOptions.map((option: any) => {
+    Content(`| \`${option.name}\` | \`${option.kind}\` | ${option.short} |
+`)
+  })
+
+  Content(`
+`)
+})
+
+
+export {
+  ReadmeOptions
+}