Class: NiceHttp

Inherits:
Object
  • Object
show all
Includes:
NiceHttpHttpMethods, NiceHttpManageRequest, NiceHttpManageResponse
Defined in:
lib/nice_http.rb

Overview

Attributes you can access using NiceHttp.the_attribute:
:host, :port, :ssl, :timeout, :headers, :debug, :log, :log_headers, :proxy_host, :proxy_port,
:last_request, :last_response, :request_id, :use_mocks, :connections,
:active, :auto_redirect, :values_for, :create_stats, :stats, :capture, :captured, :request, :requests

Constant Summary collapse

Error = 
Class.new StandardError
InfoMissing = 
Class.new Error do
  attr_reader :attribute

  def initialize(attribute, message = "")
    @attribute = attribute
    message += "It was not possible to create the http connection!!!\n"
    message += "Wrong #{attribute}. "
    message += "Remember to supply http:// or https:// in case you specify an url to create the http connection, for example:\n"
    message += "http = NiceHttp.new('http://example.com')"
    super message
  end
end

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from NiceHttpHttpMethods

#delete, #get, #head, #patch, #post, #put, #send_request

Methods included from NiceHttpManageResponse

#manage_response

Methods included from NiceHttpManageRequest

#manage_request

Constructor Details

#initialize(args = {}) ⇒ NiceHttp

Creates a new http connection.

Examples:

http = NiceHttp.new()
http = NiceHttp.new("https://www.example.com")
http = NiceHttp.new("example.com:8999")
http = NiceHttp.new("localhost:8322")
http2 = NiceHttp.new( host: "reqres.in", port: 443, ssl: true )
my_server = {host: "example.com",
             port: 80,
             headers: {"api-key": "zdDDdjkck"}
            }
http3 = NiceHttp.new my_server

Parameters:

  • args (defaults to: {}) —

    [] If no parameter supplied, by default will access how is setup on defaults

  • args (String) (defaults to: {}) —

    . The url to create the connection.

  • args (Hash) (defaults to: {}) —

    containing these possible keys:
    host -- example.com. (default blank screen)
    port -- port for the connection. 80 (default)
    ssl -- true, false (default)
    timeout -- integer or nil (default) headers -- hash with the headers
    values_for -- hash with the values_for
    debug -- true, false (default)
    log_path -- string with path for the logs, empty string (default)
    log -- :no, :screen, :file, :fix_file (default).
    log_headers -- :all, :none, :partial (default).
    A string with a path can be supplied.
    If :fix_file: nice_http.log
    In case :file it will be generated a log file with name: nice_http_YY-mm-dd-HHMMSS.log
    proxy_host
    proxy_port

Raises:



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
 
# File 'lib/nice_http.rb', line 327

