nethttputils 0.4.1.2 → 0.4.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a982e237dae69aa1f18645e6e63d231bb22d5e3
-  data.tar.gz: 71f6c6e79050d656e9bb8c290caa11e013acf386
+  metadata.gz: 8a3bdaaec8992d13db534ec38ce63c28f303bc52
+  data.tar.gz: 70adf066cd7c2d63247da3955057b9872a3d1a4f
 SHA512:
-  metadata.gz: e14f163d07b052595d502d07a3d104bcee3c6fbefc6169495f778e589dc80562817912f7fec3183741fa56379a7c6d6bd9fbd0ab3b8b05cb1bae9b2b671eacc5
-  data.tar.gz: 6d8df37fb3fedc5ca757fe8345338421a55ff15283ad5f2456a4a1559de9bc6fe98551aabc56549fc27006a014e1d1702295f1bc19f8984d5eed1b7d82324579
+  metadata.gz: adbfb02313e49c395e8f44b25d2f5f7cbfaa749220d61d855e1e29f5b3c656797347a802acbda55b40afcceb05ffa65b77ae90339f59ac12f55a9a2b88737f23
+  data.tar.gz: 37f2b5b2ea2db8620558444a21eaeeac9b15d4dcaba06d3007e7b112db84d91869a0238560c3c834f725386b64a17a377e2e4bbe081002ae7b5861b3ef93ec24

data/lib/nethttputils.rb

@@ -1,9 +1,9 @@
 require "net/http"
+require "cgi"
 require "openssl"
 
 require "logger"
 
-
 module NetHTTPUtils
   class << self
     attr_accessor :logger
@@ -16,8 +16,10 @@ module NetHTTPUtils
 
   class Error < RuntimeError
     attr_reader :code
+    attr_reader :body
     def initialize body, code = nil
       @code = code
+      @body = body
       body = body[0...997] + "..." if body.size > 1000
       super "HTTP error ##{code.inspect} #{body}"
     end
@@ -40,7 +42,7 @@ module NetHTTPUtils
         URI url
         url
       rescue URI::InvalidURIError
-        URI.escape url
+        CGI.escape url
       end unless url.is_a? URI::HTTP
       delay = 5
       begin
@@ -101,15 +103,17 @@ module NetHTTPUtils
     end
 
     private
-    def read http, mtd = :GET, type = :form, form: {}, header: {}, auth: nil, timeout: nil, no_redirect: false, max_read_retry_delay: 3600, patch_request: nil, &block
+    def read http, mtd = :GET, type = :form, form: {}, header: {}, auth: nil, force_post: false, timeout: nil, no_redirect: false, max_read_retry_delay: 3600, patch_request: nil, &block
       timeout ||= 30
-          logger = NetHTTPUtils.logger
+      logger = NetHTTPUtils.logger
+      logger.info [mtd, http].inspect
 
           uri = http.instance_variable_get :@uri
-          logger.debug "Warning: query params included in `url` argument are discarded because `:form` isn't empty" if uri.query && !form.empty?
+      if %i{ HEAD GET }.include?(mtd = mtd.upcase) && !form.empty?  # not .upcase! because it's not defined for Symbol
+        logger.debug "Warning: query params included in `url` argument are discarded because `:form` isn't empty" if uri.query
           # we can't just merge because URI fails to parse such queries as "/?1"
-
-          uri.query = URI.encode_www_form form if %i{ HEAD GET }.include?(mtd = mtd.upcase) && !form.empty?
+        uri.query = URI.encode_www_form form
+      end
           cookies = {}
           prepare_request = lambda do |uri|
             case mtd.upcase
@@ -233,6 +237,7 @@ module NetHTTPUtils
               response.add_field "Set-Cookie", "#{k}=#{v}"
             end
 
+            logger.info "response.code = #{response.code}"
             case response.code
             when /\A20/
               response
@@ -250,8 +255,8 @@ module NetHTTPUtils
                 # http.finish   # why commented out?
                 http = NetHTTPUtils.start_http new_uri, http.instance_variable_get(:@max_start_http_retry_delay), timeout, no_redirect
               end
-              if request.method == "POST"
-                logger.info "POST redirects to GET (RFC)"
+              if !force_post && request.method == "POST"
+                logger.info "POST redirects to GET (RFC)"   # TODO: do it only on code 307; note that some servers still do 302
                 mtd = :GET
               end
               do_request.call prepare_request[new_uri]
@@ -285,8 +290,9 @@ module NetHTTPUtils
               }"
               response
             else
