nice_http 1.6.5 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9134ed46c6d297b4e68c88b5e3e7e868100301bf24e3faaaa2aa17e0d75a989
-  data.tar.gz: 9ab95966908fb2365dd6573c9ddfbda4cb429741f06989fe589fb4176b4f927b
+  metadata.gz: 74ab2804913e2aaa1677a20d5819d9e8a30f4689ffc3f2cc9805ec1f1bd5a9f6
+  data.tar.gz: 24d575ea5251c1e9a39d9af68ca794c07d0f858e95d30c72dfccdcbefa40633e
 SHA512:
-  metadata.gz: 508f31aa41e757f510b95ae162ff145dce5e7a493fa0e09564414dae12b069fca20a4acb480ffd4633cb63b5cae993c2ad3620b3517e74f80e9e71b89714cd69
-  data.tar.gz: f99a4e393761bb8e69faf913ff22895f753dd531f2094b7d38eefaa66200c52bd3e454c95354823515ac0db2af3badd8e05b5dddab7a2445ed1e61f4949d5e20
+  metadata.gz: 69591afdbafca487154dd816af0eaff06edb3bfd09f877204124b9aa0978cf37f8b84a6f76d9c7f2baa5e19058d32277806226ff63b6603622065039bf7805b8
+  data.tar.gz: 3e0f852310ae7ecc1a47d4bed3b45df81ddd28cbde1c516c06da867562dcfb315530b508899742850aaae360477d68096117f61507b51ba1525ebfa1b5a514fa

data/README.md

