faraday-multipart 1.0.1 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f89d6d75b77306ce8ae98d5f67bfb374f2d8c1abb3d93e140f03145cd3af9bf4
-  data.tar.gz: 53409e6a8ef44fde13e5dae1cd651be72b0c6c530702cb1fc5f5f7e7e321da08
+  metadata.gz: 003f27fac04888822e0601b1ff9e67a374d3a07a77cdaa2a59e929956228fe6c
+  data.tar.gz: e8bf33e1089e8e3f4b9b2326edcd2e2bb2c32f87bb89b2336b798fed5806c942
 SHA512:
-  metadata.gz: 8ba9da6eb5446afb9b351d6ccef7922a395e9310a675864ed72eca191daedb44cd521cbbf94b151f29ef20b7a8c1a178ca9c63d9363262bc7b6606352c4708b0
-  data.tar.gz: 7a846e4401f7ea6a890c181f59da570c83b88bd89e7f311f3b26ae8f36ac3ac1748d95dbc46aed1f6763bf4c72222f7f049f6d2d1ed7f6db04d9d63ea6f2bb82
+  metadata.gz: 8cc6c3ac2a717c353e035f4de9b7486142df5c6266f2464db3dbd533fa4d8236f64498e7cf00b22d8afc3d17fd34d5d387d5665908454061495199ebb031cab7
+  data.tar.gz: b59ce976a29a837ff68953db793d28565d8a5579c808d8ce758cdb4663a0bca1e7ce802ab98152874b79dcaea47faa9177578e1b1eae464c5701ecf5dbe20751

data/CHANGELOG.md

@@ -1,5 +1,52 @@
 # Changelog
 
-## Unreleased
+## [1.0.4](https://github.com/lostisland/faraday-multipart/releases/tag/v1.0.3) (2022-06-07)
 
