runapi-nano-banana 0.2.6 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6f82c6314ecf49b04a4288ac55dbde5361e2eeeb5b8fcdf897189bd9804902c
-  data.tar.gz: 25d20779667b0de9393725fee52f24ad38acc10ac623b634dcb343465b60688a
+  metadata.gz: 3737c1cd6272c4da25d7e643354bd6994e1e5f7deecf0d8e50a477498aaf4069
+  data.tar.gz: 91c62e9bf1e746a6aff3e3532045d3a44fee21bc11ee745ed4927d5bb2f9e823
 SHA512:
-  metadata.gz: 8f1dbb06ac32a0e5673b25b8aedaeb3e9ab287e939cf645452905eb0bd89d1eac9600b23bf9cfa5ca140c509fa3ad31bf7009459967d603d3b0a3b6bff6a4ab5
-  data.tar.gz: d1757bc0ef46c180d40a68e63cf40bade362839ec58aac9c96e7dc9abd05764b46e939dd21875191dbe12cf1b529df63860a15fde15529c075bcd6f2a4d57c5f
+  metadata.gz: e336b5616cbb7537a6c7f12df8d5e18536c397af22d656549cf6e57f867b2b30e33265f1892f9b128cb2187695063f6e71896bb6e893088133c033c1ba21c70e
+  data.tar.gz: 6029e2fd0b8b712b86ca2ff62c9c397a0479478630f4f77a10305e9608eb7961bfaf695f0a4947b0dd4dccc3111bf237d49fcf9f8c94d64c7c66dd95ea7c5397

data/README.md

@@ -1,8 +1,8 @@
-# Nano Banana API Ruby SDK for RunAPI
+# Nano Banana Ruby SDK for RunAPI
 
-The nano banana api Ruby SDK is the language-specific package for Nano Banana on RunAPI. Use this nano banana 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 Nano Banana Ruby SDK is the language-specific package for Nano Banana 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 nano banana api README is the Ruby package guide inside the public `nano-banana-sdk` repository. For the repository overview, start at `../README.md`; for model details, use https://runapi.ai/models/nano-banana; for API reference, use https://runapi.ai/docs#nano-banana; for SDK docs, use https://runapi.ai/docs#sdk-nano-banana.
+This README is the Ruby package guide inside the public `nano-banana-sdk` repository. For the repository overview, start at `../README.md`; for model details, use https://runapi.ai/models/nano-banana; for API reference, use https://runapi.ai/docs#nano-banana; for SDK docs, use https://runapi.ai/docs#sdk-nano-banana.
 
 ## Install
 
@@ -13,13 +13,13 @@ gem install runapi-nano-banana
 ## Quick start
 
 ```ruby
-require "runapi-nano-banana"
+require "runapi/nano_banana"
 
 client = RunApi::NanoBanana::Client.new
-task = client.generations.create(
+task = client.text_to_image.create(
   # Pass the Nano Banana JSON request body from https://runapi.ai/docs#nano-banana.
 )
-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::NanoBanana` 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.
+Use Ruby keyword arguments and the `RunApi::NanoBanana` error classes when building image jobs, Rails workers, or scripts. The available resources are `text_to_image` and `edit_image`. Keep `RUNAPI_API_KEY` in the environment or your secret manager; never commit API keys or callback secrets.
 
 ## Links
 

