shotstack 0.1.3 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d7ae43e161a59f2235a19bedecbad719688f507fffbea5f3ba98290420c771d
-  data.tar.gz: e8350e8c8a158eb53d927b8abcf4ccf4aedb5800818daacde77fa7494973bc0b
+  metadata.gz: 2013cc0deefd2609694ce0d03969528246b8d9e022f43cff2f823357abfd1744
+  data.tar.gz: e79f176687123dbe267196d2cd5e56bca1975447104497a743aadb54a2d7b9ad
 SHA512:
-  metadata.gz: 5e8af0ed7bb5f3ec96c40106a718793e63cc8a4b57fb886c5b07e490251abd540af94744ad56206d32ac3f997ae346d5fb5e99082c8423374b8ff63bcd61df23
-  data.tar.gz: d22fe040921d1393dc9b00fa88a8ca54c2928a082f1e33c548d057a79f651f6bc07a47930e528a99b25b6480b817cd2a8e7762b45da7e284af5d04b25d69c193
+  metadata.gz: 826363b7b37ce3931c471574dc3a645237575512549007b1a6009775f7a2f02f7144eaebe18a5c486f50a1f5016ec601264731fb81c036b01f3ce62338da2974
+  data.tar.gz: b9b515972a02f5f661df74d0f832faa50a6a2e6f20f25f55e6c568070596402a33ca30f07395000be5cfb516c7290ded6a55b62a3406be4750875590e4a709aa

data/lib/shotstack.rb

@@ -1,12 +1,12 @@
 =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 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 visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.gitbook.io/docs/guides/getting-started) documentation.
 
 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

@@ -1,12 +1,12 @@
 =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 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 visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.gitbook.io/docs/guides/getting-started) documentation.
 
 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
 
@@ -62,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,
@@ -129,15 +130,16 @@ module Shotstack
       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

@@ -1,12 +1,12 @@
 =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 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 visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.gitbook.io/docs/guides/getting-started) documentation.
 
 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

@@ -1,12 +1,12 @@
 =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 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 visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.gitbook.io/docs/guides/getting-started) documentation.
 
 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

@@ -1,12 +1,12 @@
 =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 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 visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.gitbook.io/docs/guides/getting-started) documentation.
 
 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

@@ -1,16 +1,17 @@
 =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 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 visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.gitbook.io/docs/guides/getting-started) documentation.
 
 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
@@ -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
 
@@ -88,6 +121,10 @@ module Shotstack
       else
         self.volume = 1
       end
+
+      if attributes.key?(:'effect')
+        self.effect = attributes[:'effect']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -110,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)
@@ -121,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
@@ -133,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
@@ -149,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)
@@ -157,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
@@ -169,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
@@ -200,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
 
@@ -226,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
@@ -249,5 +303,7 @@ module Shotstack
         value
       end
     end
+
   end
+
 end