httparty 0.24.1 → 0.24.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1cb1b76559da322f97eb94d6f3ffb559cb724c4c7fda1cead989f28cdf723aa8
-  data.tar.gz: 17eca4739d3c56c970c0141f1fb37dccd20112fd7fb7c5504a80db9dea89d292
+  metadata.gz: 2389baaffd615950f7d364a762d1c7e046e6e1819070b6974137a79737ed5cef
+  data.tar.gz: 33be08cb6b537efbbe5f691eff3308c9a126f03998d8cda1827ee946edadaffd
 SHA512:
-  metadata.gz: 5c330deb338ffa53c4da1fda045dfcc133103122dc9a4df56e82f0ff184ed49b18b3775fdc55da6117c59265db3a2f2b18c062c3ba2e3c7750fe43bb67a8ee31
-  data.tar.gz: 4c777978ab92e2b2972fb2898ba61b153876db33a57411f775af3731978bde776a47c7cae0e4f641b3af093b781ab69644499384dba29a1e088ff59096ea1b07
+  metadata.gz: 205b2eda67b38f7d4febba842ee9fd13450ffae372f92455ed925b9646ad68872e6a60c7efe7ab97635209737eba19f1efddf8fd6ea58732b8552986304890f9
+  data.tar.gz: 431bf5342636a7a88bf3d64116535e20d547f089f6cabea8f66700215d9aaafc6ad8903e8205105183d24bb55115d676b28e6026d9c1a0aa969a74d6e53ec471

data/.github/workflows/ci.yml

@@ -14,7 +14,7 @@ jobs:
           - 3.4
     steps:
       - name: Check out repository code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:

data/README.md

@@ -19,7 +19,7 @@ gem install httparty
 
 ```ruby
 # Use the class methods to get down to business quickly
-response = HTTParty.get('http://api.stackexchange.com/2.2/questions?site=stackoverflow')
+response = HTTParty.get('https://api.stackexchange.com/2.2/questions?site=stackoverflow')
 
 puts response.body, response.code, response.message, response.headers.inspect
 

data/docs/README.md

@@ -4,6 +4,7 @@ Makes http fun again!
 
 ## Table of contents
 - [Parsing JSON](#parsing-json)
+- [File Uploads (Multipart)](#file-uploads-multipart)
 - [Working with SSL](#working-with-ssl)
 
 ## Parsing JSON
@@ -28,6 +29,35 @@ HTTParty.post('http://example.com', body: JSON.generate({ foo: 'bar' }), headers
 HTTParty.post('http://example.com', body: { foo: 'bar' }.to_json, headers: { 'Content-Type' => 'application/json' })
 ```
 
+## File Uploads (Multipart)
+
+When you include a `File` object in the body, HTTParty automatically uses `multipart/form-data` encoding:
+
+```ruby
+HTTParty.post('http://example.com/upload',
+  body: {
+    name: 'Foo Bar',
+    avatar: File.open('/path/to/avatar.jpg')
+  }
+)
+```
+
+### Streaming Uploads for Large Files
+
+For large file uploads, you can enable streaming mode to reduce memory usage. Instead of loading the entire file into memory, HTTParty will stream the file in chunks:
+
+```ruby
+HTTParty.post('http://example.com/upload',
+  body: {
+    name: 'Foo Bar',
+    avatar: File.open('/path/to/large_file.zip')
+  },
+  stream_body: true
+)
+```
+
+**Note:** Some servers may not handle streaming uploads correctly. If you encounter issues (e.g., 400 errors), try without the `stream_body` option.
+
 ## Working with SSL
 
 You can use this guide to work with SSL certificates.

data/examples/README.md

@@ -78,6 +78,7 @@
 
 * [Multipart](multipart.rb)
   * Multipart data upload _(with and without file)_
+  * Streaming uploads for large files with `stream_body: true`
 
 * [Uploading File](body_stream.rb)
   * Uses `body_stream` to upload file

data/examples/multipart.rb

@@ -20,3 +20,16 @@ HTTParty.post(
     email: 'example@email.com'
   }
 )
+
+
+# For large file uploads, use stream_body: true to reduce memory usage.
+# Instead of loading the entire file into memory, HTTParty will stream it in chunks.
+# Note: Some servers may not handle streaming uploads correctly.
+
+HTTParty.post(
+  'http://localhost:3000/upload',
+  body: {
+    document: File.open('/full/path/to/large_file.zip')
+  },
+  stream_body: true
+)

data/examples/tripit_sign_in.rb

@@ -9,7 +9,7 @@ class TripIt
   def initialize(email, password)
     @email = email
     get_response = self.class.get('/account/login')
-    get_response_cookie = parse_cookie(get_response.headers['Set-Cookie'])
+    get_response_cookie = parse_cookie(get_response)
 
     post_response = self.class.post(
       '/account/login',
@@ -20,7 +20,7 @@ class TripIt
       headers: {'Cookie' => get_response_cookie.to_cookie_string }
     )
 
-    @cookie = parse_cookie(post_response.headers['Set-Cookie'])
+    @cookie = parse_cookie(post_response)
   end
 
   def account_settings

data/lib/httparty/parser.rb

@@ -103,11 +103,12 @@ module HTTParty
     # @return [nil] when the response body is nil, an empty string, spaces only or "null"
     def parse
       return nil if body.nil?
+      # The bom has to be removed before the blank body checks below, otherwise a
+      # body that is nothing but a bom is handed to the format parser as an
+      # empty string and blows up instead of being reported as nil.
+      @body = strip_utf8_bom(body)
       return nil if body == 'null'
       return nil if body.valid_encoding? && body.strip.empty?
