Class: Rack::Prerender

Inherits:
Object
  • Object
show all
Defined in:
lib/prerender_rails.rb

Instance Method Summary collapse

Constructor Details

#initialize(app, options = {}) ⇒ Prerender

Returns a new instance of Prerender.



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/prerender_rails.rb', line 5

def initialize(app, options={})
  @crawler_user_agents = [
    'googlebot',
    'yahoo',
    'bingbot',
    'baiduspider'
  ]

  @extensions_to_ignore = [
    '.js',
    '.css',
    '.less',
    '.png',
    '.jpg',
    '.jpeg',
    '.gif',
    '.pdf',
    '.doc'
  ]

  @options = options
  @options[:whitelist] = [@options[:whitelist]] if @options[:whitelist].is_a? String
  @options[:blacklist] = [@options[:blacklist]] if @options[:blacklist].is_a? String
  @app = app
end

Instance Method Details

#build_api_url(env) ⇒ Object 



85
86
87
88
89
90
 
# File 'lib/prerender_rails.rb', line 85

def build_api_url(env)
  url = Rack::Request.new(env).url
  prerender_url = get_prerender_service_url()
  forward_slash = prerender_url[-1, 1] == '/' ? '' : '/'
  "#{prerender_url}#{forward_slash}#{url}"
end

#call(env) ⇒ Object 



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

def call(env)

  if should_show_prerendered_page(env)
    prerendered_response = get_prerendered_page_response(env)

    if prerendered_response && prerendered_response.is_a?(Net::HTTPSuccess)
      response = Rack::Response.new(prerendered_response.body, 200, [])
      return response.finish
    end
  end

  @app.call(env)  
end

#get_prerender_service_url ⇒ Object 



92
93
94
 
# File 'lib/prerender_rails.rb', line 92

def get_prerender_service_url
  ENV['PRERENDER_SERVICE_URL'] || 'http://prerender.herokuapp.com/'
end

#get_prerendered_page_response(env) ⇒ Object 



77
78
79
80
81
82
83
 
# File 'lib/prerender_rails.rb', line 77

def get_prerendered_page_response(env)
  begin
    Net::HTTP.get_response(URI.parse(build_api_url(env)))
  rescue
    nil
  end
end

#should_show_prerendered_page(env) ⇒ Object 



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/prerender_rails.rb', line 45

def should_show_prerendered_page(env)
  user_agent = env['HTTP_USER_AGENT']
  return false if !user_agent

  request = Rack::Request.new(env)

  #if it is not a bot...dont prerender
  return false if !@crawler_user_agents.include?(user_agent.downcase)

  #if it is a bot and is requesting a resource...dont prerender
  return false if @extensions_to_ignore.any? { |extension| request.path.include? extension }

  #if it is a bot and not requesting a resource and is not whitelisted...dont prerender
  return false if @options[:whitelist].is_a?(Array) && @options[:whitelist].all? { |whitelisted| !!Regexp.new(whitelisted).match(request.path) }

  #if it is a bot and not requesting a resource and is not blacklisted(url or referer)...dont prerender
  if @options[:blacklist].is_a?(Array) && @options[:blacklist].any? { |blacklisted|
      blacklistedUrl = false
      blacklistedReferer = false
      regex = Regexp.new(blacklisted)

      blacklistedUrl = !!regex.match(request.path)
      blacklistedReferer = !!regex.match(request.referer) if request.referer

      blacklistedUrl || blacklistedReferer
    }
    return false
  end 

  return true
end