shotstack 0.0.11 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 991d9e463ec387c1f9b95ece6cd397a6435f6584f44082a8176ee129f9691cdc
-  data.tar.gz: 6ca22d52cae38255a0faa0eb62ca6e2a351e8c5f98852ee246b6f057dbafaab7
+  metadata.gz: 579d1ec5fccbd70b7208291c253e5445b322951876de459b3e9ebd997611c402
+  data.tar.gz: 0cf0f98748009d2d237d6a65725b84f13321d8fed9226af5a7b0a021b826e538
 SHA512:
-  metadata.gz: 7932a40f77cdfcd9f2d6a698ef42929ce697ed68d4144c97c0a76dcc8f0c3d008eed0fb4e4582081b796f2e6767914e76f00b97c523c409c44c1447c40635cd2
-  data.tar.gz: f368b586aab6dfdaa9795edb4af23d06ef7fab69d29f691e4924e9048ea5457abea5cd60105e3e5b8e466f1df774f69e1cf157b0e6a5d619d31dc65934142046
+  metadata.gz: 1b276ccfa85b833e0412c9ba9e453e94a30afcfce6fb03e4cd03376da11b94c699a0b4bf28ed4f3b82271616e629316bd8a6351a4b0d40d20e8ef985915c610c
+  data.tar.gz: da0323bac62db522fc290062d405b620821ff9630cee43715d83e5647a49a73225f1f66aaadbe10460ee8f0c24c75cc0cce13d7fbdb593c77b5a2c2bbe37c485

data/README.md

@@ -1,21 +1,26 @@
 # Shotstack Ruby SDK
 
