runapi-luma 0.2.4 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d353328b60c0131de6c6507b61bce500f54199a690651297fb6a1cd3a1aff6f7
-  data.tar.gz: 65d9526976c6564cad2c5bbe806dc7404584b6a185f35546a50c4ff4a3e32819
+  metadata.gz: a534b8161b9606234d3c2c79dafaa70ea8d7108c766e3c2abc582d9dfe9efef9
+  data.tar.gz: 4b6e1751bb3952d519fe4be8f3c636753fe1fcd41f2892cfd7696156adea9aca
 SHA512:
-  metadata.gz: 924973089eee683e2a01619e2c002431e16704bbb52c7246df90a76b7a9ff0331eaf05e9af916d149b137920f701d9baf185703323d03d2e094c47b722323a5f
-  data.tar.gz: 2b9031377013a26bda82a79ccf0178bfcec43d5741f5fb05f440047b71a69678e3ca0ed6e9a8aeaaff4ccf09b1885295a81e4650aa5b18c185cc7385b6172529
+  metadata.gz: 8214de6e41dc2adde5aa44cfbdcc81b71834be141b85c8388de954b113512330281e83cb424e974700086fbcf6a879c44b1033326292066091d11f9dbf99cef2
+  data.tar.gz: 1b01d42f7c69fbeef2670fc76f591e4c459f6dccb658dc4669832ce7b84d0fa12b5877cb373540b38e8f2150804e75a269d8410e87281b1c555bd4ab2508530e

data/README.md

@@ -0,0 +1,45 @@
+# Luma AI API Ruby SDK for RunAPI
+
+The luma ai api Ruby SDK is the language-specific package for Luma on RunAPI. Use this luma ai 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 luma ai api README is the Ruby package guide inside the public `luma-sdk` repository. For the repository overview, start at `../README.md`; for model details, use https://runapi.ai/models/luma; for API reference, use https://runapi.ai/docs#luma; for SDK docs, use https://runapi.ai/docs#sdk-luma.
+
+## Install
+
+```bash
+gem install runapi-luma
+```
+
+## Quick start
+
+```ruby
+require "runapi-luma"
+
+client = RunApi::Luma::Client.new
+task = client.video_modifications.create(
+  # Pass the Luma JSON request body from https://runapi.ai/docs#luma.
+)
+status = client.video_modifications.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::Luma` error classes when building video jobs, Rails workers, or scripts. The available resources include video modifications. 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/luma
+- SDK docs: https://runapi.ai/docs#sdk-luma
+- Product docs: https://runapi.ai/docs#luma
+- Pricing and rate limits: https://runapi.ai/models/luma
+- Provider comparison: https://runapi.ai/providers/luma
+- Full catalog: https://runapi.ai/models
+- Repository: https://github.com/runapi-ai/luma-sdk
+
+## License
+
+Licensed under the Apache License, Version 2.0.

data/lib/runapi/luma/client.rb

@@ -2,14 +2,22 @@
 
 module RunApi
   module Luma
-    class Client
+    # Luma prompt-guided video modification API client.
+    # Applies visual edits to an existing video -- changing style, adjusting atmosphere,
+    # or adding effects -- while preserving the source motion.
+    #
+    # @example
+    #   client = RunApi::Luma::Client.new(api_key: "your-api-key")
+    #   result = client.modify_video.run(
+    #     prompt: "Add a dramatic sunset lighting effect",
+    #     source_video_url: "https://example.com/input.mp4"
+    #   )
+    class Client < RunApi::Core::Client
+      # @return [Resources::ModifyVideo] Prompt-guided video editing that preserves source motion.
       attr_reader :modify_video
 
       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
         @modify_video = Resources::ModifyVideo.new(http)
       end
     end

data/lib/runapi/luma/resources/modify_video.rb

@@ -3,6 +3,8 @@
 module RunApi
   module Luma
     module Resources
+      # Luma video modification resource.
+      # Apply prompt-guided visual edits to an existing video while preserving its motion.
       class ModifyVideo
         include RunApi::Core::ResourceHelpers
 
@@ -14,17 +16,29 @@ module RunApi
           @http = http
         end
 
+        # Modify a video and wait until complete.
+        #
+        # @param params [Hash] modification parameters
+        # @return [RunApi::Luma::Types::CompletedModifyVideoResponse] completed task with videos
         def run(**params)
           task = create(**params)
           poll_until_complete { get(task.id) }
         end
 
+        # Start a video modification task.
+        #
+        # @param params [Hash] modification parameters
+        # @return [RunApi::Luma::Types::ModifyVideoResponse] task creation result with id
         def create(**params)
           params = compact_params(params)
           validate_params!(params)
           request(:post, ENDPOINT, body: params)
         end
 
+        # Get video modification task status by task ID.
+        #
+        # @param id [String] task ID
+        # @return [RunApi::Luma::Types::ModifyVideoResponse] current task status
         def get(id)
           request(:get, "#{ENDPOINT}/#{id}")
         end
@@ -33,7 +47,7 @@ module RunApi
 
         def validate_params!(params)
           raise Core::ValidationError, "prompt is required" unless param(params, :prompt)
-          raise Core::ValidationError, "video_url is required" unless param(params, :video_url)
+          raise Core::ValidationError, "source_video_url is required" unless param(params, :source_video_url)
         end
       end
     end

data/lib/runapi/luma/types.rb

@@ -2,24 +2,30 @@
 
 module RunApi
   module Luma
+    # Type definitions and constants for Luma video modification.
     module Types
+      # A video file with a download URL.
       class Video < RunApi::Core::BaseModel
         optional :url, String
       end
 
+      # Base async task response with id and status tracking.
       class AsyncTaskResponse < RunApi::Core::TaskResponse
         required :id, String
         optional :status, String, enum: -> { RunApi::Core::TaskResponse::Status::ALL }
       end
 
+      # Task status response for a video modification operation.
+      # On completion, +videos+ contains the modified output and +sources+ contains the original input.
       class ModifyVideoResponse < AsyncTaskResponse
-        optional :videos, [ -> { Video } ]
-        optional :sources, [ -> { Video } ]
+        optional :videos, [-> { Video }]
+        optional :sources, [-> { Video }]
         optional :error, String
       end
 
+      # Completed video modification response with guaranteed output videos.
       class CompletedModifyVideoResponse < ModifyVideoResponse
-        required :videos, [ -> { Video } ]
+        required :videos, [-> { Video }]
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-luma
 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 Luma SDK for JavaScript, Ruby, and Go
+        version: 0.2.6
+description: The luma ai api Ruby SDK is the language-specific package for Luma on
+  RunAPI. Use this luma ai 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-luma.rb
 - lib/runapi/luma.rb
 - lib/runapi/luma/client.rb
@@ -41,7 +46,7 @@ licenses:
 - Apache-2.0
 metadata:
   homepage_uri: https://runapi.ai/models/luma
-  documentation_uri: https://github.com/runapi-ai/luma-sdk/blob/main/README.md
+  documentation_uri: https://github.com/runapi-ai/luma-sdk/blob/main/ruby/README.md
   source_code_uri: https://github.com/runapi-ai/luma-sdk
   changelog_uri: https://github.com/runapi-ai/luma-sdk/blob/main/CHANGELOG.md
 rdoc_options: []
@@ -60,5 +65,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.10
 specification_version: 4
-summary: Luma API SDKs for JavaScript, Ruby, and Go on RunAPI.
+summary: Luma AI API Ruby SDK for RunAPI
 test_files: []