http 4.0.5 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94fd7f54004fd45a400c1e9befb46ea80d4bcdebae70929330355a5ea9056cf2
-  data.tar.gz: 3bbd9c1f0a29267bff2b6682ddaeaa53832eb896ec471d6ab3db62d5cbd08be2
+  metadata.gz: 2fd67432d99ac8430c405776f6483ddb0e05d323ea9e8c18a0760936ba3c2608
+  data.tar.gz: bfcd8f950d05342a5fe993a0b88d47cbdc6418fbeef4e13b67eefb482ece7b77
 SHA512:
-  metadata.gz: 5863fb462013166b6f76ff40929768f5a87ca86c02bd23c882bf5db1aefa6bed5be2a21785a45edecf66f6a6ac3418d86042b5c24f998e1f01489a661a1d9cae
-  data.tar.gz: 04726c6858928f553380fbb221cc1164cc51917ae2122cd9b7424ef3f1ff072c7b32ae2231cb32569a4411487f6c805acee54ec09e309e6eba4675a783df8306
+  metadata.gz: 74790c3405ba4cd9ebe667d7e4ae61ae895bd9a67c36be057fe8dba446b8020ec74b06c77fbe904bccebcf23b307aa3a1fd85fd6ea48248abf2869069f5e109b
+  data.tar.gz: ce21f7ca1026c690eae83f18a688bab7d5a1da6344af13865819f5da911a4ff79a0b2424a9f22a6ac605273bb825dd848171c0f555d5d4130bd7b8e137532eea

data/CHANGES.md

