shotstack 0.1.1 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6293628e93b0b33cd83ba41500dfc12f8f729784a697c562e95b74ee1bdccc92
-  data.tar.gz: 22cf3c4fa7e787c8e85d7236870c609b9054e590e9d106844451ba7b689381b7
+  metadata.gz: beaf3d5fe2f52979dd1568eda4493f3b7a17ed4c6d31617cde1fb9fd2380c490
+  data.tar.gz: 5285621fb3665111d6604b6bc0ee6b5bf4b0a7a419c5394a2cff017419a70c04
 SHA512:
-  metadata.gz: a7bbe3ee1e9813148d25ecf3144ab30b9a6d4d309271ba45c7e2b648cbfda84e7a18589c2c1e4cc5e20d1ada0e7811679b82b7176547dda9a3985022fa84cea4
-  data.tar.gz: 730d8872e80f2e3bcf5102c8785570c0873bfe4e46ee69ee6fa219d6c6c5567e28972d91a943cac48d1704e88b3e85463c93e691a5068ef29affbb39fe36b169
+  metadata.gz: d906ed85a8bc07db5d69b65edac025ddfb85c4820881e0e9f783e227f61e5bfddd5db1ea3d514c00249c418e9ee95e9a8aac72a04e3838b6ec1565653a1ef8a2
+  data.tar.gz: 84179e26341f4a1a12a1beade04d07dac1fcb9e782fd2b983acc5b185cf98035b074f8ccdc0580d15b86df17dd7461cf6445a4e12cf79c1c80633e80e962bae3

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
 
-#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
 
@@ -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

@@ -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]}."