@voxgig/sdkgen 0.44.0 → 1.0.1

package/project/.sdk/src/cmp/py/fragment/Main.fragment.py

@@ -180,15 +180,30 @@ class ProjectNameSDK:
 
         if isinstance(fetched, dict):
             status = helpers.to_int(vs.getprop(fetched, "status"))
+            headers = vs.getprop(fetched, "headers") or {}
+
+            # No-body responses (204, 304) and explicit zero content-length
+            # must skip JSON parsing — calling json() on an empty body raises.
+            content_length = None
+            if isinstance(headers, dict):
+                content_length = headers.get("content-length")
+            no_body = status in (204, 304) or str(content_length) == "0"
+
             json_data = None
-            jf = vs.getprop(fetched, "json")
-            if callable(jf):
-                json_data = jf()
+            if not no_body:
+                jf = vs.getprop(fetched, "json")
+                if callable(jf):
+                    try:
+                        json_data = jf()
+                    except Exception:
+                        # Non-JSON body (e.g. text/plain, text/html). Surface
+                        # status + headers but leave data as None.
+                        json_data = None
 
             return {
                 "ok": status >= 200 and status < 300,
                 "status": status,
-                "headers": vs.getprop(fetched, "headers"),
+                "headers": headers,
                 "data": json_data,
             }, 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/Package_rb.ts

@@ -18,6 +18,13 @@ const Package = cmp(async function Package(props: any) {
 
   const model: Model = ctx$.model
 
+  // Gem name is namespaced to model.origin (e.g. "voxgig-sdk"). RubyGems
+  // names can't contain "/", so the parts are hyphen-joined. The require
+  // path (`${model.name}_sdk`) is unchanged.
+  const ns = model.origin || 'voxgig-sdk'
+  const pkgBase = ns.endsWith('-sdk') ? model.name : `${model.name}-sdk`
+  const gemName = `${ns}-${pkgBase}`
+
   const versionOf = (d: { version: string; source: 'feature' | 'target' }) =>
     d.source === 'target' ? (d.version || '0.0') : d.version
 
@@ -38,12 +45,12 @@ gemspec
   // Generate gemspec
   File({ name: model.const.Name + '_sdk.gemspec' }, () => {
     Content(`Gem::Specification.new do |spec|
-  spec.name          = "${model.name}-sdk"
+  spec.name          = "${gemName}"
   spec.version       = "0.0.1"
   spec.authors       = ["Voxgig"]
   spec.summary       = "${model.const.Name} SDK for Ruby"
   spec.license       = "MIT"
-  spec.homepage      = "https://github.com/voxgig/${model.name}-sdk"
+  spec.homepage      = "https://github.com/${ns}/${model.name}-sdk"
 
   spec.files         = Dir["lib/**/*.rb", "*.rb"]
   spec.require_paths = ["."]

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
+}

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

@@ -1,5 +1,5 @@
 
-import { cmp, each, Content } from '@voxgig/sdkgen'
+import { cmp, each, Content, isAuthActive } from '@voxgig/sdkgen'
 
 import {
   KIT,
@@ -18,14 +18,16 @@ const ReadmeQuick = cmp(function ReadmeQuick(props: any) {
     e.active !== false && e.ancestors && e.ancestors.length > 0
   ) as any
 
+  const apikeyArg = isAuthActive(model)
+    ? `\n  "apikey" => ENV["${model.NAME}_APIKEY"],\n`
+    : ''
+
   Content(`### 1. Create a client
 
 \`\`\`ruby
 require_relative "${model.const.Name}_sdk"
 
-client = ${model.const.Name}SDK.new({
-  "apikey" => ENV["${model.NAME}_APIKEY"],
-})
+client = ${model.const.Name}SDK.new({${apikeyArg}})
 \`\`\`
 
 `)