Class: Wallee::ApiClient
- Inherits:
-
Object
- Object
- Wallee::ApiClient
- Defined in:
- lib/wallee-ruby-sdk/api_client.rb
Instance Attribute Summary collapse
-
#config ⇒ Object
The Configuration object holding settings to be used in the API client.
-
#default_headers ⇒ Hash
Defines the headers to be used in HTTP requests of all API calls by default.
Class Method Summary collapse
Instance Method Summary collapse
-
#build_collection_param(param, collection_format) ⇒ Object
Build parameter value according to the given collection format.
-
#build_request(http_method, path, opts = {}) ⇒ Typhoeus::Request
Builds the HTTP request.
-
#build_request_body(header_params, form_params, body) ⇒ String
Builds the HTTP request body.
- #build_request_url(path) ⇒ Object
-
#calculate_hmac(secured_data) ⇒ String
Returns the calculated sha512 hmac for the given data.
-
#call_api(http_method, path, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>
Call an API with given options.
-
#convert_to_type(data, return_type) ⇒ Mixed
Convert data to the given return type.
-
#deserialize(response, return_type) ⇒ Object
Deserialize the response to the given return type.
-
#download_file(response) ⇒ Tempfile
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.
-
#get_authentication_headers(http_method, path, query) ⇒ Hash
The authentication headers.
-
#get_connection_timeout ⇒ Object
Return connection timeout.
-
#initialize(config = Configuration.default) ⇒ ApiClient
constructor
Initializes the ApiClient.
-
#json_mime?(mime) ⇒ Boolean
Check if the given MIME is a JSON MIME.
-
#object_to_hash(obj) ⇒ String
Convert object(non-array) to hash.
-
#object_to_http_body(model) ⇒ String
Convert object (array, hash, object, etc) to JSON string.
-
#sanitize_filename(filename) ⇒ String
Sanitize filename by removing path.
-
#select_header_accept(accepts) ⇒ String
Return Accept header based on an array of accepts provided.
-
#select_header_content_type(content_types) ⇒ String
Return Content-Type header based on an array of content types provided.
-
#user_agent=(user_agent) ⇒ Object
Sets user agent in HTTP header.
Constructor Details
#initialize(config = Configuration.default) ⇒ ApiClient
Initializes the ApiClient
40 41 42 43 44 45 46 47 48 49 50 |
# File 'lib/wallee-ruby-sdk/api_client.rb', line 40 def initialize(config = Configuration.default) @config = config @user_agent = "Typhoeus" @default_headers = { 'Content-Type' => "application/json", 'User-Agent' => @user_agent } config.default_headers.each do |key, value| @default_headers[key] = value end end |
Instance Attribute Details
#config ⇒ Object
The Configuration object holding settings to be used in the API client.
31 32 33 |
# File 'lib/wallee-ruby-sdk/api_client.rb', line 31 def config @config end |
#default_headers ⇒ Hash
Defines the headers to be used in HTTP requests of all API calls by default.
36 37 38 |
# File 'lib/wallee-ruby-sdk/api_client.rb', line 36 def default_headers @default_headers end |
Class Method Details
.default ⇒ Object
52 53 54 |
# File 'lib/wallee-ruby-sdk/api_client.rb', line 52 def self.default @@default ||= ApiClient.new end |
Instance Method Details
#build_collection_param(param, collection_format) ⇒ Object
Build parameter value according to the given collection format.
399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 |
# File 'lib/wallee-ruby-sdk/api_client.rb', line 399 def build_collection_param(param, collection_format) case collection_format when :csv param.join(',') when :ssv param.join(' ') when :tsv param.join("\t") when :pipes param.join('|') when :multi # return the array directly as typhoeus will handle it as expected param else fail "unknown collection format: #{collection_format.inspect}" end end |
#build_request(http_method, path, opts = {}) ⇒ Typhoeus::Request
Builds the HTTP request
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 |
# File 'lib/wallee-ruby-sdk/api_client.rb', line 100 def build_request(http_method, path, opts = {}) url = build_request_url(path) http_method = http_method.to_sym.downcase default_headers = { 'x-meta-sdk-version': "4.5.0", 'x-meta-sdk-language': "ruby", 'x-meta-sdk-provider': "wallee", 'x-meta-sdk-language-version': RUBY_VERSION } header_params = @default_headers.merge(opts[:header_params] || {}) header_params = header_params.merge(default_headers) query_params = opts[:query_params] || {} form_params = opts[:form_params] || {} # set ssl_verifyhosts option based on @config.verify_ssl_host (true/false) _verify_ssl_host = true header_params = header_params.merge(get_authentication_headers(http_method, path, query_params)) timeout = opts[:timeout] req_opts = { :method => http_method, :headers => header_params, :params => query_params, :params_encoding => @config.params_encoding, :timeout => timeout, :ssl_verifypeer => true, :ssl_verifyhost => 2, :sslcert => @config.cert_file, :sslkey => @config.key_file, :verbose => @config.debugging } req_opts.merge!(multipart: true) if header_params['Content-Type'].start_with? "multipart/" # set custom cert, if provided req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert if [:post, :patch, :put, :delete].include?(http_method) req_body = build_request_body(header_params, form_params, opts[:body]) req_opts.update :body => req_body if @config.debugging @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n" end end Typhoeus::Request.new(url, req_opts) end |
#build_request_body(header_params, form_params, body) ⇒ String
Builds the HTTP request body
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 |
# File 'lib/wallee-ruby-sdk/api_client.rb', line 319 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 |
#build_request_url(path) ⇒ Object
307 308 309 310 311 |
# File 'lib/wallee-ruby-sdk/api_client.rb', line 307 def build_request_url(path) # Add leading and trailing slashes to path path = "/#{path}".gsub(/\/+/, '/') Addressable::URI.encode(@config.base_url + path) end |
#calculate_hmac(secured_data) ⇒ String
Returns the calculated sha512 hmac for the given data
178 179 180 181 182 |
# File 'lib/wallee-ruby-sdk/api_client.rb', line 178 def calculate_hmac(secured_data) decoded_secret = Base64.decode64(@config.authentication_key); digest = OpenSSL::Digest.new('sha512') Base64.strict_encode64(OpenSSL::HMAC.digest(digest, decoded_secret, secured_data)).strip; end |
#call_api(http_method, path, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>
Call an API with given options.
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 |
# File 'lib/wallee-ruby-sdk/api_client.rb', line 60 def call_api(http_method, path, opts = {}) request = build_request(http_method, path, opts) response = request.run if @config.debugging @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n" end unless response.success? 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.) else fail ApiError.new(:code => response.code, :response_headers => response.headers.to_h, :response_body => response.body), response. end end if opts[:return_type] data = deserialize(response, opts[:return_type]) else data = nil end return data, response.code, response.headers end |
#convert_to_type(data, return_type) ⇒ Mixed
Convert data to the given return type.
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 |
# File 'lib/wallee-ruby-sdk/api_client.rb', line 232 def convert_to_type(data, return_type) return nil if data.nil? case return_type when 'String' data.to_s when 'Integer' data.to_i when 'Float' data.to_f when 'BOOLEAN' data == true when 'DateTime' # parse date time (expecting ISO 8601 format) DateTime.parse data when 'Date' # parse date time (expecting ISO 8601 format) Date.parse data when 'Object' # generic object (usually a Hash), return directly data when /\AArray<(.+)>\z/ # e.g. Array<Pet> sub_type = $1 data.map {|item| convert_to_type(item, sub_type) } when /\AHash\<String, (.+)\>\z/ # e.g. Hash<String, Integer> sub_type = $1 {}.tap do |hash| data.each {|k, v| hash[k] = convert_to_type(v, sub_type) } end else # models, e.g. Pet Wallee.const_get(return_type).new.tap do |model| model.build_from_hash data end end end |
#deserialize(response, return_type) ⇒ Object
Deserialize the response to the given return type.
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 |
# File 'lib/wallee-ruby-sdk/api_client.rb', line 200 def deserialize(response, return_type) body = response.body 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' fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type) begin data = JSON.parse("[#{body}]", :symbolize_names => true)[0] rescue JSON::ParserError => e if %w(String Date DateTime).include?(return_type) data = body else raise e end end convert_to_type data, return_type end |
#download_file(response) ⇒ Tempfile
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.
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 |
# File 'lib/wallee-ruby-sdk/api_client.rb', line 275 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?('-') tempfile = nil encoding = response.body.encoding Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding) do |file| file.write(response.body) tempfile = file 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 |
#get_authentication_headers(http_method, path, query) ⇒ Hash
Returns the authentication headers.
160 161 162 163 164 165 166 167 168 169 170 171 172 173 |
# File 'lib/wallee-ruby-sdk/api_client.rb', line 160 def get_authentication_headers(http_method, path, query) base_url = URI(@config.base_url) completed_path = "#{base_url.path}#{path}" completed_path += "?" + query.map{|k,v| "#{k}=#{v}"}.join('&') unless query.empty? version = "1" = Time.now.to_i securedData = "#{version}|#{@config.user_id}|#{timestamp}|#{http_method.upcase}|#{completed_path}" { "x-mac-version": version, "x-mac-userid": @config.user_id, "x-mac-timestamp": , "x-mac-value": calculate_hmac(securedData) } end |
#get_connection_timeout ⇒ Object
Return connection timeout.
419 420 421 |
# File 'lib/wallee-ruby-sdk/api_client.rb', line 419 def get_connection_timeout() return @config.timeout end |
#json_mime?(mime) ⇒ Boolean
Check if the given MIME is a JSON MIME. JSON MIME examples:
application/json
application/json; charset=UTF8
APPLICATION/JSON
*/*
192 193 194 |
# File 'lib/wallee-ruby-sdk/api_client.rb', line 192 def json_mime?(mime) (mime == "*/*") || !(mime =~ /\Aapplication\/json(;.*)?\z/i).nil? end |
#object_to_hash(obj) ⇒ String
Convert object(non-array) to hash.
389 390 391 392 393 394 395 |
# File 'lib/wallee-ruby-sdk/api_client.rb', line 389 def object_to_hash(obj) if obj.respond_to?(:to_hash) obj.to_hash else obj end end |
#object_to_http_body(model) ⇒ String
Convert object (array, hash, object, etc) to JSON string.
375 376 377 378 379 380 381 382 383 384 |
# File 'lib/wallee-ruby-sdk/api_client.rb', line 375 def object_to_http_body(model) return model if model.nil? || model.is_a?(String) local_body = nil if model.is_a?(Array) local_body = model.map{|m| object_to_hash(m) } else local_body = object_to_hash(model) end local_body.to_json end |
#sanitize_filename(filename) ⇒ String
Sanitize filename by removing path. e.g. ../../sun.gif becomes sun.gif
303 304 305 |
# File 'lib/wallee-ruby-sdk/api_client.rb', line 303 def sanitize_filename(filename) filename.gsub(/.*[\/\\]/, '') end |
#select_header_accept(accepts) ⇒ String
Return Accept header based on an array of accepts provided.
354 355 356 357 358 359 |
# File 'lib/wallee-ruby-sdk/api_client.rb', line 354 def select_header_accept(accepts) return nil if accepts.nil? || accepts.empty? # use JSON when present, otherwise use all of the provided json_accept = accepts.find { |s| json_mime?(s) } return json_accept || accepts.join(',') end |
#select_header_content_type(content_types) ⇒ String
Return Content-Type header based on an array of content types provided.
364 365 366 367 368 369 370 |
# File 'lib/wallee-ruby-sdk/api_client.rb', line 364 def select_header_content_type(content_types) # use application/json by default return 'application/json' if content_types.nil? || content_types.empty? # use JSON when present, otherwise use the first one json_content_type = content_types.find { |s| json_mime?(s) } return json_content_type || content_types.first end |
#user_agent=(user_agent) ⇒ Object
Sets user agent in HTTP header
346 347 348 349 |
# File 'lib/wallee-ruby-sdk/api_client.rb', line 346 def user_agent=(user_agent) @user_agent = user_agent @default_headers['User-Agent'] = @user_agent end |