faraday_middleware 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f76d03406442ddda70b51f788761197c2c78073134a684acf4a99abf24f03eb5
-  data.tar.gz: 0e2f92c6ea632aae478af7787dfbfc83765f80bbc78670be7e0e6d1b4706d721
+  metadata.gz: b9533a5d53e299a95e8b2aa19d277ac32ed800930c0abd4d92c67f025c98101d
+  data.tar.gz: 7261d4f25c4e0edeaaba0718947af74439d2fef8a114278a74f8de63f0f6c575
 SHA512:
-  metadata.gz: 6b4c9ac7430a3adca03f1911293ed6563be4d189b16b27d9096e77b6aae29c5cd634e0daf1667b69c222e427386da67be00e8eefbb9f0aeed749b146d1bc5187
-  data.tar.gz: 8959ff3fc916216ba8cf2ef713f140a77400ca74b200e703557f2b09a091c40bdfc62e9457e956ce95cc7a99c0060d8e93407d77158e28a174f16d66a5ca3b74
+  metadata.gz: 9ae2e4ea996bb4a2ad2762a7c0812c8734879205adb05eb88aed062f0be24b26fa18de82e6cc33c7c86dfc8f7c4fa8694522732c457643c8a4d3991e50ac095a
+  data.tar.gz: 512f5e9888e8adf5ac0d93c501470028079b463e407697353d55ef603b3a2590f46b9a6530a0a688a54e391fe9033302551f133b6d216281bf01c451e1a73f85

data/README.md

