httparty 0.24.1 → 0.24.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1cb1b76559da322f97eb94d6f3ffb559cb724c4c7fda1cead989f28cdf723aa8
-  data.tar.gz: 17eca4739d3c56c970c0141f1fb37dccd20112fd7fb7c5504a80db9dea89d292
+  metadata.gz: 5140fa45bdc5cad9c43dedc767d225a8d303df17e7684fb229e15b5b719c7581
+  data.tar.gz: df6926136fccc436033ebdec116d46d90c9d4cc41425e064f9caa8954d174ae2
 SHA512:
-  metadata.gz: 5c330deb338ffa53c4da1fda045dfcc133103122dc9a4df56e82f0ff184ed49b18b3775fdc55da6117c59265db3a2f2b18c062c3ba2e3c7750fe43bb67a8ee31
-  data.tar.gz: 4c777978ab92e2b2972fb2898ba61b153876db33a57411f775af3731978bde776a47c7cae0e4f641b3af093b781ab69644499384dba29a1e088ff59096ea1b07
+  metadata.gz: 0a9f6122cbddaf9929f6c0e2ecf790438b980b9c878ebb638a7ceb0f3404faf5ab722a0eeedc7d239513176a8806c5bd7963316228ab3cedc4e5a592fdea0f63
+  data.tar.gz: 140dd82771ccf6d1e97d427c7e60c00728e05389124a68b1dc9a6b24ef4fdbd2356dd2d1b3e7836afa17b70020fdff7f3e2a652c34eb6945cb40ef546cfa82a4

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/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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HTTParty
-  VERSION = '0.24.1'
+  VERSION = '0.24.2'
 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:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: httparty
 version: !ruby/object:Gem::Version
-  version: 0.24.1
+  version: 0.24.2
 platform: ruby
 authors:
 - John Nunemaker