@@ -1,3 +1,10 @@
+## 4.1.0 (2019-03-11)
+
+* [#533](https://github.com/httprb/http/pull/533)
+  Add URI normalizer feature that allows to swap default URI normalizer.
+  ([@mamoonraja])
+
+
 ## 4.0.5 (2019-02-15)
 
 * Backport [#532](https://github.com/httprb/http/pull/532) from master.
@@ -758,3 +765,4 @@ end
 [@tycoon]: https://github.com/tycooon
 [@paul]: https://github.com/paul
 [@RickCSong]: https://github.com/RickCSong
+[@mamoonraja]: https://github.com/mamoonraja

data/lib/http/client.rb

@@ -42,14 +42,14 @@ module HTTP
       uri     = make_request_uri(uri, opts)
       headers = make_request_headers(opts)
       body    = make_request_body(opts, headers)
-      proxy   = opts.proxy
 
       req = HTTP::Request.new(
-        :verb         => verb,
-        :uri          => uri,
-        :headers      => headers,
-        :proxy        => proxy,
-        :body         => body
+        :verb           => verb,
+        :uri            => uri,
+        :uri_normalizer => opts.feature(:normalize_uri)&.normalizer,
+        :proxy          => opts.proxy,
+        :headers        => headers,
+        :body           => body
       )
 
       opts.features.inject(req) do |request, (_name, feature)|

data/lib/http/feature.rb

@@ -20,3 +20,4 @@ require "http/features/auto_inflate"
 require "http/features/auto_deflate"
 require "http/features/logging"
 require "http/features/instrumentation"
+require "http/features/normalize_uri"

data/lib/http/features/auto_deflate.rb

@@ -32,7 +32,8 @@ module HTTP
           :uri => request.uri,
           :headers => request.headers,
           :proxy => request.proxy,
-          :body => deflated_body(request.body)
+          :body => deflated_body(request.body),
+          :uri_normalizer => request.uri_normalizer
         )
       end
 

data/lib/http/features/normalize_uri.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "http/uri"
+
+module HTTP
+  module Features
+    class NormalizeUri < Feature
+      attr_reader :normalizer
+
+      def initialize(normalizer: HTTP::URI::NORMALIZER)
+        @normalizer = normalizer
+      end
+
+      HTTP::Options.register_feature(:normalize_uri, self)
+    end
+  end
+end

data/lib/http/request.rb

@@ -66,6 +66,8 @@ module HTTP
     # Scheme is normalized to be a lowercase symbol e.g. :http, :https
     attr_reader :scheme
 
+    attr_reader :uri_normalizer
+
     # "Request URI" as per RFC 2616
     # http://www.w3.org/Protocols/rfc2616/rfc2616-sec5.html
     attr_reader :uri
@@ -73,25 +75,25 @@ module HTTP
 
     # @option opts [String] :version
     # @option opts [#to_s] :verb HTTP request method
+    # @option opts [#call] :uri_normalizer (HTTP::URI::NORMALIZER)
     # @option opts [HTTP::URI, #to_s] :uri
     # @option opts [Hash] :headers
     # @option opts [Hash] :proxy
     # @option opts [String, Enumerable, IO, nil] :body
     def initialize(opts)
-      @verb   = opts.fetch(:verb).to_s.downcase.to_sym
-      @uri    = normalize_uri(opts.fetch(:uri))
+      @verb           = opts.fetch(:verb).to_s.downcase.to_sym
+      @uri_normalizer = opts[:uri_normalizer] || HTTP::URI::NORMALIZER
+
+      @uri    = @uri_normalizer.call(opts.fetch(:uri))
       @scheme = @uri.scheme.to_s.downcase.to_sym if @uri.scheme
 
       raise(UnsupportedMethodError, "unknown method: #{verb}") unless METHODS.include?(@verb)
       raise(UnsupportedSchemeError, "unknown scheme: #{scheme}") unless SCHEMES.include?(@scheme)
 
       @proxy   = opts[:proxy] || {}
-      @body    = (body = opts[:body]).is_a?(Request::Body) ? body : Request::Body.new(body)
       @version = opts[:version] || "1.1"
-      @headers = HTTP::Headers.coerce(opts[:headers] || {})
-
-      @headers[Headers::HOST]        ||= default_host_header_value
-      @headers[Headers::USER_AGENT]  ||= USER_AGENT
+      @headers = prepare_headers(opts[:headers])
+      @body    = prepare_body(opts[:body])
     end
 
     # Returns new Request with updated uri
@@ -100,12 +102,13 @@ module HTTP
       headers.delete(Headers::HOST)
 
       self.class.new(
-        :verb         => verb,
-        :uri          => @uri.join(uri),
-        :headers      => headers,
-        :proxy        => proxy,
-        :body         => body.source,
-        :version      => version
+        :verb           => verb,
+        :uri            => @uri.join(uri),
+        :headers        => headers,
+        :proxy          => proxy,
+        :body           => body.source,
+        :version        => version,
+        :uri_normalizer => uri_normalizer
       )
     end
 
@@ -213,17 +216,17 @@ module HTTP
       PORTS[@scheme] != port ? "#{host}:#{port}" : host
     end
 
-    # @return [HTTP::URI] URI with all componentes but query being normalized.
-    def normalize_uri(uri)
-      uri = HTTP::URI.parse uri
+    def prepare_body(body)
+      body.is_a?(Request::Body) ? body : Request::Body.new(body)
+    end
 
-      HTTP::URI.new(
-        :scheme     => uri.normalized_scheme,
-        :authority  => uri.normalized_authority,
-        :path       => uri.normalized_path,
-        :query      => uri.query,
-        :fragment   => uri.normalized_fragment
-      )
+    def prepare_headers(headers)
+      headers = HTTP::Headers.coerce(headers || {})
+
+      headers[Headers::HOST]        ||= default_host_header_value
+      headers[Headers::USER_AGENT]  ||= USER_AGENT
+
+      headers
     end
   end
 end

data/lib/http/uri.rb

@@ -26,6 +26,19 @@ module HTTP
     # @private
     HTTPS_SCHEME = "https"
 
+    # @private
+    NORMALIZER = lambda do |uri|
+      uri = HTTP::URI.parse uri
+
+      HTTP::URI.new(
+        :scheme     => uri.normalized_scheme,
+        :authority  => uri.normalized_authority,
+        :path       => uri.normalized_path,
+        :query      => uri.query,
+        :fragment   => uri.normalized_fragment
+      )
+    end
+
     # Parse the given URI string, returning an HTTP::URI object
     #
     # @param [HTTP::URI, String, #to_str] uri to parse

data/lib/http/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HTTP
-  VERSION = "4.0.5"
+  VERSION = "4.1.0"
 end

data/spec/lib/http_spec.rb

@@ -430,6 +430,26 @@ RSpec.describe HTTP do
         expect(response.to_s).to eq("#{body}-deflated")
       end
     end
+
+    context "with :normalize_uri" do
+      it "normalizes URI" do
+        response = HTTP.get "#{dummy.endpoint}/hello world"
+        expect(response.to_s).to eq("hello world")
+      end
+
+      it "uses the custom URI Normalizer method" do
+        client = HTTP.use(:normalize_uri => {:normalizer => :itself.to_proc})
+        response = client.get("#{dummy.endpoint}/hello world")
+        expect(response.status).to eq(400)
+      end
+
+      it "uses the default URI normalizer" do
+        client = HTTP.use :normalize_uri
+        expect(HTTP::URI::NORMALIZER).to receive(:call).and_call_original
+        response = client.get("#{dummy.endpoint}/hello world")
+        expect(response.to_s).to eq("hello world")
+      end
+    end
   end
 
   it "unifies socket errors into HTTP::ConnectionError" do

data/spec/support/dummy_server/servlet.rb

@@ -148,6 +148,11 @@ class DummyServer < WEBrick::HTTPServer
       res.body   = req.body
     end
 
+    get "/hello world" do |_req, res|
+      res.status = 200
+      res.body   = "hello world"
+    end
+
     post "/encoded-body" do |req, res|
       res.status = 200
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: http
 version: !ruby/object:Gem::Version
-  version: 4.0.5
+  version: 4.1.0
 platform: ruby
 authors:
 - Tony Arcieri
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-15 00:00:00.000000000 Z
+date: 2019-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http_parser.rb
@@ -116,6 +116,7 @@ files:
 - lib/http/features/auto_inflate.rb
 - lib/http/features/instrumentation.rb
 - lib/http/features/logging.rb
+- lib/http/features/normalize_uri.rb
 - lib/http/headers.rb
 - lib/http/headers/known.rb
 - lib/http/headers/mixin.rb
@@ -197,7 +198,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: HTTP should be easy