nice_http 1.5.2 → 1.6.0

data/lib/nice_http/manage_response.rb

@@ -1,181 +1,181 @@
-module NiceHttpManageResponse
-
-  ######################################################
-  # private method to manage Response
-  #   input:
-  #     resp
-  #     data
-  #   output:
-  #     @response updated
-  ######################################################
-  def manage_response(resp, data)
-    require "json"
-    begin
-      if @start_time.kind_of?(Time)
-        @response[:time_elapsed_total] = Time.now - @start_time
-        @start_time = nil
-      else
-        @response[:time_elapsed_total] = nil
-      end
-      if @start_time_net.kind_of?(Time)
-        @response[:time_elapsed] = Time.now - @start_time_net
-        @start_time_net = nil
-      else
-        @response[:time_elapsed] = nil
-      end
-      begin
-        # this is to be able to access all keys as symbols
-        new_resp = Hash.new()
-        resp.each { |key, value|
-          if key.kind_of?(String)
-            new_resp[key.to_sym] = value
-          end
-        }
-        new_resp.each { |key, value|
-          resp[key] = value
-        }
-      rescue
-      end
-      #for mock_responses to be able to add outside of the header like content-type for example
-      if resp.kind_of?(Hash) and !resp.has_key?(:header)
-        resp[:header] = {}
-      end
-      
-      #todo: check this. not sure if this is valid anymore since resp it will be a hash only when mock_response      
-      if resp.kind_of?(Hash)
-        resp.each { |k, v|
-          if k != :code and k != :message and k != :data and k != :'set-cookie' and k != :header
-            resp[:header][k] = v
-          end
-        }
-        resp[:header].each { |k, v|
-          resp.delete(k) if resp.has_key?(k)
-        }
-      end
-
-      method_s = caller[0].to_s().scan(/:in `(.*)'/).join
-      if resp.header.kind_of?(Hash) and (resp.header["content-type"].to_s() == "application/x-deflate" or resp.header[:"content-type"].to_s() == "application/x-deflate")
-        data = Zlib::Inflate.inflate(data)
-      end
-      encoding_response = ""
-      if resp.header.kind_of?(Hash) and (resp.header["content-type"].to_s() != "" or resp.header[:"content-type"].to_s() != "")
-        encoding_response = resp.header["content-type"].scan(/;charset=(.*)/i).join if resp.header.has_key?("content-type")
-        encoding_response = resp.header[:"content-type"].scan(/;charset=(.*)/i).join if resp.header.has_key?(:"content-type")
-      end
-      if encoding_response.to_s() == ""
-        encoding_response = "UTF-8"
-      end
-
-      if encoding_response.to_s() != "" and encoding_response.to_s().upcase != "UTF-8"
-        data.encode!("UTF-8", encoding_response.to_s())
-      end
-
-      if encoding_response != "" and encoding_response.to_s().upcase != "UTF-8"
-        @response[:message] = resp.message.to_s().encode("UTF-8", encoding_response.to_s())
-        #todo: response data in here for example is convert into string, verify if that is correct or needs to maintain the original data type (hash, array...)
-        resp.each { |key, val| @response[key.to_sym] = val.to_s().encode("UTF-8", encoding_response.to_s()) }
-      else
-        @response[:message] = resp.message
-        resp.each { |key, val| 
-          @response[key.to_sym] = val 
-        }
-      end
-
-      if !defined?(Net::HTTP::Post::Multipart) or (defined?(Net::HTTP::Post::Multipart) and !data.kind_of?(Net::HTTP::Post::Multipart))
-        @response[:data] = data
-      else
-        @response[:data] = ""
-      end
-
-      @response[:code] = resp.code
-
-      unless @response.nil?
-        message = "\nRESPONSE: \n" + @response[:code].to_s() + ":" + @response[:message].to_s()
-        #if @debug
-          self.class.last_response = message if @debug
-          @response.each { |key, value|
-            if value.to_s() != ""
-              value_orig = value
-              if key.kind_of?(Symbol)
-                if key == :code or key == :data or key == :header or key == :message
-                  if key == :data and !@response[:'content-type'].to_s.include?('text/html')
-                    begin
-                      JSON.parse(value_orig)
-                      data_s = JSON.pretty_generate(JSON.parse(value_orig))
-                    rescue
-                      data_s = value_orig
-                    end
-                    if @debug
-                      self.class.last_response += "\nresponse." + key.to_s() + " = '" + data_s.gsub("<", "&lt;") + "'\n"
-                    end
-                    if value_orig != value
-                      message += "\nresponse." + key.to_s() + " = '" + value.gsub("<", "&lt;") + "'\n"
-                    else
-                      message += "\nresponse." + key.to_s() + " = '" + data_s.gsub("<", "&lt;") + "'\n"
-                    end
-                  else
-                    if @debug
-                      self.class.last_response += "\nresponse." + key.to_s() + " = '" + value.to_s().gsub("<", "&lt;") + "'"
-                      message += "\nresponse." + key.to_s() + " = '" + value.to_s().gsub("<", "&lt;") + "'"
-                    end
-                  end
-                else
-                  if @debug
-                    self.class.last_response += "\nresponse[:" + key.to_s() + "] = '" + value.to_s().gsub("<", "&lt;") + "'"
-                  end  
-                  message += "\nresponse[:" + key.to_s() + "] = '" + value.to_s().gsub("<", "&lt;") + "'"
-                end
-              elsif !@response.include?(key.to_sym)
-                if @debug
-                  self.class.last_response += "\nresponse['" + key.to_s() + "'] = '" + value.to_s().gsub("<", "&lt;") + "'"
-                end
-                message += "\nresponse['" + key.to_s() + "'] = '" + value.to_s().gsub("<", "&lt;") + "'"
-              end
-            end
-          }
-        #end
-        @logger.info message
-        if @response.kind_of?(Hash)
-          if @response.keys.include?(:requestid)
-            @headers["requestId"] = @response[:requestid]
-            self.class.request_id = @response[:requestid]
-            @logger.info "requestId was found on the response header and it has been added to the headers for the next request"
-          end
-        end
-      end
-
-      if resp[:'set-cookie'].to_s() != ""
-        if resp.kind_of?(Hash) #mock_response
-          cookies_to_set = resp[:'set-cookie'].to_s().split(", ")
-        else #Net::Http
-          cookies_to_set = resp.get_fields("set-cookie")
-        end
-        cookies_to_set.each { |cookie|
-          cookie_pair = cookie.split("; ")[0].split("=")
-          cookie_path = cookie.scan(/; path=([^;]+)/i).join
-          @cookies[cookie_path] = Hash.new() unless @cookies.keys.include?(cookie_path)
-          @cookies[cookie_path][cookie_pair[0]] = cookie_pair[1]
-        }
-
-        @logger.info "set-cookie added to Cookie header as required"
-
-        if @headers.has_key?("X-CSRFToken")
-          csrftoken = resp[:"set-cookie"].to_s().scan(/csrftoken=([\da-z]+);/).join
-          if csrftoken.to_s() != ""
-            @headers["X-CSRFToken"] = csrftoken
-            @logger.info "X-CSRFToken exists on headers and has been overwritten"
-          end
-        else
-          csrftoken = resp[:"set-cookie"].to_s().scan(/csrftoken=([\da-z]+);/).join
-          if csrftoken.to_s() != ""
-            @headers["X-CSRFToken"] = csrftoken
-            @logger.info "X-CSRFToken added to header as required"
-          end
-        end
-      end
-    rescue Exception => stack
-      @logger.fatal stack
-      @logger.fatal "manage_response Error on method #{method_s} "
-    end
-  end
+module NiceHttpManageResponse
+
+  ######################################################
+  # private method to manage Response
+  #   input:
+  #     resp
+  #     data
+  #   output:
+  #     @response updated
+  ######################################################
+  def manage_response(resp, data)
+    require "json"
+    begin
+      if @start_time.kind_of?(Time)
+        @response[:time_elapsed_total] = Time.now - @start_time
+        @start_time = nil
+      else
+        @response[:time_elapsed_total] = nil
+      end
+      if @start_time_net.kind_of?(Time)
+        @response[:time_elapsed] = Time.now - @start_time_net
+        @start_time_net = nil
+      else
+        @response[:time_elapsed] = nil
+      end
+      begin
+        # this is to be able to access all keys as symbols
+        new_resp = Hash.new()
+        resp.each { |key, value|
+          if key.kind_of?(String)
+            new_resp[key.to_sym] = value
+          end
+        }
+        new_resp.each { |key, value|
+          resp[key] = value
+        }
+      rescue
+      end
+      #for mock_responses to be able to add outside of the header like content-type for example
+      if resp.kind_of?(Hash) and !resp.has_key?(:header)
+        resp[:header] = {}
+      end
+      
+      #todo: check this. not sure if this is valid anymore since resp it will be a hash only when mock_response      
+      if resp.kind_of?(Hash)
+        resp.each { |k, v|
+          if k != :code and k != :message and k != :data and k != :'set-cookie' and k != :header
+            resp[:header][k] = v
+          end
+        }
+        resp[:header].each { |k, v|
+          resp.delete(k) if resp.has_key?(k)
+        }
+      end
+
+      method_s = caller[0].to_s().scan(/:in `(.*)'/).join
+      if resp.header.kind_of?(Hash) and (resp.header["content-type"].to_s() == "application/x-deflate" or resp.header[:"content-type"].to_s() == "application/x-deflate")
+        data = Zlib::Inflate.inflate(data)
+      end
+      encoding_response = ""
+      if resp.header.kind_of?(Hash) and (resp.header["content-type"].to_s() != "" or resp.header[:"content-type"].to_s() != "")
+        encoding_response = resp.header["content-type"].scan(/;charset=(.*)/i).join if resp.header.has_key?("content-type")
+        encoding_response = resp.header[:"content-type"].scan(/;charset=(.*)/i).join if resp.header.has_key?(:"content-type")
+      end
+      if encoding_response.to_s() == ""
+        encoding_response = "UTF-8"
+      end
+
+      if encoding_response.to_s() != "" and encoding_response.to_s().upcase != "UTF-8"
+        data.encode!("UTF-8", encoding_response.to_s())
+      end
+
+      if encoding_response != "" and encoding_response.to_s().upcase != "UTF-8"
+        @response[:message] = resp.message.to_s().encode("UTF-8", encoding_response.to_s())
+        #todo: response data in here for example is convert into string, verify if that is correct or needs to maintain the original data type (hash, array...)
+        resp.each { |key, val| @response[key.to_sym] = val.to_s().encode("UTF-8", encoding_response.to_s()) }
+      else
+        @response[:message] = resp.message
+        resp.each { |key, val| 
+          @response[key.to_sym] = val 
+        }
+      end
+
+      if !defined?(Net::HTTP::Post::Multipart) or (defined?(Net::HTTP::Post::Multipart) and !data.kind_of?(Net::HTTP::Post::Multipart))
+        @response[:data] = data
+      else
+        @response[:data] = ""
+      end
+
+      @response[:code] = resp.code
+
+      unless @response.nil?
+        message = "\nRESPONSE: \n" + @response[:code].to_s() + ":" + @response[:message].to_s()
+        #if @debug
+          self.class.last_response = message if @debug
+          @response.each { |key, value|
+            if value.to_s() != ""
+              value_orig = value
+              if key.kind_of?(Symbol)
+                if key == :code or key == :data or key == :header or key == :message
+                  if key == :data and !@response[:'content-type'].to_s.include?('text/html')
+                    begin
+                      JSON.parse(value_orig)
+                      data_s = JSON.pretty_generate(JSON.parse(value_orig))
+                    rescue
+                      data_s = value_orig
+                    end
+                    if @debug
+                      self.class.last_response += "\nresponse." + key.to_s() + " = '" + data_s.gsub("<", "&lt;") + "'\n"
+                    end
+                    if value_orig != value
+                      message += "\nresponse." + key.to_s() + " = '" + value.gsub("<", "&lt;") + "'\n"
+                    else
+                      message += "\nresponse." + key.to_s() + " = '" + data_s.gsub("<", "&lt;") + "'\n"
+                    end
+                  else
+                    if @debug
+                      self.class.last_response += "\nresponse." + key.to_s() + " = '" + value.to_s().gsub("<", "&lt;") + "'"
+                      message += "\nresponse." + key.to_s() + " = '" + value.to_s().gsub("<", "&lt;") + "'"
+                    end
+                  end
+                else
+                  if @debug
+                    self.class.last_response += "\nresponse[:" + key.to_s() + "] = '" + value.to_s().gsub("<", "&lt;") + "'"
+                  end  
+                  message += "\nresponse[:" + key.to_s() + "] = '" + value.to_s().gsub("<", "&lt;") + "'"
+                end
+              elsif !@response.include?(key.to_sym)
+                if @debug
+                  self.class.last_response += "\nresponse['" + key.to_s() + "'] = '" + value.to_s().gsub("<", "&lt;") + "'"
+                end
+                message += "\nresponse['" + key.to_s() + "'] = '" + value.to_s().gsub("<", "&lt;") + "'"
+              end
+            end
+          }
+        #end
+        @logger.info message
+        if @response.kind_of?(Hash)
+          if @response.keys.include?(:requestid)
+            @headers["requestId"] = @response[:requestid]
+            self.class.request_id = @response[:requestid]
+            @logger.info "requestId was found on the response header and it has been added to the headers for the next request"
+          end
+        end
+      end
+
+      if resp[:'set-cookie'].to_s() != ""
+        if resp.kind_of?(Hash) #mock_response
+          cookies_to_set = resp[:'set-cookie'].to_s().split(", ")
+        else #Net::Http
+          cookies_to_set = resp.get_fields("set-cookie")
+        end
+        cookies_to_set.each { |cookie|
+          cookie_pair = cookie.split("; ")[0].split("=")
+          cookie_path = cookie.scan(/; path=([^;]+)/i).join
+          @cookies[cookie_path] = Hash.new() unless @cookies.keys.include?(cookie_path)
+          @cookies[cookie_path][cookie_pair[0]] = cookie_pair[1]
+        }
+
+        @logger.info "set-cookie added to Cookie header as required"
+
+        if @headers.has_key?("X-CSRFToken")
+          csrftoken = resp[:"set-cookie"].to_s().scan(/csrftoken=([\da-z]+);/).join
+          if csrftoken.to_s() != ""
+            @headers["X-CSRFToken"] = csrftoken
+            @logger.info "X-CSRFToken exists on headers and has been overwritten"
+          end
+        else
+          csrftoken = resp[:"set-cookie"].to_s().scan(/csrftoken=([\da-z]+);/).join
+          if csrftoken.to_s() != ""
+            @headers["X-CSRFToken"] = csrftoken
+            @logger.info "X-CSRFToken added to header as required"
+          end
+        end
+      end
+    rescue Exception => stack
+      @logger.fatal stack
+      @logger.fatal "manage_response Error on method #{method_s} "
+    end
+  end
 end

data/lib/nice_http/utils.rb

@@ -1,109 +1,109 @@
-module NiceHttpUtils
-  ##################################################
-  # get a value of xml tag
-  # input:
-  #   tag_name
-  #   xml_string
-  #   take_off_prefix: boolean (optional). true, false(default)
-  # output:
-  #   the value or an array of all values found with this tag_name
-  ####################################################
-  def self.get_value_xml_tag(tag_name, xml_string, take_off_prefix = false)
-    return nil if xml_string.nil?
-    xml_string2 = xml_string.dup()
-    if take_off_prefix
-      i = tag_name.index(":")
-      if !i.nil?
-        tag_name = tag_name[i + 1..tag_name.length]
-      end
-    end
-
-    ret = Array.new()
-    if xml_string2.to_s() != ""
-      if take_off_prefix
-        xml_string2.gsub!(/<[a-zA-Z0-9]+:#{tag_name} [^>]*>/i, "<" + tag_name + ">")
-        xml_string2.gsub!(/<\/[a-zA-Z0-9]+:#{tag_name}>/i, "</" + tag_name + ">")
-        xml_string2.gsub!(/<[a-zA-Z0-9]+:#{tag_name}>/i, "<" + tag_name + ">")
-      end
-
-      xml_string2.gsub!(/<#{tag_name} [^>]*>/i, "<" + tag_name + ">")
-
-      tag1 = "<" + tag_name + ">"
-      tag2 = "</" + tag_name + ">"
-
-      x = xml_string2.index(tag1)
-      if !x.nil?
-        x += tag1.size
-        begin
-          y = xml_string2.index(tag2)
-          if y.nil?
-            ret.push("")
-            x = nil
-          else
-            y -= 1
-            value = xml_string2[x..y]
-            ret.push(value)
-            xml_string2 = xml_string2[y + tag2.size..xml_string2.length]
-            x = xml_string2.index(tag1)
-            if !x.nil?
-              x += tag1.size
-            end
-          end
-        end while !x.nil?
-      else
-        ret.push("")
-      end
-    else
-      ret.push("")
-    end
-    if ret.size == 1
-      return ret[0].to_s()
-    else
-      return ret
-    end
-  end
-
-  ##################################################
-  # set a value on xml tag
-  # input:
-  #   tag_name
-  #   xml_string
-  #   value
-  #   take_off_prefix: boolean (optional). true, false(default)
-  # output:
-  #   xml_string with the new value
-  ####################################################
-  def self.set_value_xml_tag(tag_name, xml_string, value, take_off_prefix = false)
-    tag_name = tag_name.to_s
-    if take_off_prefix
-      i = tag_name.index(":")
-      tag_name = tag_name[i + 1..tag_name.length] unless i.nil?
-    end
-    if xml_string.to_s != ""
-      if take_off_prefix
-        old_value = NiceHttpUtils.get_value_xml_tag(tag_name, xml_string.dup, true)
-        xml_string.gsub!(/:#{tag_name}>#{Regexp.escape(old_value)}<\//i, ":" + tag_name + ">" + value + "</")
-        xml_string.gsub!(/<#{tag_name}>#{Regexp.escape(old_value)}<\//i, "<" + tag_name + ">" + value + "</")
-      else
-        xml_string.gsub!(/<#{tag_name}>.*<\/#{tag_name}>/i, "<" + tag_name + ">" + value + "</" + tag_name + ">")
-      end
-      return xml_string
-    else
-      return ""
-    end
-  end
-
-  ##################################################
-  # returns the seed for Basic authentication
-  # input:
-  #   user
-  #   password
-  # output:
-  #   seed string to be used on Authorization key header on a get request
-  ####################################################
-  def self.basic_authentication(user:, password:)
-    require "base64"
-    seed = "Basic " + Base64.encode64(user + ":" + password)
-    return seed
-  end
-end
+module NiceHttpUtils
+  ##################################################
+  # get a value of xml tag
+  # input:
+  #   tag_name
+  #   xml_string
+  #   take_off_prefix: boolean (optional). true, false(default)
+  # output:
+  #   the value or an array of all values found with this tag_name
+  ####################################################
+  def self.get_value_xml_tag(tag_name, xml_string, take_off_prefix = false)
+    return nil if xml_string.nil?
+    xml_string2 = xml_string.dup()
+    if take_off_prefix
+      i = tag_name.index(":")
+      if !i.nil?
+        tag_name = tag_name[i + 1..tag_name.length]
+      end
+    end
+
+    ret = Array.new()
+    if xml_string2.to_s() != ""
+      if take_off_prefix
+        xml_string2.gsub!(/<[a-zA-Z0-9]+:#{tag_name} [^>]*>/i, "<" + tag_name + ">")
+        xml_string2.gsub!(/<\/[a-zA-Z0-9]+:#{tag_name}>/i, "</" + tag_name + ">")
+        xml_string2.gsub!(/<[a-zA-Z0-9]+:#{tag_name}>/i, "<" + tag_name + ">")
+      end
+
+      xml_string2.gsub!(/<#{tag_name} [^>]*>/i, "<" + tag_name + ">")
+
+      tag1 = "<" + tag_name + ">"
+      tag2 = "</" + tag_name + ">"
+
+      x = xml_string2.index(tag1)
+      if !x.nil?
+        x += tag1.size
+        begin
+          y = xml_string2.index(tag2)
+          if y.nil?
+            ret.push("")
+            x = nil
+          else
+            y -= 1
+            value = xml_string2[x..y]
+            ret.push(value)
+            xml_string2 = xml_string2[y + tag2.size..xml_string2.length]
+            x = xml_string2.index(tag1)
+            if !x.nil?
+              x += tag1.size
+            end
+          end
+        end while !x.nil?
+      else
+        ret.push("")
+      end
+    else
+      ret.push("")
+    end
+    if ret.size == 1
+      return ret[0].to_s()
+    else
+      return ret
+    end
+  end
+
+  ##################################################
+  # set a value on xml tag
+  # input:
+  #   tag_name
+  #   xml_string
+  #   value
+  #   take_off_prefix: boolean (optional). true, false(default)
+  # output:
+  #   xml_string with the new value
+  ####################################################
+  def self.set_value_xml_tag(tag_name, xml_string, value, take_off_prefix = false)
+    tag_name = tag_name.to_s
+    if take_off_prefix
+      i = tag_name.index(":")
+      tag_name = tag_name[i + 1..tag_name.length] unless i.nil?
+    end
+    if xml_string.to_s != ""
+      if take_off_prefix
+        old_value = NiceHttpUtils.get_value_xml_tag(tag_name, xml_string.dup, true)
+        xml_string.gsub!(/:#{tag_name}>#{Regexp.escape(old_value)}<\//i, ":" + tag_name + ">" + value + "</")
+        xml_string.gsub!(/<#{tag_name}>#{Regexp.escape(old_value)}<\//i, "<" + tag_name + ">" + value + "</")
+      else
+        xml_string.gsub!(/<#{tag_name}>.*<\/#{tag_name}>/i, "<" + tag_name + ">" + value + "</" + tag_name + ">")
+      end
+      return xml_string
+    else
+      return ""
+    end
+  end
+
+  ##################################################
+  # returns the seed for Basic authentication
+  # input:
+  #   user
+  #   password
+  # output:
+  #   seed string to be used on Authorization key header on a get request
+  ####################################################
+  def self.basic_authentication(user:, password:)
+    require "base64"
+    seed = "Basic " + Base64.encode64(user + ":" + password)
+    return seed
+  end
+end