Class: FaradayMiddleware::Caching

Inherits:
Faraday::Middleware
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/faraday_middleware/response/caching.rb

Overview

Public: Caches GET responses and pulls subsequent ones from the cache.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(app, cache = nil, options = {}) ⇒ Caching

Public: initialize the middleware.

cache - An object that responds to read, write and fetch (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: []).

Yields if no cache is given. The block should return a cache object.



23
24
25
26
27
28
 
# File 'lib/faraday_middleware/response/caching.rb', line 23

def initialize(app, cache = nil, options = {})
  super(app)
  options, cache = cache, nil if cache.is_a? Hash and block_given?
  @cache = cache || yield
  @options = options
end

Instance Attribute Details

#cache ⇒ Object (readonly)

Returns the value of attribute cache.



9
10
11
 
# File 'lib/faraday_middleware/response/caching.rb', line 9

def cache
  @cache
end

Instance Method Details

#cache_key(env) ⇒ Object 



45
46
47
48
49
50
51
52
53
54
 
# File 'lib/faraday_middleware/response/caching.rb', line 45

def cache_key(env)
  url = env[:url].dup
  if url.query && params_to_ignore.any?
    params = parse_query url.query
    params.reject! {|k,| params_to_ignore.include? k }
    url.query = build_query params
  end
  url.normalize!
  url.request_uri
end

#cache_on_complete(env) ⇒ Object 



60
61
62
63
64
65
66
67
68
 
# File 'lib/faraday_middleware/response/caching.rb', line 60

def cache_on_complete(env)
  key = cache_key(env)
  if cached_response = cache.read(key)
    finalize_response(cached_response, env)
  else
    response = @app.call(env)
    response.on_complete { cache.write(key, response) }
  end
end

#call(env) ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/faraday_middleware/response/caching.rb', line 30

def call(env)
  if :get == env[:method]
    if env[:parallel_manager]
      # callback mode
      cache_on_complete(env)
    else
      # synchronous mode
      response = cache.fetch(cache_key(env)) { @app.call(env) }
      finalize_response(response, env)
    end
  else
    @app.call(env)
  end
end

#finalize_response(response, env) ⇒ Object 



70
71
72
73
74
75
76
77
78
79
 
# File 'lib/faraday_middleware/response/caching.rb', line 70

def finalize_response(response, env)
  response = response.dup if response.frozen?
  env[:response] = response
  unless env[:response_headers]
    env.update response.env
    # FIXME: omg hax
    response.instance_variable_set('@env', env)
  end
  response
end

#params_to_ignore ⇒ Object 



56
57
58
 
# File 'lib/faraday_middleware/response/caching.rb', line 56

def params_to_ignore
  @params_to_ignore ||= Array(@options[:ignore_params]).map { |p| p.to_s }
end