def initialize(args = {})
  require "net/http"
  require "net/https"
  @host = self.class.host
  @port = self.class.port
  @prepath = ""
  @ssl = self.class.ssl
  @timeout = self.class.timeout
  @headers = self.class.headers.dup
  @values_for = self.class.values_for.dup
  @debug = self.class.debug
  @log = self.class.log
  @log_path = self.class.log_path
  @log_headers = self.class.log_headers
  @proxy_host = self.class.proxy_host
  @proxy_port = self.class.proxy_port
  @use_mocks = self.class.use_mocks
  @auto_redirect = false #set it up at the end of initialize
  auto_redirect = self.class.auto_redirect
  @num_redirects = 0
  @create_stats = self.class.create_stats
  @capture = self.class.capture

  #todo: set only the cookies for the current domain
  #key: path, value: hash with key is the name of the cookie and value the value
  # we set the default value for non existing keys to empty Hash {} so in case of merge there is no problem
  @cookies = Hash.new { |h, k| h[k] = {} }

  if args.is_a?(String)
    uri = URI.parse(args)
    @host = uri.host unless uri.host.nil?
    @port = uri.port unless uri.port.nil?
    @ssl = true if !uri.scheme.nil? && (uri.scheme == "https")
    @prepath = uri.path unless uri.path == "/"
  elsif args.is_a?(Hash) && !args.keys.empty?
    @host = args[:host] if args.keys.include?(:host)
    @port = args[:port] if args.keys.include?(:port)
    @ssl = args[:ssl] if args.keys.include?(:ssl)
    @timeout = args[:timeout] if args.keys.include?(:timeout)
    @headers = args[:headers].dup if args.keys.include?(:headers)
    @values_for = args[:values_for].dup if args.keys.include?(:values_for)
    @debug = args[:debug] if args.keys.include?(:debug)
    @log = args[:log] if args.keys.include?(:log)
    @log_path = args[:log_path] if args.keys.include?(:log_path)
    @log_headers = args[:log_headers] if args.keys.include?(:log_headers)
    @proxy_host = args[:proxy_host] if args.keys.include?(:proxy_host)
    @proxy_port = args[:proxy_port] if args.keys.include?(:proxy_port)
    @use_mocks = args[:use_mocks] if args.keys.include?(:use_mocks)
    auto_redirect = args[:auto_redirect] if args.keys.include?(:auto_redirect)
  end

  log_filename = ""
  if @log.kind_of?(String) or @log == :fix_file or @log == :file or @log == :file_run
    if @log.kind_of?(String)
      log_filename = @log.dup
      unless log_filename.start_with?(".")
        if caller.first.start_with?(Dir.pwd)
          folder = File.dirname(caller.first.scan(/(.+):\d/).join)
        else
          folder = File.dirname("#{Dir.pwd}/#{caller.first.scan(/(.+):\d/).join}")
        end
        folder += "/" unless log_filename.start_with?("/") or log_filename.match?(/^\w+:/)
        log_filename = folder + log_filename
      end
      require "fileutils"
      FileUtils.mkdir_p File.dirname(log_filename)
      unless Dir.exist?(File.dirname(log_filename))
        @logger = Logger.new nil
        raise InfoMissing, :log, "Wrong directory specified for logs.\n"
      end
    elsif @log == :fix_file
      log_filename = "nice_http.log"
    elsif @log == :file
      log_filename = "nice_http_#{Time.now.strftime("%Y-%m-%d-%H%M%S")}.log"
    elsif @log == :file_run
      log_filename = "#{caller.first.scan(/(.+):\d/).join}.log"
    end
    if Thread.current.name.to_s != ""
      log_filename.gsub!(/\.log$/, "_#{Thread.current.name}.log")
    end
    unless @log_path.to_s == ''
      log_filename.gsub!(Dir.pwd,'.')
      dpath = @log_path.split("/")
      dfile = log_filename.split("/")
      log_filenamepath = ''
      dfile.each_with_index do |d,i|
        if d==dpath[i]
          log_filenamepath<<"#{d}/"
        else
          log_filename = @log_path + "#{log_filename.gsub(/^#{log_filenamepath}/,'')}"
          break
        end
      end
      log_filename = "./#{log_filename}" unless log_filename[0..1]=='./'
      log_filename = ".#{log_filename}" unless log_filename[0]=='.'

      unless File.exist?(log_filename)
        require 'fileutils'
        FileUtils.mkdir_p(File.dirname(log_filename))
      end
    end

    if self.class.log_files.key?(log_filename) and File.exist?(log_filename)
      @logger = self.class.log_files[log_filename]
    else
      begin
        f = File.new(log_filename, "w")
        f.sync = true
        @logger = Logger.new f
      rescue Exception => stack
        @logger = Logger.new nil
        raise InfoMissing, :log
      end
      self.class.log_files[log_filename] = @logger
    end
  elsif @log == :screen
    @logger = Logger.new STDOUT
  elsif @log == :no
    @logger = Logger.new nil
  else
    raise InfoMissing, :log
  end
  @logger.level = Logger::INFO

  if @host.to_s != "" and (@host.start_with?("http:") or @host.start_with?("https:"))
    uri = URI.parse(@host)
    @host = uri.host unless uri.host.nil?
    @port = uri.port unless uri.port.nil?
    @ssl = true if !uri.scheme.nil? && (uri.scheme == "https")
    @prepath = uri.path unless uri.path == "/"
  end
  raise InfoMissing, :port if @port.to_s == ""
  raise InfoMissing, :host if @host.to_s == ""
  raise InfoMissing, :ssl unless @ssl.is_a?(TrueClass) or @ssl.is_a?(FalseClass)
  raise InfoMissing, :timeout unless @timeout.is_a?(Integer) or @timeout.nil?
  raise InfoMissing, :debug unless @debug.is_a?(TrueClass) or @debug.is_a?(FalseClass)
  raise InfoMissing, :auto_redirect unless auto_redirect.is_a?(TrueClass) or auto_redirect.is_a?(FalseClass)
  raise InfoMissing, :use_mocks unless @use_mocks.is_a?(TrueClass) or @use_mocks.is_a?(FalseClass)
  raise InfoMissing, :headers unless @headers.is_a?(Hash)
  raise InfoMissing, :values_for unless @values_for.is_a?(Hash)
  raise InfoMissing, :log_headers unless [:all, :none, :partial].include?(@log_headers)

  begin
    if !@proxy_host.nil? && !@proxy_port.nil?
      @http = Net::HTTP::Proxy(@proxy_host, @proxy_port).new(@host, @port)
      @http.use_ssl = @ssl
      @http.set_debug_output $stderr if @debug
      @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
      unless @timeout.nil?
        @http.open_timeout = @timeout
        @http.read_timeout = @timeout
      end
      @http.start
    else
      @http = Net::HTTP.new(@host, @port)
      @http.use_ssl = @ssl
      @http.set_debug_output $stderr if @debug
      @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
      unless @timeout.nil?
        @http.open_timeout = @timeout
        @http.read_timeout = @timeout
      end
      @http.start
    end

    @message_server = "(#{self.object_id}):"

    log_message = "(#{self.object_id}): Http connection created. host:#{@host},  port:#{@port},  ssl:#{@ssl}, timeout:#{@timeout}, mode:#{@mode}, proxy_host: #{@proxy_host.to_s()}, proxy_port: #{@proxy_port.to_s()} "

    @logger.info(log_message)
    @message_server += " Http connection: "
    if @ssl
      @message_server += "https://"
    else
      @message_server += "http://"
    end
    @message_server += "#{@host}:#{@port}"
    if @proxy_host.to_s != ""
      @message_server += " proxy:#{@proxy_host}:#{@proxy_port}"
    end
    @auto_redirect = auto_redirect
    # for the case we have headers following nice_hash implementation
    @headers_orig = @headers.dup
    @headers = @headers.generate

    self.class.active += 1
    self.class.connections.push(self)
  rescue Exception => stack
    puts stack
    @logger.fatal stack
    raise stack
  end
