runapi-ideogram-v3 0.2.7 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dde03331810a873fb90e94add731e8b5ba2fb708b65793635ba116c62da37097
-  data.tar.gz: 30b5662428e00828dbe82f6a86c3d606cd250a1146bc2587bf634bda637985dd
+  metadata.gz: 9add18ecc621c7606bbd4f372ffa5ca4f95b1c889404ae120a7e1f50dc4eab27
+  data.tar.gz: 1fc686288d8ae18eb75fac174d46ab7eda7859d957e2ef55a6311028adb99d14
 SHA512:
-  metadata.gz: 844c94f0cc39f4f591ea2cef59d31f7db91b0a33e0901df371e027b3bb14e80ff12cacb73c295b039894a3236b6f047fee0d9ce6fa7b046b590c6502246677c9
-  data.tar.gz: 32848ec85bbdc5d9b57e2e45215260a0652a40053a9d7584061d6aeebabaa8ebc46cf96f831bfd55d7513d9a90b6ed22479e6c0c5842f1948cdb81f6e96db771
+  metadata.gz: 46995c95f202b96d5b9ef61a86161f61267f4e73a4df1f437e8f8999a43028c982acb1a7846f26c8c2fa574dd671fa670437935be98819c2788af432816c0b9d
+  data.tar.gz: 9babe9fe93c2469047f53bbc8691fb8eb142bddc6a100491ab52bc302b0b51da32136664b7afd20171109c4790a160af9fda60fd79cdc81e720d2b69de20c155

data/README.md

@@ -1,8 +1,8 @@
-# Ideogram API Ruby SDK for RunAPI
+# Ideogram V3 API Ruby SDK for RunAPI
 
-The ideogram api Ruby SDK is the language-specific package for Ideogram V3 on RunAPI. Use this ideogram api package for text-to-image, character reference generation, edit, remix, reframe, and creative production flows when your application needs JSON request bodies, task status lookup, and consistent RunAPI errors in Ruby.
+The Ideogram V3 Ruby SDK is the language-specific package for Ideogram V3 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 ideogram api README is the Ruby package guide inside the public `ideogram-v3-sdk` repository. For the repository overview, start at `../README.md`; for model details, use https://runapi.ai/models/ideogram-v3; for API reference, use https://runapi.ai/docs#ideogram-v3; for SDK docs, use https://runapi.ai/docs#sdk-ideogram-v3.
+This README is the Ruby package guide inside the public `ideogram-v3-sdk` repository. For the repository overview, start at `../README.md`; for model details, use https://runapi.ai/models/ideogram-v3; for API reference, use https://runapi.ai/docs#ideogram-v3; for SDK docs, use https://runapi.ai/docs#sdk-ideogram-v3.
 
 ## Install
 
