runapi-happyhorse 0.2.6 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8420f63d7f99ed90385490503c24de7fcb1057aafe9c7d2e707e0509df9daeb2
-  data.tar.gz: 76648efbe65479f2c4c042ae4e5d11b2fc51e8f76c0fe113836f784e797c4f98
+  metadata.gz: e7d66e7f6bb1e4993244ffac318f0ea95a9a20d5b395588ed6f18d5a8a6dc7d3
+  data.tar.gz: 8559c1d3ee40b323fdc03a84b72cef7c076729089f8e00e3ff2e4e3e33c86442
 SHA512:
-  metadata.gz: f7e08714a1d7b8ffb5f22ac49c0d652876eeedff7c8e0a460cb9114db6604d9a98c275cb56d8244b46a0602891f62bf2ab9af652afa824476de778dc9ef6acbf
-  data.tar.gz: fefb8e30365b1d577314ef2de5dcda68bce75f85125fd0734128a5f648f255a5f2a3bdd26fc1078d637631662265ce7ab49ed197deb071cc1cfbbe5b6411c701
+  metadata.gz: 909f40ba4f68a5eb5f8fe5ceb6bf3ce42f2a30f05b1db001aa68b2da8f1e70f9aee8f79a427ec9db6adf3a24963b6ce5b92b142c2fda4c5f856f2a338132d166
+  data.tar.gz: 3633c1b80aecfff1c4f75dc930db62705415f6febcb35b37ddb156bb5f29c97444c8bd1268d87b33f089381ffc5a9a2716e447a66f042ccf34dbca29f6aa75b8

data/README.md

@@ -1,6 +1,6 @@
 # HappyHorse API Ruby SDK for RunAPI
 
-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.
+The HappyHorse Ruby SDK is the language-specific package for HappyHorse on RunAPI. Use this package for video generation, animation, and video editing workflows when your application needs request bodies, task status lookup, and consistent RunAPI errors in Ruby.
 
 ## Install
 