end

Class Attribute Details

.active ⇒ Object

Returns the value of attribute active.



75
76
77
 
# File 'lib/nice_http.rb', line 75

def active
  @active
end

.auto_redirect ⇒ Object

Returns the value of attribute auto_redirect.



75
76
77
 
# File 'lib/nice_http.rb', line 75

def auto_redirect
  @auto_redirect
end

.capture ⇒ Object

Returns the value of attribute capture.



75
76
77
 
# File 'lib/nice_http.rb', line 75

def capture
  @capture
end

.captured ⇒ Object

Returns the value of attribute captured.



75
76
77
 
# File 'lib/nice_http.rb', line 75

def captured
  @captured
end

.connections ⇒ Object

Returns the value of attribute connections.



75
76
77
 
# File 'lib/nice_http.rb', line 75

def connections
  @connections
end

.create_stats ⇒ Object

Returns the value of attribute create_stats.



75
76
77
 
# File 'lib/nice_http.rb', line 75

def create_stats
  @create_stats
end

.debug ⇒ Object

Returns the value of attribute debug.



75
76
77
 
# File 'lib/nice_http.rb', line 75

def debug
  @debug
end

.headers ⇒ Object

Returns the value of attribute headers.



75
76
77
 
# File 'lib/nice_http.rb', line 75

