runapi-gpt-4o-image 0.2.5 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2472cd75263166ddf4f6f6dcbe222c458bae3ccfc1acd0c106e9a2ce42241b1f
-  data.tar.gz: adaa442f974bf4101270ab1bbc057e95045594fdd0ec487d09edd60300729908
+  metadata.gz: 0bde0a1009adf492967f5a45e2f602da47664e435d83938704a262709c1bc8ea
+  data.tar.gz: efe6d98d743b8801b266885e4bc57e21d838727547179d1dc20af0a324832908
 SHA512:
-  metadata.gz: 6471cd4c36028b46fc900d4d3236a8cd1f45eb14ad12aa343c6b8114ab89865a371769c9b57b215f94c5afd93ec873dc35dd32bde83fedfb6703c794d6843beb
-  data.tar.gz: f5211a22702956fec1df59e764c4b3d7c45498b768f69673c08ce6c375f8eb36fe7e4534d01293aab469ee4c08e6ebab0838489c49631df4cbc13c72402699f4
+  metadata.gz: 61889c9a5c4c2fc6bdf33eeba1f76faeb171df8ff2343ca1c29cf51a5984aa3897e476f18cb28c59921096878261ae8547fb21518d9c99153a8036875655b951
+  data.tar.gz: dd3efdf22b6f1e8e8ec7525d1b72a5a14d8b4ad2e5f71296aac2ffd8043d911b51f604b0c8dd434a2fbaab65b123406c0c11c11e8baadae035fb49f2cdfc7208

data/README.md

@@ -1,32 +1,34 @@
-# GPT-4o Image API Ruby SDK for RunAPI
+# GPT-4o Image Ruby SDK for RunAPI
 
