shotstack 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5d727eb8d81617086f6b4506df8f738a8ecb07d818a375ab8822159904a4845
-  data.tar.gz: d25bdff650bb7dd955978ff1b63d2edcf4bb895ed84e4c40a3217a57afdbb1e8
+  metadata.gz: fbe23e5f4a04895111959fadb1ae057a20d64b47b3015f4ac8cad2481b83f077
+  data.tar.gz: da6e99e80bea597ef2e65a5bf09bafcecd4923015fcc3ba1dbffda46306006c0
 SHA512:
-  metadata.gz: c2411953a0b793ecfb4e8a9d651e5a9f918168b508c63bb143ab47b44b971465b17e87fe879477ca75e3fb4d3e68499cce9c968f9db0b26ad9511c950f65f726
-  data.tar.gz: 06ec520d33f69604f7ecf2b11937c353f8d67af0a463563fcbb957c25682f62a8e523e6ee11664b3a88cf2cb5e8f3fc2763909e6c69483ab46c8b2bdb6f7713c
+  metadata.gz: 69581b3a2c839530874857f0964f62cb01adb0a28c8dd04bfd65f142d172eb6465ddddf43d1fc80d55108301c7ab60a7b3939ee9903868842c5241e6314bf904
+  data.tar.gz: 1106311ee9c828f029679471cc02899342c3054927176e0c6e9b2b2cb7b433afa21f1dd997ef787df1cfbd9e9dddf3868f1497fcae89313bb6a25120c4829e00

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

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.1
+OpenAPI Generator version: 5.0.0
 
 =end
 
@@ -19,6 +19,7 @@ require 'shotstack/configuration'
 # Models
 require 'shotstack/models/audio_asset'
 require 'shotstack/models/clip'
+require 'shotstack/models/crop'
 require 'shotstack/models/edit'
 require 'shotstack/models/font'
 require 'shotstack/models/html_asset'
@@ -29,6 +30,7 @@ require 'shotstack/models/output'
 require 'shotstack/models/poster'
 require 'shotstack/models/queued_response'
 require 'shotstack/models/queued_response_data'
+require 'shotstack/models/range'
 require 'shotstack/models/render_response'
 require 'shotstack/models/render_response_data'
 require 'shotstack/models/soundtrack'

data/lib/shotstack/api/endpoints_api.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.1
+OpenAPI Generator version: 5.0.0
 
 =end
 
@@ -19,6 +19,7 @@ module Shotstack
     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
@@ -28,6 +29,7 @@ module Shotstack
       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
@@ -60,15 +62,16 @@ module Shotstack
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:return_type] || 'RenderResponse' 
+      return_type = opts[:debug_return_type] || 'RenderResponse'
 
       # auth_names
-      auth_names = opts[:auth_names] || ['DeveloperKey']
+      auth_names = opts[:debug_auth_names] || ['DeveloperKey']
 
       new_options = opts.merge(
+        :operation => :"EndpointsApi.get_render",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -84,18 +87,22 @@ module Shotstack
       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 = 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 post_render_with_http_info(edit, opts = {})
       if @api_client.config.debugging
@@ -117,20 +124,22 @@ 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] || {}
 
       # http body (model)
-      post_body = opts[:body] || @api_client.object_to_http_body(edit) 
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(edit)
 
       # return_type
-      return_type = opts[:return_type] || 'QueuedResponse' 
+      return_type = opts[:debug_return_type] || 'QueuedResponse'
 
       # auth_names
