zype 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2df35c63862b6279b75af1200befc0f356b7845de8edc15f93231a690d7cf29
-  data.tar.gz: f20b634c31d01fd1086955cbe16df0e56b80811a35afb56244e921e95103b381
+  metadata.gz: d1630781dc6b0e4329810d4b21b4c2a2636c18d6893cf00f6d5c8d560e75f111
+  data.tar.gz: a8ac71d7ca6112aa24e7740c90753689bc372f8962813ccf5443e9b7168e93d2
 SHA512:
-  metadata.gz: a252f56f298e93d5fad37283ba032f86143ee7aa6d5413f20933a51d7b135eb9b282fa98bf93365a82873386b21398045f66b74dca22b76a5d8f91eb7d11fc76
-  data.tar.gz: 238177938f1e94770fdbe99c192a6b40ca0a00b717515074d003eff2d1bd1704e0007081d14d4620567095051ca278d4bc41361b15d1fd0e247e88357fc21d6e
+  metadata.gz: 4d6e49d8de2fb7b8fe73cd59441bca8cf921ef9c89278510c940145e125fc231e34a9695299c01684f1f9cc80106b843d387d88872e14ae2cd89b9be585fe63b
+  data.tar.gz: ca28609f4888a9ede6f5e1c2659328ecfa2d918b3670246b27defb0b5618ab8a43e2dd7233a9ad2081b15e4b02c1eb2bc015da3d21a325aa5d036ae279b634ca

data/lib/zype/models/subtitle_playlists.rb

@@ -0,0 +1,33 @@
+module Zype
+  # The Subtitle Playlists API allows users to integrate subtitles with HLS manifests from a Zype video source.
+  # It’s a simple way to add subtitles which will be supported in all platforms that implement the Apple HLS specification.
+  # This class does not support all, find and update methods
+  #
+  # @since 0.7.0
+  class SubtitlePlaylists < Zype::BaseModel
+    %i[all find update].each do |mtd|
+      send(:define_method, mtd) do
+        raise NoMethodError
+      end
+    end
+
+    # Creates a new subtitle via the API.
+    # Files must be hosted and be accessible with a URL
+    #
+    # @param video_id [String] ID of the video to assign to the subtitle
+    # @param params [Hash] the properties of the subtitle
+    # @return [Hash] the newly created subtitle
+    def create(video_id:, params:)
+      client.execute(method: :post, path: "/videos/#{video_id}/subtitle_playlists", params: params)
+    end
+
+    # Deletes an existing subtitle via the API
+    #
+    # @param language [String] language of the playlist - must be full name - not code
+    # @param video_id [String] ID of the video the subtitle belongs to
+    # @return [Hash] the deleted subtitle
+    def delete(language:, video_id:)
+      client.execute(method: :delete, path: "/videos/#{video_id}/subtitle_playlists/#{language}")
+    end
+  end
+end

data/lib/zype/models/subtitles.rb

@@ -0,0 +1,56 @@
+module Zype
+  # Work with subtitles for a specific video
+  #
+  # @since 0.7.0
+  class Subtitles < Zype::BaseModel
+    # Returns all subtitles for given video - add params to filter
+    #
+    # @param video_id [String] ID of video to get subtitles for
+    # @param params [Hash] the metadata to filter objects by
+    # @return [Array<Hash>] the subtitles returned from the API
+    def all(video_id:, params: {})
+      client.execute(method: :get, path: "/videos/#{video_id}/subtitles", params: params)
+    end
+
+    # Returns subtitle matching ID
+    #
+    # @param id [String] the ID of the object
+    # @param video_id [String] ID of the video the subtitle belongs to
+    # @return [Hash] the object returned from the API
+    def find(id:, video_id:)
+      client.execute(method: :get, path: "/videos/#{video_id}/subtitles/#{id}")
+    end
+
+    # Creates a new subtitle via the API.
+    # Files must be base64 encoded
+    # @example to base64 encode a file with Ruby
+    #   require 'base64'
+    #   Base64.encode64(File.open("file_path", "rb").read)
+    #
+    # @param video_id [String] ID of the video to assign to the subtitle
+    # @param params [Hash] the properties of the subtitle
+    # @return [Hash] the newly created subtitle
+    def create(video_id:, params:)
+      client.execute(method: :post, path: "/videos/#{video_id}/subtitles", params: params)
+    end
+
+    # Updates an existing subtitle via the API
+    #
+    # @param id [String] the ID of the object
+    # @param video_id [String] ID of the video the subtitle belongs to
+    # @param params [Hash] the properties to be updated
+    # @return [Hash] the updated subtitle
+    def update(id:, video_id:, params:)
+      client.execute(method: :put, path: "/videos/#{video_id}/subtitles/#{id}", params: params)
+    end
+
+    # Deletes an existing subtitle via the API
+    #
+    # @param id [String] the ID of the object
+    # @param video_id [String] ID of the video the subtitle belongs to
+    # @return [Hash] the deleted subtitle
+    def delete(id:, video_id:)
+      client.execute(method: :delete, path: "/videos/#{video_id}/subtitles/#{id}")
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zype
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Zype
@@ -67,6 +67,8 @@ files:
 - lib/zype/models/encoders.rb
 - lib/zype/models/live_events.rb
 - lib/zype/models/playlists.rb
+- lib/zype/models/subtitle_playlists.rb
+- lib/zype/models/subtitles.rb
 - lib/zype/models/videos.rb
 homepage: http://rubygems.org/gems/zype
 licenses: