runapi-recraft 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5ca7f1872cef0015b8649790c8f17fb3777a59c21e7ddad244e090025de6f77
-  data.tar.gz: e3669590cf6b8bbb07224cf0c4ba7bc5e1992fb0f7ab2d340c3bac0806531aa7
+  metadata.gz: ac78d7e6f131188a636f5e2a83ffa3438ceb02d00275c558375c1000980ae43e
+  data.tar.gz: bf40d14ed407faf3c15250c2c1778f37e5f342c904efa20374be1f8d0c80446b
 SHA512:
-  metadata.gz: e719f5e72e01b541bcf58d977e86b3d6a17fda4489a260a6f3a99a7ddc6ee5cb7de3260a93dd1241326542b3bec9f8a60c70c94d7cdb913225314c46998bde3e
-  data.tar.gz: 71d5f65fa288b9cfdbad1b5c5ee6eb815db118fa7a91a013af813fa3350e120c2fe23e8f843b4f5ab104037d20a3efb371c91eaaa6259e72b71c49c528ce9af9
+  metadata.gz: e9cedf23b2a3730afe9a2bfeb3fa7fbc819ea2935524cbdce26e25a412f301c9c7128f63c213da60e45378339c1da35d02cf7c2568d42ac91e253370ed149960
+  data.tar.gz: 41c554461a6c770ecacfca8536440dec5d4b671438cd56e28a0fc9f8ffb6703ec669dd642805e48e71731d8c60bfd7afd78bbcc481335601a6f141d2a6a67c36

data/README.md

@@ -0,0 +1,43 @@
+# 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.
+
+## 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/resources/remove_background.rb

@@ -34,7 +34,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

@@ -34,7 +34,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

@@ -13,12 +13,12 @@ module RunApi
       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
 
       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.5
 platform: ruby
 authors:
 - RunAPI
@@ -15,22 +15,27 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: 0.2.5
   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.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.
 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: []