shotstack 0.0.9 → 0.0.10

data/lib/shotstack/api_error.rb

@@ -1,3 +1,15 @@
+=begin
+#shotstack
+
+#The Shotstack API is a video editing service that allows for the programatic creation of videos using JSON. 
+
+OpenAPI spec version: v1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.0-beta3
+
+=end
+
 module Shotstack
   class ApiError < StandardError
     attr_reader :code, :response_headers, :response_body
@@ -9,16 +21,37 @@ module Shotstack
     #   ApiError.new(:code => 404, :message => "Not Found")
     def initialize(arg = nil)
       if arg.is_a? Hash
+        if arg.key?(:message) || arg.key?('message')
+          super(arg[:message] || arg['message'])
+        else
+          super arg
+        end
+
         arg.each do |k, v|
-          if k.to_s == 'message'
-            super v
-          else
-            instance_variable_set "@#{k}", v
-          end
+          instance_variable_set "@#{k}", v
         end
       else
         super arg
       end
     end
+
+    # Override to_s to display a friendly error message
+    def to_s
+      message
+    end
+
+    def message
+      if @message.nil?
+        msg = "Error message: the server returns an error"
+      else
+        msg = @message
+      end
+
+      msg += "\nHTTP status code: #{code}" if code
+      msg += "\nResponse headers: #{response_headers}" if response_headers
+      msg += "\nResponse body: #{response_body}" if response_body
+
+      msg
+    end
   end
 end

data/lib/shotstack/configuration.rb

@@ -1,3 +1,15 @@
+=begin
+#shotstack
+
+#The Shotstack API is a video editing service that allows for the programatic creation of videos using JSON. 
+
+OpenAPI spec version: v1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.0-beta3
+
+=end
+
 require 'uri'
 
 module Shotstack
@@ -64,7 +76,12 @@ module Shotstack
     # Default to 0 (never times out).
     attr_accessor :timeout
 
-    ### TLS/SSL
+    # Set this to false to skip client side validation in the operation.
+    # Default to true.
+    # @return [true, false]
+    attr_accessor :client_side_validation
+
+    ### TLS/SSL setting
     # Set this to false to skip verifying SSL certificate when calling API from https server.
     # Default to true.
     #
@@ -73,6 +90,16 @@ module Shotstack
     # @return [true, false]
     attr_accessor :verify_ssl
 
+    ### TLS/SSL setting
+    # Set this to false to skip verifying SSL host name
+    # Default to true.
+    #
+    # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
+    #
+    # @return [true, false]
+    attr_accessor :verify_ssl_host
+
+    ### TLS/SSL setting
     # Set this to customize the certificate file to verify the peer.
     #
     # @return [String] the path to the certificate file
@@ -81,12 +108,21 @@ module Shotstack
     # https://github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145
     attr_accessor :ssl_ca_cert
 
+    ### TLS/SSL setting
     # Client certificate file (for client certificate)
     attr_accessor :cert_file
 
+    ### TLS/SSL setting
     # Client private key file (for client certificate)
     attr_accessor :key_file
 
+    # Set this to customize parameters encoding of array parameter with multi collectionFormat.
+    # Default to nil.
+    #
+    # @see The params_encoding option of Ethon. Related source code:
+    # https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96
+    attr_accessor :params_encoding
+
     attr_accessor :inject_format
 
     attr_accessor :force_ending_format
@@ -94,11 +130,14 @@ module Shotstack
     def initialize
       @scheme = 'https'
       @host = 'api.shotstack.io'
-      @base_path = '/v1'
+      @base_path = '/version'
       @api_key = {}
       @api_key_prefix = {}
       @timeout = 0
+      @client_side_validation = true
       @verify_ssl = true
+      @verify_ssl_host = true
+      @params_encoding = nil
       @cert_file = nil
       @key_file = nil
       @debugging = false
@@ -131,7 +170,7 @@ module Shotstack
     def base_path=(base_path)
       # Add leading and trailing slashes to base_path
       @base_path = "/#{base_path}".gsub(/\/+/, '/')
-      @base_path = "" if @base_path == "/"
+      @base_path = '' if @base_path == '/'
     end
 
     def base_url
@@ -166,5 +205,53 @@ module Shotstack
           },
       }
     end
