runapi-flux-kontext 0.2.6 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7a15941bf71d6217337b7d0dfa6b1136a57f2f9763c24b3a1d4aed5533d8278
-  data.tar.gz: 0b126bee144555fba38ffe81675fdbef5933c3eb21017e54c70e86cf75a2c96f
+  metadata.gz: 57ca847ab8beff9fed385c42627d4cd19e78861ace2358203947dce22b607e18
+  data.tar.gz: e36181fc9c66c936e0bfa9a208bbd8c443ca8287d972df51b912cd254564a5b1
 SHA512:
-  metadata.gz: 43a7d9be562a0877a517d0a36fe7c485f82e6ea543443787fc158721de1e968661108d0f6875a61da7e115856987384f1c9bb254f7ee239ac10b4458d5ca515c
-  data.tar.gz: 9c441b767fb721514c06266d43a3198599c27ac597b79c7cac0c8b0e630766844221a0b9f00d99d8363c5e1e38eca88ebc3d37f8272f9a74c90453ab0fa51723
+  metadata.gz: 0441a5627c3f9d02e09a7bafb89ba0b091b2f516328980ee813e338a36b9f2758dc53401ba8f90b6dcab6ca30f156d3fc667e0d5941362b034f36dacf649f73f
+  data.tar.gz: 6b32f79fcc8ef6cd0639d95a26d4737f95ae9e959b72bc7db553b35f56a76dcab073a6c110f09eb3d6948e74a8c738a7e682c827227f969f64871d0d301f6b60

data/README.md

@@ -1,8 +1,8 @@
-# Flux Kontext API Ruby SDK for RunAPI
+# Flux Kontext Ruby SDK for RunAPI
 
-The flux kontext api Ruby SDK is the language-specific package for Flux Kontext on RunAPI. Use this flux kontext 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 Flux Kontext Ruby SDK is the language-specific package for Flux Kontext 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 flux kontext api README is the Ruby package guide inside the public `flux-kontext-sdk` repository. For the repository overview, start at `../README.md`; for model details, use https://runapi.ai/models/flux-kontext; for API reference, use https://runapi.ai/docs#flux-kontext; for SDK docs, use https://runapi.ai/docs#sdk-flux-kontext.
+This README is the Ruby package guide inside the public `flux-kontext-sdk` repository. For the repository overview, start at `../README.md`; for model details, use https://runapi.ai/models/flux-kontext; for API reference, use https://runapi.ai/docs#flux-kontext; for SDK docs, use https://runapi.ai/docs#sdk-flux-kontext.
 
 ## Install
 
@@ -13,13 +13,13 @@ gem install runapi-flux-kontext
 ## Quick start
 
 ```ruby
-require "runapi-flux-kontext"
+require "runapi/flux_kontext"
 
 client = RunApi::FluxKontext::Client.new
-task = client.generations.create(
+task = client.text_to_image.create(
   # Pass the Flux Kontext JSON request body from https://runapi.ai/docs#flux-kontext.
 )
-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::FluxKontext` 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::FluxKontext` 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/flux_kontext/contract_gen.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module RunApi
+  module FluxKontext
+    CONTRACT = {
+      "text-to-image" => {
+        "models" => ["flux-kontext-max", "flux-kontext-pro"],
+        "fields_by_model" => {
+          "flux-kontext-max" => {
+            "aspect_ratio" => {
+              "enum" => ["21:9", "16:9", "4:3", "1:1", "3:4", "9:16"]
+            },
+            "model" => {
+              "required" => true
+            },
+            "output_format" => {
+              "enum" => ["jpeg", "png"]
+            },
+            "prompt" => {
+              "required" => true
+            },
+            "safety_tolerance" => {
+              "type" => "integer"
+            }
+          },
+          "flux-kontext-pro" => {
+            "aspect_ratio" => {
+              "enum" => ["21:9", "16:9", "4:3", "1:1", "3:4", "9:16"]
+            },
+            "model" => {
+              "required" => true
+            },
+            "output_format" => {
+              "enum" => ["jpeg", "png"]
+            },
+            "prompt" => {
+              "required" => true
+            },
+            "safety_tolerance" => {
+              "type" => "integer"
+            }
+          }
+        }
+      }
+    }.freeze
+  end
+end

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

@@ -21,42 +21,27 @@ module RunApi
         #
         # @param params [Hash] generation parameters
         # @return [RunApi::FluxKontext::Types::CompletedTextToImageResponse] completed generation with images
-        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
 
         # Create an image generation task.
         #
         # @param params [Hash] generation parameters
         # @return [RunApi::FluxKontext::Types::TextToImageResponse] task creation result with id
-        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
 
         # Get generation status by task ID.
         #
         # @param id [String] task ID
         # @return [RunApi::FluxKontext::Types::TextToImageResponse] current generation status
-        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)
-
-          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)
-          validate_optional!(params, :output_format, Types::OUTPUT_FORMATS)
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
       end
     end

data/lib/runapi/flux_kontext/types.rb

@@ -3,11 +3,6 @@
 module RunApi
   module FluxKontext
     module Types
-      MODELS = %w[flux-kontext-pro flux-kontext-max].freeze
-
-      ASPECT_RATIOS = %w[21:9 16:9 4:3 1:1 3:4 9:16].freeze
-      OUTPUT_FORMATS = %w[jpeg png].freeze
-
       class Image < RunApi::Core::BaseModel
         optional :url, String
         optional :origin_url, String

data/lib/runapi/flux_kontext.rb

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

metadata

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