data/lib/runapi/nano_banana/contract_gen.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module RunApi
+  module NanoBanana
+    CONTRACT = {
+      "edit-image" => {
+        "models" => ["nano-banana-edit"],
+        "fields_by_model" => {
+          "nano-banana-edit" => {
+            "aspect_ratio" => {
+              "enum" => ["1:1", "9:16", "16:9", "3:4", "4:3", "3:2", "2:3", "5:4", "4:5", "21:9", "auto"]
+            },
+            "output_format" => {
+              "enum" => ["png", "jpeg"]
+            },
+            "source_image_urls" => {
+              "required" => true
+            }
+          }
+        }
+      },
+      "text-to-image" => {
+        "models" => ["nano-banana", "nano-banana-2", "nano-banana-2-lite", "nano-banana-pro"],
+        "fields_by_model" => {
+          "nano-banana" => {
+            "aspect_ratio" => {
+              "enum" => ["1:1", "9:16", "16:9", "3:4", "4:3", "3:2", "2:3", "5:4", "4:5", "21:9", "auto"]
+            },
+            "output_format" => {
+              "enum" => ["png", "jpeg", "jpg"]
+            }
+          },
+          "nano-banana-2" => {
+            "aspect_ratio" => {
+              "enum" => ["1:1", "1:4", "1:8", "2:3", "3:2", "3:4", "4:1", "4:3", "4:5", "5:4", "8:1", "9:16", "16:9", "21:9", "auto"]
+            },
+            "output_format" => {
+              "enum" => ["png", "jpeg", "jpg"]
+            },
+            "output_resolution" => {
+              "enum" => ["1k", "2k", "4k"]
+            }
+          },
+          "nano-banana-2-lite" => {
+            "aspect_ratio" => {
+              "enum" => ["1:1", "1:4", "1:8", "2:3", "3:2", "3:4", "4:1", "4:3", "4:5", "5:4", "8:1", "9:16", "16:9", "21:9", "auto"],
+              "required" => true
+            },
+            "prompt" => {
+              "required" => true,
+              "min" => 1,
+              "max" => 20000,
+              "length" => true
+            }
+          },
+          "nano-banana-pro" => {
+            "aspect_ratio" => {
+              "enum" => ["1:1", "2:3", "3:2", "3:4", "4:3", "4:5", "5:4", "9:16", "16:9", "21:9", "auto"]
+            },
+            "output_format" => {
+              "enum" => ["png", "jpeg", "jpg"]
+            },
+            "output_resolution" => {
+              "enum" => ["1k", "2k", "4k"]
+            }
+          }
+        },
+        "rules" => [{
+          "when" => {
+            "model" => "nano-banana-2-lite"
+          },
+          "forbidden" => ["output_resolution", "output_format"]
+        }]
+      }
+    }.freeze
+  end
+end

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

@@ -21,43 +21,36 @@ module RunApi
         #
         # @param params [Hash] edit parameters
         # @return [RunApi::NanoBanana::Types::CompletedEditImageResponse] completed edit with image results
-        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 edit task.
         #
         # @param params [Hash] edit parameters
         # @return [RunApi::NanoBanana::Types::EditImageResponse] 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)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
         # Get edit status by task ID.
         #
         # @param id [String] task ID
         # @return [RunApi::NanoBanana::Types::EditImageResponse] current edit status
-        def get(id)
-          request(:get, "#{ENDPOINT}/#{id}")
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
 
         private
 
         def validate_params!(params)
-          raise Core::ValidationError, "model is required" unless param(params, :model)
+          validate_contract!(CONTRACT["edit-image"], params)
+
           raise Core::ValidationError, "prompt is required" unless param(params, :prompt)
           raise Core::ValidationError, "source_image_urls is required" unless param(params, :source_image_urls)
-
-          model = param(params, :model)
-          unless Types::EDIT_MODELS.include?(model)
-            raise Core::ValidationError, "Invalid model: #{model}. Must be one of: #{Types::EDIT_MODELS.join(", ")}"
-          end
-
-          validate_optional!(params, :output_format, Types::OUTPUT_FORMATS)
-          validate_optional!(params, :aspect_ratio, Types::BASE_ASPECT_RATIOS)
         end
       end
     end

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

@@ -19,45 +19,44 @@ module RunApi
 
         # Generate an image and wait until complete.
         #
-        # @param params [Hash] generation parameters
+        # @param params [Hash] generation parameters (see {#create} for accepted keys)
         # @return [RunApi::NanoBanana::Types::CompletedTextToImageResponse] completed generation with image results
-        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
+        # @option params [String] :model model slug, e.g. "nano-banana", "nano-banana-pro", "nano-banana-2", "nano-banana-2-lite"
+        # @option params [String] :prompt required; image description
+        # @option params [String] :aspect_ratio optional; required for nano-banana-2-lite
+        # @option params [String] :output_format optional; "png", "jpeg", or "jpg" (not supported by nano-banana-2-lite)
+        # @option params [String] :output_resolution optional; "1k", "2k", or "4k" (nano-banana-pro / nano-banana-2)
+        # @option params [Array<String>] :reference_image_urls optional; reference image URLs for visual
+        #   guidance (nano-banana / nano-banana-pro up to 8, nano-banana-2 up to 14, nano-banana-2-lite up to 10; <=30MB each)
         # @return [RunApi::NanoBanana::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)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
         # Get generation status by task ID.
         #
         # @param id [String] task ID
         # @return [RunApi::NanoBanana::Types::TextToImageResponse] current generation status
