faraday_middleware 0.9.2 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64c9daf051fce97f6b839b78e9def268977e3db9
-  data.tar.gz: f0cb5693d722bdf1097671a2e6f4ecdf8cf91049
+  metadata.gz: 2434c5fb11c290e271ebba1748a43ae5d320735e
+  data.tar.gz: e0bf3f73a45c469e8e2908ba102586299adb76b2
 SHA512:
-  metadata.gz: 00f5f605da468818380c4bf562e8d1cab6f20a5b6d175b7f10ed54a77eb12b1069ba167d3e4dd2e33225b2fba58044a7bcdf1176d7f79cd2b1c112ce9dad6fdb
-  data.tar.gz: ccae90f3b06312f241d28739ba818cbd4ab56f2e2886c84a6d38e6452999be54544d4e46d51b4128c1287544b6b1df5f57abbd2c2ead6ebb76c97e0668d1b9f9
+  metadata.gz: fcbbc5d1571c285bee8124873a91278ee3ce26eab0a7e6b5a08bf4c9a22cef8f7bd9ce13e29dc308f0c7f7537720b373a3ed4334141a009b7c971ba80f9cea92
+  data.tar.gz: acc1a19eb83cce409d3b7586714fd787b1830e7f03e222b688d9ad5a52b41ab0a142fdc1406cb8a0d6e89afc1b5bc0915c681394f16ec8d44d88eb468dc15bbc

data/lib/faraday_middleware.rb

@@ -17,6 +17,7 @@ module FaradayMiddleware
   autoload :RackCompatible,  'faraday_middleware/rack_compatible'
   autoload :FollowRedirects, 'faraday_middleware/response/follow_redirects'
   autoload :Instrumentation, 'faraday_middleware/instrumentation'
+  autoload :Gzip, 'faraday_middleware/gzip'
 
   if Faraday::Middleware.respond_to? :register_middleware
     Faraday::Request.register_middleware \
@@ -39,7 +40,8 @@ module FaradayMiddleware
       :chunked => lambda { Chunked }
 
     Faraday::Middleware.register_middleware \
-      :instrumentation  => lambda { Instrumentation }
+      :instrumentation  => lambda { Instrumentation },
+      :gzip => lambda { Gzip }
   end
 end
 

data/lib/faraday_middleware/gzip.rb

@@ -0,0 +1,54 @@
+require 'faraday'
+
+module FaradayMiddleware
+  # Middleware to automatically decompress response bodies. If the
+  # "Accept-Encoding" header wasn't set in the request, this sets it to
+  # "gzip,deflate" and appropriately handles the compressed response from the
+  # server. This resembles what Ruby 1.9+ does internally in Net::HTTP#get.
+  #
+  # This middleware is NOT necessary when these adapters are used:
+  # - net_http on Ruby 1.9+
+  # - net_http_persistent on Ruby 2.0+
+  # - em_http
+  class Gzip < Faraday::Middleware
+    dependency 'zlib'
+
+    ACCEPT_ENCODING = 'Accept-Encoding'.freeze
+    CONTENT_ENCODING = 'Content-Encoding'.freeze
+    CONTENT_LENGTH = 'Content-Length'.freeze
+    SUPPORTED_ENCODINGS = 'gzip,deflate'.freeze
+    RUBY_ENCODING = '1.9'.respond_to?(:force_encoding)
+
+    def call(env)
+      env[:request_headers][ACCEPT_ENCODING] ||= SUPPORTED_ENCODINGS
+      @app.call(env).on_complete do |response_env|
+        case response_env[:response_headers][CONTENT_ENCODING]
+        when 'gzip'
+          reset_body(response_env, &method(:uncompress_gzip))
+        when 'deflate'
+          reset_body(response_env, &method(:inflate))
+        end
+      end
+    end
+
+    def reset_body(env)
+      env[:body] = yield(env[:body])
+      env[:response_headers].delete(CONTENT_ENCODING)
+      env[:response_headers][CONTENT_LENGTH] = env[:body].length
+    end
+
+    def uncompress_gzip(body)
+      io = StringIO.new(body)
+      gzip_reader = if RUBY_ENCODING
+        Zlib::GzipReader.new(io, :encoding => 'ASCII-8BIT')
+      else
+        Zlib::GzipReader.new(io)
+      end
+      gzip_reader.read
+    end
+
+    def inflate(body)
+      Zlib::Inflate.inflate(body)
+    end
+  end
+end

data/lib/faraday_middleware/response/caching.rb

@@ -7,6 +7,15 @@ 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'
+    # * 300 - 'Multiple Choices'
+    # * 301 - 'Moved Permanently'
+    # * 302 - 'Found'
+    # * 404 - 'Not Found'
+    # * 410 - 'Gone'
+    CACHEABLE_STATUS_CODES = [200, 203, 300, 301, 302, 404, 410]
 
     extend Forwardable
     def_delegators :'Faraday::Utils', :parse_query, :build_query
@@ -34,7 +43,14 @@ module FaradayMiddleware
           cache_on_complete(env)
         else
           # synchronous mode
-          response = cache.fetch(cache_key(env)) { @app.call(env) }
+          key = cache_key(env)
+          unless response = cache.read(key) and response
+            response = @app.call(env)
+
+            if CACHEABLE_STATUS_CODES.include?(response.status)
+              cache.write(key, response)
+            end
+          end
           finalize_response(response, env)
         end
       else
@@ -63,7 +79,9 @@ module FaradayMiddleware
         finalize_response(cached_response, env)
       else
         response = @app.call(env)
-        response.on_complete { cache.write(key, response) }
+        if CACHEABLE_STATUS_CODES.include?(response.status)
+          response.on_complete { cache.write(key, response) }
+        end
       end
     end
 

