runapi-runway 0.2.1 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c214b2341bb03336e45e8d5b45ee17e767a976f48d8b3400d70a97c79c7f79aa
-  data.tar.gz: 36e6813b94e61df19973e8f50081a43e23eb8f1662c5e33842a9f80df18115b2
+  metadata.gz: 136d7bef7e251f84697d1faec9be01a6771a3948f4c2df29711f8c5d335c2e42
+  data.tar.gz: 76c88350d5408ce93c05ddb25e49e90429c5e5e76f540d8993eb3738ab5c2c94
 SHA512:
-  metadata.gz: b32644b41f4f0deaf8a79c4cae455c6a6f2ef81b582befeb445e2d19d53205484d9b4c156f69499f9946bdc2cef3d34db15a46835f1c3e9723f7d85a0e1ab162
-  data.tar.gz: 8dad4c58ee7e1bd07c2deacbb07db763031209f112ffa9f30cd14718725176c125fb8febd4d52f576c5afb6d1aeef8488f484bd37f72c2df980539524de91e32
+  metadata.gz: c850f59712359438aa95bd65cebfcd3149f2f5b80d45378978f2b7a47b0190b308e12b220a4329ffd88535da128080e40d4eb43faa45a890e9431c43d6a782a0
+  data.tar.gz: adba718ecc15852b75fef465d757c9e6e6b922f68b5a2c91c4f83cb4b3fbeb517aa7718d3e25067c4abff473e5e38241647a0568f50c9165a9fc9384d9fc7f0d

data/README.md

@@ -0,0 +1,43 @@
+# Runway API Ruby SDK for RunAPI
+
+The runway api Ruby SDK is the language-specific package for Runway on RunAPI. Use this runway api package for text-to-video, image-to-video, video editing, and animation flows when your application needs JSON request bodies, task status lookup, and consistent RunAPI errors in Ruby.
+
+This runway api README is the Ruby package guide inside the public `runway-sdk` repository. For the repository overview, start at `../README.md`; for model details, use https://runapi.ai/models/runway; for API reference, use https://runapi.ai/docs#runway; for SDK docs, use https://runapi.ai/docs#sdk-runway.
+
+## Install
+
+```bash
+gem install runapi-runway
+```
+
+## Quick start
+
+```ruby
+require "runapi-runway"
+
+client = RunApi::Runway::Client.new
+task = client.text_to_video.create(
+  # Pass the Runway JSON request body from https://runapi.ai/docs#runway.
+)
+status = client.text_to_video.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::Runway` error classes when building video jobs, Rails workers, or scripts. The available resources are `text_to_video` and `extend_video`. 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/runway
+- SDK docs: https://runapi.ai/docs#sdk-runway
+- Product docs: https://runapi.ai/docs#runway
+- Pricing and rate limits: https://runapi.ai/models/runway
+- Provider comparison: https://runapi.ai/providers/runway
+- Full catalog: https://runapi.ai/models
+- Repository: https://github.com/runapi-ai/runway-sdk
+
+## License
+
+Licensed under the Apache License, Version 2.0.

data/lib/runapi/runway/resources/extend_video.rb

@@ -32,11 +32,10 @@ module RunApi
         private
 
         def validate_params!(params)
-          raise Core::ValidationError, "task_id is required" unless param(params, :task_id)
+          raise Core::ValidationError, "source_task_id is required" unless param(params, :source_task_id)
           raise Core::ValidationError, "prompt is required" unless param(params, :prompt)
-          raise Core::ValidationError, "image_url is required" unless param(params, :image_url)
-          raise Core::ValidationError, "quality is required" unless param(params, :quality)
-          validate_optional!(params, :quality, Types::QUALITIES)
+          raise Core::ValidationError, "output_resolution is required" unless param(params, :output_resolution)
+          validate_optional!(params, :output_resolution, Types::OUTPUT_RESOLUTIONS)
         end
       end
     end

data/lib/runapi/runway/resources/text_to_video.rb

@@ -33,9 +33,9 @@ module RunApi
 
         def validate_params!(params)
           raise Core::ValidationError, "prompt is required" unless param(params, :prompt)
-          raise Core::ValidationError, "duration is required" unless param(params, :duration)
-          raise Core::ValidationError, "quality is required" unless param(params, :quality)
-          validate_optional!(params, :quality, Types::QUALITIES)
+          raise Core::ValidationError, "duration_seconds is required" unless param(params, :duration_seconds)
+          raise Core::ValidationError, "output_resolution is required" unless param(params, :output_resolution)
+          validate_optional!(params, :output_resolution, Types::OUTPUT_RESOLUTIONS)
           validate_optional!(params, :aspect_ratio, Types::ASPECT_RATIOS)
         end
       end

data/lib/runapi/runway/types.rb

@@ -3,7 +3,7 @@
 module RunApi
   module Runway
     module Types
-      QUALITIES = %w[720p 1080p].freeze
+      OUTPUT_RESOLUTIONS = %w[720p 1080p].freeze
       ASPECT_RATIOS = %w[16:9 9:16 1:1 4:3 3:4].freeze
 
       class Video < RunApi::Core::BaseModel
@@ -11,19 +11,23 @@ module RunApi
         required :url, String
       end
 
+      class Image < RunApi::Core::BaseModel
+        required :url, String
+      end
+
       class TaskResponse < RunApi::Core::TaskResponse
         required :id, String
         optional :status, String, enum: -> { RunApi::Core::TaskResponse::Status::ALL }
-        optional :videos, [ -> { Video } ]
-        optional :image_url, String
-        optional :parent_task_id, String
+        optional :videos, [-> { Video }]
+        optional :images, [-> { Image }]
+        optional :source_task_id, String
         optional :error, String
       end
 
       class TaskCreateResponse < TaskResponse; end
 
       class CompletedTaskResponse < TaskResponse
-        required :videos, [ -> { Video } ]
+        required :videos, [-> { Video }]
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-runway
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.6
 platform: ruby
 authors:
 - RunAPI
@@ -15,22 +15,27 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.2.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
-description: RunAPI Runway SDK for JavaScript, Ruby, and Go
+        version: 0.2.5
+description: The runway api Ruby SDK is the language-specific package for Runway on
+  RunAPI. Use this runway api package for text-to-video, image-to-video, video editing,
+  and animation 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-runway.rb
 - lib/runapi/runway.rb
 - lib/runapi/runway/client.rb
@@ -42,7 +47,7 @@ licenses:
 - Apache-2.0
 metadata:
   homepage_uri: https://runapi.ai/models/runway
-  documentation_uri: https://runapi.ai/models/runway
+  documentation_uri: https://github.com/runapi-ai/runway-sdk/blob/main/ruby/README.md
   source_code_uri: https://github.com/runapi-ai/runway-sdk
   changelog_uri: https://github.com/runapi-ai/runway-sdk/blob/main/CHANGELOG.md
 rdoc_options: []
@@ -59,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 4.0.10
 specification_version: 4
-summary: Runway API SDKs for JavaScript, Ruby, and Go on RunAPI.
+summary: Runway API Ruby SDK for RunAPI
 test_files: []