nice_http 1.8.5 → 1.8.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8230eed259e6a1a44d8fc84d06674addaf2a84516f3576944ed75ddf25c600c2
-  data.tar.gz: ec990b3b84242d178af775e5227f2bf6d5288461fa4d230e40de68fed4be27dc
+  metadata.gz: 5d71a8b887f41eb061251023b5490469bd1a19cb6f1c567ecb73a76dc0771a62
+  data.tar.gz: d8d11267e373ca3ffa54366be21116949c1d4bccad9ee58ded6b445708a3aa40
 SHA512:
-  metadata.gz: 70917c6be7b0f1defaafc88a6bab4caa632194800dcd274690d87f24188880507428470ca346a9bcf8e3e41b9ed37ba151b59d7d55d9e5eb3451d78200b224bd
-  data.tar.gz: 90f3739074aa0c60475e9c2162f8cf3e112e0220c5d7025807e995d0d451fa1e2031e48062decea3e76b2a443f92f5a754959e133da5e573869a44c0b76d6cf5
+  metadata.gz: 7d1f38f6e9f08c8a90094e5f15b337ca89c3f3894fa9c3ce313ed1f2360386f870393a2ac86d4f99e8c9c14f1f13bdbe191926f49fe8b7c9a7f91fce203bef24
+  data.tar.gz: c751a5dfc67127dbf5e89be704d46381888128b8f96b15a8819006d5ee4ec46cfdaec4df208fdb66eb3e8ca7db61b9020132ef0108a1dce4f03c6c6c361572c6

data/README.md