@@ -2,7 +2,6 @@ Faraday Middleware
 ==================
 [![Gem Version](https://badge.fury.io/rb/faraday_middleware.svg)](https://rubygems.org/gems/faraday_middleware)
 ![GitHub Actions CI](https://github.com/lostisland/faraday_middleware/workflows/CI/badge.svg)
-[![Maintainability](https://api.codeclimate.com/v1/badges/a971ee5025b269c39d93/maintainability)](https://codeclimate.com/github/lostisland/faraday_middleware/maintainability)
 
 A collection of useful [Faraday][] middleware. [See the documentation][docs].
 
@@ -19,12 +18,12 @@ Some dependent libraries are needed only when using specific middleware:
 
 | Middleware                  | Library        | Notes |
 | --------------------------- | -------------- | ----- |
-| [FaradayMiddleware::Instrumentation](https://github.com/lostisland/faraday_middleware/blob/master/lib/faraday_middleware/instrumentation.rb) | [`activesupport`](https://rubygems.org/gems/activesupport) |       |
-| [FaradayMiddleware::OAuth](https://github.com/lostisland/faraday_middleware/blob/master/lib/faraday_middleware/request/oauth.rb)    | [`simple_oauth`](https://rubygems.org/gems/simple_oauth) |       |
-| [FaradayMiddleware::ParseXml](https://github.com/lostisland/faraday_middleware/blob/master/lib/faraday_middleware/response/parse_xml.rb) | [`multi_xml`](https://rubygems.org/gems/multi_xml)    |       |
-| [FaradayMiddleware::ParseYaml](https://github.com/lostisland/faraday_middleware/blob/master/lib/faraday_middleware/response/parse_yaml.rb)  | [`safe_yaml`](https://rubygems.org/gems/safe_yaml)     | Not backwards compatible with versions of this middleware prior to `faraday_middleware` v0.12. See code comments for alternatives. |
-| [FaradayMiddleware::Mashify](https://github.com/lostisland/faraday_middleware/blob/master/lib/faraday_middleware/response/mashify.rb)  | [`hashie`](https://rubygems.org/gems/hashie)       |       |
-| [FaradayMiddleware::Rashify](https://github.com/lostisland/faraday_middleware/blob/master/lib/faraday_middleware/response/rashify.rb)  | [`rash_alt`](https://rubygems.org/gems/rash_alt)     | Make sure to uninstall original `rash` gem to avoid conflict. |
+| [FaradayMiddleware::Instrumentation](https://github.com/lostisland/faraday_middleware/blob/main/lib/faraday_middleware/instrumentation.rb) | [`activesupport`](https://rubygems.org/gems/activesupport) |       |
+| [FaradayMiddleware::OAuth](https://github.com/lostisland/faraday_middleware/blob/main/lib/faraday_middleware/request/oauth.rb)    | [`simple_oauth`](https://rubygems.org/gems/simple_oauth) |       |
+| [FaradayMiddleware::ParseXml](https://github.com/lostisland/faraday_middleware/blob/main/lib/faraday_middleware/response/parse_xml.rb) | [`multi_xml`](https://rubygems.org/gems/multi_xml)    |       |
+| [FaradayMiddleware::ParseYaml](https://github.com/lostisland/faraday_middleware/blob/main/lib/faraday_middleware/response/parse_yaml.rb)  | [`safe_yaml`](https://rubygems.org/gems/safe_yaml)     | Not backwards compatible with versions of this middleware prior to `faraday_middleware` v0.12. See code comments for alternatives. |
+| [FaradayMiddleware::Mashify](https://github.com/lostisland/faraday_middleware/blob/main/lib/faraday_middleware/response/mashify.rb)  | [`hashie`](https://rubygems.org/gems/hashie)       |       |
+| [FaradayMiddleware::Rashify](https://github.com/lostisland/faraday_middleware/blob/main/lib/faraday_middleware/response/rashify.rb)  | [`rash_alt`](https://rubygems.org/gems/rash_alt)     | Make sure to uninstall original `rash` gem to avoid conflict. |
 
 Examples
 --------

data/lib/faraday_middleware/rack_compatible.rb

@@ -80,9 +80,7 @@ module FaradayMiddleware
     def finalize_response(env, rack_response)
       status, headers, body = rack_response
       body = body.inject { |str, part| str << part }
-      unless headers.is_a?(Faraday::Utils::Headers)
-        headers = Faraday::Utils::Headers.new(headers)
-      end
+      headers = Faraday::Utils::Headers.new(headers) unless headers.is_a?(Faraday::Utils::Headers)
 
       env.update status: status.to_i,
                  body: body,

data/lib/faraday_middleware/request/encode_json.rb

@@ -27,7 +27,7 @@ module FaradayMiddleware
     end
 
     def encode(data)
-      ::JSON.dump data
+      ::JSON.generate data
     end
 
     def match_content_type(env)

data/lib/faraday_middleware/request/oauth.rb

@@ -38,9 +38,7 @@ module FaradayMiddleware
     end
 
     def call(env)
-      if sign_request?(env)
-        env[:request_headers][AUTH_HEADER] ||= oauth_header(env).to_s
-      end
+      env[:request_headers][AUTH_HEADER] ||= oauth_header(env).to_s if sign_request?(env)
       @app.call(env)
     end
 

data/lib/faraday_middleware/request/oauth2.rb

@@ -63,9 +63,7 @@ module FaradayMiddleware
       @param_name = options.fetch(:param_name, PARAM_NAME).to_s
       @token_type = options.fetch(:token_type, TOKEN_TYPE).to_s
 
-      if @token_type == 'param' && @param_name.empty?
-        raise ArgumentError, ":param_name can't be blank"
-      end
+      raise ArgumentError, ":param_name can't be blank" if @token_type == 'param' && @param_name.empty?
 
       return unless options[:token_type].nil?
 

data/lib/faraday_middleware/response/caching.rb

@@ -8,6 +8,7 @@ module FaradayMiddleware
   # Public: Caches GET responses and pulls subsequent ones from the cache.
   class Caching < Faraday::Middleware
     attr_reader :cache
+
     # Internal: List of status codes that can be cached:
     # * 200 - 'OK'
     # * 203 - 'Non-Authoritative Information'
@@ -26,14 +27,16 @@ module FaradayMiddleware
     # cache   - An object that responds to read and write (default: nil).
     # options - An options Hash (default: {}):
     #           :ignore_params - String name or Array names of query
-    #                            params that should be ignored when forming
-    #                            the cache key (default: []).
+    #                                    params that should be ignored when forming
+    #                                    the cache key (default: []).
     #           :write_options - Hash of settings that should be passed as the
-    #                            third options parameter to the cache's #write
-    #                            method. If not specified, no options parameter
-    #                            will be passed.
+    #                                    third options parameter to the cache's #write
+    #                                    method. If not specified, no options parameter
+    #                                    will be passed.
     #           :full_key      - Boolean - use full URL as cache key:
-    #                            (url.host + url.request_uri)
+    #                                    (url.host + url.request_uri)
+    #           :status_codes  - Array of http status code to be cache
+    #                                    (default: CACHEABLE_STATUS_CODE)
     #
     # Yields if no cache is given. The block should return a cache object.
     def initialize(app, cache = nil, options = {})
@@ -85,6 +88,13 @@ module FaradayMiddleware
       @full_key ||= @options[:full_key]
     end
 
+    def custom_status_codes
+      @custom_status_codes ||= begin
+        codes = CACHEABLE_STATUS_CODES & Array(@options[:status_codes]).map(&:to_i)
+        codes.any? ? codes : CACHEABLE_STATUS_CODES
+      end
+    end
+
     def cache_on_complete(env)
       key = cache_key(env)
       if (cached_response = cache.read(key))
@@ -100,7 +110,7 @@ module FaradayMiddleware
     end
 
     def store_response_in_cache(key, response)
-      return unless CACHEABLE_STATUS_CODES.include?(response.status)
+      return unless custom_status_codes.include?(response.status)
 
       if @options[:write_options]
         cache.write(key, response, @options[:write_options])

data/lib/faraday_middleware/response/follow_redirects.rb

@@ -133,7 +133,7 @@ module FaradayMiddleware
     def safe_escape(uri)
       uri = uri.split('#')[0] # we want to remove the fragment if present
       uri.to_s.gsub(URI_UNSAFE) do |match|
-        '%' + match.unpack('H2' * match.bytesize).join('%').upcase
+        "%#{match.unpack('H2' * match.bytesize).join('%').upcase}"
       end
     end
 

data/lib/faraday_middleware/response_middleware.rb

@@ -34,9 +34,7 @@ module FaradayMiddleware
 
     def call(environment)
       @app.call(environment).on_complete do |env|
-        if process_response_type?(response_type(env)) && parse_response?(env)
-          process_response(env)
-        end
+        process_response(env) if process_response_type?(response_type(env)) && parse_response?(env)
       end
     end
 
@@ -44,7 +42,7 @@ module FaradayMiddleware
       env[:raw_body] = env[:body] if preserve_raw?(env)
       env[:body] = parse(env[:body])
     rescue Faraday::ParsingError => e
-      raise Faraday::ParsingError.new(e, env[:response])
+      raise Faraday::ParsingError.new(e.wrapped_exception, env[:response])
     end
 
     # Parse the response body.

data/lib/faraday_middleware/version.rb

@@ -2,5 +2,5 @@
 
 # Main FaradayMiddleware module.
 module FaradayMiddleware
-  VERSION = '1.0.0' unless defined?(FaradayMiddleware::VERSION)
+  VERSION = '1.2.0' unless defined?(FaradayMiddleware::VERSION)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faraday_middleware
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Erik Michaels-Ober
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-29 00:00:00.000000000 Z
+date: 2021-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -76,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Various middleware for Faraday