def headers
  @headers
end

.host ⇒ Object

Returns the value of attribute host.



75
76
77
 
# File 'lib/nice_http.rb', line 75

def host
  @host
end

.last_request ⇒ Object

Returns the value of attribute last_request.



75
76
77
 
# File 'lib/nice_http.rb', line 75

def last_request
  @last_request
end

.last_response ⇒ Object

Returns the value of attribute last_response.



75
76
77
 
# File 'lib/nice_http.rb', line 75

def last_response
  @last_response
end

.log ⇒ Object

Returns the value of attribute log.



75
76
77
 
# File 'lib/nice_http.rb', line 75

def log
  @log
end

.log_files ⇒ Object

Returns the value of attribute log_files.



75
76
77
 
# File 'lib/nice_http.rb', line 75

def log_files
  @log_files
end

.log_headers ⇒ Object

Returns the value of attribute log_headers.



75
76
77
 
# File 'lib/nice_http.rb', line 75

def log_headers
  @log_headers
end

.log_path ⇒ Object

Returns the value of attribute log_path.



75
76
77
 
# File 'lib/nice_http.rb', line 75

def log_path
  @log_path
end

.port ⇒ Object

Returns the value of attribute port.



75
76
77
 
# File 'lib/nice_http.rb', line 75

def port
  @port
end

.proxy_host ⇒ Object

Returns the value of attribute proxy_host.



75
76
77
 
# File 'lib/nice_http.rb', line 75

def proxy_host
  @proxy_host
end

.proxy_port ⇒ Object

Returns the value of attribute proxy_port.



75
76
77
 
# File 'lib/nice_http.rb', line 75

def proxy_port
  @proxy_port
end

.request ⇒ Object

Returns the value of attribute request.



75
76
77
 
# File 'lib/nice_http.rb', line 75

def request
  @request
end

.request_id ⇒ Object

Returns the value of attribute request_id.



75
76
77
 
# File 'lib/nice_http.rb', line 75

def request_id
  @request_id
end

.requests ⇒ Object

Returns the value of attribute requests.



75
76
77
 
# File 'lib/nice_http.rb', line 75

def requests
  @requests
end

.ssl ⇒ Object

Returns the value of attribute ssl.



75
76
77
 
# File 'lib/nice_http.rb', line 75

def ssl
  @ssl
end

.stats ⇒ Object

Returns the value of attribute stats.



75
76
77
 
# File 'lib/nice_http.rb', line 75

def stats
  @stats
end

.timeout ⇒ Object

Returns the value of attribute timeout.



75
76
77
 
# File 'lib/nice_http.rb', line 75

def timeout
  @timeout
end

.use_mocks ⇒ Object

Returns the value of attribute use_mocks.



75
76
77
 
# File 'lib/nice_http.rb', line 75

def use_mocks
  @use_mocks
end

.values_for ⇒ Object

Returns the value of attribute values_for.



75
76
77
 
# File 'lib/nice_http.rb', line 75

def values_for
  @values_for
end

Instance Attribute Details

#active ⇒ Integer

Number of active connections

Returns:

  • (Integer) —

    the current value of active



54
55
56
 
# File 'lib/nice_http.rb', line 54

def active
  @active
end

#auto_redirect ⇒ Boolean

If true, NiceHttp will take care of the auto redirections when required by the responses

Returns:

  • (Boolean) —

    the current value of auto_redirect



54
55
56
 
# File 'lib/nice_http.rb', line 54

def auto_redirect
  @auto_redirect
end

#capture ⇒ Boolean

If true, NiceHttp will store all requests and responses on NiceHttp.captured as strings