@@ -29,6 +29,11 @@ Example that creates 1000 good random and unique requests to register an user an
 - [Responses](#Responses)
 - [Special settings](#Special-settings)
 - [Authentication requests](#Authentication-requests)
+    - [Basic Authentication](#Basic-Authentication)
+    - [OpenID](#OpenID)
+    - [OAuth2](#OAuth2)
+    - [JWT Token](#JWT-Token)
+    - [lambda on headers](#lambda-on-headers)
 - [Http logs](#Http-logs)
     - [Multithreading](#Multithreading)
 - [Http stats](#Http-stats)
@@ -241,6 +246,19 @@ If the request hash contains a key :method with one of these possible values: :g
      resp = @http.send_request req
 ```
 
+You can always access to the last request as a Hash object by: `NiceHttp.request`
+
+If you want to change the value of all headers using the value of the request on runtime, use `lambda`, `NiceHttp.requests` and `NiceHttp.request`:
+
+```ruby
+NiceHttp.requests = {
+  headers: {
+    Referer: lambda { "http://myserver.com" + NiceHttp.request.path }
+  }
+}
+```
+
+You can use `NiceHttp.requests` to specify certain `headers` or `data` that will apply on all requests sent.
 
 ## Responses
 
@@ -275,6 +293,8 @@ Also interesting keys would be: *time_elapsed_total*, *time_elapsed* and many mo
 
 All we need to do is to add to our request the correct authentication tokens, seeds, headers.
 
+### Basic Authentication
+
 For example for Basic Authentication we need to add to the authorization header a seed generated with the user and password we want ot authenticate
 
 ```ruby
@@ -305,6 +325,8 @@ Remember for other kind of authentication systems NiceHttp take care of the redi
 
 In case you want or need to control the redirections by yourself instead of allowing NiceHttp to do it, then set ```@http.auto_redirect = false```
 
+### OpenID
+
 An example using OpenID authentication:
 
 ```ruby
@@ -349,17 +371,65 @@ The output:
 
 ```
 
+### OAuth2
+
 You can see on the next link how to get the OAuth2 token for Microsoft Azure and add it to your Http connection header. 
 
 https://gist.github.com/MarioRuiz/d3525185024737885c0c9afa6dc8b9e5
 
+### JWT token
+
+An example for Google using JWT
+
+my_json_key_file.json:
+```json
+{
+  "type": "service_account",
+  "project_id": "example",
+  "private_key_id": "fjdslkafldkasfadsjflkjdsaklfjasdklfjlkdsjfl",
+  "private_key": "-----BEGIN PRIVATE KEY-----....==\n-----END PRIVATE KEY-----\n",
+  "client_email": "example@example.iam.gserviceaccount.com",
+  "client_id": "46545646",
+  "auth_uri": "https://accounts.google.com/o/oauth2/auth",
+  "token_uri": "https://oauth2.googleapis.com/token",
+  "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
+  "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/example%40example.iam.gserviceaccount.com"
+}
+```
+
+```ruby
+    require 'jwt'
+    require 'nice_hash'
+    def generate_jwt(audience, json_key_file)
+      json = File.open(json_key_file).read.json
+      now = Time.new
+      payload = {
+        iss: json.client_email,
+        sub: json.client_email,
+        aud: audience,
+        exp: (now + 3600).to_i,
+        iat: (now - 60).to_i,
+        kid: json.private_key_id
+      }
+      jwt_token = JWT.encode payload, OpenSSL::PKey::RSA.new(json.private_key), "RS256"
+      return jwt_token
+    end
+
+    NiceHttp.headers = {
+      Authorization: lambda { "Bearer " + generate_jwt('https:/myhost.com', './my_json_key_file.json') }
+    }
+
+```
+
+### lambda on headers
+
 If you need a new token every time a new http connection is created you can use `lambda`
 
 ```ruby
 NiceHttp.headers[:Authorization] = lambda {get_token()}
 ```
 
-NiceHttp will call the get_token method you created every time a new Http connection is created.
+NiceHttp will call the get_token method you created every time a new connection is created.
 
 ## Http logs
 
@@ -489,7 +559,7 @@ RESPONSE:
 
 ```
 
-If you want to get the last request sent or the last response use `NiceHttp.last_request` or `NiceHttp.last_response`
+If you want to get the last request sent or the last response as a message use `NiceHttp.last_request` or `NiceHttp.last_response`. If you want to access the last request as a Hash use `NiceHttp.request`
 
 Also you can collect all data sent and received by setting `NiceHttp.capture = true` and all data will be stored on `NiceHttp.captured` as an Array of Strings (Request+Response).
 

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, :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
+#   :active, :auto_redirect, :values_for, :create_stats, :stats, :capture, :captured, :request, :requests
 #
 # @attr [String] host The host to be accessed
 # @attr [Integer] port The port number
@@ -29,6 +29,8 @@ require_relative "nice_http/http_methods"
 # @attr [Integer] proxy_port the proxy port to be used
 # @attr [String] last_request The last request with all the content sent
 # @attr [String] last_response Only in case :debug is true, the last response with all the content
+# @attr [Hash] request The last request with all the content sent
+# @attr [Hash] requests The defaults for all requests. keys: :headers and :data
 # @attr [String] request_id If the response includes a requestId, will be stored here
 # @attr [Boolean] use_mocks If true, in case the request hash includes a :mock_response key, it will be used as the response instead
 # @attr [Array] connections It will include all the active connections (NiceHttp instances)
@@ -70,8 +72,8 @@ class NiceHttp
 
   class << self
     attr_accessor :host, :port, :ssl, :headers, :debug, :log_path, :log, :proxy_host, :proxy_port, :log_headers,
-                  :last_request, :last_response, :request_id, :use_mocks, :connections,
-                  :active, :auto_redirect, :log_files, :values_for, :create_stats, :stats, :capture, :captured
+                  :last_request, :last_response, :request, :request_id, :use_mocks, :connections,
+                  :active, :auto_redirect, :log_files, :values_for, :create_stats, :stats, :capture, :captured, :requests
   end
 
   at_exit do
@@ -96,6 +98,8 @@ class NiceHttp
     @proxy_host = nil
     @proxy_port = nil
     @last_request = nil
+    @request = nil
+    @requests = nil
     @last_response = nil
     @request_id = ""
     @use_mocks = false

data/lib/nice_http/manage_request.rb

@@ -13,6 +13,9 @@ module NiceHttpManageRequest
     require "json"
 
     @prev_request = Hash.new() if @prev_request.nil?
+    @defaults_request = self.class.requests if @defaults_request.nil? and self.class.requests.is_a?(Hash)
+    @request = Hash.new() if @request.nil?
+    @defaults_request = Hash.new() unless @defaults_request.is_a?(Hash)
 
     begin
       content_type_included = false
@@ -21,6 +24,8 @@ module NiceHttpManageRequest
 
       @response = Hash.new()
       headers_t = @headers.dup()
+      headers_t.merge!(@defaults_request[:headers]) if @defaults_request.key?(:headers)
+
       cookies_to_set_str = ""
       if arguments.size == 3
         path = arguments[0]
@@ -125,6 +130,13 @@ module NiceHttpManageRequest
               }
             end
           elsif data.kind_of?(Hash)
+            data.merge!(@defaults_request[:data]) if @defaults_request.key?(:data)
+            #lambdas on data only supports on root of the hash
+            data.each do |k, v|
+              if v.is_a?(Proc)
+                data[k] = v.call 
+              end
+            end
             if arguments[0].include?(:values_for)
               data = data.set_values(arguments[0][:values_for])
             end
@@ -192,6 +204,40 @@ module NiceHttpManageRequest
         headers_t["Accept-Encoding"].gsub!("gzip", "") #removed so the response is in plain text
       end
 
+      if data.to_s() != "" and encoding.to_s().upcase != "UTF-8" and encoding != ""
+        data = data.to_s().encode(encoding, "UTF-8")
+      end
+      @request[:path] = path
+      @request[:data] = data
+      @request[:headers] = headers_t
+      @request[:method] = method_s.upcase
+      if arguments.size == 1 and arguments[0].kind_of?(Hash) and arguments[0].key?(:name)
+        @request[:name] = arguments[0][:name]
+      end
+      self.class.request = @request
+      headers_t.each do |k, v|
+        # for lambdas
+        if v.is_a?(Proc)
+          headers_t[k] = v.call 
+        end
+      end
+      @request[:headers] = headers_t
+      self.class.request = @request
+
+      if @debug or @prev_request[:path] != path or @prev_request[:headers] != headers_t or @prev_request[:data] != data
+        show_headers_data = true
+      else
+        show_headers_data = false
+      end
+
+      @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
+
       headers_ts = ""
 
       if @log_headers == :none
@@ -217,7 +263,7 @@ module NiceHttpManageRequest
         message += "#{method_s.upcase} Request"
       end
       message += "\n path: " + path.to_s() + "\n"
-      if @debug or @prev_request[:path] != path or @prev_request[:headers] != headers_t or @prev_request[:data] != data
+      if show_headers_data
         message += " headers: {" + headers_ts.to_s() + "}\n"
         message += " data: " + data_s.to_s() + "\n"
         message = @message_server + "\n" + message
@@ -232,22 +278,6 @@ module NiceHttpManageRequest
         @logger.info(message)
       end
 
-      if data.to_s() != "" and encoding.to_s().upcase != "UTF-8" and encoding != ""
-        data = data.to_s().encode(encoding, "UTF-8")
-      end
-      headers_t.each do |k, v|
-        # for lambdas
-        if v.is_a?(Proc)
-          headers_t[k] = v.call 
-        end
-      end
-      @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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nice_http
 version: !ruby/object:Gem::Version
-  version: 1.8.5
+  version: 1.8.6
 platform: ruby
 authors:
 - Mario Ruiz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-09 00:00:00.000000000 Z
+date: 2020-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nice_hash
@@ -19,7 +19,7 @@ dependencies:
         version: '1.15'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.15.4
+        version: 1.15.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '1.15'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.15.4
+        version: 1.15.6
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement