runapi-recraft 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac78d7e6f131188a636f5e2a83ffa3438ceb02d00275c558375c1000980ae43e
-  data.tar.gz: bf40d14ed407faf3c15250c2c1778f37e5f342c904efa20374be1f8d0c80446b
+  metadata.gz: 55e7e0c96e8835ade78091ac2ae8730b97243801959c50b770025cff53c7819f
+  data.tar.gz: 9da9fd4900070f8b49748c3f6f8a8b9fd7b8637469c6efe144921592e430080e
 SHA512:
-  metadata.gz: e9cedf23b2a3730afe9a2bfeb3fa7fbc819ea2935524cbdce26e25a412f301c9c7128f63c213da60e45378339c1da35d02cf7c2568d42ac91e253370ed149960
-  data.tar.gz: 41c554461a6c770ecacfca8536440dec5d4b671438cd56e28a0fc9f8ffb6703ec669dd642805e48e71731d8c60bfd7afd78bbcc481335601a6f141d2a6a67c36
+  metadata.gz: 100bc2fe7dbfc4c66fa4b083c646fdf6aa629c8f83bf55b038351bcb74ff28d6e0395b5e290e9df26ea2bc5b01e769684c9492d808ecb24537dd956e41a6c5bf
+  data.tar.gz: c611577ce0b679934f79729968fa5bf38d8597406b6805d709f0029d48f01fcbaaf2481096fe3a65c0fd967a54e651039f1d31a0e23c338b11d794621d596264

data/README.md

@@ -24,6 +24,8 @@ status = client.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.
 
+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.

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://example.com/photo.jpg"
+    #   )
+    #
+    #   cutout = client.remove_background.run(
+    #     model: "recraft-remove-background",
+    #     source_image_url: "https://example.com/photo.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/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
 

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
 

data/lib/runapi/recraft/types.rb

@@ -2,14 +2,19 @@
 
 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
       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 +22,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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-recraft
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - RunAPI
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.5
+        version: 0.2.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.5
+        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,