bf_ruby2 2.2016.237 → 3.2017.174

data/lib/bf_ruby2/api/webhooks_api.rb

@@ -6,18 +6,7 @@
 OpenAPI spec version: 1.0.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+Swagger Codegen version: 2.2.3-SNAPSHOT
 
 =end
 
@@ -51,23 +40,21 @@ module Bfwd
         @api_client.config.logger.debug "Calling API: WebhooksApi.create_webhook ..."
       end
       # verify the required parameter 'webhook' is set
-      fail ArgumentError, "Missing the required parameter 'webhook' when calling WebhooksApi.create_webhook" if webhook.nil?
+      if @api_client.config.client_side_validation && webhook.nil?
+        fail ArgumentError, "Missing the required parameter 'webhook' when calling WebhooksApi.create_webhook"
+      end
       # resource path
-      local_var_path = "/webhooks".sub('{format}','json')
+      local_var_path = "/webhooks"
 
       # query parameters
       query_params = {}
 
       # header parameters
       header_params = {}
-
       # HTTP header 'Accept' (if needed)
-      local_header_accept = ['text/xml', 'application/xml', 'application/json; charset=utf-8']
-      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
-
+      header_params['Accept'] = @api_client.select_header_accept(['text/xml', 'application/xml', 'application/json; charset=utf-8'])
       # HTTP header 'Content-Type'
-      local_header_content_type = ['application/json; charset=utf-8']
-      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])
 
       # form parameters
       form_params = {}
@@ -108,23 +95,21 @@ module Bfwd
         @api_client.config.logger.debug "Calling API: WebhooksApi.create_webhook_v2 ..."
       end
       # verify the required parameter 'request' is set
-      fail ArgumentError, "Missing the required parameter 'request' when calling WebhooksApi.create_webhook_v2" if request.nil?
+      if @api_client.config.client_side_validation && request.nil?
+        fail ArgumentError, "Missing the required parameter 'request' when calling WebhooksApi.create_webhook_v2"
+      end
       # resource path
-      local_var_path = "/webhooks/create".sub('{format}','json')
+      local_var_path = "/webhooks/create"
 
       # query parameters
       query_params = {}
 
       # header parameters
       header_params = {}
-
       # HTTP header 'Accept' (if needed)
-      local_header_accept = ['text/xml', 'application/xml', 'application/json; charset=utf-8']
-      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
-
+      header_params['Accept'] = @api_client.select_header_accept(['text/xml', 'application/xml', 'application/json; charset=utf-8'])
       # HTTP header 'Content-Type'
-      local_header_content_type = ['application/json; charset=utf-8']
-      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])
 
       # form parameters
       form_params = {}
@@ -174,11 +159,11 @@ module Bfwd
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: WebhooksApi.get_all_webhooks ..."
       end
-      if opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
+      if @api_client.config.client_side_validation && opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
         fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
       end
       # resource path
-      local_var_path = "/webhooks".sub('{format}','json')
+      local_var_path = "/webhooks"
 
       # query parameters
       query_params = {}
@@ -191,14 +176,8 @@ module Bfwd
 
       # header parameters
       header_params = {}
-
       # HTTP header 'Accept' (if needed)
-      local_header_accept = ['application/json; charset=utf-8']
-      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
-
-      # HTTP header 'Content-Type'
-      local_header_content_type = []
-      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
 
       # form parameters
       form_params = {}
@@ -241,9 +220,11 @@ module Bfwd
         @api_client.config.logger.debug "Calling API: WebhooksApi.get_webhook_by_id ..."
       end
       # verify the required parameter 'webhook_id' is set
-      fail ArgumentError, "Missing the required parameter 'webhook_id' when calling WebhooksApi.get_webhook_by_id" if webhook_id.nil?
+      if @api_client.config.client_side_validation && webhook_id.nil?
+        fail ArgumentError, "Missing the required parameter 'webhook_id' when calling WebhooksApi.get_webhook_by_id"
+      end
       # resource path
