dropbox-sign 1.4.1 → 1.6.0

data/lib/dropbox-sign/api_client.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 3.0.0
 Contact: apisupport@hellosign.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.3.0
+Generator version: 7.8.0
 
 =end
 
@@ -48,9 +48,10 @@ module Dropbox::Sign
     # Call an API with given options.
     #
     # @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.
+    #   the data deserialized from response body (may be a Tempfile or nil), response status code and response headers.
     def call_api(http_method, path, opts = {})
       request = build_request(http_method, path, opts)
+      tempfile = download_file(request) if opts[:return_type] == 'File'
       response = request.run
 
       if @config.debugging
@@ -72,7 +73,9 @@ module Dropbox::Sign
         end
       end
 
-      if opts[:return_type]
+      if opts[:return_type] == 'File'
+        data = tempfile
+      elsif opts[:return_type]
         data = deserialize(response, opts[:return_type])
       else
         data = nil
@@ -96,6 +99,7 @@ module Dropbox::Sign
       header_params = @default_headers.merge(opts[:header_params] || {})
       query_params = opts[:query_params] || {}
       form_params = opts[:form_params] || {}
+      follow_location = opts[:follow_location] || true
 
       update_params_for_auth! header_params, query_params, opts[:auth_names]
 
@@ -112,7 +116,8 @@ module Dropbox::Sign
         :ssl_verifyhost => _verify_ssl_host,
         :sslcert => @config.cert_file,
         :sslkey => @config.key_file,
-        :verbose => @config.debugging
+        :verbose => @config.debugging,
+        :followlocation => follow_location
       }
 
       # set custom cert, if provided
@@ -126,9 +131,7 @@ module Dropbox::Sign
         end
       end
 
-      request = Typhoeus::Request.new(url, req_opts)
-      download_file(request) if opts[:return_type] == 'File'
-      request
+      Typhoeus::Request.new(url, req_opts)
     end
 
     # Builds the HTTP request body
@@ -166,6 +169,8 @@ module Dropbox::Sign
     # process can use.
     #
     # @see Configuration#temp_folder_path
+    #
+    # @return [Tempfile] the tempfile generated
     def download_file(request)
       tempfile = nil
       encoding = nil
@@ -180,21 +185,24 @@ module Dropbox::Sign
         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
