runapi-nano-banana 0.2.4 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad7b97a266bf40926a5a50411bf11f7d39dee8be80fe47c7c97ef9ae3ef41684
-  data.tar.gz: '09678684916edba28b6a02e3df4bbbc4f6f6869b9447acce18c937eee67995c0'
+  metadata.gz: d6f82c6314ecf49b04a4288ac55dbde5361e2eeeb5b8fcdf897189bd9804902c
+  data.tar.gz: 25d20779667b0de9393725fee52f24ad38acc10ac623b634dcb343465b60688a
 SHA512:
-  metadata.gz: 945ae7da15e1c54507af064c254f4a9b417965cbd1bbfea947644e0dc69c516e9a6a34af43a842c941d45aeaabd84b17902d3cba8f9fcb2696351eb310a0c778
-  data.tar.gz: 102d78f223c3ccd3baef8525e41336418431fec1ade4b5785be0b78feb70ac0acb323b3142a2f2ff141032218f22298564bad872ae7f49a5f7d08c7428e9e03f
+  metadata.gz: 8f1dbb06ac32a0e5673b25b8aedaeb3e9ab287e939cf645452905eb0bd89d1eac9600b23bf9cfa5ca140c509fa3ad31bf7009459967d603d3b0a3b6bff6a4ab5
+  data.tar.gz: d1757bc0ef46c180d40a68e63cf40bade362839ec58aac9c96e7dc9abd05764b46e939dd21875191dbe12cf1b529df63860a15fde15529c075bcd6f2a4d57c5f

data/README.md

