patron 0.13.1 → 0.13.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cdaf7a10ef1cf673746f7f87ae77a9d939b461fc
-  data.tar.gz: 772139466802595a3906e24f297da437de3df880
+SHA256:
+  metadata.gz: f900014f4c841d87c4db54f3db3f33d9b624d5a6dde0eb9352b7a70cc6f330b7
+  data.tar.gz: 31b35805166302cb5527734b70c3607f9dbb951e2c1e3aafd465f7f8d5dbbb75
 SHA512:
-  metadata.gz: 94787a3fd98f9253862432e8069c5088dfc703f3bb6e69ebb2e60f86d70a489a8cb2c72d2134e690649d0e908ff08068631e0cc148f41b331fca5cf4f95dc6cb
-  data.tar.gz: 19496dff4f0687cbcd664c3aa81969c5b1a810aba28f87ab9f918a05771a5567d348acdc8b862c2b430e9304854796e034fc9d68361aa2d5b16e2cd0b17bd63b
+  metadata.gz: 1989abb0ba1be73ed08df186d05349c6519a90663a7263799a1e97e024e5183ff6de9f49ab329ebf4e3b49c4c571d0e3ca7efed3bc5f803ad8edbe96a6554ff6
+  data.tar.gz: dc03c98c0f363d7d7bf273b72a62954dadb590c1236baf06739f6fdebd6ae5007afc243dc526c97359165c19244868779fc4168cc9f972c32cbf8fef81a56521

data/.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: Tests
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    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]
+
+    name: Specs - Ruby ${{ matrix.ruby-version }}
+    steps:
+    - uses: actions/checkout@v4
+    - name: Install libcurl
+      run: |
+        sudo apt-get update
+        sudo apt-get -y install libcurl4 libcurl4-openssl-dev 
+    - name: Set up Ruby ${{ matrix.ruby-version }}
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # 'bundle install' and cache
+    - name: Run tests
+      run: bundle exec rake

data/.travis.yml

@@ -1,14 +1,13 @@
 rvm:
-- 1.9.3
-- 2.1.5
-- 2.2.2
-- 2.3.4
-- 2.4.1
-- 2.5.0
-sudo: false
+- 2.3.8
+- 2.4.5
+- 2.5.3
+- 2.6.1
+- ruby-head
+
 dist: trusty
 cache: bundler
-install:
-  - gem update --system 2.6.12  # https://github.com/rubygems/rubygems/issues/2024
-  - gem install bundler
-  - "bundle install --verbose --jobs=3 --retry=3 --path=${BUNDLE_PATH:-vendor/bundle}"
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/CHANGELOG.md

@@ -1,4 +1,24 @@
-### 0.13.0
+### 0.13.4
+
+* Format README a bit better using code fences
+* Depend explicitly on base64 for running tests
+* Remove C code used for Ruby support below < 2.4 (GVL unlock etc.) and drop support for these versions
+* In tests, close Tempfiles before allowing libcurl to use them (cookie jar)
+* Fix incorrect ptr type in uses of `curl_easy_escape` / `_unescape`
+* Define methods on `Session` as private instance methods from C instead of privatising them from Ruby
+* Speed up the /slow endpoint test
+* Remove use of `curl_easy_reset`. This should fix the bug with sessions resetting each other's state during `session_free`
+
+### 0.13.3
+
+* Run Puma test servers in separate processes instead of threads
+
+### 0.13.2
+
+* Eagerly initialize libCURL handle when creating the Session instance instead of initializing it lazily
+* Remove special treatment of `Session#reset` and make it the same as `Session#interrupt`
+
+### 0.13.0, 0.13.1
 
 * Permit timeouts to be set as a Float of seconds and use `CURLOPT_(CONNECT)TIMEOUT_MS` instead of `CURLOPT_(CONNECT)TIMEOUT` so that
   sub-second timeouts can be configured, which is useful for performant services using accelerated DNS resolution.

data/Gemfile

@@ -1,4 +1,17 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in patron.gemspec
+# Runtime dependencies are in the gemspec
 gemspec
+
+# Gems below are only needed for Patron development
+# and tests
+gem "rake", ">= 12.3.3"
+gem "rspec", ">= 2.3.0"
+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 "rake-compiler"
+gem "webrick", "~> 1.8"
+gem "base64"

data/README.md