-The gpt-4o image api Ruby SDK is the language-specific package for GPT-4o Image on RunAPI. Use this gpt-4o 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 GPT-4o Image Ruby SDK is the language-specific package for GPT-4o 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 gpt-4o image api README is the Ruby package guide inside the public `gpt4o-image-sdk` repository. For the repository overview, start at `../README.md`; for model details, use https://runapi.ai/models/gpt-4o-image; for API reference, use https://runapi.ai/docs#gpt-4o-image; for SDK docs, use https://runapi.ai/docs#sdk-gpt-4o-image.
+This README is the Ruby package guide inside the public `gpt-4o-image-sdk` repository. For the repository overview, start at `../README.md`; for model details, use https://runapi.ai/models/gpt-4o-image; for API reference, use https://runapi.ai/docs#gpt-4o-image; for SDK docs, use https://runapi.ai/docs#sdk-gpt-4o-image.
 
 ## Install
 
 ```bash
-gem install runapi-gpt4o-image
+gem install runapi-gpt-4o-image
 ```
 
 ## Quick start
 
 ```ruby
-require "runapi-gpt4o-image"
+require "runapi-gpt-4o-image"
 
 client = RunApi::Gpt4oImage::Client.new
-task = client.generations.create(
+task = client.text_to_image.create(
   # Pass the GPT-4o Image JSON request body from https://runapi.ai/docs#gpt-4o-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::Gpt4oImage` 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::Gpt4oImage` 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/gpt_4o_image/client.rb

@@ -2,14 +2,32 @@
 
 module RunApi
   module Gpt4oImage
-    class Client
+    # GPT-4o Image generation and editing API client.
+    #
+    # Supports pure text-to-image generation, image editing with source images,
+    # and inpainting with an optional mask.
+    #
+    # @example
+    #   client = RunApi::Gpt4oImage::Client.new(api_key: "your-api-key")
+    #
+    #   # Pure generation
+    #   result = client.text_to_image.run(
+    #     model: "gpt-4o-image", prompt: "A mountain lake at dawn",
+    #     aspect_ratio: "3:2"
+    #   )
+    #
+    #   # Edit with source images
+    #   edited = client.text_to_image.run(
+    #     model: "gpt-4o-image", prompt: "Add a rainbow",
+    #     aspect_ratio: "3:2",
+    #     source_image_urls: ["https://cdn.runapi.ai/public/samples/image.jpg"]
+    #   )
+    class Client < RunApi::Core::Client
+      # @return [Resources::TextToImage] Image generation and editing operations.
       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/gpt_4o_image/contract_gen.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module RunApi
+  module Gpt4oImage
+    CONTRACT = {
+      "text-to-image" => {
+        "models" => ["gpt-4o-image"],
+        "fields_by_model" => {
+          "gpt-4o-image" => {
+            "aspect_ratio" => {
+              "enum" => ["1:1", "3:2", "2:3"],
+              "required" => true
+            },
+            "output_count" => {
+              "enum" => [1, 2, 4],
+              "type" => "integer"
+            }
+          }
+        }
+      }
+    }.freeze
+  end
+end

data/lib/runapi/gpt_4o_image/resources/text_to_image.rb

@@ -3,6 +3,8 @@
 module RunApi
   module Gpt4oImage
     module Resources
+      # GPT-4o Image generation and editing resource.
+      # Generate images from text, edit with source images, or inpaint with a mask.
       class TextToImage
         include RunApi::Core::ResourceHelpers
 
@@ -22,28 +24,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, "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: #{Types::MODELS.join(", ")}"
-          end
-
-          validate_optional!(params, :aspect_ratio, Types::ASPECT_RATIOS)
-          validate_optional!(params, :output_count, Types::OUTPUT_COUNTS)
-        end
       end
     end
   end

data/lib/runapi/gpt_4o_image/types.rb

@@ -2,15 +2,16 @@
 
 module RunApi
   module Gpt4oImage
+    # GPT-4o Image response models.
+    # Supports pure generation, editing with source images, and inpainting with a mask.
     module Types
-      MODELS = %w[gpt-4o-image].freeze
-      ASPECT_RATIOS = %w[1:1 3:2 2:3].freeze
-      OUTPUT_COUNTS = [1, 2, 4].freeze
-
+      # A generated image with its CDN URL.
       class Image < RunApi::Core::BaseModel
         optional :url, String
       end
 
+      # Response for GPT-4o Image tasks. Progress contains an intermediate
+      # status string while the task is running.
       class TextToImageResponse < RunApi::Core::TaskResponse
         required :id, String
         optional :status, String, enum: -> { RunApi::Core::TaskResponse::Status::ALL }

data/lib/runapi/gpt_4o_image.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-gpt-4o-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 gpt-4o image api Ruby SDK is the language-specific package for GPT-4o
-  Image on RunAPI. Use this gpt-4o 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 GPT-4o Image Ruby SDK is the language-specific package for GPT-4o
+  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-gpt_4o_image.rb
 - lib/runapi/gpt_4o_image.rb
 - lib/runapi/gpt_4o_image/client.rb
+- lib/runapi/gpt_4o_image/contract_gen.rb
 - lib/runapi/gpt_4o_image/resources/text_to_image.rb
 - lib/runapi/gpt_4o_image/types.rb
 homepage: https://runapi.ai/models/gpt-4o-image
 licenses:
 - Apache-2.0
 metadata:
+  runapi_slug: gpt-4o-image
   homepage_uri: https://runapi.ai/models/gpt-4o-image
   documentation_uri: https://github.com/runapi-ai/gpt-4o-image-sdk/blob/main/ruby/README.md
   source_code_uri: https://github.com/runapi-ai/gpt-4o-image-sdk
+  bug_tracker_uri: https://github.com/runapi-ai/gpt-4o-image-sdk/issues
   changelog_uri: https://github.com/runapi-ai/gpt-4o-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: GPT-4o Image API Ruby SDK for RunAPI
+summary: GPT-4o Image Ruby SDK for RunAPI
 test_files: []