faraday-multipart 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bd6e0b4dcb4d5905af5f8ee93c61a77858f13d1bfbbc00c3b9ea24091ef6af9
-  data.tar.gz: fd8d9f6e6cad9ad03e98e2b756be32c6862b23798552149d93568a6902bc6f19
+  metadata.gz: 5bd506d533ad9203184a3dac476941919f349e4565e81fa1521b8bc022f60f64
+  data.tar.gz: b34ae2db7c7d54de96ef743d2568c31066f2160ccc120d1b719e3fe6eb7141b0
 SHA512:
-  metadata.gz: b5644f53bad5e159723fbb174164270dc4de8668eac04d278004c9b11608337771f73295e73160125c954dd6a36b0af702bada137c4f9894a935517c3afc06e7
-  data.tar.gz: 37613553511b02097c04d4524e13fe1c3fc946b2549a07dc2b76e9519a570fa88f6f7717964c0cdbcf9425b09b46565cd8b8b73cd3cb8707ee597480d0c67f4b
+  metadata.gz: 3cb034f5f9fc6dbbb71225a967dcb81fdffdde7b7cd7790fe019e4f4c1b7e242f9df1726c6f2f8f0f33555d88613a6e6d75ebb50a638e939e9618d6dc7a65161
+  data.tar.gz: 37e5c0998d0ad5d40cd03cf3cdaf98e1f9473451035553bf61d1a8ba107ee53f62311080035520044b0b3053e1cb33bd2cd781d3480d11206197e96adc579099

data/CHANGELOG.md

@@ -1,5 +1,54 @@
 # Changelog
 
-## Unreleased
+## [1.0.4](https://github.com/lostisland/faraday-multipart/releases/tag/v1.0.4) (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.
+
+**Full Changelog**: https://github.com/lostisland/faraday-multipart/compare/v1.0.3...v1.0.4
+
+## [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

@@ -1,6 +1,6 @@
 # Faraday Multipart
 
-[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/lostisland/faraday-multipart/ci)](https://github.com/lostisland/faraday-multipart/actions?query=branch%3Amain)
+[![ci](https://github.com/lostisland/faraday-multipart/actions/workflows/ci.yaml/badge.svg)](https://github.com/lostisland/faraday-multipart/actions/workflows/ci.yaml)
 [![Gem](https://img.shields.io/gem/v/faraday-multipart.svg?style=flat-square)](https://rubygems.org/gems/faraday-multipart)
 [![License](https://img.shields.io/github/license/lostisland/faraday-multipart.svg?style=flat-square)](LICENSE.md)
 
@@ -42,10 +42,24 @@ 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
+```
+
+If you need to [specify a different content type for the multipart
+request](https://www.iana.org/assignments/media-types/media-types.xhtml#multipart),
+you can do so by providing the `content_type` option but it must start with
+`multipart/`
+otherwise it will default to `multipart/form-data`:
+
+```ruby
+conn = Faraday.new(...) do |f|
+  f.request :multipart, content_type: 'multipart/mixed'
   # ...
 end
 ```
@@ -91,6 +105,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 +157,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/middleware.rb

@@ -5,11 +5,10 @@ require 'securerandom'
 module Faraday
   module Multipart
     # Middleware for supporting multi-part requests.
-    class Middleware < Faraday::Request::UrlEncoded
+    class Middleware < Faraday::Middleware
+      CONTENT_TYPE = 'Content-Type'
       DEFAULT_BOUNDARY_PREFIX = '-----------RubyMultipartPost'
 
-      self.mime_type = 'multipart/form-data'
-
       def initialize(app = nil, options = {})
         super(app)
         @options = options
@@ -28,15 +27,37 @@ module Faraday
         @app.call env
       end
 
+      private
+
+      # @param env [Faraday::Env]
+      # @yield [request_body] Body of the request
+      def match_content_type(env)
+        return unless process_request?(env)
+
+        env.request_headers[CONTENT_TYPE] ||= mime_type
+        return if env.body.respond_to?(:to_str) || env.body.respond_to?(:read)
+
+        yield(env.body)
+      end
+
       # @param env [Faraday::Env]
       def process_request?(env)
         type = request_type(env)
         env.body.respond_to?(:each_key) && !env.body.empty? && (
           (type.empty? && has_multipart?(env.body)) ||
-            (type == self.class.mime_type)
+            (type == mime_type)
         )
       end
 
+      # @param env [Faraday::Env]
+      #
+      # @return [String]
+      def request_type(env)
+        type = env.request_headers[CONTENT_TYPE].to_s
+        type = type.split(';', 2).first if type.index(';')
+        type
+      end
+
       # Returns true if obj is an enumerable with values that are multipart.
       #
       # @param obj [Object]
@@ -97,6 +118,17 @@ module Faraday
           end
         end
       end
+
+      # Determines and provides the multipart mime type for the request.
+      #
+      # @return [String] the multipart mime type
+      def mime_type
+        @mime_type ||= if @options[:content_type].to_s.match?(%r{\Amultipart/.+})
+                         @options[:content_type].to_s
+                       else
+                         'multipart/form-data'
+                       end
+      end
     end
   end
 end

data/lib/faraday/multipart/version.rb

@@ -1,7 +1,16 @@
 # frozen_string_literal: true
 
 module Faraday
+  # #:nodoc:
   module Multipart
-    VERSION = '1.0.0'
+    VERSION = '1.1.0'
+
+    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,14 +1,26 @@
 # frozen_string_literal: true
 
-require 'faraday'
+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.
   module Multipart
     Faraday::Request.register_middleware(multipart: Faraday::Multipart::Middleware)
   end
+
+  # 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,155 +1,23 @@
 --- !ruby/object:Gem::Specification
 name: faraday-multipart
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Mattia Giuffrida
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-04 00:00:00.000000000 Z
+date: 2024-12-17 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: faraday
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
 - !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'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
-- !ruby/object:Gem::Dependency
-  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.21.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.21.0
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.21.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.21.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-packaging
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.5.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.5.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -178,12 +46,12 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/lostisland/faraday-multipart/issues
-  changelog_uri: https://github.com/lostisland/faraday-multipart/blob/v1.0.0/CHANGELOG.md
-  documentation_uri: http://www.rubydoc.info/gems/faraday-multipart/1.0.0
+  changelog_uri: https://github.com/lostisland/faraday-multipart/blob/v1.1.0/CHANGELOG.md
+  documentation_uri: http://www.rubydoc.info/gems/faraday-multipart/1.1.0
   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
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -191,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'
@@ -202,7 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Perform multipart-post requests using Faraday.
 test_files: []