@@ -1,3 +1,7 @@
+# Patron
+
+[![Build Status](https://travis-ci.org/toland/patron.svg?branch=master)](https://travis-ci.org/toland/patron)
+
 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
 sane API while taking advantage of libcurl under the hood.
@@ -8,52 +12,114 @@ First, you instantiate a Session object. You can set a few
 default options on the Session instance that will be used by all subsequent
 requests:
 
-    sess = Patron::Session.new
-    sess.timeout = 10
-    sess.base_url = "http://myserver.com:9900"
-    sess.headers['User-Agent'] = 'myapp/1.0'
+```ruby
+sess = Patron::Session.new
+sess.timeout = 10
+sess.base_url = "http://myserver.com:9900"
+sess.headers['User-Agent'] = 'myapp/1.0'
+```
 
 You can set options with a hash in the constructor:
 
-    sess = Patron::Session.new({ :timeout => 10,
-                                 :base_url => 'http://myserver.com:9900',
-                                 :headers => {'User-Agent' => 'myapp/1.0'} } )
+```ruby
+sess = Patron::Session.new({ :timeout => 10,
+                             :base_url => 'http://myserver.com:9900',
+                             :headers => {'User-Agent' => 'myapp/1.0'} } )
+```
 
 Or the set options in a block:
 
-    sess = Patron::Session.new do |patron|
-        patron.timeout = 10
-        patron.base_url = 'http://myserver.com:9900'
-        patron.headers = {'User-Agent' => 'myapp/1.0'}
-    end
+```ruby
+sess = Patron::Session.new do |patron|
+    patron.timeout = 10
+    patron.base_url = 'http://myserver.com:9900'
+    patron.headers = {'User-Agent' => 'myapp/1.0'}
+end
+```
 
 Output debug log:
 
-    sess.enable_debug "/tmp/patron.debug"
+```ruby
+sess.enable_debug "/tmp/patron.debug"
+```
 
 The Session is used to make HTTP requests.
 
-    resp = sess.get("/foo/bar")
+```ruby
+resp = sess.get("/foo/bar")
+```
 
 Requests return a Response object:
 
-    if resp.status < 400
-      puts resp.body
-    end
+```ruby
+if resp.status < 400
+  puts resp.body
+end
+```
 
 The GET, HEAD, PUT, POST and DELETE operations are all supported.
 
-    sess.put("/foo/baz", "some data")
-    sess.delete("/foo/baz")
+```ruby
+sess.put("/foo/baz", "some data")
+sess.delete("/foo/baz")
+```
 
 You can ship custom headers with a single request:
 
-    sess.post("/foo/stuff", "some data", {"Content-Type" => "text/plain"})
+```ruby
+sess.post("/foo/stuff", "some data", {"Content-Type" => "text/plain"})
+```
+
+## Threading
+
+By itself, the `Patron::Session` objects are not thread safe (each `Session` holds a single `curl_state` pointer
+from initialization to garbage collection). At this time, Patron has no support for `curl_multi_*` family of functions 
+for doing concurrent requests. However, the actual code that interacts with libCURL does unlock the RVM GIL,
+so using multiple `Session` objects in different threads actually enables a high degree of parallelism.
+For sharing a resource of sessions between threads we recommend using the excellent [connection_pool](https://rubygems.org/gems/connection_pool) gem by Mike Perham.
+
+```ruby
+patron_pool = ConnectionPool.new(size: 5, timeout: 5) { Patron::Session.new }
+patron_pool.with do |session|
+  session.get(...)
+end
+```
+
+Sharing Session objects between requests will also allow you to benefit from persistent connections (connection reuse), see below.
+
+## Persistent connections
+
+Patron follows the libCURL guidelines on [connection reuse.](https://everything.curl.dev/libcurl/connectionreuse.html) If you create the Session
+object once and use it for multiple requests, the same libCURL handle is going to be used across these requests and if requests go to
+the same hostname/port/protocol the connection should get reused.
+
+## Performance with parallel requests
+
+When performing the libCURL request, Patron goes out of it's way to unlock the GVL (global VM lock) to allow other threads to be scheduled
+in parallel. The GVL is going to be released when the libCURL request starts, and will then be shortly re-acquired to provide the progress
+callback - if the callback has been configured, and then released again until the libCURL request has been performed and the response has
+been read in full. This allows one to execute multiple libCURL requests in parallel, as well as perform other activities on other MRI threads
+that are currently active in the process.
+
+## Requirements
+
+Patron 1.0 and up requires MRI Ruby 2.3 or newer. The 0.x versions support
+Ruby 1.9.3 and these versions get tagged and developed on the `v0.x` branch.
+
+A recent version of libCURL is required. We recommend at least 7.19.4 because
+it [supports limiting the protocols](https://curl.haxx.se/libcurl/c/CURLOPT_PROTOCOLS.html),
+and that is very important for security - especially if you follow redirects. 
 
-## Known issues
+On OSX the provided libcurl is sufficient if you are not using fork+SSL combination (see below).
+You will have to install the libcurl development packages on Debian or Ubuntu. Other Linux systems are probably
+similar. For Windows we do not have an established build instruction at the moment, unfortunately.
 
-Currently, [an issue is at play](https://github.com/curl/curl/issues/788) with OSX builds of `curl` which use Apple's SecureTransport. Such builds (which Patron is linking to), are causing segfaults when performing HTTPS requests in forked subprocesses. If you need to check whether your
-system is affected, run the Patron test suite by performing
+## Forking webservers on macOS and SSL
+
+Currently, [an issue is at play](https://github.com/curl/curl/issues/788) with OSX builds of `curl` which use
+Apple's SecureTransport. Such builds (which Patron is linking to), are causing segfaults when performing HTTPS
+requests in forked subprocesses. If you need to check whether your system is affected,
+run the Patron test suite by performing
 
     $ bundle install && bundle exec rspec
 
@@ -69,37 +135,13 @@ When doing so, `curl` will use openssl as it's SSL driver. You also need to
 change the Patron compile flag:
 
 
-    $ brew install curl --with-openssl && \
-        gem install patron --with-curl-config=/usr/local/opt/curl/bin/curl-config
+    $ brew install curl-openssl && \
+        gem install patron -- --with-curl-config=/usr/local/opt/curl-openssl/bin/curl-config
 
 You can also save this parameter for all future Bundler-driven gem installs by
 setting this flag in Bundler proper:
 
-    $ bundle config build.patron --with-curl-config=/usr/local/opt/curl/bin/curl-config
-
-## Threading
-
-By itself, the `Patron::Session` objects are not thread safe (each `Session` holds a single `curl_state` pointer
-during the request/response cycle). At this time, Patron has no support for `curl_multi_*` family of functions 
-for doing concurrent requests. However, the actual code that interacts with libCURL does unlock the RVM GIL,
-so using multiple `Session` objects in different threads is possible with a high degree of concurrency.
-For sharing a resource of sessions between threads we recommend using the excellent [connection_pool](https://rubygems.org/gems/connection_pool) gem by Mike Perham.
-
-    patron_pool = ConnectionPool.new(size: 5, timeout: 5) { Patron::Session.new }
-    patron_pool.with do |session|
-      session.get(...)
-    end
-
-## Requirements
-
-Patron uses encoding features of Ruby, so you need at least Ruby 1.9. Also, a
-recent version of libCURL is required. We recommend at least 7.19.4 because
-it [supports limiting the protocols](https://curl.haxx.se/libcurl/c/CURLOPT_PROTOCOLS.html),
-and that is very important for security - especially if you follow redirects. 
-
-On OSX the provided libcurl is sufficient. You will have to install the libcurl
-development packages on Debian or Ubuntu. Other Linux systems are probably
-similar. For Windows we do not have an established build instruction at the moment, unfortunately.
+    $ bundle config build.patron --with-curl-config=/usr/local/opt/curl-openssl/bin/curl-config
 
 ## Installation
 

data/ext/patron/extconf.rb

@@ -19,9 +19,8 @@ if CONFIG['CC'] =~ /gcc/
   $CFLAGS << ' -pedantic -Wall'
 end
 
-$defs.push("-DUSE_TBR")
-$defs.push("-DHAVE_THREAD_H") if have_header('ruby/thread.h')
-$defs.push("-DHAVE_TBR") if have_func('rb_thread_blocking_region', 'ruby.h')
-$defs.push("-DHAVE_TCWOGVL") if have_header('ruby/thread.h') && have_func('rb_thread_call_without_gvl', 'ruby/thread.h')
+if CONFIG['CC'] =~ /clang/
+  $CFLAGS << ' -pedantic -Wall -Wno-void-pointer-to-enum-cast'
+end
 
 create_makefile 'patron/session_ext'