-        def get(id)
-          request(:get, "#{ENDPOINT}/#{id}")
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         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)
+          validate_contract!(CONTRACT["text-to-image"], params)
 
-          model = param(params, :model)
-          unless Types::GENERATION_MODELS.include?(model)
-            raise Core::ValidationError, "Invalid model: #{model}. Must be one of: #{Types::GENERATION_MODELS.join(", ")}"
-          end
-
-          validate_optional!(params, :aspect_ratio, Types::ASPECT_RATIOS)
-          validate_optional!(params, :output_resolution, Types::OUTPUT_RESOLUTIONS)
-          validate_optional!(params, :output_format, Types::OUTPUT_FORMATS)
+          raise Core::ValidationError, "prompt is required" unless param(params, :prompt)
         end
       end
     end

data/lib/runapi/nano_banana/types.rb

@@ -3,18 +3,6 @@
 module RunApi
   module NanoBanana
     module Types
-      # Generation tiers: standard (fast), pro (higher res + more refs), v2 (longest prompts + extreme ratios).
-      GENERATION_MODELS = %w[nano-banana nano-banana-pro nano-banana-2].freeze
-      # Dedicated editing model. Requires source images to transform.
-      EDIT_MODELS = %w[nano-banana-edit].freeze
-
-      BASE_ASPECT_RATIOS = %w[1:1 9:16 16:9 3:4 4:3 3:2 2:3 5:4 4:5 21:9 auto].freeze
-      # Full aspect ratio set including extreme panoramic ratios (1:4, 1:8, 4:1, 8:1) for v2.
-      ASPECT_RATIOS = %w[1:1 1:4 1:8 2:3 3:2 3:4 4:1 4:3 4:5 5:4 8:1 9:16 16:9 21:9 auto].freeze
-      # Output resolution tiers. Pro and v2 default to 1k; higher tiers increase generation time.
-      OUTPUT_RESOLUTIONS = %w[1k 2k 4k].freeze
-      OUTPUT_FORMATS = %w[png jpg jpeg].freeze
-
       # A single generated or edited image result.
       class Image < RunApi::Core::BaseModel
         optional :url, String

data/lib/runapi/nano_banana.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-nano-banana
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.9
 platform: ruby
 authors:
 - RunAPI
@@ -15,18 +15,18 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.6
+        version: 0.2.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.6
-description: The nano banana api Ruby SDK is the language-specific package for Nano
-  Banana on RunAPI. Use this nano banana 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.9
+description: The Nano Banana Ruby SDK is the language-specific package for Nano Banana
+  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-nano_banana.rb
 - lib/runapi/nano_banana.rb
 - lib/runapi/nano_banana/client.rb
+- lib/runapi/nano_banana/contract_gen.rb
 - lib/runapi/nano_banana/resources/edit_image.rb
 - lib/runapi/nano_banana/resources/text_to_image.rb
 - lib/runapi/nano_banana/types.rb
@@ -46,9 +47,11 @@ homepage: https://runapi.ai/models/nano-banana
 licenses:
 - Apache-2.0
 metadata:
+  runapi_slug: nano-banana
   homepage_uri: https://runapi.ai/models/nano-banana
   documentation_uri: https://github.com/runapi-ai/nano-banana-sdk/blob/main/ruby/README.md
   source_code_uri: https://github.com/runapi-ai/nano-banana-sdk
+  bug_tracker_uri: https://github.com/runapi-ai/nano-banana-sdk/issues
   changelog_uri: https://github.com/runapi-ai/nano-banana-sdk/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
@@ -66,5 +69,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.10
 specification_version: 4
-summary: Nano Banana API Ruby SDK for RunAPI
+summary: Nano Banana Ruby SDK for RunAPI
 test_files: []