runapi-topaz 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bb62f2b5c763e463433c6a31953baaf2f0f6fe9d2586898149e759b2b7a4544
-  data.tar.gz: 2890b5d76de93833bb898c9d2ad25eee601dc3597db7d35e1f332f3d3499b199
+  metadata.gz: 52dc7160d3ead033cba7dcfd96c3e5b8d2155a76c2f2a7a0ff43b5525a4e6f38
+  data.tar.gz: e2ccac89059ab9e7c30353e2ec249a22957fc15eba0dc25d2818d52d703ebf46
 SHA512:
-  metadata.gz: 52ede417926cb5fffe3af6af0dd5e5a9e00ccb2cbb73ca86be7b963a94ee1dd04c913b4c05817a0ab34c9eafcca34c90bf936fef8fa21ef8f575d3ed03abaf34
-  data.tar.gz: 4d0496f468fd8c1277420c461cb7856e61efe269dc17614836c25da379104f42e9574b4b04f8d69885e458956ab60b52e3d1febaf3e62bf22edddc40f3192bf9
+  metadata.gz: 1de31db31fd7c9740230ad62de53cc32e07211e3914e6e0ec3acd45871f3055c0bcb0fd7423b1ba4364796d5f9a120cd1bd07948a7d6f3ceb34ad1ae35864f21
+  data.tar.gz: d635d7b485ffe75a77cb1999a4ecbf98310d9f5ae6f745a3035ef1d469b87f5838c9bc0a01d2b4052f12e23787ae4ac0ab4c82443a0a22c03c3aa91ce97344b0

data/README.md

@@ -1,8 +1,8 @@
-# Topaz API Ruby SDK for RunAPI
+# Topaz 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.
+The Topaz Ruby SDK is the language-specific package for Topaz on RunAPI. Use this package for image upscale, video upscale, restoration, and production cleanup workflows when your application needs 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.
+This 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
 
@@ -16,10 +16,10 @@ gem install runapi-topaz
 require "runapi-topaz"
 
 client = RunApi::Topaz::Client.new
-task = client.image_upscales.create(
+task = client.upscale_image.create(
   # Pass the Topaz JSON request body from https://runapi.ai/docs#topaz.
 )
-status = client.image_upscales.get(task.id)
+status = client.upscale_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::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.
+Use Ruby keyword arguments and the `RunApi::Topaz` error classes when building upscaling jobs, Rails workers, or scripts. The available resources are `upscale_image` and `upscale_video`. Keep `RUNAPI_API_KEY` in the environment or your secret manager; never commit API keys or callback secrets.
 
 ## Links
 

data/lib/runapi/topaz/client.rb

@@ -8,7 +8,7 @@ module RunApi
     #   client = RunApi::Topaz::Client.new(api_key: "sk-...")
     #   result = client.upscale_image.run(
     #     model: "topaz-upscale-image",
-    #     source_image_url: "https://example.com/photo.jpg",
+    #     source_image_url: "https://cdn.runapi.ai/public/samples/image.jpg",
     #     upscale_factor: 2
     #   )
     #   puts result.images.first.url

data/lib/runapi/topaz/contract_gen.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module RunApi
+  module Topaz
+    CONTRACT = {
+      "upscale-image" => {
+        "models" => ["topaz-upscale-image"],
+        "fields_by_model" => {
+          "topaz-upscale-image" => {
+            "source_image_url" => {
+              "required" => true
+            },
+            "upscale_factor" => {
+              "enum" => [1, 2, 4, 8],
+              "required" => true,
+              "type" => "integer"
+            }
+          }
+        }
+      },
+      "upscale-video" => {
+        "models" => ["topaz-upscale-video"],
+        "fields_by_model" => {
+          "topaz-upscale-video" => {
+            "source_video_url" => {
+              "required" => true
+            },
+            "upscale_factor" => {
+              "enum" => [1, 2, 4],
+              "type" => "integer"
+            }
+          }
+        }
+      }
+    }.freeze
+  end
+end

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

@@ -24,26 +24,13 @@ module RunApi
 
         def create(**params)
           params = compact_params(params)
-          validate_params!(params)
+          validate_contract!(CONTRACT["upscale-image"], params)
           request(:post, ENDPOINT, body: params)
         end
 
         def get(id)
           request(:get, "#{ENDPOINT}/#{id}")
         end
-
-        private
-
-        def validate_params!(params)
-          raise Core::ValidationError, "model is required" unless param(params, :model) == Types::UPSCALE_IMAGE_MODEL
-          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)
-
-          raise Core::ValidationError, "upscale_factor must be one of: #{Types::UPSCALE_IMAGE_FACTORS.join(", ")}"
-        end
       end
     end
   end

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