Returns:

  • (Boolean) —

    the current value of capture



54
55
56
 
# File 'lib/nice_http.rb', line 54

def capture
  @capture
end

#captured ⇒ Array

It contains all the http requests and responses if NiceHttp.capture is set to true

Returns:

  • (Array) —

    the current value of captured



54
55
56
 
# File 'lib/nice_http.rb', line 54

def captured
  @captured
end

#connections ⇒ Array

It will include all the active connections (NiceHttp instances)

Returns:

  • (Array) —

    the current value of connections



54
55
56
 
# File 'lib/nice_http.rb', line 54

def connections
  @connections
end

#cookies ⇒ Hash

Cookies set. The key is the path (String) where cookies are set and the value a Hash with pairs of cookie keys and values, example:
{ '/' => { "cfid" => "d95adfas2550255", "amddom.settings" => "doom" } }

Returns:

  • (Hash) —

    the current value of cookies



54
55
56
 
# File 'lib/nice_http.rb', line 54

def cookies
  @cookies
end

#create_stats ⇒ Boolean

If true, NiceHttp will create stats of the http communication and store them on NiceHttp.stats hash

Returns:

  • (Boolean) —

    the current value of create_stats



54
55
56
 
# File 'lib/nice_http.rb', line 54

def create_stats
  @create_stats
end

#debug ⇒ Boolean

In case true shows all the details of the communication with the host

Returns:

  • (Boolean) —

    the current value of debug



54
55
56
 
# File 'lib/nice_http.rb', line 54

def debug
  @debug
end

#headers ⇒ Hash

Contains the headers you will be using on your connection

Returns:

  • (Hash) —

    the current value of headers



54
55
56
 
# File 'lib/nice_http.rb', line 54

def headers
  @headers
end

#host ⇒ String

The host to be accessed

Returns:

  • (String) —

    the current value of host



54
55
56
 
# File 'lib/nice_http.rb', line 54

def host
  @host
end

#last_request ⇒ String

The last request with all the content sent

Returns:

  • (String) —

    the current value of last_request



54
55
56
 
# File 'lib/nice_http.rb', line 54

def last_request
  @last_request
end

#last_response ⇒ String

Only in case :debug is true, the last response with all the content

Returns:

  • (String) —

    the current value of last_response



54
55
56
 
# File 'lib/nice_http.rb', line 54

def last_response
  @last_response
end

#log ⇒ String, Symbol

:fix_file, :no, :screen, :file, "path and file name".
:fix_file, will log the communication on nice_http.log. (default).
:no, will not generate any logs.
:screen, will print the logs on the screen.
:file, will be generated a log file with name: nice_http_YY-mm-dd-HHMMSS.log.
:file_run, will generate a log file with the name where the object was created and extension .log, fex: myfile.rb.log
String the path and file name where the logs will be stored.

Returns:

  • (String, Symbol) —

    the current value of log



54
55
56
 
# File 'lib/nice_http.rb', line 54

def log
  @log
end

#log_headers ⇒ Object

Returns the value of attribute log_headers.



143
144
145
 
# File 'lib/nice_http.rb', line 143

def log_headers
  @log_headers
end

#log_headers. ⇒ Symbol

:all, :partial, :none (default :all) If :all will log all the headers. If :partial will log the last 10 characters. If :none no headers.

Returns:

  • (Symbol) —

    the current value of log_headers.



54
55
56
 
# File 'lib/nice_http.rb', line 54

def log_headers.
  @log_headers.
end

#log_path ⇒ String

The path where the logs will be stored. By default empty string.

Returns:

  • (String) —

    the current value of log_path



54
55
56
 
# File 'lib/nice_http.rb', line 54

def log_path
  @log_path
end

#logger ⇒ Logger

An instance of the Logger class where logs will be stored. You can access on anytime to store specific data, for example:
my_http.logger.info "add this to the log file"

Returns:

  • (Logger) —

    the current value of logger

See Also:



54
55
56
 
