shotstack 0.0.10 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c25bb8f71fb1b0d993a60aa4028546375451f0978461b1c91ac0caf9b651df55
-  data.tar.gz: cdeea3fed0658a006339aef975b40b94067d2e0d80c611cea9319fd304f5f1b8
+  metadata.gz: 1d7ae43e161a59f2235a19bedecbad719688f507fffbea5f3ba98290420c771d
+  data.tar.gz: e8350e8c8a158eb53d927b8abcf4ccf4aedb5800818daacde77fa7494973bc0b
 SHA512:
-  metadata.gz: 33c957198774b015ddcf9364efa98f1f104b883c02561f65acb946b790266943cac49f98178f5dbb774821c08f735c9be1f8918df30e9ff23f82f7a880ef3183
-  data.tar.gz: c7edb8be614276130289c71bf100892ef32d124b8cd480704b83f5dd26fb5bbe1c3302af6ca50a514aaac8075ab57894f390d133d96703aed7610186832f3099
+  metadata.gz: 5e8af0ed7bb5f3ec96c40106a718793e63cc8a4b57fb886c5b07e490251abd540af94744ad56206d32ac3f997ae346d5fb5e99082c8423374b8ff63bcd61df23
+  data.tar.gz: d22fe040921d1393dc9b00fa88a8ca54c2928a082f1e33c548d057a79f651f6bc07a47930e528a99b25b6480b817cd2a8e7762b45da7e284af5d04b25d69c193

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,129 +1,154 @@
 =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'
+require 'cgi'
 
 module Shotstack
-  class DefaultApi
+  class EndpointsApi
     attr_accessor :api_client
 
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Get the rendering status and details of a timeline by ID.
+    # 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 the rendering status and details of a timeline by ID.
+    # 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 = {}
+      query_params = opts[:query_params] || {}
 
       # header parameters
-      header_params = {}
+      header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
 
       # form parameters
-      form_params = {}
+      form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = nil
-      auth_names = ['DeveloperKey']
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+      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 => 'RenderResponse')
+        :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: 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'
 
       # query parameters
-      query_params = {}
+      query_params = opts[:query_params] || {}
 
       # header parameters
-      header_params = {}
+      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'])
+      header_params[:'x-api-queue-id'] = opts[:'x_api_queue_id'] if !opts[:'x_api_queue_id'].nil?
 
       # form parameters
-      form_params = {}
+      form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = @api_client.object_to_http_body(edit)
-      auth_names = ['DeveloperKey']
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+      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 => 'QueuedResponse')
+        :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: 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"
+                ]
               }
             }
         }