@@ -0,0 +1,45 @@
+# Nano Banana API 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.
+
+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.
+
+## Install
+
+```bash
+gem install runapi-nano-banana
+```
+
+## Quick start
+
+```ruby
+require "runapi-nano-banana"
+
+client = RunApi::NanoBanana::Client.new
+task = client.generations.create(
+  # Pass the Nano Banana JSON request body from https://runapi.ai/docs#nano-banana.
+)
+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::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.
+
+## Links
+
+- Model page: https://runapi.ai/models/nano-banana
+- SDK docs: https://runapi.ai/docs#sdk-nano-banana
+- Product docs: https://runapi.ai/docs#nano-banana
+- Pricing and rate limits: https://runapi.ai/models/nano-banana/nano-banana
+- Provider comparison: https://runapi.ai/providers/google
+- Full catalog: https://runapi.ai/models
+- Repository: https://github.com/runapi-ai/nano-banana-sdk
+
+## License
+
+Licensed under the Apache License, Version 2.0.

data/lib/runapi/nano_banana/client.rb

@@ -2,23 +2,25 @@
 
 module RunApi
   module NanoBanana
-    # NanoBanana image generation API client.
+    # NanoBanana image generation and editing API client.
+    #
+    # Three generation tiers: standard (fast), pro (higher resolution, more
+    # reference images), and v2 (longest prompts, extreme aspect ratios, up to
+    # 14 reference images). Editing uses the dedicated +nano-banana-edit+ model.
     #
     # @example
     #   client = RunApi::NanoBanana::Client.new(api_key: "your-api-key")
     #   result = client.text_to_image.run(
-    #     model: "flux-kontext-pro", prompt: "A futuristic cityscape"
+    #     model: "nano-banana-pro", prompt: "A futuristic cityscape"
     #   )
-    class Client
-      # @return [Resources::TextToImage] Image generation operations.
-      # @return [Resources::EditImage] Image editing operations.
-      attr_reader :text_to_image, :edit_image
+    class Client < RunApi::Core::Client
+      # @return [Resources::TextToImage] Generate images from text prompts with optional reference image guidance.
+      attr_reader :text_to_image
+      # @return [Resources::EditImage] Edit existing images using text prompts and source images.
+      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/nano_banana/resources/edit_image.rb

@@ -20,7 +20,7 @@ module RunApi
         # Edit an image and wait until complete.
         #
         # @param params [Hash] edit parameters
-        # @return [RunApi::NanoBanana::Types::CompletedEditImageResponse] completed edit with result URLs
+        # @return [RunApi::NanoBanana::Types::CompletedEditImageResponse] completed edit with image results
         def run(**params)
           task = create(**params)
           poll_until_complete { get(task.id) }
@@ -49,7 +49,7 @@ module RunApi
         def validate_params!(params)
           raise Core::ValidationError, "model is required" unless param(params, :model)
           raise Core::ValidationError, "prompt is required" unless param(params, :prompt)
-          raise Core::ValidationError, "image_urls is required" unless param(params, :image_urls)
+          raise Core::ValidationError, "source_image_urls is required" unless param(params, :source_image_urls)
 
           model = param(params, :model)
           unless Types::EDIT_MODELS.include?(model)
@@ -57,6 +57,7 @@ module RunApi
           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

@@ -20,7 +20,7 @@ module RunApi
         # Generate an image and wait until complete.
         #
         # @param params [Hash] generation parameters
-        # @return [RunApi::NanoBanana::Types::CompletedTextToImageResponse] completed generation with result URLs
+        # @return [RunApi::NanoBanana::Types::CompletedTextToImageResponse] completed generation with image results
         def run(**params)
           task = create(**params)
           poll_until_complete { get(task.id) }
@@ -56,7 +56,7 @@ module RunApi
           end
 
           validate_optional!(params, :aspect_ratio, Types::ASPECT_RATIOS)
-          validate_optional!(params, :resolution, Types::RESOLUTIONS)
+          validate_optional!(params, :output_resolution, Types::OUTPUT_RESOLUTIONS)
           validate_optional!(params, :output_format, Types::OUTPUT_FORMATS)
         end
       end

data/lib/runapi/nano_banana/types.rb

@@ -3,18 +3,22 @@
 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
 
-      IMAGE_SIZES = %w[1:1 9:16 16:9 3:4 4:3 3:2 2:3 5:4 4:5 21:9 auto].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
-      RESOLUTIONS = %w[1K 2K 4K].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 :id, String
         optional :url, String
-        optional :image_url, String
+        optional :origin_url, String
       end
 
       class AsyncTaskResponse < RunApi::Core::TaskResponse
@@ -23,24 +27,22 @@ module RunApi
       end
 
       class TextToImageResponse < AsyncTaskResponse
-        optional :result_urls, [ String ]
-        optional :image, -> { Image }
+        optional :images, [-> { Image }]
       end
 
       class EditImageResponse < AsyncTaskResponse
-        optional :result_urls, [ String ]
-        optional :image, -> { Image }
+        optional :images, [-> { Image }]
       end
 
       # Narrowed responses returned by `run()` methods once polling observes
-      # `status: "completed"`. `result_urls` is required so consumers never
+      # `status: "completed"`. `images` is required so consumers never
       # have to null-check it on a successful task.
       class CompletedTextToImageResponse < TextToImageResponse
-        required :result_urls, [ String ]
+        required :images, [-> { Image }]
       end
 
       class CompletedEditImageResponse < EditImageResponse
-        required :result_urls, [ String ]
+        required :images, [-> { Image }]
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-nano-banana
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.6
 platform: ruby
 authors:
 - RunAPI
@@ -15,22 +15,27 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: 0.2.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.4
-description: RunAPI Nano Banana SDK for JavaScript, Ruby, and Go
+        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.
 email:
 - contact@runapi.ai
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
 - LICENSE
+- README.md
 - lib/runapi-nano_banana.rb
 - lib/runapi/nano_banana.rb
 - lib/runapi/nano_banana/client.rb
@@ -42,7 +47,7 @@ licenses:
 - Apache-2.0
 metadata:
   homepage_uri: https://runapi.ai/models/nano-banana
-  documentation_uri: https://github.com/runapi-ai/nano-banana-sdk/blob/main/README.md
+  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
   changelog_uri: https://github.com/runapi-ai/nano-banana-sdk/blob/main/CHANGELOG.md
 rdoc_options: []
@@ -61,5 +66,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.10
 specification_version: 4
-summary: Nano Banana API SDKs for JavaScript, Ruby, and Go on RunAPI.
+summary: Nano Banana API Ruby SDK for RunAPI
 test_files: []