-Ruby SDK for Shotstack, the cloud video editing API.
+Ruby SDK for [Shotstack](http://shotstack.io), the cloud video editing API.
 
-## Build Instructions
+Shotstack is a cloud based video editing platform that enables the editing of videos using code.
 
-First make sure the version in `shotstack/version.rb` is correct.
+The platform uses an API and a JSON format for specifying how videos should be edited and what assets and titles should be used.
 
-Then, to build as a gem:
+A server based render farm takes care of rendering the videos allowing multiple videos to be created simultaneously.
 
-```bash
-rm shotstack-*.gem
-gem build shotstack
-gem push shotstack-*.*.*.gem   # use the correct version number
-```
+For examples of how to use the SDK to create videos using code checkout the Ruby demo repo: https://github.com/shotstack/ruby-demos
 
-For local development install the gem:
+## Installation
 
-```bash
-sudo gem install shotstack
 ```
+bundle install
+```
+
+## Documentation
+
+- [Getting Started Guide](https://shotstack.gitbook.io/docs/guides/getting-started)
+- [API Reference](https://shotstack.restlet.io/)
+- [Examples](https://github.com/shotstack/ruby-demos)
+- [Shotstack Website](http://shotstack.io)
+
+###

data/lib/shotstack.rb

@@ -1,12 +1,12 @@
 =begin
-#shotstack
+#Shotstack
 
-#The Shotstack API is a video editing service that allows for the programatic creation of videos using JSON. 
+#The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details check https://shotstack.io
 
-OpenAPI spec version: v1
+The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.0.0-beta3
+OpenAPI Generator version: 4.2.1
 
 =end
 
@@ -17,15 +17,22 @@ require 'shotstack/version'
 require 'shotstack/configuration'
 
 # Models
+require 'shotstack/models/audio_asset'
 require 'shotstack/models/clip'
 require 'shotstack/models/edit'
+require 'shotstack/models/font'
+require 'shotstack/models/html_asset'
 require 'shotstack/models/image_asset'
+require 'shotstack/models/luma_asset'
+require 'shotstack/models/offset'
 require 'shotstack/models/output'
+require 'shotstack/models/poster'
 require 'shotstack/models/queued_response'
 require 'shotstack/models/queued_response_data'
 require 'shotstack/models/render_response'
 require 'shotstack/models/render_response_data'
 require 'shotstack/models/soundtrack'
+require 'shotstack/models/thumbnail'
 require 'shotstack/models/timeline'
 require 'shotstack/models/title_asset'
 require 'shotstack/models/track'
@@ -33,7 +40,7 @@ require 'shotstack/models/transition'
 require 'shotstack/models/video_asset'
 
 # APIs
-require 'shotstack/api/default_api'
+require 'shotstack/api/endpoints_api'
 
 module Shotstack
   class << self

data/lib/shotstack/api/{default_api.rb → endpoints_api.rb}

@@ -1,52 +1,54 @@
 =begin
-#shotstack
+#Shotstack
 
-#The Shotstack API is a video editing service that allows for the programatic creation of videos using JSON. 
+#The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details check https://shotstack.io
 
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.0.0
+OpenAPI Generator version: 4.2.1
 
 =end
 
-require 'uri'
+require 'cgi'
 
 module Shotstack
-  class DefaultApi
+  class EndpointsApi
     attr_accessor :api_client
 
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # Get Render Status
     # Get the rendering status, video url and details of a timeline by ID.
     # @param id [String] The id of the timeline render task in UUID format
     # @param [Hash] opts the optional parameters
     # @return [RenderResponse]
     def get_render(id, opts = {})
-      data, _status_code, _headers = g_et_render_id_with_http_info(id, opts)
+      data, _status_code, _headers = get_render_with_http_info(id, opts)
       data
     end
 
+    # Get Render Status
     # Get the rendering status, video url and details of a timeline by ID.
     # @param id [String] The id of the timeline render task in UUID format
     # @param [Hash] opts the optional parameters
     # @return [Array<(RenderResponse, Integer, Hash)>] RenderResponse data, response status code and response headers
-    def g_et_render_id_with_http_info(id, opts = {})
+    def get_render_with_http_info(id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: DefaultApi.g_et_render_id ...'
+        @api_client.config.logger.debug 'Calling API: EndpointsApi.get_render ...'
       end
       # verify the required parameter 'id' is set
       if @api_client.config.client_side_validation && id.nil?
-        fail ArgumentError, "Missing the required parameter 'id' when calling DefaultApi.g_et_render_id"
+        fail ArgumentError, "Missing the required parameter 'id' when calling EndpointsApi.get_render"
       end
       pattern = Regexp.new(/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/)
       if @api_client.config.client_side_validation && id !~ pattern
-        fail ArgumentError, "invalid value for 'id' when calling DefaultApi.get_render, must conform to the pattern #{pattern}."
+        fail ArgumentError, "invalid value for 'id' when calling EndpointsApi.get_render, must conform to the pattern #{pattern}."
       end
 
       # resource path
-      local_var_path = '/render/{id}'.sub('{' + 'id' + '}', id.to_s)
+      local_var_path = '/render/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -79,31 +81,35 @@ module Shotstack
 
       data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: DefaultApi#get_render\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: EndpointsApi#get_render\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Render the contents of a timeline as a video file.
-    # @param edit [Edit] 
+    # Render Video
+    # Queue and render the contents of a timeline as a video file.
+    # @param edit [Edit] The video edit specified using JSON.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_api_queue_id The id of a dedicated queue (enterprise customers only).
     # @return [QueuedResponse]
     def post_render(edit, opts = {})
-      data, _status_code, _headers = p_ost_render_with_http_info(edit, opts)
+      data, _status_code, _headers = post_render_with_http_info(edit, opts)
       data
     end
 
-    # Render the contents of a timeline as a video file.
-    # @param edit [Edit] 
+    # Render Video
+    # Queue and render the contents of a timeline as a video file.
+    # @param edit [Edit] The video edit specified using JSON.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_api_queue_id The id of a dedicated queue (enterprise customers only).
     # @return [Array<(QueuedResponse, Integer, Hash)>] QueuedResponse data, response status code and response headers
-    def p_ost_render_with_http_info(edit, opts = {})
+    def post_render_with_http_info(edit, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: DefaultApi.post_render ...'
+        @api_client.config.logger.debug 'Calling API: EndpointsApi.post_render ...'
       end
       # verify the required parameter 'edit' is set
       if @api_client.config.client_side_validation && edit.nil?
-        fail ArgumentError, "Missing the required parameter 'edit' when calling DefaultApi.post_render"
+        fail ArgumentError, "Missing the required parameter 'edit' when calling EndpointsApi.post_render"
       end
       # resource path
       local_var_path = '/render'
@@ -117,6 +123,7 @@ module Shotstack
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+      header_params[:'x-api-queue-id'] = opts[:'x_api_queue_id'] if !opts[:'x_api_queue_id'].nil?
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -141,7 +148,7 @@ module Shotstack
 
       data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: DefaultApi#post_render\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: EndpointsApi#post_render\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end

data/lib/shotstack/api_client.rb

@@ -1,12 +1,12 @@
 =begin
-#shotstack
+#Shotstack
 
-#The Shotstack API is a video editing service that allows for the programatic creation of videos using JSON. 
+#The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details check https://shotstack.io
 
-OpenAPI spec version: v1
+The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.0.0-beta3
+OpenAPI Generator version: 4.2.1
 
 =end
 
@@ -15,7 +15,6 @@ require 'json'
 require 'logger'
 require 'tempfile'
 require 'typhoeus'
-require 'uri'
 
 module Shotstack
   class ApiClient
@@ -128,6 +127,34 @@ module Shotstack
       request
     end
 
+    # Builds the HTTP request body
+    #
+    # @param [Hash] header_params Header parameters
+    # @param [Hash] form_params Query parameters
+    # @param [Object] body HTTP body (JSON/XML)
+    # @return [String] HTTP body data in the form of string
+    def build_request_body(header_params, form_params, body)
+      # http form
+      if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
+          header_params['Content-Type'] == 'multipart/form-data'
+        data = {}
+        form_params.each do |key, value|
+          case value
+          when ::File, ::Array, nil
+            # let typhoeus handle File, Array and nil parameters
+            data[key] = value
+          else
+            data[key] = value.to_s
+          end
+        end
+      elsif body
+        data = body.is_a?(String) ? body : body.to_json
+      else
+        data = nil
+      end
+      data
+    end
+
     # Check if the given MIME is a JSON MIME.
     # JSON MIME examples:
     #   application/json
@@ -262,35 +289,7 @@ module Shotstack
     def build_request_url(path)
       # Add leading and trailing slashes to path
       path = "/#{path}".gsub(/\/+/, '/')
-      URI.encode(@config.base_url + path)
-    end
-
-    # Builds the HTTP request body
-    #
-    # @param [Hash] header_params Header parameters
-    # @param [Hash] form_params Query parameters
-    # @param [Object] body HTTP body (JSON/XML)
-    # @return [String] HTTP body data in the form of string
-    def build_request_body(header_params, form_params, body)
-      # http form
-      if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
-          header_params['Content-Type'] == 'multipart/form-data'
-        data = {}
-        form_params.each do |key, value|
-          case value
-          when ::File, ::Array, nil
-            # let typhoeus handle File, Array and nil parameters
-            data[key] = value
-          else
-            data[key] = value.to_s
-          end
-        end
-      elsif body
-        data = body.is_a?(String) ? body : body.to_json
-      else
-        data = nil
-      end
-      data
+      @config.base_url + path
     end
 
     # Update hearder and query params based on authentication settings.

data/lib/shotstack/api_error.rb

@@ -1,12 +1,12 @@
 =begin
-#shotstack
+#Shotstack
 
-#The Shotstack API is a video editing service that allows for the programatic creation of videos using JSON. 
+#The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details check https://shotstack.io
 
-OpenAPI spec version: v1
+The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.0.0-beta3
+OpenAPI Generator version: 4.2.1
 
 =end
 

data/lib/shotstack/configuration.rb

@@ -1,17 +1,15 @@
 =begin
-#shotstack
+#Shotstack
 
-#The Shotstack API is a video editing service that allows for the programatic creation of videos using JSON. 
+#The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details check https://shotstack.io
 
-OpenAPI spec version: v1
+The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.0.0-beta3
+OpenAPI Generator version: 4.2.1
 
 =end
 
-require 'uri'
-
 module Shotstack
   class Configuration
     # Defines url scheme
@@ -130,7 +128,7 @@ module Shotstack
     def initialize
       @scheme = 'https'
       @host = 'api.shotstack.io'
-      @base_path = '/version'
+      @base_path = '/v1'
       @api_key = {}
       @api_key_prefix = {}
       @timeout = 0
@@ -174,8 +172,7 @@ module Shotstack
     end
 
     def base_url
-      url = "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
-      URI.encode(url)
+      "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
     end
 
     # Gets API key (with prefix if set).
@@ -215,7 +212,11 @@ module Shotstack
           variables: {
             version: {
                 description: "No descriptoin provided",
-                default_value: "version",
+                default_value: "v1",
+                enum_values: [
+                  "v1",
+                  "stage"
+                ]
               }
             }
         }

data/lib/shotstack/models/audio_asset.rb

@@ -0,0 +1,253 @@
+=begin
+#Shotstack
+
+#The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details check https://shotstack.io
+
+The version of the OpenAPI document: v1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.1
+
+=end
+
+require 'date'
+require_relative 'asset'
+
+module Shotstack
+  # The AudioAsset is used to add sound effects and audio at specific intervals on the timeline. The src must be a publicly accessible URL to an audio resource such  as an mp3 file.
+  class AudioAsset < Asset
+    # The type of asset - set to `audio` for audio assets.
+    attr_accessor :type
+
+    # The audio source URL. The URL must be publicly accessible or include credentials.
+    attr_accessor :src
+
+    # The start trim point of the audio clip, in seconds (defaults to 0). Audio will start from the in trim point. The audio will play until the file ends or the Clip length is reached.
+    attr_accessor :trim
+
+    # Set the volume for the audio clip between 0 and 1 where 0 is muted and 1 is full volume (defaults to 1).
+    attr_accessor :volume
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'type' => :'type',
+        :'src' => :'src',
+        :'trim' => :'trim',
+        :'volume' => :'volume'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'type' => :'String',
+        :'src' => :'String',
+        :'trim' => :'Float',
+        :'volume' => :'Float'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Shotstack::AudioAsset` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Shotstack::AudioAsset`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = 'audio'
+      end
+
+      if attributes.key?(:'src')
+        self.src = attributes[:'src']
+      end
+
+      if attributes.key?(:'trim')
+        self.trim = attributes[:'trim']
+      end
+
+      if attributes.key?(:'volume')
+        self.volume = attributes[:'volume']
+      else
+        self.volume = 1
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @src.nil?
+        invalid_properties.push('invalid value for "src", src cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @type.nil?
+      return false if @src.nil?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          type == o.type &&
+          src == o.src &&
+          trim == o.trim &&
+          volume == o.volume
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [type, src, trim, volume].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        Shotstack.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+        
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end