-      local_var_path = "/webhooks/{webhook-ID}".sub('{format}','json').sub('{' + 'webhook-ID' + '}', webhook_id.to_s)
+      local_var_path = "/webhooks/{webhook-ID}".sub('{' + 'webhook-ID' + '}', webhook_id.to_s)
 
       # query parameters
       query_params = {}
@@ -251,14 +232,10 @@ module Bfwd
 
       # header parameters
       header_params = {}
-
       # HTTP header 'Accept' (if needed)
-      local_header_accept = ['application/json; charset=utf-8']
-      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
-
+      header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
       # HTTP header 'Content-Type'
-      local_header_content_type = ['text/plain']
-      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+      header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain'])
 
       # form parameters
       form_params = {}
@@ -301,11 +278,15 @@ module Bfwd
         @api_client.config.logger.debug "Calling API: WebhooksApi.retire_webhook ..."
       end
       # verify the required parameter 'webhook_id' is set
-      fail ArgumentError, "Missing the required parameter 'webhook_id' when calling WebhooksApi.retire_webhook" if webhook_id.nil?
+      if @api_client.config.client_side_validation && webhook_id.nil?
+        fail ArgumentError, "Missing the required parameter 'webhook_id' when calling WebhooksApi.retire_webhook"
+      end
       # verify the required parameter 'organizations' is set
-      fail ArgumentError, "Missing the required parameter 'organizations' when calling WebhooksApi.retire_webhook" if organizations.nil?
+      if @api_client.config.client_side_validation && organizations.nil?
+        fail ArgumentError, "Missing the required parameter 'organizations' when calling WebhooksApi.retire_webhook"
+      end
       # resource path
-      local_var_path = "/webhooks/{webhook-ID}".sub('{format}','json').sub('{' + 'webhook-ID' + '}', webhook_id.to_s)
+      local_var_path = "/webhooks/{webhook-ID}".sub('{' + 'webhook-ID' + '}', webhook_id.to_s)
 
       # query parameters
       query_params = {}
@@ -313,14 +294,10 @@ module Bfwd
 
       # header parameters
       header_params = {}
-
       # HTTP header 'Accept' (if needed)
-      local_header_accept = ['application/json; charset=utf-8']
-      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
-
+      header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
       # HTTP header 'Content-Type'
-      local_header_content_type = ['text/plain']
-      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+      header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain'])
 
       # form parameters
       form_params = {}
@@ -361,23 +338,21 @@ module Bfwd
         @api_client.config.logger.debug "Calling API: WebhooksApi.update_webhook ..."
       end
       # verify the required parameter 'webhook' is set
-      fail ArgumentError, "Missing the required parameter 'webhook' when calling WebhooksApi.update_webhook" if webhook.nil?
+      if @api_client.config.client_side_validation && webhook.nil?
+        fail ArgumentError, "Missing the required parameter 'webhook' when calling WebhooksApi.update_webhook"
+      end
       # resource path
-      local_var_path = "/webhooks".sub('{format}','json')
+      local_var_path = "/webhooks"
 
       # query parameters
       query_params = {}
 
       # header parameters
       header_params = {}
-
       # HTTP header 'Accept' (if needed)
-      local_header_accept = ['text/xml', 'application/xml', 'application/json; charset=utf-8']
-      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
-
+      header_params['Accept'] = @api_client.select_header_accept(['text/xml', 'application/xml', 'application/json; charset=utf-8'])
       # HTTP header 'Content-Type'
-      local_header_content_type = ['application/json; charset=utf-8']
-      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])
 
       # form parameters
       form_params = {}
@@ -420,9 +395,11 @@ module Bfwd
         @api_client.config.logger.debug "Calling API: WebhooksApi.verify_webhook ..."
       end
       # verify the required parameter 'verification_id' is set
-      fail ArgumentError, "Missing the required parameter 'verification_id' when calling WebhooksApi.verify_webhook" if verification_id.nil?
+      if @api_client.config.client_side_validation && verification_id.nil?
+        fail ArgumentError, "Missing the required parameter 'verification_id' when calling WebhooksApi.verify_webhook"
+      end
       # resource path
-      local_var_path = "/webhooks/verify/{verification-ID}".sub('{format}','json').sub('{' + 'verification-ID' + '}', verification_id.to_s)
+      local_var_path = "/webhooks/verify/{verification-ID}".sub('{' + 'verification-ID' + '}', verification_id.to_s)
 
       # query parameters
       query_params = {}
@@ -430,14 +407,10 @@ module Bfwd
 
       # header parameters
       header_params = {}
-
       # HTTP header 'Accept' (if needed)
-      local_header_accept = ['application/json; charset=utf-8']
-      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
-
+      header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
       # HTTP header 'Content-Type'
-      local_header_content_type = ['text/plain']
-      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+      header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain'])
 
       # form parameters
       form_params = {}

data/lib/bf_ruby2/api_client.rb

@@ -6,18 +6,7 @@
 OpenAPI spec version: 1.0.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+Swagger Codegen version: 2.2.3-SNAPSHOT
 
 =end
 
@@ -66,10 +55,18 @@ module Bfwd
       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]
@@ -125,7 +122,9 @@ module Bfwd
         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
 
     # Check if the given MIME is a JSON MIME.
@@ -133,10 +132,11 @@ module Bfwd
     #   application/json
     #   application/json; charset=UTF8
     #   APPLICATION/JSON
+    #   */*
     # @param [String] mime MIME
-    # @return [Boolean] True if the MIME is applicaton/json
+    # @return [Boolean] True if the MIME is application/json
     def json_mime?(mime)
-       !(mime =~ /\Aapplication\/json(;.*)?\z/i).nil?
+       (mime == "*/*") || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
     end
 
     # Deserialize the response to the given return type.
@@ -145,14 +145,16 @@ module Bfwd
     # @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'
 
-      # handle file downloading - save response body into a tmp file and return the File instance
-      return download_file(response) if return_type == 'File'
-
       # ensuring a default content type
       content_type = response.headers['Content-Type'] || 'application/json'
 
@@ -215,30 +217,38 @@ module Bfwd
 
     # 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 and content_disposition =~ /filename=/i
-        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 and 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
+        @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.

data/lib/bf_ruby2/api_error.rb

@@ -6,24 +6,15 @@
 OpenAPI spec version: 1.0.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+Swagger Codegen version: 2.2.3-SNAPSHOT
 
 =end
 
+require 'json'
+
 module Bfwd
   class ApiError < StandardError
-    attr_reader :code, :response_headers, :response_body
+    attr_reader :code, :response_headers, :response_body, :parsed
 
     # Usage examples:
     #   ApiError.new
@@ -32,16 +23,22 @@ module Bfwd
     #   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
+
+        parsed = JSON.parse(arg[:response_body]) rescue {'errorMessage': arg.response_body}
       else
         super arg
+        parsed = {'errorMessage': 'Failed to parse error response from API; was not JSON-formatted.'}
       end
+      @parsed = parsed
     end
   end
 end

data/lib/bf_ruby2/configuration.rb

@@ -6,18 +6,7 @@
 OpenAPI spec version: 1.0.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+Swagger Codegen version: 2.2.3-SNAPSHOT
 
 =end
 
@@ -87,6 +76,11 @@ module Bfwd
     # Default to 0 (never times out).
     attr_accessor :timeout
 
+    # 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.
@@ -140,6 +134,7 @@ module Bfwd
       @api_key = {}
       @api_key_prefix = {}
       @timeout = 0
+      @client_side_validation = true
       @verify_ssl = true
       @verify_ssl_host = true
       @params_encoding = nil