wreq 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55fb3870a295fb5c880d3114c560170df733c64738bf07fae26bcbe7055a3d0e
-  data.tar.gz: d40e5a5942c85fbfb80c3a6dc76ee1bdc4da80a2286f38d217bdf2fe18e7e924
+  metadata.gz: 15ad9f6cc6c41b23c065d2118942ce008260dd0b0ec0124e03d5d72379ed9dda
+  data.tar.gz: ef0c61872bffe6dc3e3e7e820d1d774f944d129a5e486e1c8fe50c53d06b4c5d
 SHA512:
-  metadata.gz: 7eef95347359cbfbf15654d89425eee6ca329f3603d2c5467368f3f90118c7195b201fe2380026354901998a7bb73befccff227e5f71040d513b0953e09410ee
-  data.tar.gz: d8b5c0a8416a36ef9f43721f824fb8f7201c8b31e709b2fd42c5b1ef61f5da8031fc529725013832efd4a1101f86d6e503c4e67e1d9f84c790d35897e2090fac
+  metadata.gz: a2c870dd5fedc1dfd0c72de4b1567b63f9a44ce361a7f6e47a57bfe751ddf1c083a4828542f778236ce1bc2bc529e7b85df19ef33c742580a695df33ac114cd2
+  data.tar.gz: b2616fcfc85af1ac603ea330ca6f2c697aa81049d36471df4619327ad0d549af974078f14d4d3f76aee0e581ac8f8fed6d711778d64c8b82fad8c038cec3f14b

data/Cargo.lock

