patron 0.13.4 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f900014f4c841d87c4db54f3db3f33d9b624d5a6dde0eb9352b7a70cc6f330b7
-  data.tar.gz: 31b35805166302cb5527734b70c3607f9dbb951e2c1e3aafd465f7f8d5dbbb75
+  metadata.gz: 355b38921e6368ee1ad7815cd78ad9135630b10c82d60365978747e4189be390
+  data.tar.gz: efbebf2f2e6393e93411d5583c9062b3170e0bf4e30ae370d1e998110b19c3c3
 SHA512:
-  metadata.gz: 1989abb0ba1be73ed08df186d05349c6519a90663a7263799a1e97e024e5183ff6de9f49ab329ebf4e3b49c4c571d0e3ca7efed3bc5f803ad8edbe96a6554ff6
-  data.tar.gz: dc03c98c0f363d7d7bf273b72a62954dadb590c1236baf06739f6fdebd6ae5007afc243dc526c97359165c19244868779fc4168cc9f972c32cbf8fef81a56521
+  metadata.gz: 760418bb81862c742f9873caa2513a6ed60093a084145b77e9f21996f041b0e848a0a6914e0248c0dca806bc5313c59eed68afd2546c828218a2e0aa52734ecf
+  data.tar.gz: 77510952d581ea162ef55e93260fc8188e58b5f919dd97912c6d7b40863c94e2c517027c6de5fe2b5041431fb9645c85ad674b08f37ce7e2fcdb37b4f16f2da2

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

data/.github/workflows/ci.yml

@@ -4,15 +4,19 @@ on: [push, pull_request]
 
 jobs:
   test:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
+    continue-on-error: ${{ matrix.allow-failure || false }}
     strategy:
       fail-fast: false
       matrix:
-        ruby-version: [2.4, 2.5, 2.6, 2.7, '3.0', 3.1, 3.2, 3.3, 3.4.1]
+        ruby-version: ["2.4", "3.0", "3.4.1", "4.0.5"]
+        include:
+          - ruby-version: "head"
+            allow-failure: true
 
     name: Specs - Ruby ${{ matrix.ruby-version }}
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v7
     - name: Install libcurl
       run: |
         sudo apt-get update
@@ -24,3 +28,52 @@ jobs:
         bundler-cache: true # 'bundle install' and cache
     - name: Run tests
       run: bundle exec rake
+
+  valgrind:
+    runs-on: ubuntu-latest
+    name: Specs under valgrind memcheck
+    steps:
+    - uses: actions/checkout@v7
+    - name: Install libcurl and valgrind
+      run: |
+        sudo apt-get update
+        sudo apt-get -y install libcurl4-openssl-dev valgrind
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: "3.4"
+        bundler-cache: true
+    - name: Compile the extension with debug info
+      run: bundle exec rake clobber compile
+      env:
+        PATRON_EXTRA_CFLAGS: "-g -O1"
+    - name: Run the specs under memcheck
+      # The ruby process itself is under valgrind (bundle exec only sets up the environment).
+      # Specs tagged :timing assert on wall-clock windows that valgrind's slowdown breaks.
+      run: |
+        bundle exec valgrind --error-exitcode=99 --leak-check=no --undef-value-errors=no \
+          --child-silent-after-fork=yes --num-callers=30 \
+          --suppressions=spec/support/valgrind.supp \
+          ruby -S rspec --tag ~timing
+
+  malloc-check:
+    runs-on: ubuntu-latest
+    name: Specs with glibc malloc checking
+    steps:
+    - uses: actions/checkout@v7
+    - name: Install libcurl
+      run: |
+        sudo apt-get update
+        sudo apt-get -y install libcurl4-openssl-dev
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: "3.4"
+        bundler-cache: true
+    - name: Run tests
+      # glibc aborts on heap corruption and fills freed memory with 0xA5, so a use-after-free
+      # shows up as garbage data rather than passing by luck
+      run: bundle exec rake
+      env:
+        MALLOC_CHECK_: "3"
+        MALLOC_PERTURB_: "165"

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+### Unreleased
+
+### 0.14.0
+
+* Expose libcurl's transfer timings (name lookup, connect, TLS, first byte, total) as `Response#timings`
+* Add `ssl_cert`, `ssl_cert_type`, `ssl_key` and `ssl_key_password` for presenting a client certificate (mutual TLS). Thanks @lenage for the original contribution in #165
+* Raise `Patron::ClientCertificateError` when the client certificate or its key can't be used
+* Accept a `Pathname` for `cacert`
+* Fix a request whose options fail to apply (for example an option of the wrong type) leaking its headers and open files into the next request on the same `Session`
+* Fix the request body being read from freed memory when `upload_data` is not a String (its `#to_s` result was not kept alive during the transfer)
+* Fix multipart field names and values pointing at temporary Strings, and binary multipart values being cut at the first NUL byte
+* Fix an exception raised inside `progress_callback` (including `Timeout.timeout` and `Thread#raise`) unwinding through libcurl; it is now re-raised after the transfer is aborted
+* Raise `Patron::Error` when a second thread uses a `Session` that is already performing a request, instead of corrupting both requests
+* Fix the progress callback being declared with `size_t` arguments where libcurl passes `curl_off_t`
+* Accept `download_byte_limit` above 2 GiB, and Floats for `dns_cache_timeout`, `low_speed_time` and `low_speed_limit`
+* Fix `Session#unescape` cutting the result at a `%00`, and raise instead of crashing when libcurl fails to escape or unescape
+* Reject file paths containing NUL bytes for cookie files, debug output and uploads
+* Raise `NoMemoryError` instead of crashing later when libcurl cannot allocate a Session's handles
+* Register the exception classes the extension looks up at load time with the GC, so heap compaction (`GC.compact`, `GC.auto_compact`) cannot move them out from under `rb_raise`
+
 ### 0.13.4
 
 * Format README a bit better using code fences