@@ -13,7 +13,7 @@ gem install runapi-ideogram-v3
 ## Quick start
 
 ```ruby
-require "runapi-ideogram-v3"
+require "runapi/ideogram_v3"
 
 client = RunApi::IdeogramV3::Client.new
 task = client.text_to_image.create(

data/lib/runapi/ideogram_v3/contract_gen.rb

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+
+module RunApi
+  module IdeogramV3
+    CONTRACT = {
+      "edit-image" => {
+        "models" => ["ideogram-v3-character-edit", "ideogram-v3-edit"],
+        "fields_by_model" => {
+          "ideogram-v3-character-edit" => {
+            "mask_url" => {
+              "required" => true
+            },
+            "output_count" => {
+              "enum" => [1, 2, 3, 4],
+              "type" => "integer"
+            },
+            "reference_image_urls" => {
+              "required" => true
+            },
+            "rendering_speed" => {
+              "enum" => ["turbo", "balanced", "quality"]
+            },
+            "seed" => {
+              "type" => "integer"
+            },
+            "source_image_url" => {
+              "required" => true
+            },
+            "style" => {
+              "enum" => ["auto", "realistic", "fiction"]
+            }
+          },
+          "ideogram-v3-edit" => {
+            "mask_url" => {
+              "required" => true
+            },
+            "output_count" => {
+              "enum" => [1, 2, 3, 4],
+              "type" => "integer"
+            },
+            "rendering_speed" => {
+              "enum" => ["turbo", "balanced", "quality"]
+            },
+            "seed" => {
+              "type" => "integer"
+            },
+            "source_image_url" => {
+              "required" => true
+            }
+          }
+        }
+      },
+      "reframe-image" => {
+        "models" => ["ideogram-v3-reframe"],
+        "fields_by_model" => {
+          "ideogram-v3-reframe" => {
+            "aspect_ratio" => {
+              "enum" => ["1:1", "3:4", "9:16", "4:3", "16:9"]
+            },
+            "output_count" => {
+              "enum" => [1, 2, 3, 4],
+              "type" => "integer"
+            },
+            "rendering_speed" => {
+              "enum" => ["turbo", "balanced", "quality"]
+            },
+            "seed" => {
+              "type" => "integer"
+            },
+            "source_image_url" => {
+              "required" => true
+            },
+            "style" => {
+              "enum" => ["auto", "general", "realistic", "design"]
+            }
+          }
+        }
+      },
+      "remix-image" => {
+        "models" => ["ideogram-v3-character-remix", "ideogram-v3-remix"],
+        "fields_by_model" => {
+          "ideogram-v3-character-remix" => {
+            "aspect_ratio" => {
+              "enum" => ["1:1", "3:4", "9:16", "4:3", "16:9"]
+            },
+            "output_count" => {
+              "enum" => [1, 2, 3, 4],
+              "type" => "integer"
+            },
+            "reference_image_urls" => {
+              "required" => true
+            },
+            "rendering_speed" => {
+              "enum" => ["turbo", "balanced", "quality"]
+            },
+            "seed" => {
+              "type" => "integer"
+            },
+            "source_image_url" => {
+              "required" => true
+            },
+            "style" => {
+              "enum" => ["auto", "realistic", "fiction"]
+            }
+          },
+          "ideogram-v3-remix" => {
+            "aspect_ratio" => {
+              "enum" => ["1:1", "3:4", "9:16", "4:3", "16:9"]
+            },
+            "output_count" => {
+              "enum" => [1, 2, 3, 4],
+              "type" => "integer"
+            },
+            "rendering_speed" => {
+              "enum" => ["turbo", "balanced", "quality"]
+            },
+            "seed" => {
+              "type" => "integer"
+            },
+            "source_image_url" => {
+              "required" => true
+            },
+            "style" => {
+              "enum" => ["auto", "general", "realistic", "design"]
+            }
+          }
+        }
+      },
+      "text-to-image" => {
+        "models" => ["ideogram-v3-character", "ideogram-v3-text-to-image"],
+        "fields_by_model" => {
+          "ideogram-v3-character" => {
+            "aspect_ratio" => {
+              "enum" => ["1:1", "3:4", "9:16", "4:3", "16:9"]
+            },
+            "output_count" => {
+              "enum" => [1, 2, 3, 4],
+              "type" => "integer"
+            },
+            "reference_image_urls" => {
+              "required" => true
+            },
+            "rendering_speed" => {
+              "enum" => ["turbo", "balanced", "quality"]
+            },
+            "seed" => {
+              "type" => "integer"
+            },
+            "style" => {
+              "enum" => ["auto", "realistic", "fiction"]
+            }
+          },
+          "ideogram-v3-text-to-image" => {
+            "aspect_ratio" => {
+              "enum" => ["1:1", "3:4", "9:16", "4:3", "16:9"]
+            },
+            "output_count" => {
+              "enum" => [1, 2, 3, 4],
+              "type" => "integer"
+            },
+            "rendering_speed" => {
+              "enum" => ["turbo", "balanced", "quality"]
+            },
+            "seed" => {
+              "type" => "integer"
+            },
+            "style" => {
+              "enum" => ["auto", "general", "realistic", "design"]
+            }
+          }
+        }
+      }
+    }.freeze
+  end
+end

data/lib/runapi/ideogram_v3/resources/edit_image.rb

@@ -16,29 +16,26 @@ 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)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
-        def get(id)
-          request(:get, "#{ENDPOINT}/#{id}")
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
 
         private
 
         def validate_params!(params)
+          validate_contract!(CONTRACT["edit-image"], params)
           model = param(params, :model)
-          raise Core::ValidationError, "model is required" unless model
-          unless [Types::EDIT_MODEL, Types::CHARACTER_EDIT_MODEL].include?(model)
-            raise Core::ValidationError, "Invalid model: #{model}. Must be #{Types::EDIT_MODEL} or #{Types::CHARACTER_EDIT_MODEL}"
-          end
 
           prompt = param(params, :prompt)
           raise Core::ValidationError, "prompt is required" unless prompt.is_a?(String) && !prompt.empty?
@@ -46,10 +43,8 @@ module RunApi
             raise Core::ValidationError, "prompt must be at most #{PROMPT_MAX_LENGTH} characters"
           end
 
-          raise Core::ValidationError, "source_image_url is required" unless param(params, :source_image_url)
           raise Core::ValidationError, "mask_url is required" unless param(params, :mask_url)
 
-          validate_optional!(params, :rendering_speed, Types::RENDERING_SPEEDS)
           validate_character_fields!(params, model)
         end
 
@@ -57,18 +52,9 @@ module RunApi
           refs = param(params, :reference_image_urls)
           if model == Types::CHARACTER_EDIT_MODEL
             raise Core::ValidationError, "reference_image_urls is required" unless refs.is_a?(Array) && refs.any?
-            validate_optional!(params, :style, Types::CHARACTER_STYLES)
           elsif refs || param(params, :style)
             raise Core::ValidationError, "character edit fields are not supported for #{model}"
           end
-          validate_output_count!(params)
-        end
-
-        def validate_output_count!(params)
-          return unless (output_count = param(params, :output_count))
-          return if Types::OUTPUT_COUNTS.include?(output_count)
-
-          raise Core::ValidationError, "Invalid output_count: #{output_count}. Must be one of: #{Types::OUTPUT_COUNTS.join(", ")}"
         end
       end
     end

data/lib/runapi/ideogram_v3/resources/reframe_image.rb

@@ -15,44 +15,27 @@ 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)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
-        def get(id)
-          request(:get, "#{ENDPOINT}/#{id}")
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
 
         private
 
         def validate_params!(params)
-          model = param(params, :model)
-          raise Core::ValidationError, "model is required" unless model
-          unless model == Types::REFRAME_MODEL
-            raise Core::ValidationError, "Invalid model: #{model}. Must be #{Types::REFRAME_MODEL}"
-          end
+          validate_contract!(CONTRACT["reframe-image"], params)
 
-          raise Core::ValidationError, "source_image_url is required" unless param(params, :source_image_url)
           raise Core::ValidationError, "aspect_ratio is required" unless param(params, :aspect_ratio)
-
-          validate_optional!(params, :aspect_ratio, Types::ASPECT_RATIOS)
-          validate_optional!(params, :rendering_speed, Types::RENDERING_SPEEDS)
-          validate_optional!(params, :style, Types::STYLES)
-          validate_output_count!(params)
-        end
-
-        def validate_output_count!(params)
-          return unless (output_count = param(params, :output_count))
-          return if Types::OUTPUT_COUNTS.include?(output_count)
-
-          raise Core::ValidationError, "Invalid output_count: #{output_count}. Must be one of: #{Types::OUTPUT_COUNTS.join(", ")}"
         end
       end
     end

data/lib/runapi/ideogram_v3/resources/remix_image.rb

@@ -19,29 +19,26 @@ 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)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
-        def get(id)
-          request(:get, "#{ENDPOINT}/#{id}")
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
 
         private
 
         def validate_params!(params)
+          validate_contract!(CONTRACT["remix-image"], params)
           model = param(params, :model)
-          raise Core::ValidationError, "model is required" unless model
-          unless [Types::REMIX_MODEL, Types::CHARACTER_REMIX_MODEL].include?(model)
-            raise Core::ValidationError, "Invalid model: #{model}. Must be #{Types::REMIX_MODEL} or #{Types::CHARACTER_REMIX_MODEL}"
-          end
 
           prompt = param(params, :prompt)
           raise Core::ValidationError, "prompt is required" unless prompt.is_a?(String) && !prompt.empty?
@@ -49,20 +46,8 @@ module RunApi
             raise Core::ValidationError, "prompt must be at most #{PROMPT_MAX_LENGTH} characters"
           end
 
-          raise Core::ValidationError, "source_image_url is required" unless param(params, :source_image_url)
-
-          validate_optional!(params, :rendering_speed, Types::RENDERING_SPEEDS)
-          style_values = (model == Types::CHARACTER_REMIX_MODEL) ? Types::CHARACTER_STYLES : Types::STYLES
-          validate_optional!(params, :style, style_values)
-          validate_optional!(params, :aspect_ratio, Types::ASPECT_RATIOS)
           validate_character_fields!(params, model)
 
-          if (output_count = param(params, :output_count))
-            unless Types::OUTPUT_COUNTS.include?(output_count)
-              raise Core::ValidationError, "Invalid output_count: #{output_count}. Must be one of: #{Types::OUTPUT_COUNTS.join(", ")}"
-            end
-          end
-
           if (strength = param(params, :strength))
             numeric = Float(strength, exception: false)
             min = (model == Types::CHARACTER_REMIX_MODEL) ? CHARACTER_REMIX_STRENGTH_MIN : STRENGTH_MIN

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

@@ -16,29 +16,26 @@ 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)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
-        def get(id)
-          request(:get, "#{ENDPOINT}/#{id}")
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
 
         private
 
         def validate_params!(params)
+          validate_contract!(CONTRACT["text-to-image"], params)
           model = param(params, :model)
-          raise Core::ValidationError, "model is required" unless model
-          unless [Types::GENERATION_MODEL, Types::CHARACTER_MODEL].include?(model)
-            raise Core::ValidationError, "Invalid model: #{model}. Must be #{Types::GENERATION_MODEL} or #{Types::CHARACTER_MODEL}"
-          end
 
           prompt = param(params, :prompt)
           raise Core::ValidationError, "prompt is required" unless prompt.is_a?(String) && !prompt.empty?
@@ -46,12 +43,7 @@ module RunApi
             raise Core::ValidationError, "prompt must be at most #{PROMPT_MAX_LENGTH} characters"
           end
 
-          validate_optional!(params, :rendering_speed, Types::RENDERING_SPEEDS)
-          style_values = (model == Types::CHARACTER_MODEL) ? Types::CHARACTER_STYLES : Types::STYLES
-          validate_optional!(params, :style, style_values)
-          validate_optional!(params, :aspect_ratio, Types::ASPECT_RATIOS)
           validate_character_refs!(params, model)
-          validate_output_count!(params)
         end
 
         def validate_character_refs!(params, model)
@@ -62,14 +54,6 @@ module RunApi
             raise Core::ValidationError, "reference_image_urls is not supported for #{model}"
           end
         end
-
-        def validate_output_count!(params)
-          output_count = param(params, :output_count)
-          return unless output_count
-          return if Types::OUTPUT_COUNTS.include?(output_count)
-
-          raise Core::ValidationError, "Invalid output_count: #{output_count}. Must be one of: #{Types::OUTPUT_COUNTS.join(", ")}"
-        end
       end
     end
   end

data/lib/runapi/ideogram_v3/types.rb

@@ -5,23 +5,9 @@ module RunApi
     # Type definitions and constants for Ideogram V3.
     # Character model variants add character consistency from reference images.
     module Types
-      GENERATION_MODEL = "ideogram-v3-text-to-image"
-      EDIT_MODEL = "ideogram-v3-edit"
-      REMIX_MODEL = "ideogram-v3-remix"
       CHARACTER_MODEL = "ideogram-v3-character"
       CHARACTER_EDIT_MODEL = "ideogram-v3-character-edit"
       CHARACTER_REMIX_MODEL = "ideogram-v3-character-remix"
-      REFRAME_MODEL = "ideogram-v3-reframe"
-
-      # Speed-quality tradeoff: turbo is fastest, quality is highest fidelity.
-      RENDERING_SPEEDS = %w[turbo balanced quality].freeze
-      # Visual style presets for standard (non-character) models.
-      STYLES = %w[auto general realistic design].freeze
-      # Visual style presets for character-consistency models.
-      CHARACTER_STYLES = %w[auto realistic fiction].freeze
-      ASPECT_RATIOS = %w[1:1 3:4 9:16 4:3 16:9].freeze
-      # Number of images per request (1-4).
-      OUTPUT_COUNTS = [1, 2, 3, 4].freeze
 
       # A single generated image with its CDN URL.
       class Image < RunApi::Core::BaseModel

data/lib/runapi/ideogram_v3.rb

@@ -2,6 +2,7 @@
 
 require "runapi/core"
 require_relative "ideogram_v3/types"
+require_relative "ideogram_v3/contract_gen"
 require_relative "ideogram_v3/resources/text_to_image"
 require_relative "ideogram_v3/resources/edit_image"
 require_relative "ideogram_v3/resources/remix_image"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-ideogram-v3
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  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 ideogram api Ruby SDK is the language-specific package for Ideogram
-  V3 on RunAPI. Use this ideogram api package for text-to-image, character reference
-  generation, edit, remix, reframe, 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 Ideogram V3 Ruby SDK is the language-specific package for Ideogram
+  V3 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,6 +39,7 @@ files:
 - lib/runapi-ideogram_v3.rb
 - lib/runapi/ideogram_v3.rb
 - lib/runapi/ideogram_v3/client.rb
+- lib/runapi/ideogram_v3/contract_gen.rb
 - lib/runapi/ideogram_v3/resources/edit_image.rb
 - lib/runapi/ideogram_v3/resources/reframe_image.rb
 - lib/runapi/ideogram_v3/resources/remix_image.rb
@@ -48,9 +49,11 @@ homepage: https://runapi.ai/models/ideogram-v3
 licenses:
 - Apache-2.0
 metadata:
+  runapi_slug: ideogram-v3
   homepage_uri: https://runapi.ai/models/ideogram-v3
   documentation_uri: https://github.com/runapi-ai/ideogram-v3-sdk/blob/main/ruby/README.md
   source_code_uri: https://github.com/runapi-ai/ideogram-v3-sdk
+  bug_tracker_uri: https://github.com/runapi-ai/ideogram-v3-sdk/issues
   changelog_uri: https://github.com/runapi-ai/ideogram-v3-sdk/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
@@ -66,7 +69,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: Ideogram API Ruby SDK for RunAPI
+summary: Ideogram V3 API Ruby SDK for RunAPI
 test_files: []