+
+    # Returns an array of Server setting
+    def server_settings
+      [
+        {
+          url: "https://api.shotstack.io/{version}",
+          description: "No descriptoin provided",
+          variables: {
+            version: {
+                description: "No descriptoin provided",
+                default_value: "version",
+              }
+            }
+        }
+      ]
+    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
+
+      # check array index out of bound
+      if (index < 0 || index >= servers.size)
+        fail ArgumentError, "Invalid index #{index} when selecting the server. Must be less than #{servers.size}"
+      end
+
+      server = servers[index]
+      url = server[:url]
+
+      # 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])
+            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]}."
+          end
+        else
+          # use default value
+          url.gsub! "{" + name.to_s + "}", server[:variables][name][:default_value]
+        end
+      end
+
+      url
+    end
   end
 end

data/lib/shotstack/models/asset.rb

@@ -0,0 +1,17 @@
+module Shotstack
+  class Asset
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+
+    end
+  end
+end

data/lib/shotstack/models/clip.rb

@@ -0,0 +1,308 @@
+=begin
+#shotstack
+
+#The Shotstack API is a video editing service that allows for the programatic creation of videos using JSON. 
+
+OpenAPI spec version: v1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.0-beta3
+
+=end
+
+require 'date'
+
+module Shotstack
+  # A clip is a container for a specific type of asset, i.e. a title, photo or video. You use a Clip to define when an asset will display on the timeline, how long it will play for and transitions and effects to apply to it. 
+  class Clip
+    # The type of asset to display for the duration of this Clip. Value must be one of <b>TitleAsset</b>, <b>ImageAsset</b> or <b>VideoAsset</b>. 
+    attr_accessor :asset
+
+    # The start position of the Clip on the timeline, in seconds.
+    attr_accessor :start
+
+    # The length, in seconds, the Clip should play for.
+    attr_accessor :length
+
+    attr_accessor :transition
+
+    # A motion effect to apply to the Clip.
+    attr_accessor :effect
+
+    # A filter effect to apply to the Clip.
+    attr_accessor :filter
+
+    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
+      {
+        :'asset' => :'asset',
+        :'start' => :'start',
+        :'length' => :'length',
+        :'transition' => :'transition',
+        :'effect' => :'effect',
+        :'filter' => :'filter'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'asset' => :'Asset',
+        :'start' => :'Float',
+        :'length' => :'Float',
+        :'transition' => :'Transition',
+        :'effect' => :'String',
+        :'filter' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Shotstack::Clip` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Shotstack::Clip`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'asset')
+        self.asset = attributes[:'asset']
+      end
+
+      if attributes.key?(:'start')
+        self.start = attributes[:'start']
+      end
+
+      if attributes.key?(:'length')
+        self.length = attributes[:'length']
+      end
+
+      if attributes.key?(:'transition')
+        self.transition = attributes[:'transition']
+      end
+
+      if attributes.key?(:'effect')
+        self.effect = attributes[:'effect']
+      end
+
+      if attributes.key?(:'filter')
+        self.filter = attributes[:'filter']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @asset.nil?
+        invalid_properties.push('invalid value for "asset", asset cannot be nil.')
+      end
+
+      if @start.nil?
+        invalid_properties.push('invalid value for "start", start cannot be nil.')
+      end
+
+      if @length.nil?
+        invalid_properties.push('invalid value for "length", length cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @asset.nil?
+      return false if @start.nil?
+      return false if @length.nil?
+      effect_validator = EnumAttributeValidator.new('String', ["zoomIn", "zoomOut", "slideLeft", "slideRight", "slideUp", "slideDown"])
+      return false unless effect_validator.valid?(@effect)
+      filter_validator = EnumAttributeValidator.new('String', ["boost", "contrast", "darken", "greyscale", "lighten", "muted", "negative"])
+      return false unless filter_validator.valid?(@filter)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] effect Object to be assigned
+    def effect=(effect)
+      validator = EnumAttributeValidator.new('String', ["zoomIn", "zoomOut", "slideLeft", "slideRight", "slideUp", "slideDown"])
+      unless validator.valid?(effect)
+        fail ArgumentError, "invalid value for \"effect\", must be one of #{validator.allowable_values}."
+      end
+      @effect = effect
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] filter Object to be assigned
+    def filter=(filter)
+      validator = EnumAttributeValidator.new('String', ["boost", "contrast", "darken", "greyscale", "lighten", "muted", "negative"])
+      unless validator.valid?(filter)
+        fail ArgumentError, "invalid value for \"filter\", must be one of #{validator.allowable_values}."
+      end
+      @filter = filter
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          asset == o.asset &&
+          start == o.start &&
+          length == o.length &&
+          transition == o.transition &&
+          effect == o.effect &&
+          filter == o.filter
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [asset, start, length, transition, effect, filter].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    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
+          # 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)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          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
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        Shotstack.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end