# File 'lib/nice_http.rb', line 54

def logger
  @logger
end

#num_redirects ⇒ Integer

Number of consecutive redirections managed

Returns:

  • (Integer) —

    the current value of num_redirects



54
55
56
 
# File 'lib/nice_http.rb', line 54

def num_redirects
  @num_redirects
end

#port ⇒ Integer

The port number

Returns:

  • (Integer) —

    the current value of port



54
55
56
 
# File 'lib/nice_http.rb', line 54

def port
  @port
end

#proxy_host ⇒ String

the proxy host to be used

Returns:

  • (String) —

    the current value of proxy_host



54
55
56
 
# File 'lib/nice_http.rb', line 54

def proxy_host
  @proxy_host
end

#proxy_port ⇒ Integer

the proxy port to be used

Returns:

  • (Integer) —

    the current value of proxy_port



54
55
56
 
# File 'lib/nice_http.rb', line 54

def proxy_port
  @proxy_port
end

#request ⇒ Hash

The last request with all the content sent

Returns:

  • (Hash) —

    the current value of request



54
55
56
 
# File 'lib/nice_http.rb', line 54

def request
  @request
end

#request_id ⇒ String

If the response includes a requestId, will be stored here

Returns:

  • (String) —

    the current value of request_id



54
55
56
 
# File 'lib/nice_http.rb', line 54

def request_id
  @request_id
end

#requests ⇒ Hash

The defaults for all requests. keys: :headers and :data

Returns:

  • (Hash) —

    the current value of requests



54
55
56
 
# File 'lib/nice_http.rb', line 54

def requests
  @requests
end

#response ⇒ Hash

Contains the full response hash

Returns:

  • (Hash) —

    the current value of response



54
55
56
 
# File 'lib/nice_http.rb', line 54

def response
  @response
end

#ssl ⇒ Boolean

If you use ssl or not

Returns:

  • (Boolean) —

    the current value of ssl



54
55
56
 
# File 'lib/nice_http.rb', line 54

def ssl
  @ssl
end

#stats ⇒ Hash

It contains detailed stats of the http communication

Returns:

  • (Hash) —

    the current value of stats



54
55
56
 
# File 'lib/nice_http.rb', line 54

def stats
  @stats
end

#timeout ⇒ Integer

Max time to wait until connected to the host or getting a response.

Returns:

  • (Integer) —

    the current value of timeout



54
55
56
 
# File 'lib/nice_http.rb', line 54

def timeout
  @timeout
end

#use_mocks ⇒ Boolean

If true, in case the request hash includes a :mock_response key, it will be used as the response instead

Returns:

  • (Boolean) —

    the current value of use_mocks



54
55
56
 
# File 'lib/nice_http.rb', line 54

def use_mocks
  @use_mocks
end

#values_for ⇒ Hash

The default values to set on the data in case not specified others

Returns:

  • (Hash) —

    the current value of values_for



54
55
56
 
# File 'lib/nice_http.rb', line 54

def values_for
  @values_for
end

Class Method Details

.add_stats(name, state, started, finished, item = nil) ⇒ Object

To add specific stats
The stats will be added to NiceHttp.stats[:specific]

Examples:

started = Time.now
@http.send_request Requests::Customer.add_customer
30.times do
   resp = @http.get(Requests::Customer.get_customer)
   break if resp.code == 200
   sleep 0.5
end
NiceHttp.add_stats(:customer, :create, started, Time.now)

Parameters:

  • name (Symbol) —

    name to group your specific stats

  • state (Symbol) —

    state of the name supplied to group your specific stats

  • started (Time) —

    when the process you want the stats started

  • finished (Time) —

    when the process you want the stats finished

  • item (Object) (defaults to: nil) —

    (Optional) The item to be added to :items key to store all items in an array



189
190
191
192
193
194
195
196
197
198
199
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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/nice_http.rb', line 189