-      auth_names = opts[:auth_names] || ['DeveloperKey']
+      auth_names = opts[:debug_auth_names] || ['DeveloperKey']
 
       new_options = opts.merge(
+        :operation => :"EndpointsApi.post_render",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,

data/lib/shotstack/api_client.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.1
+OpenAPI Generator version: 5.0.0
 
 =end
 
@@ -14,6 +14,7 @@ require 'date'
 require 'json'
 require 'logger'
 require 'tempfile'
+require 'time'
 require 'typhoeus'
 
 module Shotstack
@@ -86,7 +87,7 @@ module Shotstack
     # @option opts [Object] :body HTTP body (JSON/XML)
     # @return [Typhoeus::Request] A Typhoeus Request
     def build_request(http_method, path, opts = {})
-      url = build_request_url(path)
+      url = build_request_url(path, opts)
       http_method = http_method.to_sym.downcase
 
       header_params = @default_headers.merge(opts[:header_params] || {})
@@ -155,6 +156,44 @@ module Shotstack
       data
     end
 
+    # Save response body into a file in (the defined) temporary folder, using the filename
+    # from the "Content-Disposition" header if provided, otherwise a random filename.
+    # The response body is written to the file in chunks in order to handle files which
+    # size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
+    # process can use.
+    #
+    # @see Configuration#temp_folder_path
+    def download_file(request)
+      tempfile = nil
+      encoding = nil
+      request.on_headers do |response|
+        content_disposition = response.headers['Content-Disposition']
+        if content_disposition && content_disposition =~ /filename=/i
+          filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
+          prefix = sanitize_filename(filename)
+        else
+          prefix = 'download-'
+        end
+        prefix = prefix + '-' unless prefix.end_with?('-')
+        encoding = response.body.encoding
+        tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
+        @tempfile = tempfile
+      end
+      request.on_body do |chunk|
+        chunk.force_encoding(encoding)
+        tempfile.write(chunk)
+      end
+      request.on_complete do |response|
+        if tempfile
+          tempfile.close
+          @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
+                              "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
+                              "will be deleted automatically with GC. It's also recommended to delete the temp file "\
+                              "explicitly with `tempfile.delete`"
+        end
+      end
+    end
+
     # Check if the given MIME is a JSON MIME.
     # JSON MIME examples:
     #   application/json
@@ -191,7 +230,7 @@ module Shotstack
       begin
         data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
       rescue JSON::ParserError => e
-        if %w(String Date DateTime).include?(return_type)
+        if %w(String Date Time).include?(return_type)
           data = body
         else
           raise e
@@ -216,9 +255,9 @@ module Shotstack
         data.to_f
       when 'Boolean'
         data == true
-      when 'DateTime'
+      when 'Time'
         # parse date time (expecting ISO 8601 format)
-        DateTime.parse data
+        Time.parse data
       when 'Date'
         # parse date time (expecting ISO 8601 format)
         Date.parse data
@@ -236,44 +275,9 @@ module Shotstack
           data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
         end
       else
-        # models, e.g. Pet
-        Shotstack.const_get(return_type).build_from_hash(data)
-      end
-    end
-
-    # Save response body into a file in (the defined) temporary folder, using the filename
-    # from the "Content-Disposition" header if provided, otherwise a random filename.
-    # The response body is written to the file in chunks in order to handle files which
-    # size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
-    # process can use.
-    #
-    # @see Configuration#temp_folder_path
-    def download_file(request)
-      tempfile = nil
-      encoding = nil
-      request.on_headers do |response|
-        content_disposition = response.headers['Content-Disposition']
-        if content_disposition && content_disposition =~ /filename=/i
-          filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
-          prefix = sanitize_filename(filename)
-        else
-          prefix = 'download-'
-        end
-        prefix = prefix + '-' unless prefix.end_with?('-')
-        encoding = response.body.encoding
-        tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
-        @tempfile = tempfile
-      end
-      request.on_body do |chunk|
-        chunk.force_encoding(encoding)
-        tempfile.write(chunk)
-      end
-      request.on_complete do |response|
-        tempfile.close if tempfile
-        @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
-                            "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
-                            "will be deleted automatically with GC. It's also recommended to delete the temp file "\
-                            "explicitly with `tempfile.delete`"
+        # models (e.g. Pet) or oneOf
+        klass = Shotstack.const_get(return_type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(data) : klass.build_from_hash(data)
       end
     end
 
@@ -286,10 +290,10 @@ module Shotstack
       filename.gsub(/.*[\/\\]/, '')
     end
 
-    def build_request_url(path)
+    def build_request_url(path, opts = {})
       # Add leading and trailing slashes to path
       path = "/#{path}".gsub(/\/+/, '/')
-      @config.base_url + path
+      @config.base_url(opts[:operation]) + path
     end
 
     # Update hearder and query params based on authentication settings.

data/lib/shotstack/api_error.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.1
+OpenAPI Generator version: 5.0.0
 
 =end
 

data/lib/shotstack/configuration.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.1
+OpenAPI Generator version: 5.0.0
 
 =end
 
@@ -21,6 +21,18 @@ module Shotstack
     # Defines url base path
     attr_accessor :base_path
 
+    # Define server configuration index
+    attr_accessor :server_index
+
+    # Define server operation configuration index
+    attr_accessor :server_operation_index
+
+    # Default server variables
+    attr_accessor :server_variables
+
+    # Default server operation variables
+    attr_accessor :server_operation_variables
+
     # Defines API keys used with API Key authentications.
     #
     # @return [Hash] key: parameter name, value: parameter value (API key)
@@ -129,6 +141,10 @@ module Shotstack
       @scheme = 'https'
       @host = 'api.shotstack.io'
       @base_path = '/v1'
+      @server_index = 0
+      @server_operation_index = {}
+      @server_variables = {}
+      @server_operation_variables = {}
       @api_key = {}
       @api_key_prefix = {}
       @timeout = 0
@@ -171,8 +187,12 @@ module Shotstack
       @base_path = '' if @base_path == '/'
     end
 
-    def base_url
-      "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
+    # Returns base URL for specified operation based on server settings
+    def base_url(operation = nil)
+      index = server_operation_index.fetch(operation, server_index)
+      return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') # if index == nil
+
+      #server_url(index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
     end
 
     # Gets API key (with prefix if set).
@@ -208,10 +228,10 @@ module Shotstack
       [
         {
           url: "https://api.shotstack.io/{version}",
-          description: "No descriptoin provided",
+          description: "No description provided",
           variables: {
             version: {
-                description: "No descriptoin provided",
+                description: "No description provided",
                 default_value: "v1",
                 enum_values: [
                   "v1",
@@ -223,12 +243,17 @@ module Shotstack
       ]
     end
 
+    def operation_server_settings
+      {
+      }
+    end
+
     # Returns URL based on server settings
     #
     # @param index array index of the server settings
     # @param variables hash of variable and the corresponding value
-    def server_url(index, variables = {})
-      servers = server_settings
+    def server_url(index, variables = {}, servers = nil)
+      servers = server_settings if servers == nil
 
       # check array index out of bound
       if (index < 0 || index >= servers.size)
@@ -238,10 +263,12 @@ module Shotstack
       server = servers[index]
       url = server[:url]
 
+      return url unless server.key? :variables
+
       # go through variable and assign a value
       server[:variables].each do |name, variable|
         if variables.key?(name)
-          if (server[:variables][name][:enum_values].include? variables[name])
+          if (!server[:variables][name].key?(:enum_values) || server[:variables][name][:enum_values].include?(variables[name]))
             url.gsub! "{" + name.to_s + "}", variables[name]
           else
             fail ArgumentError, "The variable `#{name}` in the server URL has invalid value #{variables[name]}. Must be #{server[:variables][name][:enum_values]}."

data/lib/shotstack/models/audio_asset.rb

@@ -6,17 +6,18 @@
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.1
+OpenAPI Generator version: 5.0.0
 
 =end
 
 require 'date'
+require 'time'
 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 <b>audio</b> for audio assets.
+    # 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.
@@ -28,23 +29,55 @@ module Shotstack
     # 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
 
+    # The effect to apply to the audio asset <ul>   <li>`fadeIn` - fade volume in only</li>   <li>`fadeOut` - fade volume out only</li>   <li>`fadeInFadeOut` - fade volume in and out</li> </ul>
+    attr_accessor :effect
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'type' => :'type',
         :'src' => :'src',
         :'trim' => :'trim',
-        :'volume' => :'volume'
+        :'volume' => :'volume',
+        :'effect' => :'effect'
       }
     end
 
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
     # Attribute type mapping.
     def self.openapi_types
       {
         :'type' => :'String',
         :'src' => :'String',
         :'trim' => :'Float',
-        :'volume' => :'Float'
+        :'volume' => :'Float',
+        :'effect' => :'String'
       }
     end
 
@@ -85,6 +118,12 @@ module Shotstack
 
       if attributes.key?(:'volume')
         self.volume = attributes[:'volume']
+      else
+        self.volume = 1
+      end
+
+      if attributes.key?(:'effect')
+        self.effect = attributes[:'effect']
       end
     end
 
@@ -108,9 +147,21 @@ module Shotstack
     def valid?
       return false if @type.nil?
       return false if @src.nil?
+      effect_validator = EnumAttributeValidator.new('String', ["fadeIn", "fadeOut", "fadeInFadeOut"])
+      return false unless effect_validator.valid?(@effect)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] effect Object to be assigned
+    def effect=(effect)
+      validator = EnumAttributeValidator.new('String', ["fadeIn", "fadeOut", "fadeInFadeOut"])
+      unless validator.valid?(effect)
+        fail ArgumentError, "invalid value for \"effect\", must be one of #{validator.allowable_values}."
+      end
+      @effect = effect
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -119,7 +170,8 @@ module Shotstack
           type == o.type &&
           src == o.src &&
           trim == o.trim &&
-          volume == o.volume
+          volume == o.volume &&
+          effect == o.effect
     end
 
     # @see the `==` method
@@ -131,7 +183,7 @@ module Shotstack
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [type, src, trim, volume].hash
+      [type, src, trim, volume, effect].hash
     end
 
     # Builds the object from hash
@@ -147,7 +199,9 @@ module Shotstack
     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
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif 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)
@@ -155,7 +209,7 @@ module Shotstack
           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
       end
 
       self
@@ -167,8 +221,8 @@ module Shotstack
     # @return [Object] Deserialized data
     def _deserialize(type, value)
       case type.to_sym
-      when :DateTime
-        DateTime.parse(value)
+      when :Time
+        Time.parse(value)
       when :Date
         Date.parse(value)
       when :String
@@ -198,7 +252,9 @@ module Shotstack
           end
         end
       else # model
-        Shotstack.const_get(type).build_from_hash(value)
+        # models (e.g. Pet) or oneOf
+        klass = Shotstack.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 
@@ -224,7 +280,7 @@ module Shotstack
           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
@@ -247,5 +303,7 @@ module Shotstack
         value
       end
     end
+
   end
+
 end