runapi-gpt-image 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f0f24d53e5a9bb71de80a322a18692628ce317bd934ef4b940be87f7b89c214
-  data.tar.gz: 34900b290a2914977d76d8c436fd8f2cdd9486583bbf9e9f68d45b09059accee
+  metadata.gz: cd933bb97d1ca6a8ccf0708928f4985b1cfb06aae5cef4ec9d65b8b84448d0b1
+  data.tar.gz: cd13517224d400ec1f493166b6fc9ce4b6c479c967e14b680efa4f0c4f1db2f2
 SHA512:
-  metadata.gz: 607cb5ba0c1ab470b6851667c0cba9567a1ee79e3dcd314eeb5c76563f555fd861c5428fb5695045c98560d98a5c9ca4e1a05c120cd972c290d5df8d988a8db7
-  data.tar.gz: 26386b6c23a5a82143d3e9acc2ef9e28fd0340c35aade98202a819796c5ae3ec1f91f21f1788b17540207c276d567de8aaa1a71bcf895a78c2e0e2414f60cea3
+  metadata.gz: 2706384365717c217ffd71e4e654e92c1e24bb57318cd07cf7a420f78f1cb33a74faf19c0e01d6b30075e4d180204afc21cf66a5f6ce6f5a6f975d5eda50d3e6
+  data.tar.gz: 2c3b05a82ff0868976e4c0c0277dd1b8baeb9364eb816da8989f7161a6b91a9a36aa9a882e78a8de055a8ed1812e62146098dfb74e5d75285896e41f3fe65b18

data/README.md

@@ -24,6 +24,8 @@ status = client.generations.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::GptImage` error classes when building image jobs, Rails workers, or scripts. The available resources include generations, and edits. Keep `RUNAPI_API_KEY` in the environment or your secret manager; never commit API keys or callback secrets.

data/lib/runapi/gpt_image/client.rb

@@ -2,7 +2,9 @@
 
 module RunApi
   module GptImage
-    # GPT Image 1.5 image generation API client.
+    # GPT Image 1.5 generation and editing API client.
+    #
+    # Both aspect_ratio and quality are required for all operations.
     #
     # @example
     #   client = RunApi::GptImage::Client.new(api_key: "your-api-key")
@@ -18,17 +20,14 @@ module RunApi
     #     prompt: "Transform into oil painting",
     #     source_image_urls: ["https://cdn.runapi.ai/public/samples/photo.jpg"]
     #   )
-    class Client
+    class Client < RunApi::Core::Client
       # @return [Resources::TextToImage] Text-to-image generation operations.
       attr_reader :text_to_image
       # @return [Resources::EditImage] Image edit operations.
       attr_reader :edit_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)
         @edit_image = Resources::EditImage.new(http)
       end

data/lib/runapi/gpt_image/types.rb

@@ -2,18 +2,24 @@
 
 module RunApi
   module GptImage
+    # Type definitions and constants for GPT Image 1.5.
+    # Both aspect_ratio and quality are required for all operations.
     module Types
       MODELS = %w[gpt-image-1.5].freeze
       GENERATION_MODELS = MODELS
       EDIT_MODELS = MODELS
 
+      # Required for all operations.
       ASPECT_RATIOS = %w[1:1 2:3 3:2].freeze
+      # Higher quality takes longer but produces finer detail.
       QUALITY_VALUES = %w[medium high].freeze
 
+      # A single generated image with its CDN URL.
       class Image < RunApi::Core::BaseModel
         optional :url, String
       end
 
+      # Generation result. +images+ is populated once +status+ is +"completed"+.
       class TextToImageResponse < RunApi::Core::TaskResponse
         required :id, String
         optional :status, String, enum: -> { RunApi::Core::TaskResponse::Status::ALL }
@@ -21,6 +27,7 @@ module RunApi
         optional :error, String
       end
 
+      # Edit response -- same shape as generation.
       EditImageResponse = TextToImageResponse
 
       # Narrowed response returned by `run()` methods once polling observes

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-gpt-image
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - RunAPI
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.5
+        version: 0.2.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.5
+        version: 0.2.6
 description: The gpt image api Ruby SDK is the language-specific package for GPT Image
   on RunAPI. Use this gpt image api package for text-to-image, image editing, and
   creative production flows when your application needs JSON request bodies, task