-              logger.warn "code #{response.code} at #{request.method} #{request.uri} from #{
-                [__FILE__, caller.map{ |i| i[/(?<=:)\d+/] }].join ?:
+              logger.warn "code #{response.code} from #{request.method} #{request.uri} at #{
+                caller_path, caller_locs = caller_locations.chunk(&:path).first
+                [caller_path, caller_locs.map(&:lineno).chunk(&:itself).map(&:first)].join ":"
               }"
               logger.debug "< body: #{
                 response.body.tap do |body|
@@ -304,10 +310,8 @@ module NetHTTPUtils
 
     require "set"
     @@_405 ||= Set.new
-    def request_data http, mtd = :GET, type = :form, form: {}, header: {}, auth: nil, proxy: nil,
-        timeout: nil, no_redirect: no_redirect,
-        max_start_http_retry_delay: 3600,
-        max_read_retry_delay: 3600,
+    def request_data http, mtd = :GET, type = :form, form: {}, header: {}, auth: nil, proxy: nil, force_post: false, no_redirect: false, head: false,
+        timeout: nil, max_start_http_retry_delay: 3600, max_read_retry_delay: 3600,
         patch_request: nil, &block
       timeout ||= 30
       http = start_http http, max_start_http_retry_delay, timeout, no_redirect, *proxy unless http.is_a? Net::HTTP
@@ -327,7 +331,7 @@ module NetHTTPUtils
             )
         end
       end
-      if mtd == :GET && !@@_405.include?(http.address)
+      if head && mtd == :GET && !@@_405.include?(http.address)
         body = begin
           request_data http, :HEAD, form: form, header: header, auth: auth,
             max_start_http_retry_delay: max_start_http_retry_delay,
@@ -341,7 +345,7 @@ module NetHTTPUtils
           check_code.call body
         end
       end
-      body = read http, mtd, type, form: form, header: header, auth: auth,
+      body = read http, mtd, type, form: form, header: header, auth: auth, force_post: force_post,
         timeout: timeout, no_redirect: no_redirect,
         max_read_retry_delay: max_read_retry_delay,
         patch_request: patch_request, &block
@@ -352,7 +356,6 @@ module NetHTTPUtils
         Zlib::GzipReader.new(StringIO.new(body)).read
       else
         body
-      end.tap do |string|
       end
     # ensure
     #   response.instance_variable_get("@nethttputils_close").call if response
@@ -416,6 +419,7 @@ if $0 == __FILE__
   server.shutdown
   t.join
 
+  # HEAD should raise on 404 but not in two other cases
   [
     [WEBrick::HTTPStatus::NotFound, 404],
     [WEBrick::HTTPStatus::BadRequest],
@@ -427,7 +431,7 @@ if $0 == __FILE__
     end
     t = Thread.new{ server.start }
     begin
-      NetHTTPUtils.request_data "http://localhost:8000/"
+      NetHTTPUtils.request_data "http://localhost:8000/", head: true
       NetHTTPUtils.class_variable_get(:@@_405).clear
       fail if should_raise
     rescue NetHTTPUtils::Error => e
@@ -452,7 +456,7 @@ if $0 == __FILE__
   NetHTTPUtils.request_data("http://localhost:8000/", :head)
   fail stack.inspect unless stack == %w{ HEAD }
   stack.clear
-  NetHTTPUtils.request_data("http://localhost:8000/")
+  NetHTTPUtils.request_data("http://localhost:8000/", head: true)
   fail stack.inspect unless stack == %w{ HEAD GET }
   server.shutdown
   t.join
@@ -519,7 +523,7 @@ if $0 == __FILE__
     http://www.aeronautica.difesa.it/organizzazione/REPARTI/divolo/PublishingImages/6%C2%B0%20Stormo/2013-decollo%20al%20tramonto%20REX%201280.jpg
   }.each do |url|
     begin
-      NetHTTPUtils.request_data url, timeout: 5, max_read_retry_delay: -1
+      NetHTTPUtils.request_data url, timeout: 5, max_read_retry_delay: -1, head: true
       fail
     rescue Net::ReadTimeout
     end

data/nethttputils.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name         = "nethttputils"
-  spec.version      = "0.4.1.2"
+  spec.version      = "0.4.3.2"
   spec.summary      = "this tool is like a pet that I adopted young and now I depend on, sorry"
   spec.description = <<-EOF
     Back in 2015 I was a guy automating things at my job and two scripts had a common need --

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nethttputils
 version: !ruby/object:Gem::Version
-  version: 0.4.1.2
+  version: 0.4.3.2
 platform: ruby
 authors:
 - Victor Maslov aka Nakilon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-28 00:00:00.000000000 Z
+date: 2022-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable