runapi-z-image 0.2.5 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d5897ea70dd32d8d473283b3fc553f9b0ef44b45b861548476fe0c291ba011f
-  data.tar.gz: 8f35b13c1a81f908672f11fdaf0ba5381f7a61635f8c2cf36e6a15337b5bf856
+  metadata.gz: c3ba1f1d12e10c898bf7d5395cee0a63f52d103ffe9ff60d617edd9d91189fab
+  data.tar.gz: 18fb2a8d3b7f2e5d85b53d60c75828bc824db8a1ac2c24967b9a9dfb8320213d
 SHA512:
-  metadata.gz: 559123b0ae56392d7e330ba32292f0279f9b574e5623ed74ffa86502a7c59e0db683e98f814c84843f451abdd5753cce3b91699defd57f8df29a798870bb94cd
-  data.tar.gz: '09f5c253adb7fdcf239e6e7905cbc699172a7dc1d2e6f8653f794a1f023400920e87ce9b7f05bfa9681d6043c0c8baf9e4be6b2070c5e3b935bc15a4d428ed50'
+  metadata.gz: 6427e15c5cb423df4c65bc6d5162a2eef9192b3f6fc1607837c94dcd88c31659c882015221fae47efe12683acafa698a86ad4fddc45a613388518c57856a39da
+  data.tar.gz: 016ec72fbf4cb1e7dad8d643178a42040d203e51376d5b11cb1008a4fb07c5cf3f49d7f4c74f3b313777cceaa2cf6bcd36d22c0721085dab5c85c56e093af31d

data/README.md

@@ -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
 
@@ -16,17 +16,19 @@ gem install 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.
 
+RunAPI-generated file URLs are temporary. Download and store generated images, videos, audio, or other files in your own durable storage within 7 days; do not treat returned URLs as long-term assets.
+
 ## 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/client.rb

@@ -2,14 +2,22 @@
 
 module RunApi
   module ZImage
-    class Client
+    # Z-Image text-to-image generation client.
+    #
+    # @example
+    #   client = RunApi::ZImage::Client.new(api_key: "sk-...")
+    #   result = client.text_to_image.run(
+    #     model: "z-image",
+    #     prompt: "A serene Japanese garden at sunrise",
+    #     aspect_ratio: "16:9"
+    #   )
+    #   puts result.images.first.url
+    class Client < RunApi::Core::Client
+      # @return [Resources::TextToImage] Text-to-image generation with configurable aspect ratio and safety filtering.
       attr_reader :text_to_image
 
       def initialize(api_key: nil, **options)
-        @api_key = Core::Auth.resolve_api_key(api_key)
-
-        client_options = Core::ClientOptions.new(api_key: @api_key, **options)
-        http = client_options.http_client || Core::HttpClient.new(client_options)
+        super
         @text_to_image = Resources::TextToImage.new(http)
       end
     end

data/lib/runapi/z_image/contract_gen.rb

@@ -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

@@ -3,6 +3,7 @@
 module RunApi
   module ZImage
     module Resources
+      # Generates images from text prompts with configurable aspect ratio and safety filtering.
       class TextToImage
         include RunApi::Core::ResourceHelpers
 
@@ -22,28 +23,13 @@ module RunApi
 
         def create(**params)
           params = compact_params(params)
-          validate_params!(params)
+          validate_contract!(CONTRACT["text-to-image"], params)
           request(:post, ENDPOINT, body: params)
         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)
-        end
       end
     end
   end

data/lib/runapi/z_image/types.rb

@@ -2,14 +2,14 @@
 
 module RunApi
   module ZImage
+    # Response models for the Z-Image text-to-image API.
     module Types
-      MODELS = %w[z-image].freeze
-      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
       end
 
+      # Async text-to-image task result with lifecycle status.
       class TextToImageResponse < RunApi::Core::TaskResponse
         required :id, String
         optional :status, String, enum: -> { RunApi::Core::TaskResponse::Status::ALL }
@@ -17,6 +17,8 @@ module RunApi
         optional :error, String
       end
 
+      # Narrowed response returned by +run+ once polling confirms completion.
+      # Images are guaranteed present.
       class CompletedTextToImageResponse < TextToImageResponse
         required :images, [-> { Image }]
       end

data/lib/runapi/z_image.rb

@@ -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

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-z-image
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.7
 platform: ruby
 authors:
 - RunAPI
@@ -15,18 +15,18 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.5
+        version: 0.2.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.5
-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.2.7
+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:
@@ -65,5 +68,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.10
 specification_version: 4
-summary: Z-Image API Ruby SDK for RunAPI
+summary: Z-Image Ruby SDK for RunAPI
 test_files: []