def self.add_stats(name, state, started, finished, item = nil)
  self.stats[:specific] ||= {}
  self.stats[:specific][name] ||= { num: 0, started: started, finished: started, real_time_elapsed: 0, time_elapsed: { total: 0, maximum: 0, minimum: 100000, average: 0 } }
  self.stats[:specific][name][:num] += 1

  if started < self.stats[:specific][name][:finished]
    self.stats[:specific][name][:real_time_elapsed] += (finished - self.stats[:specific][name][:finished])
  else
    self.stats[:specific][name][:real_time_elapsed] += (finished - started)
  end
  self.stats[:specific][name][:finished] = finished

  time_elapsed = self.stats[:specific][name][:time_elapsed]
  time_elapsed[:total] += finished - started
  if time_elapsed[:maximum] < (finished - started)
    time_elapsed[:maximum] = (finished - started)
    if !item.nil?
      time_elapsed[:item_maximum] = item
    elsif Thread.current.name.to_s != ""
      time_elapsed[:item_maximum] = Thread.current.name
    end
  end
  if time_elapsed[:minimum] > (finished - started)
    time_elapsed[:minimum] = (finished - started)
    if !item.nil?
      time_elapsed[:item_minimum] = item
    elsif Thread.current.name.to_s != ""
      time_elapsed[:item_minimum] = Thread.current.name
    end
  end
  time_elapsed[:average] = time_elapsed[:total] / self.stats[:specific][name][:num]

  self.stats[:specific][name][state] ||= { num: 0, started: started, finished: started, real_time_elapsed: 0, time_elapsed: { total: 0, maximum: 0, minimum: 1000, average: 0 }, items: [] }
  self.stats[:specific][name][state][:num] += 1
  if started < self.stats[:specific][name][state][:finished]
    self.stats[:specific][name][state][:real_time_elapsed] += (finished - self.stats[:specific][name][state][:finished])
  else
    self.stats[:specific][name][state][:real_time_elapsed] += (finished - started)
  end

  self.stats[:specific][name][state][:finished] = finished

  self.stats[:specific][name][state][:items] << item unless item.nil? or self.stats[:specific][name][state][:items].include?(item)
  time_elapsed = self.stats[:specific][name][state][:time_elapsed]
  time_elapsed[:total] += finished - started
  if time_elapsed[:maximum] < (finished - started)
    time_elapsed[:maximum] = (finished - started)
    if !item.nil?
      time_elapsed[:item_maximum] = item
    elsif Thread.current.name.to_s != ""
      time_elapsed[:item_maximum] = Thread.current.name
    end
  end
  if time_elapsed[:minimum] > (finished - started)
    time_elapsed[:minimum] = (finished - started)
    if !item.nil?
      time_elapsed[:item_minimum] = item
    elsif Thread.current.name.to_s != ""
      time_elapsed[:item_minimum] = Thread.current.name
    end
  end
  time_elapsed[:average] = time_elapsed[:total] / self.stats[:specific][name][state][:num]
end

.defaults=(par = {}) ⇒ Object

Change the default values for NiceHttp supplying a Hash

Parameters:

  • par (Hash) (defaults to: {}) —

    keys: :host, :port, :ssl, :timeout, :headers, :debug, :log, :log_path, :proxy_host, :proxy_port, :use_mocks, :auto_redirect, :values_for, :create_stats, :log_headers, :capture



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/nice_http.rb', line 150

def self.defaults=(par = {})
  @host = par[:host] if par.key?(:host)
  @port = par[:port] if par.key?(:port)
  @ssl = par[:ssl] if par.key?(:ssl)
  @timeout = par[:timeout] if par.key?(:timeout)
  @headers = par[:headers].dup if par.key?(:headers)
  @values_for = par[:values_for].dup if par.key?(:values_for)
  @debug = par[:debug] if par.key?(:debug)
  @log_path = par[:log_path] if par.key?(:log_path)
  @log = par[:log] if par.key?(:log)
  @log_headers = par[:log_headers] if par.key?(:log_headers)
  @proxy_host = par[:proxy_host] if par.key?(:proxy_host)
  @proxy_port = par[:proxy_port] if par.key?(:proxy_port)
  @use_mocks = par[:use_mocks] if par.key?(:use_mocks)
  @auto_redirect = par[:auto_redirect] if par.key?(:auto_redirect)
  @create_stats = par[:create_stats] if par.key?(:create_stats)
  @capture = par[:capture] if par.key?(:capture)