data/lib/faraday_middleware/response/follow_redirects.rb

@@ -12,26 +12,24 @@ module FaradayMiddleware
     end
   end
 
-  # Public: Follow HTTP 301, 302, 303, and 307 redirects for GET, PATCH, POST,
-  # PUT, and DELETE requests.
+  # Public: Follow HTTP 301, 302, 303, and 307 redirects.
   #
-  # This middleware does not follow the HTTP specification for HTTP 302, by
-  # default, in that it follows the improper implementation used by most major
-  # web browsers which forces the redirected request to become a GET request
-  # regardless of the original request method.
+  # For HTTP 301, 302, and 303, the original GET, POST, PUT, DELETE, or PATCH
+  # request gets converted into a GET. With `:standards_compliant => true`,
+  # however, the HTTP method after 301/302 remains unchanged. This allows you
+  # to opt into HTTP/1.1 compliance and act unlike the major web browsers.
   #
-  # For HTTP 301, 302, and 303, the original request is transformed into a
-  # GET request to the response Location, by default. However, with standards
-  # compliance enabled, a 302 will instead act in accordance with the HTTP
-  # specification, which will replay the original request to the received
-  # Location, just as with a 307.
+  # This middleware currently only works with synchronous requests; i.e. it
+  # doesn't support parallelism.
   #
-  # For HTTP 307, the original request is replayed to the response Location,
-  # including original HTTP request method (GET, POST, PUT, DELETE, PATCH),
-  # original headers, and original body.
+  # If you wish to persist cookies across redirects, you could use
+  # the faraday-cookie_jar gem:
   #
-  # This middleware currently only works with synchronous requests; in other
-  # words, it doesn't support parallelism.
+  #   Faraday.new(:url => url) do |faraday|
+  #     faraday.use FaradayMiddleware::FollowRedirects
+  #     faraday.use :cookie_jar
+  #     faraday.adapter Faraday.default_adapter
+  #   end
   class FollowRedirects < Faraday::Middleware
     # HTTP methods for which 30x redirects can be followed
     ALLOWED_METHODS = Set.new [:head, :options, :get, :post, :put, :patch, :delete]
@@ -50,19 +48,16 @@ module FaradayMiddleware
     # Public: Initialize the middleware.
     #
     # options - An options Hash (default: {}):
-    #           limit - A Numeric redirect limit (default: 3)
-    #           standards_compliant - A Boolean indicating whether to respect
-    #                                 the HTTP spec when following 302
-    #                                 (default: false)
-    #          cookie - Use either an array of strings
-    #                  (e.g. ['cookie1', 'cookie2']) to choose kept cookies
-    #                  or :all to keep all cookies.
+    #           :limit               - A Numeric redirect limit (default: 3)
+    #           :standards_compliant - A Boolean indicating whether to respect
+    #                                  the HTTP spec when following 301/302
+    #                                  (default: false)
     def initialize(app, options = {})
       super(app)
       @options = options
 
-      @replay_request_codes = Set.new [307]
-      @replay_request_codes << 302 if standards_compliant?
+      @convert_to_get = Set.new [303]
+      @convert_to_get << 301 << 302 unless standards_compliant?
     end
 
     def call(env)
@@ -71,11 +66,9 @@ module FaradayMiddleware
 
     private
 
-    def transform_into_get?(response)
-      return false if [:head, :options].include? response.env[:method]
-      # Never convert head or options to a get. That would just be silly.
-
-      !@replay_request_codes.include? response.status
+    def convert_to_get?(response)
+      ![:head, :options].include?(response.env[:method]) &&
+        @convert_to_get.include?(response.status)
     end
 
     def perform_with_redirection(env, follows)
@@ -94,12 +87,8 @@ module FaradayMiddleware
 
     def update_env(env, request_body, response)
       env[:url] += safe_escape(response['location'])
-      if @options[:cookies]
-        cookies = keep_cookies(env)
-        env[:request_headers][:cookies] = cookies unless cookies.nil?
-      end
 
-      if transform_into_get?(response)
+      if convert_to_get?(response)
         env[:method] = :get
         env[:body] = nil
       else
@@ -120,25 +109,6 @@ module FaradayMiddleware
       @options.fetch(:limit, FOLLOW_LIMIT)
     end
 
-    def keep_cookies(env)
-      cookies = @options.fetch(:cookies, [])
-      response_cookies = env[:response_headers][:cookies]
-      cookies == :all ? response_cookies : selected_request_cookies(response_cookies)
-    end
-
-    def selected_request_cookies(cookies)
-      selected_cookies(cookies)[0...-1]
-    end
-
-    def selected_cookies(cookies)
-      "".tap do |cookie_string|
-        @options[:cookies].each do |cookie|
-          string = /#{cookie}=?[^;]*/.match(cookies)[0] + ';'
-          cookie_string << string
-        end
-      end
-    end
-
     def standards_compliant?
       @options.fetch(:standards_compliant, false)
     end

data/lib/faraday_middleware/version.rb

@@ -1,3 +1,3 @@
 module FaradayMiddleware
-  VERSION = "0.9.2" unless defined?(FaradayMiddleware::VERSION)
+  VERSION = "0.10.0" unless defined?(FaradayMiddleware::VERSION)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faraday_middleware
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.10.0
 platform: ruby
 authors:
 - Erik Michaels-Ober
@@ -61,6 +61,7 @@ files:
 - lib/faraday_middleware.rb
 - lib/faraday_middleware/addressable_patch.rb
 - lib/faraday_middleware/backwards_compatibility.rb
+- lib/faraday_middleware/gzip.rb
 - lib/faraday_middleware/instrumentation.rb
 - lib/faraday_middleware/rack_compatible.rb
 - lib/faraday_middleware/request/encode_json.rb