runapi-recraft 0.2.5 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac78d7e6f131188a636f5e2a83ffa3438ceb02d00275c558375c1000980ae43e
-  data.tar.gz: bf40d14ed407faf3c15250c2c1778f37e5f342c904efa20374be1f8d0c80446b
+  metadata.gz: 477bd23affda1ef60acfcd9d9add3cbfb216c0e8fe9ecaca17bfa053077cd144
+  data.tar.gz: d754513ee14f79f3af3e94658994b5d5128f9775dabbbc9f57b1e75ac18a20e0
 SHA512:
-  metadata.gz: e9cedf23b2a3730afe9a2bfeb3fa7fbc819ea2935524cbdce26e25a412f301c9c7128f63c213da60e45378339c1da35d02cf7c2568d42ac91e253370ed149960
-  data.tar.gz: 41c554461a6c770ecacfca8536440dec5d4b671438cd56e28a0fc9f8ffb6703ec669dd642805e48e71731d8c60bfd7afd78bbcc481335601a6f141d2a6a67c36
+  metadata.gz: 2ef6f4ecaafd2a69e537fd2acdbabde0b2fb5623b2d12ce8dc589b196019b8626a0c3c60df77a07b32c14563f9b5dda7603d4380bcd13457013ded2463cf711a
+  data.tar.gz: fb15f2bd59d56d4316095e2e1e29a71e3be9fa80bc791a69d0fa8358aaacaf6eb1dc769c5b707357bccf8e2718e092d1ac6ee0a8c979c660785e91e46b204125

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
 
@@ -16,17 +16,19 @@ gem install 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.
 
+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::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

@@ -2,14 +2,30 @@
 
 module RunApi
   module Recraft
-    class Client
-      attr_reader :upscale_image, :remove_background
+    # Recraft image post-processing API client.
+    #
+    # Provides AI-powered image upscaling and background removal.
+    #
+    # @example
+    #   client = RunApi::Recraft::Client.new(api_key: "your-api-key")
+    #
+    #   upscaled = client.upscale_image.run(
+    #     model: "recraft-crisp-upscale",
+    #     source_image_url: "https://cdn.runapi.ai/public/samples/image.jpg"
+    #   )
+    #
+    #   cutout = client.remove_background.run(
+    #     model: "recraft-remove-background",
+    #     source_image_url: "https://cdn.runapi.ai/public/samples/image.jpg"
+    #   )
+    class Client < RunApi::Core::Client
+      # @return [Resources::UpscaleImage] AI-powered image upscaling operations.
+      attr_reader :upscale_image
+      # @return [Resources::RemoveBackground] Background removal operations.
+      attr_reader :remove_background
 
       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
         @upscale_image = Resources::UpscaleImage.new(http)
         @remove_background = Resources::RemoveBackground.new(http)
       end

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

@@ -3,6 +3,8 @@
 module RunApi
   module Recraft
     module Resources
+      # Background removal resource.
+      # Produces a transparent cutout by removing the image background.
       class RemoveBackground
         include RunApi::Core::ResourceHelpers
 
@@ -22,25 +24,13 @@ module RunApi
 
         def create(**params)
           params = compact_params(params)
-          validate_params!(params)
+          validate_contract!(CONTRACT["remove-background"], 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)
-          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
-        end
       end
     end
   end

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

@@ -3,6 +3,8 @@
 module RunApi
   module Recraft
     module Resources
+      # AI-powered image upscaling resource.
+      # Enhance image resolution while preserving detail.
       class UpscaleImage
         include RunApi::Core::ResourceHelpers
 
@@ -22,25 +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)
-          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
-        end
       end
     end
   end

data/lib/runapi/recraft/types.rb

@@ -2,14 +2,14 @@
 
 module RunApi
   module Recraft
+    # Type definitions and constants for the Recraft image processing API.
     module Types
-      UPSCALE_IMAGE_MODELS = %w[recraft-crisp-upscale].freeze
-      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
       end
 
+      # Async image task result shared by upscale and background removal operations.
       class ImageTaskResponse < RunApi::Core::TaskResponse
         required :id, String
         optional :status, String, enum: -> { RunApi::Core::TaskResponse::Status::ALL }
@@ -17,6 +17,8 @@ module RunApi
         optional :error, String
       end
 
+      # Narrowed response returned by +run+ once polling confirms completion.
+      # Images are guaranteed present.
       class CompletedImageTaskResponse < ImageTaskResponse
         required :images, [-> { Image }]
       end

data/lib/runapi/recraft.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 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.5
+  version: 0.2.7
 platform: ruby
 authors:
 - RunAPI
@@ -15,18 +15,18 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.5
+        version: 0.2.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.5
-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.2.7
+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:
@@ -66,5 +69,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.10
 specification_version: 4
-summary: Recraft API Ruby SDK for RunAPI
+summary: Recraft Ruby SDK for RunAPI
 test_files: []