@@ -1559,7 +1559,7 @@ dependencies = [
 
 [[package]]
 name = "wreq-ruby"
-version = "1.2.0"
+version = "1.2.1"
 dependencies = [
  "arc-swap",
  "bytes",

data/Cargo.toml

@@ -6,7 +6,7 @@ homepage = "https://github.com/SearchApi/wreq-ruby"
 repository = "https://github.com/SearchApi/wreq-ruby"
 edition = "2024"
 rust-version = "1.85"
-version = "1.2.0"
+version = "1.2.1"
 
 [lib]
 crate-type = ["cdylib"]
@@ -38,7 +38,7 @@ indexmap = { version = "2.14.0", features = ["serde"] }
 cookie = "0.18.1"
 bytes = "1.11.1"
 arc-swap = "1.9.1"
-http = "1.4.0"
+http = "1.4.1"
 http-body-util = "0.1.3"
 futures-util = { version = "0.3.32", default-features = false }
 

data/lib/wreq.rb

@@ -25,7 +25,7 @@ unless defined?(Wreq)
     # @param method [Wreq::Method] HTTP method to use
     # @param url [String] Target URL
     # @param headers [Wreq::Headers, Hash{String=>String}, nil] Custom headers for this request
-    # @param orig_headers [Hash{String=>String}, nil] Original headers (raw, unmodified)
+    # @param orig_headers [Array<String>, nil] Original header names used to preserve raw header order and HTTP/1 case-sensitive header handling
     # @param default_headers [Hash{String=>String}, nil] Default headers to merge
     # @param query [Hash, nil] URL query parameters
     # @param auth [String, nil] Authorization header value
@@ -56,7 +56,7 @@ unless defined?(Wreq)
     #
     # @param url [String] Target URL
     # @param headers [Wreq::Headers, Hash{String=>String}, nil] Custom headers for this request
-    # @param orig_headers [Hash{String=>String}, nil] Original headers (raw, unmodified)
+    # @param orig_headers [Array<String>, nil] Original header names used to preserve raw header order and HTTP/1 case-sensitive header handling
     # @param default_headers [Hash{String=>String}, nil] Default headers to merge
     # @param query [Hash, nil] URL query parameters
     # @param auth [String, nil] Authorization header value
@@ -87,7 +87,7 @@ unless defined?(Wreq)
     #
     # @param url [String] Target URL
     # @param headers [Wreq::Headers, Hash{String=>String}, nil] Custom headers for this request
-    # @param orig_headers [Hash{String=>String}, nil] Original headers (raw, unmodified)
+    # @param orig_headers [Array<String>, nil] Original header names used to preserve raw header order and HTTP/1 case-sensitive header handling
     # @param default_headers [Hash{String=>String}, nil] Default headers to merge
     # @param query [Hash, nil] URL query parameters
     # @param auth [String, nil] Authorization header value
@@ -118,7 +118,7 @@ unless defined?(Wreq)
     #
     # @param url [String] Target URL
     # @param headers [Wreq::Headers, Hash{String=>String}, nil] Custom headers for this request
-    # @param orig_headers [Hash{String=>String}, nil] Original headers (raw, unmodified)
+    # @param orig_headers [Array<String>, nil] Original header names used to preserve raw header order and HTTP/1 case-sensitive header handling
     # @param default_headers [Hash{String=>String}, nil] Default headers to merge
     # @param query [Hash, nil] URL query parameters
     # @param auth [String, nil] Authorization header value
@@ -149,7 +149,7 @@ unless defined?(Wreq)
     #
     # @param url [String] Target URL
     # @param headers [Wreq::Headers, Hash{String=>String}, nil] Custom headers for this request
-    # @param orig_headers [Hash{String=>String}, nil] Original headers (raw, unmodified)
+    # @param orig_headers [Array<String>, nil] Original header names used to preserve raw header order and HTTP/1 case-sensitive header handling
     # @param default_headers [Hash{String=>String}, nil] Default headers to merge
     # @param query [Hash, nil] URL query parameters
     # @param auth [String, nil] Authorization header value
@@ -180,7 +180,7 @@ unless defined?(Wreq)
     #
     # @param url [String] Target URL
     # @param headers [Wreq::Headers, Hash{String=>String}, nil] Custom headers for this request
-    # @param orig_headers [Hash{String=>String}, nil] Original headers (raw, unmodified)
+    # @param orig_headers [Array<String>, nil] Original header names used to preserve raw header order and HTTP/1 case-sensitive header handling
     # @param default_headers [Hash{String=>String}, nil] Default headers to merge
     # @param query [Hash, nil] URL query parameters
     # @param auth [String, nil] Authorization header value
@@ -211,7 +211,7 @@ unless defined?(Wreq)
     #
     # @param url [String] Target URL
     # @param headers [Wreq::Headers, Hash{String=>String}, nil] Custom headers for this request
-    # @param orig_headers [Hash{String=>String}, nil] Original headers (raw, unmodified)
+    # @param orig_headers [Array<String>, nil] Original header names used to preserve raw header order and HTTP/1 case-sensitive header handling
     # @param default_headers [Hash{String=>String}, nil] Default headers to merge
     # @param query [Hash, nil] URL query parameters
     # @param auth [String, nil] Authorization header value
@@ -242,7 +242,7 @@ unless defined?(Wreq)
     #
     # @param url [String] Target URL
     # @param headers [Wreq::Headers, Hash{String=>String}, nil] Custom headers for this request
-    # @param orig_headers [Hash{String=>String}, nil] Original headers (raw, unmodified)
+    # @param orig_headers [Array<String>, nil] Original header names used to preserve raw header order and HTTP/1 case-sensitive header handling
     # @param default_headers [Hash{String=>String}, nil] Default headers to merge
     # @param query [Hash, nil] URL query parameters
     # @param auth [String, nil] Authorization header value
@@ -273,7 +273,7 @@ unless defined?(Wreq)
     #
     # @param url [String] Target URL
     # @param headers [Wreq::Headers, Hash{String=>String}, nil] Custom headers for this request
-    # @param orig_headers [Hash{String=>String}, nil] Original headers (raw, unmodified)
+    # @param orig_headers [Array<String>, nil] Original header names used to preserve raw header order and HTTP/1 case-sensitive header handling
     # @param default_headers [Hash{String=>String}, nil] Default headers to merge
     # @param query [Hash, nil] URL query parameters
     # @param auth [String, nil] Authorization header value

data/lib/wreq_ruby/client.rb

@@ -38,6 +38,8 @@ unless defined?(Wreq)
       # @param headers [Wreq::Headers, Hash{String=>String}, nil] Default headers to include
       #   in every request. Header names are case-insensitive. These headers
       #   can be overridden on a per-request basis.
+      # @param orig_headers [Array<String>, nil] Original header names used to
+      #   preserve raw header order and HTTP/1 case-sensitive header handling.
       #
       # @param referer [Boolean, nil] Whether to automatically send Referer
       #   headers when following redirects. When true, the previous URL will
@@ -237,7 +239,7 @@ unless defined?(Wreq)
       # @param method [Wreq::Method] HTTP method to use
       # @param url [String] Target URL
       # @param headers [Wreq::Headers, Hash{String=>String}, nil] Custom headers for this request
-      # @param orig_headers [Hash{String=>String}, nil] Original headers (raw, unmodified)
+      # @param orig_headers [Array<String>, nil] Original header names used to preserve raw header order and HTTP/1 case-sensitive header handling
       # @param default_headers [Hash{String=>String}, nil] Default headers to merge
       # @param query [Hash, nil] URL query parameters
       # @param auth [String, nil] Authorization header value
@@ -268,7 +270,7 @@ unless defined?(Wreq)
       #
       # @param url [String] Target URL
       # @param headers [Wreq::Headers, Hash{String=>String}, nil] Custom headers for this request
-      # @param orig_headers [Hash{String=>String}, nil] Original headers (raw, unmodified)
+      # @param orig_headers [Array<String>, nil] Original header names used to preserve raw header order and HTTP/1 case-sensitive header handling
       # @param default_headers [Hash{String=>String}, nil] Default headers to merge
       # @param query [Hash, nil] URL query parameters
       # @param auth [String, nil] Authorization header value
@@ -299,7 +301,7 @@ unless defined?(Wreq)
       #
       # @param url [String] Target URL
       # @param headers [Wreq::Headers, Hash{String=>String}, nil] Custom headers for this request
-      # @param orig_headers [Hash{String=>String}, nil] Original headers (raw, unmodified)
+      # @param orig_headers [Array<String>, nil] Original header names used to preserve raw header order and HTTP/1 case-sensitive header handling
       # @param default_headers [Hash{String=>String}, nil] Default headers to merge
       # @param query [Hash, nil] URL query parameters
       # @param auth [String, nil] Authorization header value
@@ -330,7 +332,7 @@ unless defined?(Wreq)
       #
       # @param url [String] Target URL
       # @param headers [Wreq::Headers, Hash{String=>String}, nil] Custom headers for this request
-      # @param orig_headers [Hash{String=>String}, nil] Original headers (raw, unmodified)
+      # @param orig_headers [Array<String>, nil] Original header names used to preserve raw header order and HTTP/1 case-sensitive header handling
       # @param default_headers [Hash{String=>String}, nil] Default headers to merge
       # @param query [Hash, nil] URL query parameters
       # @param auth [String, nil] Authorization header value
@@ -361,7 +363,7 @@ unless defined?(Wreq)
       #
       # @param url [String] Target URL
       # @param headers [Wreq::Headers, Hash{String=>String}, nil] Custom headers for this request
-      # @param orig_headers [Hash{String=>String}, nil] Original headers (raw, unmodified)
+      # @param orig_headers [Array<String>, nil] Original header names used to preserve raw header order and HTTP/1 case-sensitive header handling
       # @param default_headers [Hash{String=>String}, nil] Default headers to merge
       # @param query [Hash, nil] URL query parameters
       # @param auth [String, nil] Authorization header value
@@ -392,7 +394,7 @@ unless defined?(Wreq)
       #
       # @param url [String] Target URL
       # @param headers [Wreq::Headers, Hash{String=>String}, nil] Custom headers for this request
-      # @param orig_headers [Hash{String=>String}, nil] Original headers (raw, unmodified)
+      # @param orig_headers [Array<String>, nil] Original header names used to preserve raw header order and HTTP/1 case-sensitive header handling
       # @param default_headers [Hash{String=>String}, nil] Default headers to merge
       # @param query [Hash, nil] URL query parameters
       # @param auth [String, nil] Authorization header value
@@ -423,7 +425,7 @@ unless defined?(Wreq)
       #
       # @param url [String] Target URL
       # @param headers [Wreq::Headers, Hash{String=>String}, nil] Custom headers for this request
-      # @param orig_headers [Hash{String=>String}, nil] Original headers (raw, unmodified)
+      # @param orig_headers [Array<String>, nil] Original header names used to preserve raw header order and HTTP/1 case-sensitive header handling
       # @param default_headers [Hash{String=>String}, nil] Default headers to merge
       # @param query [Hash, nil] URL query parameters
       # @param auth [String, nil] Authorization header value
@@ -454,7 +456,7 @@ unless defined?(Wreq)
       #
       # @param url [String] Target URL
       # @param headers [Wreq::Headers, Hash{String=>String}, nil] Custom headers for this request
-      # @param orig_headers [Hash{String=>String}, nil] Original headers (raw, unmodified)
+      # @param orig_headers [Array<String>, nil] Original header names used to preserve raw header order and HTTP/1 case-sensitive header handling
       # @param default_headers [Hash{String=>String}, nil] Default headers to merge
       # @param query [Hash, nil] URL query parameters
       # @param auth [String, nil] Authorization header value
@@ -485,7 +487,7 @@ unless defined?(Wreq)
       #
       # @param url [String] Target URL
       # @param headers [Wreq::Headers, Hash{String=>String}, nil] Custom headers for this request
-      # @param orig_headers [Hash{String=>String}, nil] Original headers (raw, unmodified)
+      # @param orig_headers [Array<String>, nil] Original header names used to preserve raw header order and HTTP/1 case-sensitive header handling
       # @param default_headers [Hash{String=>String}, nil] Default headers to merge
       # @param query [Hash, nil] URL query parameters
       # @param auth [String, nil] Authorization header value

data/lib/wreq_ruby/http.rb

@@ -49,6 +49,20 @@ module Wreq
       def to_s
       end
     end
+
+    # Compares HTTP versions by semantic value, not object identity.
+    #
+    # This method is implemented by the native extension.
+    # When comparing with non-{Wreq::Version} objects, it returns false.
+    #
+    # @param other [Object] object to compare against
+    # @return [Boolean] true when both represent the same HTTP version
+    # @example
+    #   Wreq::Version::HTTP_11 == response.version
+    unless method_defined?(:==)
+      def ==(other)
+      end
+    end
   end
 
   # HTTP status code wrapper.

data/src/client/req.rs

@@ -3,7 +3,7 @@ use std::{net::IpAddr, time::Duration};
 use http::header;
 use magnus::{RHash, TryConvert, typed_data::Obj, value::ReprValue};
 use serde::Deserialize;
-use wreq::{Client, Proxy, Version, header::OrigHeaderMap};
+use wreq::{Client, Proxy};
 
 use super::body::{Body, Form, Json};
 use crate::{
@@ -12,8 +12,8 @@ use crate::{
     emulate::Emulation,
     error::wreq_error_to_magnus,
     extractor::Extractor,
-    header::Headers,
-    http::Method,
+    header::{Headers, OrigHeaders},
+    http::{Method, Version},
     rt,
 };
 
@@ -54,7 +54,7 @@ pub struct Request {
 
     /// The original headers to use for the request.
     #[serde(skip)]
-    orig_headers: Option<OrigHeaderMap>,
+    orig_headers: Option<OrigHeaders>,
 
     /// The cookies to use for the request.
     #[serde(skip)]
@@ -112,10 +112,18 @@ impl Request {
             builder.emulation = Some((*obj).clone());
         }
 
+        if let Some(v) = hash.get(ruby.to_symbol(stringify!(version))) {
+            builder.version = Some(Version::try_convert(v)?);
+        }
+
         if let Some(v) = hash.get(ruby.to_symbol(stringify!(headers))) {
             builder.headers = Some(Headers::try_convert(v)?);
         }
 
+        if let Some(v) = hash.get(ruby.to_symbol(stringify!(orig_headers))) {
+            builder.orig_headers = Some(OrigHeaders::try_convert(v)?);
+        }
+
         if let Some(v) = hash.get(ruby.to_symbol(stringify!(cookies))) {
             builder.cookies = Some(Cookies::try_convert(v)?);
         }
@@ -125,8 +133,6 @@ impl Request {
         }
 
         builder.proxy = Extractor::<Proxy>::try_convert(keyword)?.into_inner();
-        builder.version = Extractor::<Version>::try_convert(keyword)?.into_inner();
-        builder.orig_headers = Extractor::<OrigHeaderMap>::try_convert(keyword)?.into_inner();
 
         Ok(builder)
     }
@@ -145,7 +151,13 @@ pub fn execute_request<U: AsRef<str>>(
         apply_option!(set_if_some_inner, builder, request.emulation, emulation);
 
         // Version options.
-        apply_option!(set_if_some, builder, request.version, version);
+        apply_option!(
+            set_if_some_map,
+            builder,
+            request.version,
+            version,
+            Version::into_ffi
+        );
 
         // Timeout options.
         apply_option!(
@@ -170,7 +182,12 @@ pub fn execute_request<U: AsRef<str>>(
 
         // Headers options.
         apply_option!(set_if_some_into_inner, builder, request.headers, headers);
-        apply_option!(set_if_some, builder, request.orig_headers, orig_headers);
+        apply_option!(
+            set_if_some_inner,
+            builder,
+            request.orig_headers,
+            orig_headers
+        );
         apply_option!(
             set_if_some,
             builder,

data/src/client.rs

@@ -10,10 +10,7 @@ use magnus::{
     Module, Object, RHash, RModule, Ruby, TryConvert, Value, function, method, typed_data::Obj,
 };
 use serde::Deserialize;
-use wreq::{
-    Proxy,
-    header::{HeaderValue, OrigHeaderMap},
-};
+use wreq::{Proxy, header::HeaderValue};
 
 use crate::{
     client::{req::execute_request, resp::Response},
@@ -22,7 +19,7 @@ use crate::{
     error::wreq_error_to_magnus,
     extractor::Extractor,
     gvl,
-    header::Headers,
+    header::{Headers, OrigHeaders},
     http::Method,
 };
 
@@ -40,7 +37,7 @@ struct Builder {
     headers: Option<Headers>,
     /// The original headers to use for the client.
     #[serde(skip)]
-    orig_headers: Option<OrigHeaderMap>,
+    orig_headers: Option<OrigHeaders>,
     /// Whether to use referer.
     referer: Option<bool>,
     /// Whether to allow redirects.
@@ -143,6 +140,10 @@ impl Builder {
             builder.headers = Some(Headers::try_convert(v)?);
         }
 
+        if let Some(v) = hash.get(ruby.to_symbol(stringify!(orig_headers))) {
+            builder.orig_headers = Some(OrigHeaders::try_convert(v)?);
+        }
+
         if let Some(v) = hash.get(ruby.to_symbol(stringify!(cookie_provider))) {
             builder.cookie_provider = Some((*Obj::<Jar>::try_convert(v)?).clone());
         }
@@ -152,7 +153,6 @@ impl Builder {
         }
 
         builder.user_agent = Extractor::<HeaderValue>::try_convert(*keyword)?.into_inner();
-        builder.orig_headers = Extractor::<OrigHeaderMap>::try_convert(*keyword)?.into_inner();
         builder.proxy = Extractor::<Proxy>::try_convert(*keyword)?.into_inner();
 
         Ok(builder)
@@ -175,14 +175,19 @@ impl Client {
                 // User agent options.
                 apply_option!(set_if_some, builder, params.user_agent, user_agent);
 
-                // Default headers options.
+                // Headers options.
                 apply_option!(
                     set_if_some_into_inner,
                     builder,
                     params.headers,
                     default_headers
                 );
-                apply_option!(set_if_some, builder, params.orig_headers, orig_headers);
+                apply_option!(
+                    set_if_some_inner,
+                    builder,
+                    params.orig_headers,
+                    orig_headers
+                );
 
                 // Allow redirects options.
                 apply_option!(set_if_some, builder, params.referer, referer);

data/src/error.rs

@@ -117,6 +117,14 @@ pub fn header_value_error_to_magnus(err: wreq::header::InvalidHeaderValue) -> Ma
     )
 }
 
+/// Map type/value errors to corresponding [`magnus::Error`]
+pub fn type_value_error_to_magnus(err: &str) -> MagnusError {
+    MagnusError::new(
+        ruby!().get_inner(&BUILDER_ERROR),
+        format!("type error: {err}"),
+    )
+}
+
 /// Map [`wreq::Error`] to corresponding [`magnus::Error`]
 pub fn wreq_error_to_magnus(err: wreq::Error) -> MagnusError {
     let error_msg = err.to_string();

data/src/extractor.rs

@@ -1,6 +1,6 @@
 use magnus::{RArray, RHash, RString, Ruby, TryConvert, r_hash::ForEach};
 use wreq::{
-    Proxy, Version,
+    Proxy,
     header::{HeaderMap, HeaderName, HeaderValue, OrigHeaderMap},
 };
 
@@ -32,27 +32,6 @@ where
     }
 }
 
-// ===== impl Extractor<Version> =====
-
-impl ExtractorName for Version {
-    const NAME: &str = "version";
-}
-
-impl TryConvert for Extractor<Version> {
-    fn try_convert(value: magnus::Value) -> Result<Self, magnus::Error> {
-        let keyword = RHash::try_convert(value)?;
-        if let Some(version_val) = keyword.get(Version::NAME) {
-            return <&crate::http::Version>::try_convert(version_val)
-                .cloned()
-                .map(crate::http::Version::into_ffi)
-                .map(Some)
-                .map(Extractor);
-        }
-
-        Ok(Extractor(None))
-    }
-}
-
 // ===== impl Extractor<HeaderValue> =====
 
 impl ExtractorName for HeaderValue {

data/src/header.rs

@@ -9,8 +9,11 @@ use magnus::{
     r_hash::ForEach,
     typed_data::{Inspect, Obj},
 };
+use wreq::header::OrigHeaderMap;
 
-use crate::error::{header_name_error_to_magnus, header_value_error_to_magnus};
+use crate::error::{
+    header_name_error_to_magnus, header_value_error_to_magnus, type_value_error_to_magnus,
+};
 
 /// HTTP headers collection with read and write operations.
 ///
@@ -20,6 +23,9 @@ use crate::error::{header_name_error_to_magnus, header_value_error_to_magnus};
 #[magnus::wrap(class = "Wreq::Headers", free_immediately, size)]
 pub struct Headers(pub RefCell<HeaderMap>);
 
+/// A map from header names to their original casing as received in an HTTP message.
+pub struct OrigHeaders(pub OrigHeaderMap);
+
 struct HeaderIter {
     inner: http::header::IntoIter<HeaderValue>,
     next_name: Option<HeaderName>,
@@ -166,6 +172,23 @@ impl TryConvert for Headers {
     }
 }
 
+// ===== impl OrigHeaders =====
+
+impl TryConvert for OrigHeaders {
+    fn try_convert(value: magnus::Value) -> Result<Self, magnus::Error> {
+        let mut map = OrigHeaderMap::new();
+
+        let rarray = RArray::from_value(value)
+            .ok_or_else(|| type_value_error_to_magnus("Expected an array of strings"))?;
+
+        for value in rarray.into_iter().flat_map(RString::from_value) {
+            map.insert(value.to_bytes());
+        }
+
+        Ok(Self(map))
+    }
+}
+
 // ===== impl HeaderIter =====
 
 impl Iterator for HeaderIter {

data/src/http.rs

@@ -1,4 +1,4 @@
-use magnus::{Error, Module, RModule, Ruby, method, typed_data::Inspect};
+use magnus::{Error, Module, RModule, Ruby, TryConvert, Value, method, typed_data::Inspect};
 
 define_ruby_enum!(
     /// An HTTP version.
@@ -41,6 +41,20 @@ impl Version {
     pub fn to_s(&self) -> String {
         self.into_ffi().inspect()
     }
+
+    /// Value-based equality for Ruby (`==`).
+    #[inline]
+    pub fn equals(&self, other: Value) -> bool {
+        <&Version>::try_convert(other)
+            .map(|other| *self == *other)
+            .unwrap_or(false)
+    }
+}
+
+impl TryConvert for Version {
+    fn try_convert(value: magnus::Value) -> Result<Self, magnus::Error> {
+        <&Version>::try_convert(value).cloned()
+    }
 }
 
 // ===== impl StatusCode =====
@@ -113,6 +127,7 @@ pub fn include(ruby: &Ruby, gem_module: &RModule) -> Result<(), Error> {
     version_class.const_set("HTTP_2", Version::HTTP_2)?;
     version_class.const_set("HTTP_3", Version::HTTP_3)?;
     version_class.define_method("to_s", method!(Version::to_s, 0))?;
+    version_class.define_method("==", method!(Version::equals, 1))?;
 
     let status_code_class = gem_module.define_class("StatusCode", ruby.class_object())?;
     status_code_class.define_method("as_int", method!(StatusCode::as_int, 0))?;

data/test/orig_header_test.rb

@@ -0,0 +1,115 @@
+require "test_helper"
+
+class OrigHeaderTest < Minitest::Test
+  URL = "https://tls.browserleaks.com/http1"
+
+  CASES = [
+    {
+      name: "mixed_case_descending",
+      headers: {
+        "X-Zeta-Token" => "zeta",
+        "x-alpha-key" => "alpha",
+        "X-MiXeD-CaSe" => "mixed"
+      },
+      orig_headers: ["X-Zeta-Token", "x-alpha-key", "X-MiXeD-CaSe"]
+    },
+    {
+      name: "reverse_alpha_order",
+      headers: {
+        "X-Third" => "3",
+        "X-Second" => "2",
+        "X-First" => "1"
+      },
+      orig_headers: ["X-Third", "X-Second", "X-First"]
+    },
+    {
+      name: "preserve_weird_casing",
+      headers: {
+        "x-a" => "a",
+        "X-B" => "b",
+        "x-C" => "c"
+      },
+      orig_headers: ["x-C", "x-a", "X-B"]
+    },
+    {
+      name: "interleaved_tokens",
+      headers: {
+        "X-Token-3" => "v3",
+        "X-Token-1" => "v1",
+        "X-Token-2" => "v2"
+      },
+      orig_headers: ["X-Token-1", "X-Token-2", "X-Token-3"]
+    }
+  ].freeze
+
+  def test_client_default_orig_headers_preserves_header_order_in_multiple_shuffled_cases
+    CASES.each do |kase|
+      client = Wreq::Client.new(
+        headers: kase[:headers],
+        orig_headers: kase[:orig_headers]
+      )
+
+      response = client.get(URL, version: Wreq::Version::HTTP_11)
+      assert_equal 200, response.code, "case=#{kase[:name]}"
+
+      echoed_headers = extract_http1_headers(response.json, kase[:name])
+      assert_header_order(echoed_headers, kase[:orig_headers], kase[:name])
+      assert_header_values(echoed_headers, kase[:headers], kase[:name])
+    end
+  end
+
+  def test_module_request_orig_headers_preserves_header_order_in_multiple_shuffled_cases
+    CASES.each do |kase|
+      response = Wreq.get(
+        URL,
+        headers: kase[:headers],
+        orig_headers: kase[:orig_headers],
+        version: Wreq::Version::HTTP_11
+      )
+      assert_equal 200, response.code, "case=#{kase[:name]}"
+
+      echoed_headers = extract_http1_headers(response.json, kase[:name])
+      assert_header_order(echoed_headers, kase[:orig_headers], kase[:name])
+      assert_header_values(echoed_headers, kase[:headers], kase[:name])
+    end
+  end
+
+  private
+
+  def extract_http1_headers(json, case_name)
+    http1 = fetch_by_name(json, "http1")
+    refute_nil http1, "case=#{case_name}: expected JSON key 'http1', got #{json.keys.inspect}"
+
+    headers = fetch_by_name(http1, "headers")
+    refute_nil headers, "case=#{case_name}: expected JSON key 'http1.headers'"
+    headers
+  end
+
+  def fetch_by_name(hash_like, key_name)
+    return hash_like[key_name] if hash_like.respond_to?(:key?) && hash_like.key?(key_name)
+    return hash_like[key_name.to_sym] if hash_like.respond_to?(:key?) && hash_like.key?(key_name.to_sym)
+
+    pair = hash_like.find { |k, _| k.to_s == key_name }
+    pair&.last
+  end
+
+  def assert_header_order(echoed_headers, ordered_names, case_name)
+    echoed_keys = echoed_headers.keys
+    positions = ordered_names.map do |expected_name|
+      index = echoed_keys.index(expected_name)
+      refute_nil index, "case=#{case_name}: expected header to exist in echo: #{expected_name}"
+      index
+    end
+
+    assert_equal positions.sort, positions,
+      "case=#{case_name}: expected header order #{ordered_names.inspect}, got keys #{echoed_keys.inspect}"
+  end
+
+  def assert_header_values(echoed_headers, expected_headers, case_name)
+    expected_headers.each do |name, expected_value|
+      assert echoed_headers.key?(name),
+        "case=#{case_name}: expected exact-case header name #{name}, got #{echoed_headers.keys.inspect}"
+      assert_equal expected_value, echoed_headers[name]
+    end
+  end
+end

data/test/request_test.rb

@@ -6,6 +6,16 @@ class WreqHttpbinTest < Minitest::Test
     @client = Wreq::Client.new(timeout: 30)
   end
 
+  def test_spec_http1_version
+    response = Wreq.get("https://tls.browserleaks.com", version: Wreq::Version::HTTP_11)
+    assert_equal response.version, Wreq::Version::HTTP_11
+  end
+
+  def test_spec_http2_version
+    response = Wreq.get("https://tls.browserleaks.com", version: Wreq::Version::HTTP_2)
+    assert_equal response.version, Wreq::Version::HTTP_2
+  end
+
   def test_module_get_method
     response = Wreq.get("http://localhost:8080/get")
     assert_equal 200, response.code

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wreq
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - SearchApi
@@ -74,6 +74,7 @@ files:
 - test/header_test.rb
 - test/inspect_test.rb
 - test/module_methods_test.rb
+- test/orig_header_test.rb
 - test/request_parameters_test.rb
 - test/request_test.rb
 - test/response_test.rb