data/Gemfile

@@ -11,7 +11,8 @@ gem "simplecov", "~> 0.10"
 gem "yard", "~> 0.9.20"
 rack_version = RUBY_VERSION >= "3.3" ? "~> 2.2" : "~> 2.1.4"
 gem "rack", rack_version
-gem "puma", '~> 3.11'
+gem "puma", '~> 5.6'
 gem "rake-compiler"
 gem "webrick", "~> 1.8"
 gem "base64"
+gem "ostruct"

data/README.md

@@ -1,6 +1,6 @@
 # Patron
 
-[![Build Status](https://travis-ci.org/toland/patron.svg?branch=master)](https://travis-ci.org/toland/patron)
+[![Tests](https://github.com/toland/patron/actions/workflows/ci.yml/badge.svg)](https://github.com/toland/patron/actions/workflows/ci.yml)
 
 Patron is a Ruby HTTP client library based on libcurl. It does not try to expose
 the full "power" (read complexity) of libcurl but instead tries to provide a
@@ -70,6 +70,35 @@ You can ship custom headers with a single request:
 sess.post("/foo/stuff", "some data", {"Content-Type" => "text/plain"})
 ```
 
+libcurl's transfer timings are available on the response, in seconds since the request started:
+
+```ruby
+resp = sess.get("/foo/bar")
+resp.timings # => {namelookup: 0.001, connect: 0.012, appconnect: 0.045, pretransfer: 0.045,
+             #     starttransfer: 0.210, redirect: 0.0, total: 0.214}
+```
+
+To authenticate with a client certificate (mutual TLS), point Patron at a PKCS#12 bundle:
+
+```ruby
+sess.ssl_cert = "/path/to/client.p12"
+sess.ssl_cert_type = "P12"
+sess.ssl_key_password = "secret"
+```
+
+or at a PEM certificate with a separate private key:
+
+```ruby
+sess.ssl_cert = "/path/to/client.pem"
+sess.ssl_key = "/path/to/client_key.pem"
+sess.ssl_key_password = "secret" # if the key is encrypted
+```
+
+If the certificate or key can't be loaded (wrong password, missing file) the request raises `Patron::ClientCertificateError`.
+This depends on the TLS library libcurl is built against: with GnuTLS these surface as a plain `Patron::Error`.
+Client certificates are tested with the OpenSSL and LibreSSL backends - libcurl's Secure Transport backend
+can't load a PEM certificate from a file at all.
+
 ## Threading
 
 By itself, the `Patron::Session` objects are not thread safe (each `Session` holds a single `curl_state` pointer

data/ext/patron/extconf.rb

@@ -23,4 +23,8 @@ if CONFIG['CC'] =~ /clang/
   $CFLAGS << ' -pedantic -Wall -Wno-void-pointer-to-enum-cast'
 end
 
+# Lets CI build with debug info for valgrind without editing this file, like so:
+# PATRON_EXTRA_CFLAGS="-g -O1" rake compile
+$CFLAGS << ' ' << ENV['PATRON_EXTRA_CFLAGS'] if ENV['PATRON_EXTRA_CFLAGS']
+
 create_makefile 'patron/session_ext'