runapi-happyhorse 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c4f0f454f1eb15878f3c4edd3f7d958db1777e5ffb6260c0f29e0774fa587bd
-  data.tar.gz: 0c0f9d96f07ed1d893a531df62c42f5c2896b1c61d56e751635b973d7608d6f0
+  metadata.gz: 8420f63d7f99ed90385490503c24de7fcb1057aafe9c7d2e707e0509df9daeb2
+  data.tar.gz: 76648efbe65479f2c4c042ae4e5d11b2fc51e8f76c0fe113836f784e797c4f98
 SHA512:
-  metadata.gz: 1464ac2c22e0349fdb59df6a910a8afd1ae31be12831847359182b09da136ed7e332f9a3df0d32bbe2a5ada0c711a2e78eb14f3ecb509e8f5e25640100de8490
-  data.tar.gz: 0cc07a34f20984589248c3571a528e35085194557e5477fbed9b524ecc78dacf308511dc0a68750488ff5da5c926b454d42e7be743d51d8b061ce587fd3c6975
+  metadata.gz: f7e08714a1d7b8ffb5f22ac49c0d652876eeedff7c8e0a460cb9114db6604d9a98c275cb56d8244b46a0602891f62bf2ab9af652afa824476de778dc9ef6acbf
+  data.tar.gz: fefb8e30365b1d577314ef2de5dcda68bce75f85125fd0734128a5f648f255a5f2a3bdd26fc1078d637631662265ce7ab49ed197deb071cc1cfbbe5b6411c701

data/README.md

