shotstack 0.0.9 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 31d87d73c44a309627e675a50328dd0595745f55
-  data.tar.gz: 43089c6e46758d056c8c7926f160a6b9437890ed
+SHA256:
+  metadata.gz: d1177fae43086a9c88b2f244d5cc366de2d36ea4c1072c06e98b4b37b8ca11b5
+  data.tar.gz: 9d34f601b12b4d2452271e16f5dfe60d1c847792b8b4cda368222a30c35974e1
 SHA512:
-  metadata.gz: 734bb28a5608c27273234cae6e3cfcfcf7f95ad89fb04c7399adac6e3e2f54da3733da9785866211ebf5717a4ac49ef097a78a5b35f58a9e02759dd375784864
-  data.tar.gz: c13acb5444f705bbdef61583edb555d0ab0a3809f9378e89604c592f302d645c8860207708ad9badccacad21fd9c2ffd25e7c00a8175ec7b0eccbea2ea0af54c
+  metadata.gz: 9e14b9e05c8c7291e15069e43abd65ea098ed0f842c587aa295f5bb05889dc25881aedda157576467ffb20fffc1ffdcdf469869408ac7e3a1728067f36c58fa5
+  data.tar.gz: 76fff0a5ed03bbbfe2c7f3cdbf0e4fe2341ea826c5878b13acee0c4d5db336d1cedde40eea0d846746c296abf514a1def2345e453539804eea88173cc986884a

data/README.md

@@ -2,3 +2,20 @@
 
 Ruby SDK for Shotstack, the cloud video editing API.
 
+## Build Instructions
+
+First make sure the version in `shotstack/version.rb` is correct.
+
+Then, to build as a gem:
+
+```bash
+rm shotstack-*.gem
+gem build shotstack
+gem push shotstack-*.*.*.gem   # use the correct version number
+```
+
+For local development install the gem:
+
+```bash
+sudo gem install shotstack
+```

data/lib/shotstack.rb

@@ -1,3 +1,15 @@
+=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
+
 # Common files
 require 'shotstack/api_client'
 require 'shotstack/api_error'
@@ -5,26 +17,30 @@ require 'shotstack/version'
 require 'shotstack/configuration'
 
 # Models
-require 'shotstack/models/render_response_data'
-require 'shotstack/models/render_response'
-require 'shotstack/models/queued_response_data'
-require 'shotstack/models/queued_response'
+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/transition'
-require 'shotstack/models/video_clip_options'
-require 'shotstack/models/video_clip'
-require 'shotstack/models/image_clip_options'
-require 'shotstack/models/image_clip'
-require 'shotstack/models/title_clip_options'
-require 'shotstack/models/title_clip'
-require 'shotstack/models/track'
-require 'shotstack/models/clips'
+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/edit'
+require 'shotstack/models/title_asset'
+require 'shotstack/models/track'
+require 'shotstack/models/transition'
+require 'shotstack/models/video_asset'
 
 # APIs
-require 'shotstack/api/render_api'
+require 'shotstack/api/endpoints_api'
 
 module Shotstack
   class << self

data/lib/shotstack/api/endpoints_api.rb

@@ -0,0 +1,149 @@
+=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 'cgi'
+
+module Shotstack
+  class EndpointsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # 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 = get_render_with_http_info(id, opts)
+      data
+    end
+
+    # 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 get_render_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @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 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 EndpointsApi.get_render, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/render/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'RenderResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['DeveloperKey']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      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: 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] 
+    # @param [Hash] opts the optional parameters
+    # @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] 
+    # @param [Hash] opts the optional parameters
+    # @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
+        @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 EndpointsApi.post_render"
+      end
+      # resource path
+      local_var_path = '/render'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(edit) 
+
+      # return_type
+      return_type = opts[:return_type] || 'QueuedResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['DeveloperKey']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      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: EndpointsApi#post_render\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/shotstack/api_client.rb

@@ -1,9 +1,20 @@
+=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 'json'
 require 'logger'
 require 'tempfile'
 require 'typhoeus'
-require 'uri'
 
 module Shotstack
   class ApiClient
@@ -15,11 +26,13 @@ module Shotstack
     # @return [Hash]
     attr_accessor :default_headers
 
+    # Initializes the ApiClient
+    # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "ruby-swagger-#{VERSION}"
+      @user_agent = "OpenAPI-Generator/#{VERSION}/ruby"
       @default_headers = {
-        'Content-Type' => "application/json",
+        'Content-Type' => 'application/json',
         'User-Agent' => @user_agent
       }
     end