@@ -11,7 +11,7 @@ gem install runapi-happyhorse
 ## Quick start
 
 ```ruby
-require "runapi-happyhorse"
+require "runapi/happyhorse"
 
 client = RunApi::HappyHorse::Client.new
 video = client.text_to_video.run(

data/lib/runapi/happyhorse/contract_gen.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module RunApi
+  module HappyHorse
+    CONTRACT = {
+      "edit-video" => {
+        "models" => ["happyhorse-edit-video"],
+        "fields_by_model" => {
+          "happyhorse-edit-video" => {
+            "audio_setting" => {
+              "enum" => ["auto", "original"]
+            },
+            "output_resolution" => {
+              "enum" => ["720p", "1080p"]
+            },
+            "reference_image_urls" => {
+              "max_items" => 5
+            },
+            "seed" => {
+              "type" => "integer"
+            },
+            "source_video_url" => {
+              "required" => true
+            }
+          }
+        }
+      },
+      "image-to-video" => {
+        "models" => ["happyhorse-image-to-video"],
+        "fields_by_model" => {
+          "happyhorse-image-to-video" => {
+            "duration_seconds" => {
+              "type" => "integer"
+            },
+            "first_frame_image_url" => {
+              "required" => true
+            },
+            "output_resolution" => {
+              "enum" => ["720p", "1080p"]
+            },
+            "seed" => {
+              "type" => "integer"
+            }
+          }
+        }
+      },
+      "text-to-video" => {
+        "models" => ["happyhorse-character", "happyhorse-text-to-video"],
+        "fields_by_model" => {
+          "happyhorse-character" => {
+            "aspect_ratio" => {
+              "enum" => ["16:9", "9:16", "1:1", "4:3", "3:4"]
+            },
+            "duration_seconds" => {
+              "type" => "integer"
+            },
+            "output_resolution" => {
+              "enum" => ["720p", "1080p"]
+            },
+            "reference_image_urls" => {
+              "required" => true,
+              "min_items" => 1,
+              "max_items" => 9
+            },
+            "seed" => {
+              "type" => "integer"
+            }
+          },
+          "happyhorse-text-to-video" => {
+            "aspect_ratio" => {
+              "enum" => ["16:9", "9:16", "1:1", "4:3", "3:4"]
+            },
+            "duration_seconds" => {
+              "type" => "integer"
+            },
+            "output_resolution" => {
+              "enum" => ["720p", "1080p"]
+            },
+            "seed" => {
+              "type" => "integer"
+            }
+          }
+        }
+      }
+    }.freeze
+  end
+end

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

@@ -12,7 +12,6 @@ module RunApi
 
         RESPONSE_CLASS = Types::EditVideoResponse
         COMPLETED_RESPONSE_CLASS = Types::CompletedEditVideoResponse
-        REFERENCE_IMAGE_RANGE = (0..5)
 
         def initialize(http)
           @http = http
@@ -22,43 +21,36 @@ module RunApi
         #
         # @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) }
+        def run(options: nil, **params)
+          task = create(options: options, **params)
+          poll_until_complete { get(task.id, options: options) }
         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)
+        def create(options: nil, **params)
           params = compact_params(params)
           validate_params!(params)
-          request(:post, ENDPOINT, body: params)
+          request(:post, ENDPOINT, body: params, options: options)
         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}")
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
 
         private
 
         def validate_params!(params)
-          raise Core::ValidationError, "model is required" unless param(params, :model) == Types::EDIT_VIDEO_MODEL
-          raise Core::ValidationError, "prompt is required" unless param(params, :prompt)
-          raise Core::ValidationError, "source_video_url is required" unless param(params, :source_video_url)
+          validate_contract!(CONTRACT["edit-video"], params)
 
-          reference_image_urls = param(params, :reference_image_urls)
-          if reference_image_urls && (!reference_image_urls.is_a?(Array) || !REFERENCE_IMAGE_RANGE.cover?(reference_image_urls.size))
-            raise Core::ValidationError, "reference_image_urls must include at most #{REFERENCE_IMAGE_RANGE.max} entries"
-          end
+          raise Core::ValidationError, "prompt is required" unless param(params, :prompt)
 
-          validate_optional!(params, :output_resolution, Types::OUTPUT_RESOLUTIONS)
-          validate_optional!(params, :audio_setting, Types::AUDIO_SETTINGS)
           validate_integer_range!(params, :seed, Types::SEED_RANGE)
         end
 

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

@@ -21,36 +21,34 @@ module RunApi
         #
         # @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) }
+        def run(options: nil, **params)
+          task = create(options: options, **params)
+          poll_until_complete { get(task.id, options: options) }
         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)
+        def create(options: nil, **params)
           params = compact_params(params)
           validate_params!(params)
-          request(:post, ENDPOINT, body: params)
+          request(:post, ENDPOINT, body: params, options: options)
         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}")
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
 
         private
 
         def validate_params!(params)
-          raise Core::ValidationError, "model is required" unless param(params, :model) == Types::IMAGE_TO_VIDEO_MODEL
-          raise Core::ValidationError, "first_frame_image_url is required" unless param(params, :first_frame_image_url)
+          validate_contract!(CONTRACT["image-to-video"], params)
 
-          validate_optional!(params, :output_resolution, Types::OUTPUT_RESOLUTIONS)
           validate_integer_range!(params, :duration_seconds, Types::DURATION_RANGE)
           validate_integer_range!(params, :seed, Types::SEED_RANGE)
         end

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

@@ -12,7 +12,6 @@ module RunApi
 
         RESPONSE_CLASS = Types::TextToVideoResponse
         COMPLETED_RESPONSE_CLASS = Types::CompletedTextToVideoResponse
-        REFERENCE_IMAGE_URLS_RANGE = (1..9)
 
         def initialize(http)
           @http = http
@@ -22,47 +21,41 @@ module RunApi
         #
         # @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) }
+        def run(options: nil, **params)
+          task = create(options: options, **params)
+          poll_until_complete { get(task.id, options: options) }
         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)
+        def create(options: nil, **params)
           params = compact_params(params)
           validate_params!(params)
-          request(:post, ENDPOINT, body: params)
+          request(:post, ENDPOINT, body: params, options: options)
         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}")
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
 
         private
 
         def validate_params!(params)
-          model = param(params, :model)
-          raise Core::ValidationError, "model is required" unless Types::TEXT_TO_VIDEO_MODELS.include?(model)
+          validate_contract!(CONTRACT["text-to-video"], params)
+
           raise Core::ValidationError, "prompt is required" unless param(params, :prompt)
 
           reference_image_urls = param(params, :reference_image_urls)
-          if model == Types::CHARACTER_MODEL
-            unless reference_image_urls.is_a?(Array) && REFERENCE_IMAGE_URLS_RANGE.cover?(reference_image_urls.size)
-              raise Core::ValidationError, "reference_image_urls must include between #{REFERENCE_IMAGE_URLS_RANGE.min} and #{REFERENCE_IMAGE_URLS_RANGE.max} entries"
-            end
-          elsif reference_image_urls
+          if param(params, :model) != Types::CHARACTER_MODEL && reference_image_urls
             raise Core::ValidationError, "reference_image_urls is only supported for #{Types::CHARACTER_MODEL}"
           end
 
-          validate_optional!(params, :output_resolution, Types::OUTPUT_RESOLUTIONS)
-          validate_optional!(params, :aspect_ratio, Types::ASPECT_RATIOS)
           validate_integer_range!(params, :duration_seconds, Types::DURATION_RANGE)
           validate_integer_range!(params, :seed, Types::SEED_RANGE)
         end

data/lib/runapi/happyhorse/types.rb

@@ -4,20 +4,8 @@ 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.

data/lib/runapi/happyhorse.rb

@@ -2,6 +2,7 @@
 
 require "runapi/core"
 require_relative "happyhorse/types"
+require_relative "happyhorse/contract_gen"
 require_relative "happyhorse/resources/edit_video"
 require_relative "happyhorse/resources/image_to_video"
 require_relative "happyhorse/resources/text_to_video"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-happyhorse
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.8
 platform: ruby
 authors:
 - RunAPI
@@ -15,17 +15,18 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.6
+        version: 0.2.14
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        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.
+        version: 0.2.14
+description: The HappyHorse Ruby SDK is the language-specific package for HappyHorse
+  on RunAPI. Use this package for video generation, animation, and video editing workflows
+  when your application needs request bodies, task status lookup, and consistent RunAPI
+  errors in Ruby.
 email:
 - contact@runapi.ai
 executables: []
@@ -38,6 +39,7 @@ files:
 - lib/runapi-happyhorse.rb
 - lib/runapi/happyhorse.rb
 - lib/runapi/happyhorse/client.rb
+- lib/runapi/happyhorse/contract_gen.rb
 - lib/runapi/happyhorse/resources/edit_video.rb
 - lib/runapi/happyhorse/resources/image_to_video.rb
 - lib/runapi/happyhorse/resources/text_to_video.rb
@@ -46,9 +48,11 @@ homepage: https://runapi.ai/models/happyhorse
 licenses:
 - Apache-2.0
 metadata:
+  runapi_slug: happyhorse
   homepage_uri: https://runapi.ai/models/happyhorse
   documentation_uri: https://github.com/runapi-ai/happyhorse-sdk/blob/main/ruby/README.md
   source_code_uri: https://github.com/runapi-ai/happyhorse-sdk
+  bug_tracker_uri: https://github.com/runapi-ai/happyhorse-sdk/issues
   changelog_uri: https://github.com/runapi-ai/happyhorse-sdk/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths: