faraday 2.14.3 → 2.14.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecc5e9592d7434d7e39bc5cc827be5b62af99e258582468c8b6fd78e0122bf7e
-  data.tar.gz: 4f5728ac524a3456a800c8d0159b4569173b1c841f80fae7d0d2704e261b6588
+  metadata.gz: bfb9bdb4e8b26d58a269ecb088231f9b6b3fa41dcba2e45030e148e3fed39c85
+  data.tar.gz: f14d4a3d9fde7a433af42981764ef381347fbbe96414fe0f576a5d9e7d32c12e
 SHA512:
-  metadata.gz: 12567175cd7d08a95ccf8203bffcb9bebf8d1b52f279ce034c3f3e17dc5efc81e08259c2992ff792560ed626dd59ae305c163cb43018860b3c0ae833c3f68855
-  data.tar.gz: bb786c688b4629c6bc43e4715715fcd42de120eee3802a3614eca60e17627ff77f40298af500a431158b1f1de8bd0d0bd58817a8793bab92e11bac9aa9b482f2
+  metadata.gz: 3f757a719af96c446b1c90a02ed43a190b551c489c72c4f158f041c8afdcec9385903e28f057929c217cdd29ed2a396316ffc650c66352be26503edd2a70eefa
+  data.tar.gz: b34d0e1b1816abc2ae2987088abc08153acc0786582e742fe384418e8b8fc3ae4f5ee14b3e768d1f06ba8b1b44b4a10effd61858297db08e47775cf712e7f190

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2009-2023 Rick Olson, Zack Hobson
+Copyright (c) 2009-2026 Rick Olson, Zack Hobson
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -58,7 +58,7 @@ But before you start coding, please read our [Contributing Guide][contributing]
 
 ## Copyright
 
-© 2009 - 2023, the Faraday Team. Website and branding design by [Elena Lo Piccolo](https://elelopic.design).
+© 2009 - 2026, the Faraday Team. Website and branding design by [Elena Lo Piccolo](https://elelopic.design).
 
 [awesome]: https://github.com/lostisland/awesome-faraday/#adapters
 [website]: https://lostisland.github.io/faraday

data/lib/faraday/options/connection_options.rb

@@ -4,6 +4,33 @@ module Faraday
   # @!parse
   #   # ConnectionOptions contains the configurable properties for a Faraday
   #   # connection object.
+  #   #
+  #   # @!attribute request
+  #   #   @return [RequestOptions] default request options for the connection
+  #   #
+  #   # @!attribute proxy
+  #   #   @return [ProxyOptions] proxy options for the connection
+  #   #
+  #   # @!attribute ssl
+  #   #   @return [SSLOptions] SSL options for the connection
+  #   #
+  #   # @!attribute builder
+  #   #   @return [RackBuilder] the middleware stack builder for the connection
+  #   #
+  #   # @!attribute url
+  #   #   @return [String, URI] the base URL for the connection
+  #   #
+  #   # @!attribute parallel_manager
+  #   #   @return [Object] manager used when the connection runs in parallel mode
+  #   #
+  #   # @!attribute params
+  #   #   @return [Hash] default query parameters for the connection
+  #   #
+  #   # @!attribute headers
+  #   #   @return [Hash] default headers for the connection
+  #   #
+  #   # @!attribute builder_class
+  #   #   @return [Class] the class used to build the middleware stack
   #   class ConnectionOptions < Options; end
   ConnectionOptions = Options.new(:request, :proxy, :ssl, :builder, :url,
                                   :parallel_manager, :params, :headers,

data/lib/faraday/options/proxy_options.rb

@@ -4,6 +4,15 @@ module Faraday
   # @!parse
   #   # ProxyOptions contains the configurable properties for the proxy
   #   # configuration used when making an HTTP request.
+  #   #
+  #   # @!attribute uri
+  #   #   @return [URI] the proxy server URI
+  #   #
+  #   # @!attribute user
+  #   #   @return [String] the proxy server username
+  #   #
+  #   # @!attribute password
+  #   #   @return [String] the proxy server password
   #   class ProxyOptions < Options; end
   ProxyOptions = Options.new(:uri, :user, :password) do
     extend Forwardable

data/lib/faraday/options/request_options.rb

@@ -3,6 +3,41 @@
 module Faraday
   # @!parse
   #   # RequestOptions contains the configurable properties for a Faraday request.
+  #   #
+  #   # @!attribute params_encoder
+  #   #   @return [Object] the params encoder used to serialize the request params
+  #   #
+  #   # @!attribute proxy
+  #   #   @return [ProxyOptions] proxy options for this request
+  #   #
+  #   # @!attribute bind
+  #   #   @return [Hash] the local host and port to bind the connection to
+  #   #
+  #   # @!attribute timeout
+  #   #   @return [Integer] time limit for the entire request (in seconds)
+  #   #
+  #   # @!attribute open_timeout
+  #   #   @return [Integer] time limit for just the connection phase (in seconds)
+  #   #
+  #   # @!attribute read_timeout
+  #   #   @return [Integer] time limit for the first response byte received from
+  #   #           the server (in seconds)
+  #   #
+  #   # @!attribute write_timeout
+  #   #   @return [Integer] time limit for the client to send the request to the
+  #   #           server (in seconds)
+  #   #
+  #   # @!attribute boundary
+  #   #   @return [String] the boundary used for multipart request bodies
+  #   #
+  #   # @!attribute oauth
+  #   #   @return [Hash] OAuth options used by the OAuth middleware
+  #   #
+  #   # @!attribute context
+  #   #   @return [Hash] free-form storage carried alongside the request
+  #   #
+  #   # @!attribute on_data
+  #   #   @return [Proc] callback invoked with each chunk when streaming the response
   #   class RequestOptions < Options; end
   RequestOptions = Options.new(:params_encoder, :proxy, :bind,
                                :timeout, :open_timeout, :read_timeout,

data/lib/faraday/response/json.rb

@@ -8,7 +8,7 @@ module Faraday
     class Json < Middleware
       def initialize(app = nil, parser_options: nil, content_type: /\bjson$/, preserve_raw: false)
         super(app)
-        @parser_options = parser_options
+        @parser_options = parser_options&.dup
         @content_types = Array(content_type)
         @preserve_raw = preserve_raw
 
@@ -33,7 +33,7 @@ module Faraday
 
         decoder, method_name = @decoder_options
 
-        decoder.public_send(method_name, body, @parser_options || {})
+        decoder.public_send(method_name, body, **(@parser_options || {}))
       end
 
       def parse_response?(env)

data/lib/faraday/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Faraday
-  VERSION = '2.14.3'
+  VERSION = '2.14.4'
 end

data/lib/faraday.rb

@@ -137,6 +137,38 @@ module Faraday
       @default_connection_options = ConnectionOptions.from(options)
     end
 
+    # HTTP verb methods, forwarded to {.default_connection}.
+    #
+    # They take the same arguments as their {Faraday::Connection} counterparts,
+    # see {Faraday::Connection#get} and {Faraday::Connection#post}.
+    # Defining them here rather than relying on {method_missing} keeps them
+    # visible to `Faraday.methods`, `pry`'s `ls`, documentation tools and
+    # editor autocomplete.
+
+    # @!visibility private
+    METHODS_WITH_QUERY.each do |method|
+      class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        # def get(url = nil, params = nil, headers = nil, &block)
+        #   default_connection.get(url, params, headers, &block)
+        # end
+        def #{method}(url = nil, params = nil, headers = nil, &block)
+          default_connection.#{method}(url, params, headers, &block)
+        end
+      RUBY
+    end
+
+    # @!visibility private
+    METHODS_WITH_BODY.each do |method|
+      class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        # def post(url = nil, body = nil, headers = nil, &block)
+        #   default_connection.post(url, body, headers, &block)
+        # end
+        def #{method}(url = nil, body = nil, headers = nil, &block)
+          default_connection.#{method}(url, body, headers, &block)
+        end
+      RUBY
+    end
+
     private
 
     # Internal: Proxies method calls on the Faraday constant to

data/spec/faraday_spec.rb

@@ -40,4 +40,30 @@ RSpec.describe Faraday do
       Faraday.default_connection = nil
     end
   end
+
+  context 'HTTP verb methods' do
+    let(:mock_connection) { double('Connection') }
+
+    before do
+      Faraday.default_connection = mock_connection
+    end
+
+    (Faraday::METHODS_WITH_QUERY + Faraday::METHODS_WITH_BODY).each do |http_method|
+      it "defines .#{http_method} and forwards it to the default_connection" do
+        expect(Faraday.singleton_class.instance_methods(false)).to include(http_method.to_sym)
+
+        block = proc { |request| request }
+        expect(mock_connection).to receive(http_method) do |*args, &blk|
+          expect(args).to eq(['/foo', { page: 1 }, { 'X-Custom' => 'yes' }])
+          expect(blk).to be(block)
+        end
+
+        Faraday.public_send(http_method, '/foo', { page: 1 }, { 'X-Custom' => 'yes' }, &block)
+      end
+    end
+
+    after do
+      Faraday.default_connection = nil
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -24,9 +24,18 @@ WebMock.disable_net_connect!(allow_localhost: true)
 SimpleCov.formatters = [SimpleCov::Formatter::HTMLFormatter, Coveralls::SimpleCov::Formatter]
 
 SimpleCov.start do
-  add_filter '/spec/'
   minimum_coverage 84
-  minimum_coverage_by_file 26
+
+  # SimpleCov 1.0 first, then older.
+  if SimpleCov.respond_to?(:skip)
+    skip '/spec/'
+    skip '/tmp/'
+    coverage(:line) { minimum 26, per: :file }
+  else
+    add_filter '/spec/'
+    add_filter '/tmp/'
+    minimum_coverage_by_file 26
+  end
 end
 
 require 'faraday'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faraday
 version: !ruby/object:Gem::Version
-  version: 2.14.3
+  version: 2.14.4
 platform: ruby
 authors:
 - "@technoweenie"
@@ -144,7 +144,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://lostisland.github.io/faraday
-  changelog_uri: https://github.com/lostisland/faraday/releases/tag/v2.14.3
+  changelog_uri: https://github.com/lostisland/faraday/releases/tag/v2.14.4
   source_code_uri: https://github.com/lostisland/faraday
   bug_tracker_uri: https://github.com/lostisland/faraday/issues
   rubygems_mfa_required: 'true'