runapi-recraft 0.2.6 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55e7e0c96e8835ade78091ac2ae8730b97243801959c50b770025cff53c7819f
-  data.tar.gz: 9da9fd4900070f8b49748c3f6f8a8b9fd7b8637469c6efe144921592e430080e
+  metadata.gz: 2c2b2912ab879d8963f9509e01b310536fdc90a037c93d6cd015ae73cde2cf10
+  data.tar.gz: be332c3935373d34ce7f75a7ae56e0c5737b3ef1598512baa4366e26ef1afbe4
 SHA512:
-  metadata.gz: 100bc2fe7dbfc4c66fa4b083c646fdf6aa629c8f83bf55b038351bcb74ff28d6e0395b5e290e9df26ea2bc5b01e769684c9492d808ecb24537dd956e41a6c5bf
-  data.tar.gz: c611577ce0b679934f79729968fa5bf38d8597406b6805d709f0029d48f01fcbaaf2481096fe3a65c0fd967a54e651039f1d31a0e23c338b11d794621d596264
+  metadata.gz: a77247d24f83011ed6f68409d824803f51761047e7c782ec026f623eb0124fae7d273514e051bcff302eefbc4b4e294b5732bf7b206d59c8767da12cecdd3ab5
+  data.tar.gz: 27ee47c83816546c004fb2a2829d27baa9efec25f3b0ce075c3a650fa66295ff3143af107c0238d3b0be632d34099d9adcedea4dc0502c1104318d6ec47a98a5

data/README.md

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

data/lib/runapi/recraft/client.rb

@@ -11,12 +11,12 @@ module RunApi
     #
     #   upscaled = client.upscale_image.run(
     #     model: "recraft-crisp-upscale",
-    #     source_image_url: "https://example.com/photo.jpg"
+    #     source_image_url: "https://cdn.runapi.ai/public/samples/image.jpg"
     #   )
     #
     #   cutout = client.remove_background.run(
     #     model: "recraft-remove-background",
-    #     source_image_url: "https://example.com/photo.jpg"
+    #     source_image_url: "https://cdn.runapi.ai/public/samples/image.jpg"
     #   )
     class Client < RunApi::Core::Client
       # @return [Resources::UpscaleImage] AI-powered image upscaling operations.

data/lib/runapi/recraft/contract_gen.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module RunApi
+  module Recraft
+    CONTRACT = {
+      "remove-background" => {
+        "models" => ["recraft-remove-background"],
+        "fields_by_model" => {
+          "recraft-remove-background" => {
+            "source_image_url" => {
+              "required" => true
+            }
+          }
+        }
+      },
+      "upscale-image" => {
+        "models" => ["recraft-crisp-upscale"],
+        "fields_by_model" => {
+          "recraft-crisp-upscale" => {
+            "source_image_url" => {
+              "required" => true
+            }
+          }
+        }
+      }
+    }.freeze
+  end
+end

data/lib/runapi/recraft/resources/remove_background.rb

@@ -17,31 +17,19 @@ module RunApi
           @http = http
         end
 
-        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
 
-        def create(**params)
+        def create(options: nil, **params)
           params = compact_params(params)
-          validate_params!(params)
-          request(:post, ENDPOINT, body: params)
+          validate_contract!(CONTRACT["remove-background"], params)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
-        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, "source_image_url is required" unless param(params, :source_image_url)
-
-          model = param(params, :model)
-          unless Types::REMOVE_BACKGROUND_MODELS.include?(model)
-            raise Core::ValidationError, "Invalid model: #{model}. Must be one of: #{Types::REMOVE_BACKGROUND_MODELS.join(", ")}"
-          end
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
       end
     end

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

@@ -17,31 +17,19 @@ module RunApi
           @http = http
         end
 
-        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
 
-        def create(**params)
+        def create(options: nil, **params)
           params = compact_params(params)
-          validate_params!(params)
-          request(:post, ENDPOINT, body: params)
+          validate_contract!(CONTRACT["upscale-image"], params)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
-        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, "source_image_url is required" unless param(params, :source_image_url)
-
-          model = param(params, :model)
-          unless Types::UPSCALE_IMAGE_MODELS.include?(model)
-            raise Core::ValidationError, "Invalid model: #{model}. Must be one of: #{Types::UPSCALE_IMAGE_MODELS.join(", ")}"
-          end
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
       end
     end

data/lib/runapi/recraft/types.rb

@@ -4,11 +4,6 @@ module RunApi
   module Recraft
     # Type definitions and constants for the Recraft image processing API.
     module Types
-      # Crisp upscaling model that enhances resolution while preserving detail.
-      UPSCALE_IMAGE_MODELS = %w[recraft-crisp-upscale].freeze
-      # Background removal model that isolates the foreground subject.
-      REMOVE_BACKGROUND_MODELS = %w[recraft-remove-background].freeze
-
       # URL to a processed image (upscaled or background-removed).
       class Image < RunApi::Core::BaseModel
         optional :url, String

data/lib/runapi/recraft.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
+require "runapi/core"
 require_relative "recraft/types"
+require_relative "recraft/contract_gen"
 require_relative "recraft/resources/upscale_image"
 require_relative "recraft/resources/remove_background"
 require_relative "recraft/client"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-recraft
 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 recraft api Ruby SDK is the language-specific package for Recraft
-  on RunAPI. Use this recraft 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 Recraft Ruby SDK is the language-specific package for Recraft 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-recraft.rb
 - lib/runapi/recraft.rb
 - lib/runapi/recraft/client.rb
+- lib/runapi/recraft/contract_gen.rb
 - lib/runapi/recraft/resources/remove_background.rb
 - lib/runapi/recraft/resources/upscale_image.rb
 - lib/runapi/recraft/types.rb
@@ -46,9 +47,11 @@ homepage: https://runapi.ai/models/recraft
 licenses:
 - Apache-2.0
 metadata:
+  runapi_slug: recraft
   homepage_uri: https://runapi.ai/models/recraft
   documentation_uri: https://github.com/runapi-ai/recraft-sdk/blob/main/ruby/README.md
   source_code_uri: https://github.com/runapi-ai/recraft-sdk
+  bug_tracker_uri: https://github.com/runapi-ai/recraft-sdk/issues
   changelog_uri: https://github.com/runapi-ai/recraft-sdk/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
@@ -64,7 +67,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: Recraft API Ruby SDK for RunAPI
+summary: Recraft Ruby SDK for RunAPI
 test_files: []