runapi-recraft 0.2.4 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5ca7f1872cef0015b8649790c8f17fb3777a59c21e7ddad244e090025de6f77
-  data.tar.gz: e3669590cf6b8bbb07224cf0c4ba7bc5e1992fb0f7ab2d340c3bac0806531aa7
+  metadata.gz: 55e7e0c96e8835ade78091ac2ae8730b97243801959c50b770025cff53c7819f
+  data.tar.gz: 9da9fd4900070f8b49748c3f6f8a8b9fd7b8637469c6efe144921592e430080e
 SHA512:
-  metadata.gz: e719f5e72e01b541bcf58d977e86b3d6a17fda4489a260a6f3a99a7ddc6ee5cb7de3260a93dd1241326542b3bec9f8a60c70c94d7cdb913225314c46998bde3e
-  data.tar.gz: 71d5f65fa288b9cfdbad1b5c5ee6eb815db118fa7a91a013af813fa3350e120c2fe23e8f843b4f5ab104037d20a3efb371c91eaaa6259e72b71c49c528ce9af9
+  metadata.gz: 100bc2fe7dbfc4c66fa4b083c646fdf6aa629c8f83bf55b038351bcb74ff28d6e0395b5e290e9df26ea2bc5b01e769684c9492d808ecb24537dd956e41a6c5bf
+  data.tar.gz: c611577ce0b679934f79729968fa5bf38d8597406b6805d709f0029d48f01fcbaaf2481096fe3a65c0fd967a54e651039f1d31a0e23c338b11d794621d596264

data/README.md

@@ -0,0 +1,45 @@
+# Recraft API 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.
+
+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.
+
+## Install
+
+```bash
+gem install runapi-recraft
+```
+
+## Quick start
+
+```ruby
+require "runapi-recraft"
+
+client = RunApi::Recraft::Client.new
+task = client.upscales.create(
+  # Pass the Recraft JSON request body from https://runapi.ai/docs#recraft.
+)
+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.
+
+## Links
+
+- Model page: https://runapi.ai/models/recraft
+- SDK docs: https://runapi.ai/docs#sdk-recraft
+- Product docs: https://runapi.ai/docs#recraft
+- Pricing and rate limits: https://runapi.ai/models/recraft/crisp-upscale
+- Provider comparison: https://runapi.ai/providers/recraft
+- Full catalog: https://runapi.ai/models
+- Repository: https://github.com/runapi-ai/recraft-sdk
+
+## License
+
+Licensed under the Apache License, Version 2.0.

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
 
@@ -34,7 +36,7 @@ module RunApi
 
         def validate_params!(params)
           raise Core::ValidationError, "model is required" unless param(params, :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)
 
           model = param(params, :model)
           unless Types::REMOVE_BACKGROUND_MODELS.include?(model)

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
 
@@ -34,7 +36,7 @@ module RunApi
 
         def validate_params!(params)
           raise Core::ValidationError, "model is required" unless param(params, :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)
 
           model = param(params, :model)
           unless Types::UPSCALE_IMAGE_MODELS.include?(model)

data/lib/runapi/recraft/types.rb

@@ -2,23 +2,30 @@
 
 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 }
-        optional :images, [ -> { Image } ]
+        optional :images, [-> { Image }]
         optional :error, String
       end
 
+      # Narrowed response returned by +run+ once polling confirms completion.
+      # Images are guaranteed present.
       class CompletedImageTaskResponse < ImageTaskResponse
-        required :images, [ -> { Image } ]
+        required :images, [-> { Image }]
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-recraft
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.6
 platform: ruby
 authors:
 - RunAPI
@@ -15,22 +15,27 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: 0.2.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.4
-description: RunAPI Recraft SDK for JavaScript, Ruby, and Go
+        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.
 email:
 - contact@runapi.ai
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
 - LICENSE
+- README.md
 - lib/runapi-recraft.rb
 - lib/runapi/recraft.rb
 - lib/runapi/recraft/client.rb
@@ -42,7 +47,7 @@ licenses:
 - Apache-2.0
 metadata:
   homepage_uri: https://runapi.ai/models/recraft
-  documentation_uri: https://github.com/runapi-ai/recraft-sdk/blob/main/README.md
+  documentation_uri: https://github.com/runapi-ai/recraft-sdk/blob/main/ruby/README.md
   source_code_uri: https://github.com/runapi-ai/recraft-sdk
   changelog_uri: https://github.com/runapi-ai/recraft-sdk/blob/main/CHANGELOG.md
 rdoc_options: []
@@ -61,5 +66,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.10
 specification_version: 4
-summary: Recraft API SDKs for JavaScript, Ruby, and Go on RunAPI.
+summary: Recraft API Ruby SDK for RunAPI
 test_files: []