runapi-topaz 0.2.1 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e86dbb9f547efb7a1c3bbbf9ad5f1f30f7a3b2e8a682ce6821f96578d7e3fc36
-  data.tar.gz: d9fedb3f0ddd26c9a7c0ed24385e50f37004e3522e42974f84b07392d35062f6
+  metadata.gz: 40f94d07e2d993a379822f44b3a4c56e630472b9ec8a0a882c38d746f223206f
+  data.tar.gz: f8649bed0ba63f962c14e335546b81dc2d6ec61304b51976309d5bd076e39f23
 SHA512:
-  metadata.gz: 97f076f67882de3898f7e0956f626f93cbc4e62f7dfde553f614f5d560824ba52ee854754744dd2cbcddf61510a64f41078afb03646c3cae65bbdc514870815f
-  data.tar.gz: 80cc131adf8bac5eca114001426c96ecbc461ef09dfcb1a4687d5b8393998ed4172c983a3f08e8a34dcf07eb892b082f46f68a44214748394780ec567483c2f9
+  metadata.gz: 59b8eee6de311173b3cd3159918352d2a6ae98714e3ec99d730dfaad9d27e3be87ac185fd76a6a9f20e2cfcbf3fa04f4a86cd6001c5c44474ee997164f27b3fb
+  data.tar.gz: 196b238d9eb37a8aecc2574515778dd46469ad2239d9015731cb2599db57e9aadacabfaebedb5797a0930f1fca120d07ea4a352721b7896989ca30139e3401ac

data/README.md