+      # run the request to ensure the tempfile is created successfully before returning it
+      request.run
+      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`"
+      else
+        fail ApiError.new("Failed to create the tempfile based on the HTTP response from the server: #{request.inspect}") 
       end
+
+      tempfile
     end
 
     # Check if the given MIME is a JSON MIME.
@@ -206,7 +214,7 @@ module Dropbox::Sign
     # @param [String] mime MIME
     # @return [Boolean] True if the MIME is application/json
     def json_mime?(mime)
-      (mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
+      (mime == '*/*') || !(mime =~ /^Application\/.*json(?!p)(;.*)?/i).nil?
     end
 
     # Deserialize the response to the given return type.
@@ -215,15 +223,10 @@ module Dropbox::Sign
     # @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?
 
       # return response body directly for String return type
-      return body if return_type == 'String'
+      return body.to_s if return_type == 'String'
 
       # ensuring a default content type
       content_type = response.headers['Content-Type'] || 'application/json'
@@ -278,7 +281,6 @@ module Dropbox::Sign
           data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
         end
       else
-        # models (e.g. Pet)
         klass = Dropbox::Sign.const_get(return_type)
         klass.respond_to?(:openapi_one_of) ? klass.build(data) : klass.build_from_hash(data)
       end
@@ -290,7 +292,7 @@ module Dropbox::Sign
     # @param [String] filename the filename to be sanitized
     # @return [String] the sanitized filename
     def sanitize_filename(filename)
-      filename.gsub(/.*[\/\\]/, '')
+      filename.split(/[\/\\]/).last
     end
 
     def build_request_url(path, opts = {})

data/lib/dropbox-sign/api_error.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 3.0.0
 Contact: apisupport@hellosign.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.3.0
+Generator version: 7.8.0
 
 =end
 
@@ -15,7 +15,10 @@ end
 
 module Dropbox::Sign
   class ApiError < StandardError
-    attr_reader :code, :response_headers, :response_body
+    attr_reader :code, :response_headers
+
+    # @return [ErrorResponse]
+    attr_accessor :response_body
 
     # Usage examples:
     #   ApiError.new
@@ -35,6 +38,7 @@ module Dropbox::Sign
         end
       else
         super arg
+        @message = arg
       end
     end
 

data/lib/dropbox-sign/configuration.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 3.0.0
 Contact: apisupport@hellosign.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.3.0
+Generator version: 7.8.0
 
 =end
 
@@ -65,6 +65,16 @@ module Dropbox::Sign
     # Defines the access token (Bearer) used with OAuth2.
     attr_accessor :access_token
 
+    # Defines a Proc used to fetch or refresh access tokens (Bearer) used with OAuth2.
+    # Overrides the access_token if set
+    # @return [Proc]
+    attr_accessor :access_token_getter
+
+    # Set this to return data as binary instead of downloading a temp file. When enabled (set to true)
+    # HTTP responses with return type `File` will be returned as a stream of binary data.
+    # Default to false.
+    attr_accessor :return_binary_data
+
     # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
     # details will be logged with `logger.debug` (see the `logger` attribute).
     # Default to false.
@@ -72,6 +82,14 @@ module Dropbox::Sign
     # @return [true, false]
     attr_accessor :debugging
 
+    # Set this to ignore operation servers for the API client. This is useful when you need to
+    # send requests to a different server than the one specified in the OpenAPI document.
+    # Will default to the base url defined in the spec but can be overridden by setting
+    # `scheme`, `host`, `base_path` directly.
+    # Default to false.
+    # @return [true, false]
+    attr_accessor :ignore_operation_servers
+
     # Defines the logger used for debugging.
     # Default to `Rails.logger` (when in Rails) or logging to STDOUT.
     #
@@ -136,6 +154,7 @@ module Dropbox::Sign
     # 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
@@ -144,7 +163,7 @@ module Dropbox::Sign
       @scheme = 'https'
       @host = 'api.hellosign.com'
       @base_path = '/v3'
-      @server_index = 0
+      @server_index = nil
       @server_operation_index = {}
       @server_variables = {}
       @server_operation_variables = {}
@@ -153,11 +172,12 @@ module Dropbox::Sign
       @client_side_validation = true
       @verify_ssl = true
       @verify_ssl_host = true
-      @params_encoding = nil
       @cert_file = nil
       @key_file = nil
       @timeout = 0
+      @params_encoding = nil
       @debugging = false
+      @ignore_operation_servers = false
       @inject_format = false
       @force_ending_format = false
       @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
@@ -192,10 +212,13 @@ module Dropbox::Sign
 
     # 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])
+      return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if ignore_operation_servers
+      if operation_server_settings.key?(operation) then
+        index = server_operation_index.fetch(operation, server_index)
+        server_url(index.nil? ? 0 : index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
+      else
+        server_index.nil? ? "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') : server_url(server_index, server_variables, nil)
+      end
     end
 
     # Gets API key (with prefix if set).
@@ -210,6 +233,12 @@ module Dropbox::Sign
       end
     end
 
+    # Gets access_token using access_token_getter or uses the static access_token
+    def access_token_with_refresh
+      return access_token if access_token_getter.nil?
+      access_token_getter.call
+    end
+
     # Gets Basic Auth token string
     def basic_auth_token
       'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
@@ -273,8 +302,8 @@ module Dropbox::Sign
       servers = server_settings if servers == nil
 
       # 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}"
+      if (index.nil? || index < 0 || index >= servers.size)
+        fail ArgumentError, "Invalid index #{index} when selecting the server. Must not be nil and must be less than #{servers.size}"
       end
 
       server = servers[index]
@@ -299,5 +328,6 @@ module Dropbox::Sign
       url
     end
 
+
   end
 end

data/lib/dropbox-sign/event_callback_helper.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 3.0.0
 Contact: apisupport@hellosign.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.3.0
+Generator version: 7.8.0
 
 =end
 

data/lib/dropbox-sign/models/account_create_request.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 3.0.0
 Contact: apisupport@hellosign.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.3.0
+Generator version: 7.8.0
 
 =end
 
@@ -49,11 +49,6 @@ module Dropbox::Sign
       attribute_map.values
     end
 
-    # Returns attribute map of this model + parent
-    def self.merged_attributes
-      self.attribute_map
-    end
-
     # Attribute type mapping.
     def self.openapi_types
       {
@@ -64,17 +59,22 @@ module Dropbox::Sign
       }
     end
 
-    # Attribute type mapping of this model + parent
-    def self.merged_types
-      self.openapi_types
-    end
-
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
       ])
     end
 
+    # Returns attribute map of this model + parent
+    def self.merged_attributes
+      self.attribute_map
+    end
+
+    # Attribute type mapping of this model + parent
+    def self.merged_types
+      self.openapi_types
+    end
+
     # Returns list of attributes with nullable: true of this model + parent
     def self.merged_nullable
       self.openapi_nullable
@@ -214,8 +214,6 @@ module Dropbox::Sign
         else
           false
         end
-      when :File
-        value
       when :Object
         # generic object (usually a Hash), return directly
         value
@@ -231,9 +229,8 @@ module Dropbox::Sign
           end
         end
       else # model
-        # models (e.g. Pet)
         klass = Dropbox::Sign.const_get(type)
-        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 

data/lib/dropbox-sign/models/account_create_response.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 3.0.0
 Contact: apisupport@hellosign.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.3.0
+Generator version: 7.8.0
 
 =end
 
@@ -42,11 +42,6 @@ module Dropbox::Sign
       attribute_map.values
     end
 
-    # Returns attribute map of this model + parent
-    def self.merged_attributes
-      self.attribute_map
-    end
-
     # Attribute type mapping.
     def self.openapi_types
       {
@@ -56,17 +51,22 @@ module Dropbox::Sign
       }
     end
 
-    # Attribute type mapping of this model + parent
-    def self.merged_types
-      self.openapi_types
-    end
-
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
       ])
     end
 
+    # Returns attribute map of this model + parent
+    def self.merged_attributes
+      self.attribute_map
+    end
+
+    # Attribute type mapping of this model + parent
+    def self.merged_types
+      self.openapi_types
+    end
+
     # Returns list of attributes with nullable: true of this model + parent
     def self.merged_nullable
       self.openapi_nullable
@@ -116,12 +116,17 @@ module Dropbox::Sign
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @account.nil?
+        invalid_properties.push('invalid value for "account", account 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 @account.nil?
       true
     end
 
@@ -198,8 +203,6 @@ module Dropbox::Sign
         else
           false
         end
-      when :File
-        value
       when :Object
         # generic object (usually a Hash), return directly
         value
@@ -215,9 +218,8 @@ module Dropbox::Sign
           end
         end
       else # model
-        # models (e.g. Pet)
         klass = Dropbox::Sign.const_get(type)
-        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 

data/lib/dropbox-sign/models/account_get_response.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 3.0.0
 Contact: apisupport@hellosign.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.3.0
+Generator version: 7.8.0
 
 =end
 
@@ -38,11 +38,6 @@ module Dropbox::Sign
       attribute_map.values
     end
 
-    # Returns attribute map of this model + parent
-    def self.merged_attributes
-      self.attribute_map
-    end
-
     # Attribute type mapping.
     def self.openapi_types
       {
@@ -51,17 +46,22 @@ module Dropbox::Sign
       }
     end
 
-    # Attribute type mapping of this model + parent
-    def self.merged_types
-      self.openapi_types
-    end
-
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
       ])
     end
 
+    # Returns attribute map of this model + parent
+    def self.merged_attributes
+      self.attribute_map
+    end
+
+    # Attribute type mapping of this model + parent
+    def self.merged_types
+      self.openapi_types
+    end
+
     # Returns list of attributes with nullable: true of this model + parent
     def self.merged_nullable
       self.openapi_nullable
@@ -107,12 +107,17 @@ module Dropbox::Sign
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @account.nil?
+        invalid_properties.push('invalid value for "account", account 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 @account.nil?
       true
     end
 
@@ -188,8 +193,6 @@ module Dropbox::Sign
         else
           false
         end
-      when :File
-        value
       when :Object
         # generic object (usually a Hash), return directly
         value
@@ -205,9 +208,8 @@ module Dropbox::Sign
           end
         end
       else # model
-        # models (e.g. Pet)
         klass = Dropbox::Sign.const_get(type)
-        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 

data/lib/dropbox-sign/models/account_response.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 3.0.0
 Contact: apisupport@hellosign.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.3.0
+Generator version: 7.8.0
 
 =end
 
@@ -57,6 +57,9 @@ module Dropbox::Sign
     # @return [String, nil]
     attr_accessor :locale
 
+    # @return [AccountResponseUsage]
+    attr_accessor :usage
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -69,7 +72,8 @@ module Dropbox::Sign
         :'callback_url' => :'callback_url',
         :'role_code' => :'role_code',
         :'team_id' => :'team_id',
-        :'locale' => :'locale'
+        :'locale' => :'locale',
+        :'usage' => :'usage'
       }
     end
 
@@ -78,11 +82,6 @@ module Dropbox::Sign
       attribute_map.values
     end
 
-    # Returns attribute map of this model + parent
-    def self.merged_attributes
-      self.attribute_map
-    end
-
     # Attribute type mapping.
     def self.openapi_types
       {
@@ -95,25 +94,31 @@ module Dropbox::Sign
         :'callback_url' => :'String',
         :'role_code' => :'String',
         :'team_id' => :'String',
-        :'locale' => :'String'
+        :'locale' => :'String',
+        :'usage' => :'AccountResponseUsage'
       }
     end
 
-    # Attribute type mapping of this model + parent
-    def self.merged_types
-      self.openapi_types
-    end
-
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
         :'callback_url',
         :'role_code',
         :'team_id',
-        :'locale'
+        :'locale',
       ])
     end
 
+    # Returns attribute map of this model + parent
+    def self.merged_attributes
+      self.attribute_map
+    end
+
+    # Attribute type mapping of this model + parent
+    def self.merged_types
+      self.openapi_types
+    end
+
     # Returns list of attributes with nullable: true of this model + parent
     def self.merged_nullable
       self.openapi_nullable
@@ -183,6 +188,10 @@ module Dropbox::Sign
       if attributes.key?(:'locale')
         self.locale = attributes[:'locale']
       end
+
+      if attributes.key?(:'usage')
+        self.usage = attributes[:'usage']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -212,7 +221,8 @@ module Dropbox::Sign
           callback_url == o.callback_url &&
           role_code == o.role_code &&
           team_id == o.team_id &&
-          locale == o.locale
+          locale == o.locale &&
+          usage == o.usage
     end
 
     # @see the `==` method
@@ -224,7 +234,7 @@ module Dropbox::Sign
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [account_id, email_address, is_locked, is_paid_hs, is_paid_hf, quotas, callback_url, role_code, team_id, locale].hash
+      [account_id, email_address, is_locked, is_paid_hs, is_paid_hf, quotas, callback_url, role_code, team_id, locale, usage].hash
     end
 
     # Builds the object from hash
@@ -278,8 +288,6 @@ module Dropbox::Sign
         else
           false
         end
-      when :File
-        value
       when :Object
         # generic object (usually a Hash), return directly
         value
@@ -295,9 +303,8 @@ module Dropbox::Sign
           end
         end
       else # model
-        # models (e.g. Pet)
         klass = Dropbox::Sign.const_get(type)
-        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end