Class: ActiveRecordApi::Request::FaradayFollowNextLinks

Inherits:
Faraday::Middleware
  • Object
show all
Defined in:
lib/active_record_api/request/faraday_follow_next_links.rb

Constant Summary collapse

ENV_TO_CLEAR = 
%i[status response response_headers].to_set.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(app, max_pages = nil) ⇒ FaradayFollowNextLinks

Returns a new instance of FaradayFollowNextLinks.



10
11
12
13
 
# File 'lib/active_record_api/request/faraday_follow_next_links.rb', line 10

def initialize(app, max_pages = nil)
  super(app)
  @max_pages = max_pages
end

Instance Attribute Details

#max_pages ⇒ Object (readonly)

Returns the value of attribute max_pages.



8
9
10
 
# File 'lib/active_record_api/request/faraday_follow_next_links.rb', line 8

def max_pages
  @max_pages
end

Instance Method Details

#call(env) ⇒ Object 



15
16
17
18
19
20
21
 
# File 'lib/active_record_api/request/faraday_follow_next_links.rb', line 15

def call(env)
  if :get == env[:method]
    perform_with_next_links(env, max_pages)
  else
    @app.call(env)
  end
end

#handle_response(env, request_body, response_env, max_pages_left) ⇒ Object 



39
40
41
42
43
44
 
# File 'lib/active_record_api/request/faraday_follow_next_links.rb', line 39

def handle_response(env, request_body, response_env, max_pages_left)
  return unless env[:body].is_a?(Array)
  new_request_env = update_env(response_env.dup, request_body, next_link(env))
  max_pages_left -= 1 unless max_pages_left.nil?
  env[:body] += perform_with_next_links(new_request_env, max_pages_left).body
end

#next_link(env) ⇒ Object 



35
36
37
 
# File 'lib/active_record_api/request/faraday_follow_next_links.rb', line 35

def next_link(env)
  env.response.headers.fetch('x-link-next', nil)
end

#perform_with_next_links(env, max_pages_left) ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/active_record_api/request/faraday_follow_next_links.rb', line 23

def perform_with_next_links(env, max_pages_left)
  request_body = env[:body]
  response = @app.call(env)
  response.on_complete do |response_env|
    if next_link(env).present?
      raise FaradayMiddleware::RedirectLimitReached, response if max_pages_left == 0
      handle_response(env, request_body, response_env, max_pages_left)
    end
  end
  response
end

#update_env(env, request_body, next_link) ⇒ Object 



46
47
48
49
50
51
 
# File 'lib/active_record_api/request/faraday_follow_next_links.rb', line 46

def update_env(env, request_body, next_link)
  env[:url] = URI.parse(next_link)
  env[:body] = request_body
  ENV_TO_CLEAR.each { |key| env.delete key }
  env
end