@@ -26,6 +26,8 @@ video = client.text_to_video.run(
 
 For image-to-video, call `client.image_to_video.run` with `model: "happyhorse-image-to-video"` and exactly one `image_urls` entry. For character-guided text-to-video, call `client.text_to_video.run` with `model: "happyhorse-character"` and 1-9 `reference_image_urls` entries. For edit-video, call `client.edit_video.run` with `model: "happyhorse-edit-video"`, one `video_url`, and optional `reference_image` entries.
 
+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.
+
 ## Links
 
 - Model page: https://runapi.ai/models/happyhorse

data/lib/runapi/happyhorse/client.rb

@@ -2,14 +2,23 @@
 
 module RunApi
   module HappyHorse
-    class Client
-      attr_reader :text_to_video, :image_to_video, :edit_video
+    # HappyHorse video generation and editing API client.
+    #
+    # @example
+    #   client = RunApi::HappyHorse::Client.new(api_key: "your-api-key")
+    #   result = client.text_to_video.run(
+    #     model: "happyhorse-text-to-video", prompt: "A horse galloping across a sunset beach"
+    #   )
+    class Client < RunApi::Core::Client
+      # @return [Resources::TextToVideo] Text-to-video generation with optional character consistency.
+      attr_reader :text_to_video
+      # @return [Resources::ImageToVideo] Image-to-video animation from a first-frame image.
+      attr_reader :image_to_video
+      # @return [Resources::EditVideo] Video editing with text prompts and reference images.
+      attr_reader :edit_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
         @text_to_video = Resources::TextToVideo.new(http)
         @image_to_video = Resources::ImageToVideo.new(http)
         @edit_video = Resources::EditVideo.new(http)

data/lib/runapi/happyhorse/resources/edit_video.rb

@@ -3,6 +3,8 @@
 module RunApi
   module HappyHorse
     module Resources
+      # HappyHorse edit-video resource.
+      # Transform an existing video with a text prompt and optional reference images.
       class EditVideo
         include RunApi::Core::ResourceHelpers
 
@@ -16,17 +18,29 @@ module RunApi
           @http = http
         end
 
+        # Create an edit-video task and wait until complete.
+        #
+        # @param params [Hash] edit-video parameters
+        # @return [RunApi::HappyHorse::Types::CompletedEditVideoResponse] completed task with videos
         def run(**params)
           task = create(**params)
           poll_until_complete { get(task.id) }
         end
 
+        # Create an edit-video task.
+        #
+        # @param params [Hash] edit-video parameters
+        # @return [RunApi::HappyHorse::Types::EditVideoResponse] task creation result with id
         def create(**params)
           params = compact_params(params)
           validate_params!(params)
           request(:post, ENDPOINT, body: params)
         end
 
+        # Get edit-video task status by task ID.
+        #
+        # @param id [String] task ID
+        # @return [RunApi::HappyHorse::Types::EditVideoResponse] current task status
         def get(id)
           request(:get, "#{ENDPOINT}/#{id}")
         end

data/lib/runapi/happyhorse/resources/image_to_video.rb

@@ -3,6 +3,8 @@
 module RunApi
   module HappyHorse
     module Resources
+      # HappyHorse image-to-video resource.
+      # Animate a still first-frame image into video, guided by an optional text prompt.
       class ImageToVideo
         include RunApi::Core::ResourceHelpers
 
@@ -15,17 +17,29 @@ module RunApi
           @http = http
         end
 
+        # Create an image-to-video task and wait until complete.
+        #
+        # @param params [Hash] image-to-video parameters
+        # @return [RunApi::HappyHorse::Types::CompletedImageToVideoResponse] completed task with videos
         def run(**params)
           task = create(**params)
           poll_until_complete { get(task.id) }
         end
 
+        # Create an image-to-video task.
+        #
+        # @param params [Hash] image-to-video parameters
+        # @return [RunApi::HappyHorse::Types::ImageToVideoResponse] task creation result with id
         def create(**params)
           params = compact_params(params)
           validate_params!(params)
           request(:post, ENDPOINT, body: params)
         end
 
+        # Get image-to-video task status by task ID.
+        #
+        # @param id [String] task ID
+        # @return [RunApi::HappyHorse::Types::ImageToVideoResponse] current task status
         def get(id)
           request(:get, "#{ENDPOINT}/#{id}")
         end

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

@@ -3,6 +3,8 @@
 module RunApi
   module HappyHorse
     module Resources
+      # HappyHorse text-to-video resource.
+      # Generate video from a text prompt, with optional character consistency via happyhorse-character.
       class TextToVideo
         include RunApi::Core::ResourceHelpers
 
@@ -16,17 +18,29 @@ module RunApi
           @http = http
         end
 
+        # Create a text-to-video task and wait until complete.
+        #
+        # @param params [Hash] text-to-video parameters
+        # @return [RunApi::HappyHorse::Types::CompletedTextToVideoResponse] completed task with videos
         def run(**params)
           task = create(**params)
           poll_until_complete { get(task.id) }
         end
 
+        # Create a text-to-video task.
+        #
+        # @param params [Hash] text-to-video parameters
+        # @return [RunApi::HappyHorse::Types::TextToVideoResponse] task creation result with id
         def create(**params)
           params = compact_params(params)
           validate_params!(params)
           request(:post, ENDPOINT, body: params)
         end
 
+        # Get text-to-video task status by task ID.
+        #
+        # @param id [String] task ID
+        # @return [RunApi::HappyHorse::Types::TextToVideoResponse] current task status
         def get(id)
           request(:get, "#{ENDPOINT}/#{id}")
         end

data/lib/runapi/happyhorse/types.rb

@@ -2,18 +2,28 @@
 
 module RunApi
   module HappyHorse
+    # Type definitions and constants for HappyHorse video generation and editing.
     module Types
+      # Standard text-to-video model.
       TEXT_TO_VIDEO_MODEL = "happyhorse-text-to-video"
+      # Character-consistent model; requires 1-9 reference_image_urls.
       CHARACTER_MODEL = "happyhorse-character"
+      # All text-to-video model variants.
       TEXT_TO_VIDEO_MODELS = [TEXT_TO_VIDEO_MODEL, CHARACTER_MODEL].freeze
       IMAGE_TO_VIDEO_MODEL = "happyhorse-image-to-video"
       EDIT_VIDEO_MODEL = "happyhorse-edit-video"
+      # Output resolution options. Defaults to 1080p.
       OUTPUT_RESOLUTIONS = %w[720p 1080p].freeze
+      # Aspect ratio options. Defaults to 16:9.
       ASPECT_RATIOS = %w[16:9 9:16 1:1 4:3 3:4].freeze
+      # Audio handling for video editing: "auto" lets the model decide, "original" preserves source audio.
       AUDIO_SETTINGS = %w[auto original].freeze
+      # Duration range in seconds (3-15). Defaults to 5.
       DURATION_RANGE = (3..15)
+      # Reproducibility seed range.
       SEED_RANGE = (0..2_147_483_647)
 
+      # A generated video file with a download URL.
       class MediaUrl < RunApi::Core::BaseModel
         optional :url, String
       end
@@ -25,6 +35,8 @@ module RunApi
         optional :error, String
       end
 
+      # Narrowed response returned by +run()+ once polling observes +status: "completed"+.
+      # +videos+ is required so consumers never have to null-check it on a successful task.
       class CompletedTextToVideoResponse < TextToVideoResponse
         required :videos, [-> { MediaUrl }]
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-happyhorse
 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 happyhorse ai api Ruby SDK is the language-specific package for HappyHorse
   on RunAPI. Use this package for text, image, and edit-video workflows that need
   JSON request bodies, task status lookup, and consistent RunAPI errors in Ruby.