@@ -30,7 +43,7 @@ module Shotstack
 
     # Call an API with given options.
     #
-    # @return [Array<(Object, Fixnum, Hash)>] an array of 3 elements:
+    # @return [Array<(Object, Integer, Hash)>] an array of 3 elements:
     #   the data deserialized from response body (could be nil), response status code and response headers.
     def call_api(http_method, path, opts = {})
       request = build_request(http_method, path, opts)
@@ -41,10 +54,18 @@ module Shotstack
       end
 
       unless response.success?
-        fail ApiError.new(:code => response.code,
-                          :response_headers => response.headers,
-                          :response_body => response.body),
-             response.status_message
+        if response.timed_out?
+          fail ApiError.new('Connection timed out')
+        elsif response.code == 0
+          # Errors from libcurl will be made visible here
+          fail ApiError.new(:code => 0,
+                            :message => response.return_message)
+        else
+          fail ApiError.new(:code => response.code,
+                            :response_headers => response.headers,
+                            :response_body => response.body),
+               response.status_message
+        end
       end
 
       if opts[:return_type]
@@ -55,6 +76,15 @@ module Shotstack
       return data, response.code, response.headers
     end
 
+    # Builds the HTTP request
+    #
+    # @param [String] http_method HTTP method/verb (e.g. POST)
+    # @param [String] path URL path (e.g. /account/new)
+    # @option opts [Hash] :header_params Header parameters
+    # @option opts [Hash] :query_params Query parameters
+    # @option opts [Hash] :form_params Query parameters
+    # @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)
       http_method = http_method.to_sym.downcase
@@ -63,22 +93,27 @@ module Shotstack
       query_params = opts[:query_params] || {}
       form_params = opts[:form_params] || {}
 
-      
       update_params_for_auth! header_params, query_params, opts[:auth_names]
-      
+
+      # set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
+      _verify_ssl_host = @config.verify_ssl_host ? 2 : 0
 
       req_opts = {
         :method => http_method,
         :headers => header_params,
         :params => query_params,
+        :params_encoding => @config.params_encoding,
         :timeout => @config.timeout,
         :ssl_verifypeer => @config.verify_ssl,
+        :ssl_verifyhost => _verify_ssl_host,
         :sslcert => @config.cert_file,
         :sslkey => @config.key_file,
-        :cainfo => @config.ssl_ca_cert,
         :verbose => @config.debugging
       }
 
+      # set custom cert, if provided
+      req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
+
       if [:post, :patch, :put, :delete].include?(http_method)
         req_body = build_request_body(header_params, form_params, opts[:body])
         req_opts.update :body => req_body
@@ -87,7 +122,37 @@ module Shotstack
         end
       end
 
-      Typhoeus::Request.new(url, req_opts)
+      request = Typhoeus::Request.new(url, req_opts)
+      download_file(request) if opts[:return_type] == 'File'
+      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.
@@ -95,19 +160,28 @@ module Shotstack
     #   application/json
     #   application/json; charset=UTF8
     #   APPLICATION/JSON
+    #   */*
+    # @param [String] mime MIME
+    # @return [Boolean] True if the MIME is application/json
     def json_mime?(mime)