-*   Initial release.
+### What's Changed
+
+* Drop support for 'multipart-post' < 2.0.0. This is not a breaking change as this gem's code didn't work with 1.x.
+* Change references to `UploadIO` and `Parts` according to class reorganization in the 'multipart-post' gem 2.2.0 (see [multipart-post gem PR #89](https://github.com/socketry/multipart-post/pull/89))
+* Introduce a backwards compatible safeguard so the gem still works with previous 'multipart-post' 2.x releases.
+
+## [1.0.3](https://github.com/lostisland/faraday-multipart/releases/tag/v1.0.3) (2022-01-08)
+
+### What's Changed
+
+* Add `Faraday::ParamPart` alias back by @iMacTia in https://github.com/lostisland/faraday-multipart/pull/2
+
+**Full Changelog**: https://github.com/lostisland/faraday-multipart/compare/v1.0.2...v1.0.3
+
+## [1.0.2](https://github.com/lostisland/faraday-multipart/releases/tag/v1.0.2) (2022-01-06)
+
+### Fixes
+
+* Add missing UploadIO alias
+* Re-add support for Ruby 2.4+
+
+**Full Changelog**: https://github.com/lostisland/faraday-multipart/compare/v1.0.1...v1.0.2
+
+## [1.0.1](https://github.com/lostisland/faraday-multipart/releases/tag/v1.0.1) (2022-01-06)
+
+### What's Changed
+* Add support for Faraday v1 by @iMacTia in https://github.com/lostisland/faraday-multipart/pull/1
+
+**Full Changelog**: https://github.com/lostisland/faraday-multipart/compare/v1.0.0...v1.0.1
+
+## [1.0.0](https://github.com/lostisland/faraday-multipart/releases/tag/v1.0.0) (2022-01-04)
+
+### Summary
+
+The initial release of the `faraday-multipart` gem.
+
+This middleware was previously bundled with Faraday but was removed as of v2.0.
+
+### MIGRATION NOTES
+
+If you're upgrading from Faraday 1.0 and including this middleware as a gem, please be aware the namespacing for helper classes has changed:
+
+* `Faraday::FilePart` is now `Faraday::Multipart::FilePart`
+* `Faraday::Parts` is now `Faraday::Multipart::Parts`
+* `Faraday::CompositeReadIO` is now `Faraday::Multipart::CompositeReadIO`
+* `Faraday::ParamPart` is now `Faraday::Multipart::ParamPart`
+
+Moreover, in case you're adding the middleware to your faraday connection with the full qualified name rather than the `:multipart` alias, please be aware the middleware class is now `Faraday::Multipart::Middleware`.

data/README.md

@@ -42,14 +42,16 @@ gem install faraday-multipart
 First of all, you'll need to add the multipart middleware to your Faraday connection:
 
 ```ruby
+require 'faraday'
 require 'faraday/multipart'
 
 conn = Faraday.new(...) do |f|
-  f.request :multipart
+  f.request :multipart, **options
   # ...
 end
 ```
 
+
 Payload can be a mix of POST data and multipart values.
 
 ```ruby
@@ -91,6 +93,50 @@ payload[:raw_with_id] = Faraday::Multipart::ParamPart.new(
 conn.post('/', payload)
 ```
 
+### Sending an array of documents
+
+Sometimes, the server you're calling will expect an array of documents or other values for the same key.
+The `multipart` middleware will automatically handle this scenario for you:
+
+```ruby
+payload = {
+  files: [
+    Faraday::Multipart::FilePart.new(__FILE__, 'text/x-ruby'),
+    Faraday::Multipart::FilePart.new(__FILE__, 'text/x-pdf')
+  ],
+  url: [
+    'http://mydomain.com/callback1',
+    'http://mydomain.com/callback2'
+  ]
+}
+
+conn.post(url, payload)
+#=> POST url[]=http://mydomain.com/callback1&url[]=http://mydomain.com/callback2
+#=>   and includes both files in the request under the `files[]` name
+```
+
+However, by default these will be sent with `files[]` key and the URLs with `url[]`, similarly to arrays in URL parameters.
+Some servers (e.g. Mailgun) expect each document to have the same parameter key instead.
+You can instruct the `multipart` middleware to do so by providing the `flat_encode` option:
+
+```ruby
+require 'faraday'
+require 'faraday/multipart'
+
+conn = Faraday.new(...) do |f|
+  f.request :multipart, flat_encode: true
+  # ...
+end
+
+payload = ... # see example above
+
+conn.post(url, payload)
+#=> POST url=http://mydomain.com/callback1&url=http://mydomain.com/callback2
+#=>   and includes both files in the request under the `files` name
+```
+
+This works for both `UploadIO` and normal parameters alike.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.
@@ -99,8 +145,9 @@ Then, run `bin/test` to run the tests.
 
 To install this gem onto your local machine, run `rake build`.
 
-To release a new version, make a commit with a message such as "Bumped to 0.0.2" and then run `rake release`. See how it
-works [here](https://bundler.io/guides/creating_gem.html#releasing-the-gem).
+### Releasing a new version
+
+To release a new version, make a commit with a message such as "Bumped to 0.0.2", and change the _Unreleased_ heading in `CHANGELOG.md` to a heading like "0.0.2 (2022-01-01)", and then use GitHub Releases to author a release. A GitHub Actions workflow then publishes a new gem to [RubyGems.org](https://rubygems.org/gems/faraday-multipart).
 
 ## Contributing
 

data/lib/faraday/multipart/file_part.rb

@@ -2,11 +2,10 @@
 
 require 'stringio'
 
-# multipart-post gem
-require 'composite_io'
-require 'parts'
-
 module Faraday
+  # Rubocop doesn't seem to understand that this is an extension to the
+  # Multipart module, so let's add a nodoc
+  # #:nodoc:
   module Multipart
     # Multipart value used to POST a binary data from a file or
     #
@@ -51,9 +50,16 @@ module Faraday
     # The open IO object for the uploaded file.
     #
     # @return [IO]
-    FilePart = ::UploadIO
-
-    Parts = ::Parts
+    if ::Gem::Requirement.new('>= 2.2.0').satisfied_by?(multipart_post_version)
+      require 'multipart/post'
+      FilePart = ::Multipart::Post::UploadIO
+      Parts = ::Multipart::Post::Parts
+    else
+      require 'composite_io'
+      require 'parts'
+      FilePart = ::UploadIO
+      Parts = ::Parts
+    end
 
     # Similar to, but not compatible with CompositeReadIO provided by the
     # multipart-post gem.

data/lib/faraday/multipart/version.rb

@@ -1,7 +1,16 @@
 # frozen_string_literal: true
 
 module Faraday
+  # #:nodoc:
   module Multipart
-    VERSION = '1.0.1'
+    VERSION = '1.0.4'
+
+    def self.multipart_post_version
+      require 'multipart/post/version'
+      ::Gem::Version.new(::Multipart::Post::VERSION)
+    rescue LoadError
+      require 'multipart_post'
+      ::Gem::Version.new(::MultipartPost::VERSION)
+    end
   end
 end

data/lib/faraday/multipart.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
+require_relative 'multipart/version'
 require_relative 'multipart/file_part'
 require_relative 'multipart/param_part'
 require_relative 'multipart/middleware'
-require_relative 'multipart/version'
 
 module Faraday
   # Main Faraday::Multipart module.
@@ -11,8 +11,16 @@ module Faraday
     Faraday::Request.register_middleware(multipart: Faraday::Multipart::Middleware)
   end
 
-  # Aliases for Faraday v1
+  # Aliases for Faraday v1, these are all deprecated and will be removed in v2 of this middleware
   FilePart = Multipart::FilePart
+  ParamPart = Multipart::ParamPart
   Parts = Multipart::Parts
   CompositeReadIO = Multipart::CompositeReadIO
+  # multipart-post v2.2.0 introduces a new class hierarchy for classes like Parts and UploadIO
+  # For backwards compatibility, detect the gem version and use the right class
+  UploadIO = if ::Gem::Requirement.new('>= 2.2.0').satisfied_by?(Multipart.multipart_post_version)
+               ::Multipart::Post::UploadIO
+             else
+               ::UploadIO
+             end
 end

metadata

@@ -1,35 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: faraday-multipart
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.4
 platform: ruby
 authors:
 - Mattia Giuffrida
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-06 00:00:00.000000000 Z
+date: 2022-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multipart-post
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.2'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '2'
 description: 'Perform multipart-post requests using Faraday.
 
   '
@@ -52,8 +46,8 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/lostisland/faraday-multipart/issues
-  changelog_uri: https://github.com/lostisland/faraday-multipart/blob/v1.0.1/CHANGELOG.md
-  documentation_uri: http://www.rubydoc.info/gems/faraday-multipart/1.0.1
+  changelog_uri: https://github.com/lostisland/faraday-multipart/blob/v1.0.4/CHANGELOG.md
+  documentation_uri: http://www.rubydoc.info/gems/faraday-multipart/1.0.4
   homepage_uri: https://github.com/lostisland/faraday-multipart
   source_code_uri: https://github.com/lostisland/faraday-multipart
   wiki_uri: https://github.com/lostisland/faraday-multipart/wiki
@@ -65,7 +59,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.4'
   - - "<"
     - !ruby/object:Gem::Version
       version: '4'