@@ -24,25 +24,13 @@ module RunApi
 
         def create(**params)
           params = compact_params(params)
-          validate_params!(params)
+          validate_contract!(CONTRACT["upscale-video"], params)
           request(:post, ENDPOINT, body: params)
         end
 
         def get(id)
           request(:get, "#{ENDPOINT}/#{id}")
         end
-
-        private
-
-        def validate_params!(params)
-          raise Core::ValidationError, "model is required" unless param(params, :model) == Types::UPSCALE_VIDEO_MODEL
-          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)
-
-          raise Core::ValidationError, "upscale_factor must be one of: #{Types::UPSCALE_VIDEO_FACTORS.join(", ")}"
-        end
       end
     end
   end

data/lib/runapi/topaz/types.rb

@@ -2,17 +2,8 @@
 
 module RunApi
   module Topaz
-    # Type definitions and constants for the Topaz upscaling API.
+    # Response models for the Topaz upscaling API.
     module Types
-      # Image upscaling model slug.
-      UPSCALE_IMAGE_MODEL = "topaz-upscale-image"
-      # Video upscaling model slug.
-      UPSCALE_VIDEO_MODEL = "topaz-upscale-video"
-      # Allowed image upscale factors. Higher factors produce larger output but take longer.
-      UPSCALE_IMAGE_FACTORS = [1, 2, 4, 8].freeze
-      # Allowed video upscale factors. Max 4x (8x is not supported for video).
-      UPSCALE_VIDEO_FACTORS = [1, 2, 4].freeze
-
       # URL to an upscaled image.
       class Image < RunApi::Core::BaseModel
         optional :url, String

data/lib/runapi/topaz.rb

@@ -2,6 +2,7 @@
 
 require "runapi/core"
 require_relative "topaz/types"
+require_relative "topaz/contract_gen"
 require_relative "topaz/resources/upscale_image"
 require_relative "topaz/resources/upscale_video"
 require_relative "topaz/client"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-topaz
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - RunAPI
@@ -15,18 +15,18 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.6
+        version: 0.2.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.6
-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.
+        version: 0.2.7
+description: The Topaz Ruby SDK is the language-specific package for Topaz on RunAPI.
+  Use this package for image upscale, video upscale, restoration, and production cleanup
+  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-topaz.rb
 - lib/runapi/topaz.rb
 - lib/runapi/topaz/client.rb
+- lib/runapi/topaz/contract_gen.rb
 - lib/runapi/topaz/resources/upscale_image.rb
 - lib/runapi/topaz/resources/upscale_video.rb
 - lib/runapi/topaz/types.rb
@@ -46,9 +47,11 @@ homepage: https://runapi.ai/models/topaz
 licenses:
 - Apache-2.0
 metadata:
+  runapi_slug: topaz
   homepage_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
+  bug_tracker_uri: https://github.com/runapi-ai/topaz-sdk/issues
   changelog_uri: https://github.com/runapi-ai/topaz-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: Topaz API Ruby SDK for RunAPI
+summary: Topaz Ruby SDK for RunAPI
 test_files: []