-       !!(mime =~ /\Aapplication\/json(;.*)?\z/i)
+      (mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
     end
 
     # Deserialize the response to the given return type.
     #
-    # @param [String] return_type some examples: "User", "Array[User]", "Hash[String,Integer]"
+    # @param [Response] response HTTP response
+    # @param [String] return_type some examples: "User", "Array<User>", "Hash<String, Integer>"
     def deserialize(response, return_type)
       body = response.body
+
+      # handle file downloading - return the File instance processed in request callbacks
+      # note that response body is empty when the file is written in chunks in request on_body callback
+      return @tempfile if return_type == 'File'
+
       return nil if body.nil? || body.empty?
 
-      # handle file downloading - save response body into a tmp file and return the File instance
-      return download_file(response) if return_type == 'File'
+      # return response body directly for String return type
+      return body if return_type == 'String'
 
       # ensuring a default content type
       content_type = response.headers['Content-Type'] || 'application/json'
@@ -128,6 +202,9 @@ module Shotstack
     end
 
     # Convert data to the given return type.
+    # @param [Object] data Data to be converted
+    # @param [String] return_type Return type
+    # @return [Mixed] Data in a particular type
     def convert_to_type(data, return_type)
       return nil if data.nil?
       case return_type
@@ -137,7 +214,7 @@ module Shotstack
         data.to_i
       when 'Float'
         data.to_f
-      when 'BOOLEAN'
+      when 'Boolean'
         data == true
       when 'DateTime'
         # parse date time (expecting ISO 8601 format)
@@ -146,52 +223,58 @@ module Shotstack
         # parse date time (expecting ISO 8601 format)
         Date.parse data
       when 'Object'
-        # generic object, return directly
+        # generic object (usually a Hash), return directly
         data
       when /\AArray<(.+)>\z/
         # e.g. Array<Pet>
         sub_type = $1
-        data.map {|item| convert_to_type(item, sub_type) }
+        data.map { |item| convert_to_type(item, sub_type) }
       when /\AHash\<String, (.+)\>\z/
         # e.g. Hash<String, Integer>
         sub_type = $1
         {}.tap do |hash|
-          data.each {|k, v| hash[k] = convert_to_type(v, sub_type) }
+          data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
         end
       else
         # models, e.g. Pet
-        Shotstack.const_get(return_type).new.tap do |model|
-          model.build_from_hash data
-        end
+        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
-    # @return [Tempfile] the file downloaded
-    def download_file(response)
-      content_disposition = response.headers['Content-Disposition']
-      if content_disposition
-        filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
-        prefix = sanitize_filename(filename)
-      else
-        prefix = 'download-'
-      end
-      prefix = prefix + '-' unless prefix.end_with?('-')
-
+    def download_file(request)
       tempfile = nil
-      encoding = response.body.encoding
-      Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding) do |file|
-        file.write(response.body)
-        tempfile = file
+      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`"
       end
-      @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`"
-      tempfile
     end
 
     # Sanitize filename by removing path.
@@ -200,38 +283,20 @@ module Shotstack
     # @param [String] filename the filename to be sanitized
     # @return [String] the sanitized filename
     def sanitize_filename(filename)
-      filename.gsub /.*[\/\\]/, ''
+      filename.gsub(/.*[\/\\]/, '')
     end
 
     def build_request_url(path)
       # Add leading and trailing slashes to path
       path = "/#{path}".gsub(/\/+/, '/')
-      URI.encode(@config.base_url + path)
-    end
-
-    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.
+    #
+    # @param [Hash] header_params Header parameters
+    # @param [Hash] query_params Query parameters
+    # @param [String] auth_names Authentication scheme name
     def update_params_for_auth!(header_params, query_params, auth_names)
       Array(auth_names).each do |auth_name|
         auth_setting = @config.auth_settings[auth_name]
@@ -244,6 +309,9 @@ module Shotstack
       end
     end
 
+    # Sets user agent in HTTP header
+    #
+    # @param [String] user_agent User agent (e.g. openapi-generator/ruby/1.0.0)
     def user_agent=(user_agent)
       @user_agent = user_agent
       @default_headers['User-Agent'] = @user_agent
@@ -256,7 +324,7 @@ module Shotstack
       return nil if accepts.nil? || accepts.empty?
       # use JSON when present, otherwise use all of the provided
       json_accept = accepts.find { |s| json_mime?(s) }
-      return json_accept || accepts.join(',')
+      json_accept || accepts.join(',')
     end
 
     # Return Content-Type header based on an array of content types provided.
@@ -267,21 +335,21 @@ module Shotstack
       return 'application/json' if content_types.nil? || content_types.empty?
       # use JSON when present, otherwise use the first one
       json_content_type = content_types.find { |s| json_mime?(s) }
-      return json_content_type || content_types.first
+      json_content_type || content_types.first
     end
 
     # Convert object (array, hash, object, etc) to JSON string.
     # @param [Object] model object to be converted into JSON string
     # @return [String] JSON string representation of the object
     def object_to_http_body(model)
-      return if model.nil?
-      _body = nil
+      return model if model.nil? || model.is_a?(String)
+      local_body = nil
       if model.is_a?(Array)
-        _body = model.map{|m| object_to_hash(m) }
+        local_body = model.map { |m| object_to_hash(m) }
       else
-        _body = object_to_hash(model)
+        local_body = object_to_hash(model)
       end
-      _body.to_json
+      local_body.to_json
     end
 
     # Convert object(non-array) to hash.