@@ -0,0 +1,43 @@
+# Topaz API Ruby SDK for RunAPI
+
+The topaz api Ruby SDK is the language-specific package for Topaz on RunAPI. Use this topaz api package for image upscale, video upscale, restoration, and production cleanup flows when your application needs JSON request bodies, task status lookup, and consistent RunAPI errors in Ruby.
+
+This topaz api README is the Ruby package guide inside the public `topaz-sdk` repository. For the repository overview, start at `../README.md`; for model details, use https://runapi.ai/models/topaz; for API reference, use https://runapi.ai/docs#topaz; for SDK docs, use https://runapi.ai/docs#sdk-topaz.
+
+## Install
+
+```bash
+gem install runapi-topaz
+```
+
+## Quick start
+
+```ruby
+require "runapi-topaz"
+
+client = RunApi::Topaz::Client.new
+task = client.image_upscales.create(
+  # Pass the Topaz JSON request body from https://runapi.ai/docs#topaz.
+)
+status = client.image_upscales.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.
+
+## Language notes
+
+Use Ruby keyword arguments and the `RunApi::Topaz` error classes when building upscaling jobs, Rails workers, or scripts. The available resources include image upscales, and video upscales. 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/topaz
+- SDK docs: https://runapi.ai/docs#sdk-topaz
+- Product docs: https://runapi.ai/docs#topaz
+- Pricing and rate limits: https://runapi.ai/models/topaz/upscale-image
+- Provider comparison: https://runapi.ai/providers/topaz
+- Full catalog: https://runapi.ai/models
+- Repository: https://github.com/runapi-ai/topaz-sdk
+
+## License
+
+Licensed under the Apache License, Version 2.0.

data/lib/runapi/topaz/resources/upscale_image.rb

@@ -34,11 +34,11 @@ module RunApi
 
         def validate_params!(params)
           raise Core::ValidationError, "model is required" unless param(params, :model) == Types::UPSCALE_IMAGE_MODEL
-          raise Core::ValidationError, "image_url is required" unless param(params, :image_url)
+          raise Core::ValidationError, "source_image_url is required" unless param(params, :source_image_url)
 
           factor = param(params, :upscale_factor)
           raise Core::ValidationError, "upscale_factor is required" unless factor
-          return if Types::UPSCALE_IMAGE_FACTORS.include?(factor.to_s)
+          return if Types::UPSCALE_IMAGE_FACTORS.include?(factor)
 
           raise Core::ValidationError, "upscale_factor must be one of: #{Types::UPSCALE_IMAGE_FACTORS.join(", ")}"
         end

data/lib/runapi/topaz/resources/upscale_video.rb

@@ -34,10 +34,10 @@ module RunApi
 
         def validate_params!(params)
           raise Core::ValidationError, "model is required" unless param(params, :model) == Types::UPSCALE_VIDEO_MODEL
-          raise Core::ValidationError, "video_url is required" unless param(params, :video_url)
+          raise Core::ValidationError, "source_video_url is required" unless param(params, :source_video_url)
 
           factor = param(params, :upscale_factor)
-          return unless factor && !Types::UPSCALE_VIDEO_FACTORS.include?(factor.to_s)
+          return unless factor && !Types::UPSCALE_VIDEO_FACTORS.include?(factor)
 
           raise Core::ValidationError, "upscale_factor must be one of: #{Types::UPSCALE_VIDEO_FACTORS.join(", ")}"
         end

data/lib/runapi/topaz/types.rb

@@ -3,10 +3,10 @@
 module RunApi
   module Topaz
     module Types
-      UPSCALE_IMAGE_MODEL = "topaz-image-upscale"
-      UPSCALE_VIDEO_MODEL = "topaz-video-upscale"
-      UPSCALE_IMAGE_FACTORS = %w[1 2 4 8].freeze
-      UPSCALE_VIDEO_FACTORS = %w[1 2 4].freeze
+      UPSCALE_IMAGE_MODEL = "topaz-upscale-image"
+      UPSCALE_VIDEO_MODEL = "topaz-upscale-video"
+      UPSCALE_IMAGE_FACTORS = [1, 2, 4, 8].freeze
+      UPSCALE_VIDEO_FACTORS = [1, 2, 4].freeze
 
       class Image < RunApi::Core::BaseModel
         optional :url, String
@@ -19,23 +19,23 @@ module RunApi
       class UpscaleImageResponse < RunApi::Core::TaskResponse
         required :id, String
         optional :status, String, enum: -> { RunApi::Core::TaskResponse::Status::ALL }
-        optional :images, [ -> { Image } ]
+        optional :images, [-> { Image }]
         optional :error, String
       end
 
       class UpscaleVideoResponse < RunApi::Core::TaskResponse
         required :id, String
         optional :status, String, enum: -> { RunApi::Core::TaskResponse::Status::ALL }
-        optional :videos, [ -> { Video } ]
+        optional :videos, [-> { Video }]
         optional :error, String
       end
 
       class CompletedUpscaleImageResponse < UpscaleImageResponse
-        required :images, [ -> { Image } ]
+        required :images, [-> { Image }]
       end
 
       class CompletedUpscaleVideoResponse < UpscaleVideoResponse
-        required :videos, [ -> { Video } ]
+        required :videos, [-> { Video }]
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-topaz
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.5
 platform: ruby
 authors:
 - RunAPI
@@ -15,22 +15,27 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.2.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
-description: RunAPI Topaz SDK for JavaScript, Ruby, and Go
+        version: 0.2.5
+description: The topaz api Ruby SDK is the language-specific package for Topaz on
+  RunAPI. Use this topaz api package for image upscale, video upscale, restoration,
+  and production cleanup 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-topaz.rb
 - lib/runapi/topaz.rb
 - lib/runapi/topaz/client.rb
@@ -42,7 +47,7 @@ licenses:
 - Apache-2.0
 metadata:
   homepage_uri: https://runapi.ai/models/topaz
-  documentation_uri: https://runapi.ai/models/topaz
+  documentation_uri: https://github.com/runapi-ai/topaz-sdk/blob/main/ruby/README.md
   source_code_uri: https://github.com/runapi-ai/topaz-sdk
   changelog_uri: https://github.com/runapi-ai/topaz-sdk/blob/main/CHANGELOG.md
 rdoc_options: []
@@ -59,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 4.0.10
 specification_version: 4
-summary: Topaz API SDKs for JavaScript, Ruby, and Go on RunAPI.
+summary: Topaz API Ruby SDK for RunAPI
 test_files: []