RubyGems - runapi-z-image - Versions diffs - 0.2.6 → 0.2.8 - Mend

runapi-z-image 0.2.6 → 0.2.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

checksums.yaml +4 -4
data/README.md +7 -7
data/lib/runapi/z_image/contract_gen.rb +25 -0
data/lib/runapi/z_image/resources/text_to_image.rb +8 -23
data/lib/runapi/z_image/types.rb +1 -6
data/lib/runapi/z_image.rb +1 -0
metadata +12 -9

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0cc4cee5277c6f3caf58569a36a33c9f3a697637917c9091f4f42a6eaf5ebf3
-  data.tar.gz: da3efb2dada6fed4c156cf49401d49daa1ffcdeaf7013a8082e9f5c2d5c310f4
+  metadata.gz: 58ef3ee01eda999e989ff9f6d08380ae01344598622fbc8b8b7772d703b8dfcb
+  data.tar.gz: 824abb45e84e3b97378cae64d29dd0c4b98d8c5cb98edc1705586927e6d44a9a
 SHA512:
-  metadata.gz: 75846ad36c5f89f307132964b79bea2b0a8fb05b1ee7774262263e8fc948e785f54af2da3ff9502e0f09c605de728cc7abdbe8339daf57386e3572297bfa5634
-  data.tar.gz: f5ac2d339056d52006b69cdc5871f0ba024a4e546c9b3db8b7359ca5fb14d5716d2b625d90f46ac28ef6706a92dc5452c45e49bc3d9d95b04c5830d261371c86
+  metadata.gz: d9d5f299612e31c1464d3a8118802e0983c6a7a31b6dfae1e885f958f50ae2fa8b71ebbc568d684e34b8f80111f4795f300d98fc3fb88a0c1e7b1a75cd7ba22a
+  data.tar.gz: 6561e4c58d7834da030a271a42be3bed8721a43cfb3a0a532d5fbbdaec8a59fd4dff453f24358061bb72f6ca6dae93d24466cf0b940e325798c481390e899167

data/README.md CHANGED Viewed

@@ -1,8 +1,8 @@
-# Z-Image API Ruby SDK for RunAPI
+# Z-Image Ruby SDK for RunAPI
-The z-image api Ruby SDK is the language-specific package for Z-Image on RunAPI. Use this z-image api package for text-to-image, image editing, and creative production flows when your application needs JSON request bodies, task status lookup, and consistent RunAPI errors in Ruby.
+The Z-Image Ruby SDK is the language-specific package for Z-Image on RunAPI. Use this package for image generation, image editing, and creative production workflows when your application needs request bodies, task status lookup, and consistent RunAPI errors in Ruby.
-This z-image api README is the Ruby package guide inside the public `z-image-sdk` repository. For the repository overview, start at `../README.md`; for model details, use https://runapi.ai/models/z-image; for API reference, use https://runapi.ai/docs#z-image; for SDK docs, use https://runapi.ai/docs#sdk-z-image.
+This README is the Ruby package guide inside the public `z-image-sdk` repository. For the repository overview, start at `../README.md`; for model details, use https://runapi.ai/models/z-image; for API reference, use https://runapi.ai/docs#z-image; for SDK docs, use https://runapi.ai/docs#sdk-z-image.
 ## Install
@@ -13,13 +13,13 @@ gem install runapi-z-image
 ## Quick start
 ```ruby
-require "runapi-z-image"
+require "runapi/z_image"
 client = RunApi::ZImage::Client.new
-task = client.generations.create(
+task = client.text_to_image.create(
   # Pass the Z-Image JSON request body from https://runapi.ai/docs#z-image.
 )
-status = client.generations.get(task.id)
+status = client.text_to_image.get(task.id)
 ```
 Use `create` when you want to submit a task and return quickly, `get` when you need the latest task state, and `run` when a script should create and poll until completion. In web request handlers, prefer `create` plus webhook or later `get` polling so a worker is not held open.
@@ -28,7 +28,7 @@ RunAPI-generated file URLs are temporary. Download and store generated images, v
 ## Language notes
-Use Ruby keyword arguments and the `RunApi::ZImage` error classes when building image jobs, Rails workers, or scripts. The available resources include generations. Keep `RUNAPI_API_KEY` in the environment or your secret manager; never commit API keys or callback secrets.
+Use Ruby keyword arguments and the `RunApi::ZImage` error classes when building image jobs, Rails workers, or scripts. The available resources are `text_to_image`. Keep `RUNAPI_API_KEY` in the environment or your secret manager; never commit API keys or callback secrets.
 ## Links