-      if body.valid_encoding? && body.encoding == Encoding::UTF_8
-        @body = body.gsub(/\A#{UTF8_BOM}/, '')
-      end
       if supports_format?
         parse_supported_format
       else
@@ -119,14 +120,44 @@ module HTTParty
 
     def xml
       require 'multi_xml'
-      MultiXml.parse(body)
+      (defined?(MultiXML) ? MultiXML : MultiXml).parse(body)
     end
 
     UTF8_BOM = "\xEF\xBB\xBF"
+    UTF8_BOM_ENCODINGS = [Encoding::UTF_8, Encoding::US_ASCII, Encoding::BINARY].freeze
+
+    # Compares bytes rather than characters because Net::HTTP hands bodies
+    # over as ASCII-8BIT when the response has no charset, and a UTF-8 regex
+    # would never match those. ASCII-8BIT bodies in a format we don't parse
+    # are left alone, since they may be genuine binary data (images, files).
+    def strip_utf8_bom(string)
+      return string unless UTF8_BOM_ENCODINGS.include?(string.encoding)
+      return string if string.encoding == Encoding::BINARY && !supports_format?
+      return string.byteslice(UTF8_BOM.bytesize..-1) if utf8_bom?(string)
+
+      # Valid UTF-8 bodies have always been handed back as a copy, so mutating
+      # parsed_response doesn't also change response.body. Other encodings
+      # (ASCII-8BIT, US-ASCII, ISO-8859-1, invalid UTF-8) have always been
+      # handed back as the same object, and still are.
+      if string.encoding == Encoding::UTF_8 && string.valid_encoding?
+        string.dup
+      else
+        string
+      end
+    end
+
+    # Checks bytes one at a time so the common no-BOM case allocates nothing.
+    def utf8_bom?(string)
+      string.getbyte(0) == 0xEF && string.getbyte(1) == 0xBB && string.getbyte(2) == 0xBF
+    end
 
     def json
       require 'json'
-      JSON.parse(body, :quirks_mode => true, :allow_nan => true)
+      if JSON::VERSION.to_i >= 3
+        JSON.parse(body, :allow_nan => true)
+      else
+        JSON.parse(body, :quirks_mode => true, :allow_nan => true)
+      end
     end
 
     def csv

data/lib/httparty/request.rb

@@ -251,7 +251,7 @@ module HTTParty
           @raw_request['Content-Type'] = 'application/x-www-form-urlencoded'
         end
 
-        if body.streaming? && options[:stream_body] != false
+        if body.streaming? && options[:stream_body] == true
           stream = body.to_stream
           @raw_request.body_stream = stream
           @raw_request['Content-Length'] = stream.size.to_s

data/lib/httparty/response.rb

@@ -133,13 +133,27 @@ module HTTParty
     end
 
     def throw_exception
-      if @request.options[:raise_on].to_a.detect { |c| code.to_s.match(/#{c.to_s}/) }
+      raise_on = @request.options[:raise_on]
+      return if raise_on.nil?
+
+      matchers = raise_on.is_a?(Range) ? [raise_on] : [*raise_on]
+
+      if matchers.any? { |matcher| code_matches?(matcher) }
         ::Kernel.raise ::HTTParty::ResponseError.new(@response), "Code #{code} - #{body}"
       end
     end
 
     private
 
+    def code_matches?(matcher)
+      case matcher
+      when Range
+        matcher.cover?(code) || matcher.cover?(code.to_s)
+      else
+        /#{matcher}/.match?(code.to_s)
+      end
+    end
+
     def warn_about_nil_deprecation
       trace_line = caller.reject { |line| line.include?('httparty') }.first
       warning = "[DEPRECATION] HTTParty will no longer override `response#nil?`. " \

data/lib/httparty/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HTTParty
-  VERSION = '0.24.1'
+  VERSION = '0.24.3'
 end

data/lib/httparty.rb

@@ -41,7 +41,7 @@ module HTTParty
   # [:+local_host+:] Local address to bind to before connecting.
   # [:+local_port+:] Local port to bind to before connecting.
   # [:+body_stream+:] Allow streaming to a REST server to specify a body_stream.
-  # [:+stream_body+:] Allow for streaming large files without loading them into memory.
+  # [:+stream_body+:] When downloading with a block, avoids accumulating the response in memory. When uploading files, streams the request body to reduce memory usage (opt-in).
   # [:+multipart+:] Force content-type to be multipart
   #
   # There are also another set of options with names corresponding to various class methods. The methods in question are those that let you set a class-wide default, and the options override the defaults on a request-by-request basis. Those options are:
@@ -84,14 +84,15 @@ module HTTParty
       default_options[:log_format] = format
     end
 
-    # Raises HTTParty::ResponseError if response's code matches this statuses
+    # Raises HTTParty::ResponseError if the response status matches a code,
+    # range, or regular expression string.
     #
     #   class Foo
     #     include HTTParty
-    #     raise_on [404, 500, '5[0-9]*']
+    #     raise_on [404, 500..599, '3[0-9]*']
     #   end
     def raise_on(codes = [])
-      default_options[:raise_on] = *codes
+      default_options[:raise_on] = codes.is_a?(Range) ? [codes] : [*codes]
     end
 
     # Allows setting http proxy information to be used

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: httparty
 version: !ruby/object:Gem::Version
-  version: 0.24.1
+  version: 0.24.3
 platform: ruby
 authors:
 - John Nunemaker
 - Sandro Turriate
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-01-14 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: csv
@@ -148,8 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 4.0.18
 specification_version: 4
 summary: Makes http fun! Also, makes consuming restful web services dead easy.
 test_files: []