end

.inherited(subclass) ⇒ Object

If inheriting from NiceHttp class



138
139
140
 
# File 'lib/nice_http.rb', line 138

def self.inherited(subclass)
  subclass.reset!
end

.reset! ⇒ Object

to reset to the original defaults



89
90
91
92
93
94
95
96
97
98
99
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
 
# File 'lib/nice_http.rb', line 89

def self.reset!
  @host = nil
  @port = 80
  @ssl = false
  @timeout = nil
  @headers = {}
  @values_for = {}
  @debug = false
  @log = :fix_file
  @log_path = ''
  @log_headers = :all
  @proxy_host = nil
  @proxy_port = nil
  @last_request = nil
  @request = nil
  @requests = nil
  @last_response = nil
  @request_id = ""
  @use_mocks = false
  @connections = []
  @active = 0
  @auto_redirect = true
  @log_files = {}
  @create_stats = false
  @stats = {
    all: {
      num_requests: 0,
      started: nil,
      finished: nil,
      real_time_elapsed: 0,
      time_elapsed: {
        total: 0,
        maximum: 0,
        minimum: 1000000,
        average: 0,
      },
      method: {},
    },
    path: {},
    name: {},
  }
  @capture = false
  @captured = []
end

.save_stats(file_name = "") ⇒ Object

It will save the NiceHttp.stats on different files, each key of the hash in a different file.

Examples:

NiceHttp.save_stats
NiceHttp.save_stats('./stats/my_stats.yaml')
NiceHttp.save_stats('./stats/my_stats.json')

Parameters:

  • file_name (String) (defaults to: "") —

    path and file name to be used to store the stats.
    In case no one supplied it will be used the value in NiceHttp.log and it will be saved on YAML format.
    In case extension is .yaml will be saved on YAML format.
    In case extension is .json will be saved on JSON format.



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/nice_http.rb', line 266

def self.save_stats(file_name = "")
  if file_name == ""
    if self.log.is_a?(String)
      file_name = self.log
    else
      file_name = "./#{self.log_path}nice_http.log"
    end
  end
  require "fileutils"
  FileUtils.mkdir_p File.dirname(file_name)
  if file_name.match?(/\.json$/)
    require "json"
    self.stats.keys.each do |key|
      File.open("#{file_name.gsub(/.json$/, "_stats_")}#{key}.json", "w") { |file| file.write(self.stats[key].to_json) }
    end
  else
    require "yaml"
    self.stats.keys.each do |key|
      File.open("#{file_name.gsub(/.\w+$/, "_stats_")}#{key}.yaml", "w") { |file| file.write(self.stats[key].to_yaml) }
    end
  end
end

Instance Method Details

#close ⇒ Object

Close HTTP connection



524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
 
# File 'lib/nice_http.rb', line 524

def close
  begin
    pos = 0
    found = false
    self.class.connections.each { |conn|
      if conn.object_id == self.object_id
        found = true
        break
      else
        pos += 1
      end
    }
    if found
      self.class.connections.delete_at(pos)
    end

    unless @closed
      if !@http.nil?
        @http.finish()
        @http = nil
        @logger.info "the HTTP connection was closed: #{@message_server}"
      else
        @http = nil
        @logger.fatal "It was not possible to close the HTTP connection: #{@message_server}"
      end
      @closed = true
    else
      @logger.warn "It was not possible to close the HTTP connection, already closed: #{@message_server}"
    end
  rescue Exception => stack
    @logger.fatal stack
  end
  self.class.active -= 1
end