@@ -351,6 +351,197 @@ Example posting a csv file:
 
 ```
 
+## Http logs
+
+You can set where the http logs will be stored by using the log attribute of the NiceHttp. 
+By default they will be stored in your root directory with the name nice_http.log.
+```ruby
+    # you can specify the default for all connections
+    NiceHttp.log = :file_run
+
+    # also you can specify for a concrete connection
+    http = NiceHttp.new({host: 'www.example.com', log: './example.log'})
+```
+
+Other values you can supply:
+* :fix_file, will log the communication on nice_http.log. (default).
+* :no, won't 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.
+
+Example of logs:
+```
+I, [2019-03-22T18:38:58.518964 #29412]  INFO -- : (47266856647720): Http connection created. host:www.reqres.in,  port:443,  ssl:true, mode:, proxy_host: , proxy_port:  
+I, [2019-03-22T18:38:58.537106 #29412]  INFO -- : (47266856647720): Http connection: https://www.reqres.in:443
+
+
+- - - - - - - - - - - - - - - - - - - - - - - - - 
+POST Request: Doom.example
+ path: /api/users
+ headers: {Loop:44, Cookie:, Boom:33, Content-Type:application/json, }
+ data: {
+  "name": "peter",
+  "job": "leader",
+  "products": [
+    {
+      "one": "uno",
+      "two": 2
+    },
+    {
+      "one": "uno",
+      "two": 22
+    }
+  ]
+}
+
+I, [2019-03-22T18:38:58.873935 #29412]  INFO -- : 
+RESPONSE: 
+ 201:Created
+ time_elapsed_total: '0.335720719'
+ time_elapsed: '0.335728095'
+ date: 'Fri, 22 Mar 2019 18:38:58 GMT'
+ content-type: 'application/json; charset=utf-8'
+ content-length: '172'
+ connection: 'keep-alive'
+ set-cookie: '__cfduid=dfb962e62cd8386ce4ab9bad601611553272738; expires=Sat, 21-Mar-20 18:38:58 GMT; path=/; domain=.reqres.in; HttpOnly'
+ x-powered-by: 'Express'
+ access-control-allow-origin: '*'
+ etag: 'W/"ac-EMh4XBmK5vry/OeKaGWILGtmHU0"'
+ expect-ct: 'max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"'
+ server: 'cloudflare'
+ cf-ray: '4bb99958090dbf89-AMS'
+ data: '{
+  "name": "peter",
+  "job": "leader",
+  "products": [
+    {
+      "one": "uno",
+      "two": 2
+    },
+    {
+      "one": "uno",
+      "two": 22
+    }
+  ],
+  "id": "628",
+  "createdAt": "2019-03-22T18:43:33.619Z"
+}'
+
+I, [2019-03-22T18:38:58.874190 #29412]  INFO -- : set-cookie added to Cookie header as required
+I, [2019-03-22T18:38:59.075293 #29412]  INFO -- : 
+
+- - - - - - - - - - - - - - - - - - - - - - - - - 
+GET Request: Doom.example
+ path: /api/users
+ Same headers and data as in the previous request.
+I, [2019-03-22T18:38:59.403459 #29412]  INFO -- : 
+RESPONSE: 
+ 200:OK
+ time_elapsed_total: '0.327002338'
+ time_elapsed: '0.327004766'
+ date: 'Fri, 22 Mar 2019 18:38:59 GMT'
+ content-type: 'application/json; charset=utf-8'
+ transfer-encoding: 'chunked'
+ connection: 'keep-alive'
+ x-powered-by: 'Express'
+ access-control-allow-origin: '*'
+ etag: 'W/"1bb-D+c3sZ5g5u/nmLPQRl1uVo2heAo"'
+ expect-ct: 'max-age=604800, report-uri="https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct"'
+ server: 'cloudflare'
+ cf-ray: '4bb9995b5c20bf89-AMS'
+ data: '{
+  "page": 1,
+  "per_page": 3,
+  "total": 12,
+  "total_pages": 4,
+  "data": [
+    {
+      "id": 1,
+      "first_name": "George",
+      "last_name": "Bluth",
+      "avatar": "https://s3.amazonaws.com/uifaces/faces/twitter/calebogden/128.jpg"
+    },
+    {
+      "id": 2,
+      "first_name": "Janet",
+      "last_name": "Weaver",
+      "avatar": "https://s3.amazonaws.com/uifaces/faces/twitter/josephstein/128.jpg"
+    },
+  ]
+}'
+
+```
+
+## Http stats
+
+If you want to get a summarize stats of your http communication you need to set `NiceHttp.create_stats = true` 
+
+Then whenever you want to access the stats: `NiceHttp.stats`
+
+Also it is very convenient to store the stats on a file, for example on YAML format. You can use the at_exit method to be run at the end of the run:
+
+```ruby
+at_exit do
+    require 'yaml'
+    NiceHttp.stats.keys.each do |key|
+        File.open("./nice_http_stats_#{key}.yaml", "w") { |file| file.write(NiceHttp.stats[key].to_yaml) }
+    end
+end
+```
+
+This is an example of the output:
+
+```yaml
+---
+www.reqres.in:443:
+  :num_requests: 11
+  :time_elapsed:
+    :total: 2.947269038
+    :maximum: 0.357101109
+    :minimum: 0.198707111
+    :average: 0.2679335489090909
+  "/api/users":
+    :num_requests: 11
+    :time_elapsed:
+      :total: 2.947269038
+      :maximum: 0.357101109
+      :minimum: 0.198707111
+      :average: 0.2679335489090909
+    :method:
+      POST:
+        :num_requests: 8
+        :time_elapsed:
+          :total: 2.3342455970000002
+          :maximum: 0.357101109
+          :minimum: 0.198707111
+          :average: 0.29178069962500003
+        :response:
+          '201':
+            :num_requests: 8
+            :time_elapsed:
+              :total: 2.3342455970000002
+              :maximum: 0.357101109
+              :minimum: 0.198707111
+              :average: 0.29178069962500003
+      GET:
+        :num_requests: 3
+        :time_elapsed:
+          :total: 0.613023441
+          :maximum: 0.210662528
+          :minimum: 0.200197583
+          :average: 0.20434114699999997
+        :response:
+          '200':
+            :num_requests: 3
+            :time_elapsed:
+              :total: 0.613023441
+              :maximum: 0.210662528
+              :minimum: 0.200197583
+              :average: 0.20434114699999997
+```
+
 ## Contributing
 
 Bug reports are very welcome on GitHub at https://github.com/marioruiz/nice_http.

data/lib/nice_http.rb

@@ -9,7 +9,7 @@ require_relative "nice_http/http_methods"
 # Attributes you can access using NiceHttp.the_attribute:
 #   :host, :port, :ssl, :headers, :debug, :log, :proxy_host, :proxy_port,
 #   :last_request, :last_response, :request_id, :use_mocks, :connections,
-#   :active, :auto_redirect, :values_for
+#   :active, :auto_redirect, :values_for, :create_stats, :stats
 #
 # @attr [String] host The host to be accessed
 # @attr [Integer] port The port number
@@ -41,6 +41,8 @@ require_relative "nice_http/http_methods"
 #   my_http.logger.info "add this to the log file"
 #   @see https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html
 # @attr [Hash] values_for The default values to set on the data in case not specified others
+# @attr [Boolean] create_stats If true, NiceHttp will create stats of the http communication and store them on NiceHttp.stats hash
+# @attr [Hash] stats It contains detailed stats of the http communication
 ######################################################
 class NiceHttp
   include NiceHttpManageRequest
@@ -64,7 +66,7 @@ class NiceHttp
   class << self
     attr_accessor :host, :port, :ssl, :headers, :debug, :log, :proxy_host, :proxy_port,
                   :last_request, :last_response, :request_id, :use_mocks, :connections,
-                  :active, :auto_redirect, :log_files, :values_for
+                  :active, :auto_redirect, :log_files, :values_for, :create_stats, :stats
   end
 
   ######################################################
@@ -88,6 +90,21 @@ class NiceHttp
     @active = 0
     @auto_redirect = true
     @log_files = {}
+    @create_stats = false
+    @stats = {
+      all: {
+        num_requests: 0,
+        time_elapsed: {
+          total: 0,
+          maximum: 0,
+          minimum: 100000,
+          average: 0,
+        },
+        method: {},
+      },
+      path: {},
+      name: {},
+    }
   end
   reset!
 
@@ -104,7 +121,7 @@ class NiceHttp
   ######################################################
   # Change the default values for NiceHttp supplying a Hash
   #
-  # @param par [Hash] keys: :host, :port, :ssl, :headers, :debug, :log, :proxy_host, :proxy_port, :use_mocks, :auto_redirect, :values_for
+  # @param par [Hash] keys: :host, :port, :ssl, :headers, :debug, :log, :proxy_host, :proxy_port, :use_mocks, :auto_redirect, :values_for, :create_stats
   ######################################################
   def self.defaults=(par = {})
     @host = par[:host] if par.key?(:host)
@@ -118,6 +135,7 @@ class NiceHttp
     @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)
   end
 
   ######################################################
@@ -184,6 +202,7 @@ class NiceHttp
     @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
 
     #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

data/lib/nice_http/manage_request.rb

@@ -191,7 +191,7 @@ module NiceHttpManageRequest
 
       headers_ts = ""
       headers_t.each { |key, val| headers_ts += key.to_s + ":" + val.to_s() + ", " }
-      message = "#{"- " * 25}\n"
+      message = "\n\n#{"- " * 25}\n"
       if arguments.size == 1 and arguments[0].kind_of?(Hash) and arguments[0].key?(:name)
         message += "#{method_s.upcase} Request: #{arguments[0][:name]}"
       else
@@ -203,7 +203,7 @@ module NiceHttpManageRequest
         message += " data: " + data_s.to_s() + "\n"
         message = @message_server + "\n" + message
       else
-        message += " Same as the last request."
+        message += " Same#{" headers" if headers_t != {}}#{" and" if headers_t != {} and data.to_s != ""}#{" data" if data.to_s != ""} as in the previous request."
       end
       if path.to_s().scan(/^https?:\/\//).size > 0 and path.to_s().scan(/^https?:\/\/#{@host}/).size == 0
         # the path is for another server than the current
@@ -219,6 +219,10 @@ module NiceHttpManageRequest
       @prev_request[:path] = path
       @prev_request[:data] = data
       @prev_request[:headers] = headers_t
+      @prev_request[:method] = method_s.upcase
+      if arguments.size == 1 and arguments[0].kind_of?(Hash) and arguments[0].key?(:name)
+        @prev_request[:name] = arguments[0][:name]
+      end
       return path, data, headers_t
     rescue Exception => stack
       @logger.fatal(stack)

data/lib/nice_http/manage_response.rb

@@ -24,6 +24,9 @@ module NiceHttpManageResponse
       else
         @response[:time_elapsed] = nil
       end
+
+      create_stats(resp) if @create_stats
+
       begin
         # this is to be able to access all keys as symbols
         new_resp = Hash.new()
@@ -90,8 +93,8 @@ module NiceHttpManageResponse
 
       @response[:code] = resp.code
       message = "\nRESPONSE: \n " + @response[:code].to_s() + ":" + @response[:message].to_s()
-      if @debug or @prev_response[:'content-type']!=@response[:'content-type'] or @prev_response[:'content-length']!=@response[:'content-length'] or
-        @prev_response[:data]!=@response[:data] or @prev_response[:code]!=@response[:code] or @prev_response[:message]!= @response[:message]
+      if @debug or @prev_response[:'content-type'] != @response[:'content-type'] or @prev_response[:'content-length'] != @response[:'content-length'] or
+         @prev_response[:data] != @response[:data] or @prev_response[:code] != @response[:code] or @prev_response[:message] != @response[:message]
         self.class.last_response = message if @debug
         @response.each { |key, value|
           if value.to_s() != ""
@@ -180,4 +183,97 @@ module NiceHttpManageResponse
       @logger.fatal "manage_response Error on method #{method_s} "
     end
   end
+
+  private
+
+  def set_stats(hash)
+    unless hash.key?(:num_requests)
+      # to add to the end the previous keys so num_requests and time_elapsed come first
+      keys = hash.keys
+      hash.keys.each do |k|
+        hash.delete(k)
+      end
+
+      hash[:num_requests] = 0
+      hash[:time_elapsed] = {
+        total: 0,
+        maximum: 0,
+        minimum: 100000,
+        average: 0,
+      }
+
+      # to add to the end the previous keys so num_requests and time_elapsed come first
+      keys.each do |k|
+        hash[k] = {}
+      end
+    end
+    hash[:num_requests] += 1
+    hash[:time_elapsed][:total] += @response[:time_elapsed]
+    hash[:time_elapsed][:maximum] = @response[:time_elapsed] if @response[:time_elapsed] > hash[:time_elapsed][:maximum]
+    hash[:time_elapsed][:minimum] = @response[:time_elapsed] if @response[:time_elapsed] < hash[:time_elapsed][:minimum]
+    hash[:time_elapsed][:average] = hash[:time_elapsed][:total] / hash[:num_requests]
+  end
+
+  private
+
+  def create_stats(resp)
+    # all
+    set_stats(self.class.stats[:all])
+    # all method
+    unless self.class.stats[:all][:method].key?(@prev_request[:method])
+      self.class.stats[:all][:method][@prev_request[:method]] = {
+        response: {},
+      }
+    end
+    set_stats(self.class.stats[:all][:method][@prev_request[:method]])
+    # all method response
+    unless self.class.stats[:all][:method][@prev_request[:method]][:response].key?(resp.code)
+      self.class.stats[:all][:method][@prev_request[:method]][:response][resp.code] = {}
+    end
+    set_stats(self.class.stats[:all][:method][@prev_request[:method]][:response][resp.code])
+
+    # server
+    server = "#{@host}:#{@port}"
+    unless self.class.stats[:path].key?(server) 
+      self.class.stats[:path][server] = {}
+    end
+    set_stats(self.class.stats[:path][server])
+    # server path
+    unless self.class.stats[:path][server].key?(@prev_request[:path])
+      self.class.stats[:path][server][@prev_request[:path]] = {method: {}}
+    end
+    set_stats(self.class.stats[:path][server][@prev_request[:path]])
+    # server path method
+    unless self.class.stats[:path][server][@prev_request[:path]][:method].key?(@prev_request[:method])
+      self.class.stats[:path][server][@prev_request[:path]][:method][@prev_request[:method]] = {
+        response: {},
+      }
+    end
+    set_stats(self.class.stats[:path][server][@prev_request[:path]][:method][@prev_request[:method]])
+    # server path method response
+    unless self.class.stats[:path][server][@prev_request[:path]][:method][@prev_request[:method]][:response].key?(resp.code)
+      self.class.stats[:path][server][@prev_request[:path]][:method][@prev_request[:method]][:response][resp.code] = {}
+    end
+    set_stats(self.class.stats[:path][server][@prev_request[:path]][:method][@prev_request[:method]][:response][resp.code])
+
+    if @prev_request.key?(:name)
+      # name
+      unless self.class.stats[:name].key?(@prev_request[:name])
+        self.class.stats[:name][@prev_request[:name]] = {method: {}}
+      end
+      set_stats(self.class.stats[:name][@prev_request[:name]])
+      # name method
+      unless self.class.stats[:name][@prev_request[:name]][:method].key?(@prev_request[:method])
+        self.class.stats[:name][@prev_request[:name]][:method][@prev_request[:method]] = {
+          response: {},
+        }
+      end
+      set_stats(self.class.stats[:name][@prev_request[:name]][:method][@prev_request[:method]])
+      # name method response
+      unless self.class.stats[:name][@prev_request[:name]][:method][@prev_request[:method]][:response].key?(resp.code)
+        self.class.stats[:name][@prev_request[:name]][:method][@prev_request[:method]][:response][resp.code] = {}
+      end
+      set_stats(self.class.stats[:name][@prev_request[:name]][:method][@prev_request[:method]][:response][resp.code])
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nice_http
 version: !ruby/object:Gem::Version
-  version: 1.6.5
+  version: 1.7.0
 platform: ruby
 authors:
 - Mario Ruiz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-19 00:00:00.000000000 Z
+date: 2019-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nice_hash