data/lib/runapi/z_image/contract_gen.rb ADDED Viewed

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+module RunApi
+  module ZImage
+    CONTRACT = {
+      "text-to-image" => {
+        "models" => ["z-image"],
+        "fields_by_model" => {
+          "z-image" => {
+            "aspect_ratio" => {
+              "enum" => ["1:1", "4:3", "3:4", "16:9", "9:16"],
+              "required" => true
+            },
+            "prompt" => {
+              "required" => true,
+              "min" => 1,
+              "max" => 1000,
+              "length" => true
+            }
+          }
+        }
+      }
+    }.freeze
+  end
+end

data/lib/runapi/z_image/resources/text_to_image.rb CHANGED Viewed

@@ -16,34 +16,19 @@ module RunApi
           @http = http
         end
-        def run(**params)
-          task = create(**params)
-          poll_until_complete { get(task.id) }
+        def run(options: nil, **params)
+          task = create(options: options, **params)
+          poll_until_complete { get(task.id, options: options) }
         end
-        def create(**params)
+        def create(options: nil, **params)
           params = compact_params(params)
-          validate_params!(params)
-          request(:post, ENDPOINT, body: params)
+          validate_contract!(CONTRACT["text-to-image"], params)
+          request(:post, ENDPOINT, body: params, options: options)
         end
-        def get(id)
-          request(:get, "#{ENDPOINT}/#{id}")
-        end
-        private
-        def validate_params!(params)
-          raise Core::ValidationError, "model is required" unless param(params, :model)
-          raise Core::ValidationError, "prompt is required" unless param(params, :prompt)
-          raise Core::ValidationError, "aspect_ratio is required" unless param(params, :aspect_ratio)
-          model = param(params, :model)
-          unless Types::MODELS.include?(model)
-            raise Core::ValidationError, "Invalid model: #{model}. Must be one of: #{Types::MODELS.join(", ")}"
-          end
-          validate_optional!(params, :aspect_ratio, Types::ASPECT_RATIOS)
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
       end
     end

data/lib/runapi/z_image/types.rb CHANGED Viewed

@@ -2,13 +2,8 @@
 module RunApi
   module ZImage
-    # Type definitions and constants for the Z-Image text-to-image API.
+    # Response models for the Z-Image text-to-image API.
     module Types
-      # Z-Image model slug.
-      MODELS = %w[z-image].freeze
-      # Output aspect ratios controlling generated image dimensions.
-      ASPECT_RATIOS = %w[1:1 4:3 3:4 16:9 9:16].freeze
       # URL to a generated image.
       class Image < RunApi::Core::BaseModel
         optional :url, String

data/lib/runapi/z_image.rb CHANGED Viewed

@@ -2,6 +2,7 @@
 require "runapi/core"
 require_relative "z_image/types"
+require_relative "z_image/contract_gen"
 require_relative "z_image/resources/text_to_image"
 require_relative "z_image/client"

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-z-image
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.8
 platform: ruby
 authors:
 - RunAPI
@@ -15,18 +15,18 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.6
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.6
-description: The z-image api Ruby SDK is the language-specific package for Z-Image
-  on RunAPI. Use this z-image api package for text-to-image, image editing, and creative
-  production flows when your application needs JSON request bodies, task status lookup,
-  and consistent RunAPI errors in Ruby.
+        version: 0.3.0
+description: The Z-Image Ruby SDK is the language-specific package for Z-Image on
+  RunAPI. Use this package for image generation, image editing, and creative production
+  workflows when your application needs request bodies, task status lookup, and consistent
+  RunAPI errors in Ruby.
 email:
 - contact@runapi.ai
 executables: []
@@ -39,15 +39,18 @@ files:
 - lib/runapi-z_image.rb
 - lib/runapi/z_image.rb
 - lib/runapi/z_image/client.rb
+- lib/runapi/z_image/contract_gen.rb
 - lib/runapi/z_image/resources/text_to_image.rb
 - lib/runapi/z_image/types.rb
 homepage: https://runapi.ai/models/z-image
 licenses:
 - Apache-2.0
 metadata:
+  runapi_slug: z-image
   homepage_uri: https://runapi.ai/models/z-image
   documentation_uri: https://github.com/runapi-ai/z-image-sdk/blob/main/ruby/README.md
   source_code_uri: https://github.com/runapi-ai/z-image-sdk
+  bug_tracker_uri: https://github.com/runapi-ai/z-image-sdk/issues
   changelog_uri: https://github.com/runapi-ai/z-image-sdk/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
@@ -63,7 +66,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.17
 specification_version: 4
-summary: Z-Image API Ruby SDK for RunAPI
+summary: Z-Image Ruby SDK for RunAPI
 test_files: []