Class: Rack::Prerender
- Inherits:
-
Object
- Object
- Rack::Prerender
- Defined in:
- lib/prerender_rails.rb
Instance Method Summary collapse
- #after_render(env, response) ⇒ Object
- #before_render(env) ⇒ Object
- #build_api_url(env) ⇒ Object
- #build_rack_response_from_prerender(prerendered_response) ⇒ Object
- #call(env) ⇒ Object
- #get_prerender_service_url ⇒ Object
- #get_prerendered_page_response(env) ⇒ Object
-
#initialize(app, options = {}) ⇒ Prerender
constructor
A new instance of Prerender.
- #should_show_prerendered_page(env) ⇒ Object
Constructor Details
#initialize(app, options = {}) ⇒ Prerender
Returns a new instance of Prerender.
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 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 76 77 78 |
# File 'lib/prerender_rails.rb', line 6 def initialize(app, ={}) # googlebot, yahoo, and bingbot are not in this list because # we support _escaped_fragment_ and want to ensure people aren't # penalized for cloaking. @crawler_user_agents = [ # 'googlebot', # 'yahoo', # 'bingbot', 'baiduspider', 'facebookexternalhit', 'twitterbot', 'rogerbot', 'linkedinbot', 'embedly', 'bufferbot', 'quora link preview', 'showyoubot', 'outbrain', 'pinterest', 'developers.google.com/+/web/snippet', 'slackbot', 'vkShare', 'W3C_Validator' ] @extensions_to_ignore = [ '.js', '.css', '.xml', '.less', '.png', '.jpg', '.jpeg', '.gif', '.pdf', '.doc', '.txt', '.ico', '.rss', '.zip', '.mp3', '.rar', '.exe', '.wmv', '.doc', '.avi', '.ppt', '.mpg', '.mpeg', '.tif', '.wav', '.mov', '.psd', '.ai', '.xls', '.mp4', '.m4a', '.swf', '.dat', '.dmg', '.iso', '.flv', '.m4v', '.torrent' ] @options = @options[:whitelist] = [@options[:whitelist]] if @options[:whitelist].is_a? String @options[:blacklist] = [@options[:blacklist]] if @options[:blacklist].is_a? String @extensions_to_ignore = @options[:extensions_to_ignore] if @options[:extensions_to_ignore] @crawler_user_agents = @options[:crawler_user_agents] if @options[:crawler_user_agents] @app = app end |
Instance Method Details
#after_render(env, response) ⇒ Object
222 223 224 225 |
# File 'lib/prerender_rails.rb', line 222 def after_render(env, response) return true unless @options[:after_render] @options[:after_render].call(env, response) end |
#before_render(env) ⇒ Object
207 208 209 210 211 212 213 214 215 216 217 218 219 |
# File 'lib/prerender_rails.rb', line 207 def before_render(env) return nil unless @options[:before_render] cached_render = @options[:before_render].call(env) if cached_render && cached_render.is_a?(String) Rack::Response.new(cached_render, 200, []) elsif cached_render && cached_render.is_a?(Rack::Response) cached_render else nil end end |
#build_api_url(env) ⇒ Object
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 |
# File 'lib/prerender_rails.rb', line 169 def build_api_url(env) new_env = env if env["CF-VISITOR"] match = /"scheme":"(http|https)"/.match(env['CF-VISITOR']) new_env["HTTPS"] = true and new_env["rack.url_scheme"] = "https" and new_env["SERVER_PORT"] = 443 if (match && match[1] == "https") new_env["HTTPS"] = false and new_env["rack.url_scheme"] = "http" and new_env["SERVER_PORT"] = 80 if (match && match[1] == "http") end if env["X-FORWARDED-PROTO"] new_env["HTTPS"] = true and new_env["rack.url_scheme"] = "https" and new_env["SERVER_PORT"] = 443 if env["X-FORWARDED-PROTO"].split(',')[0] == "https" new_env["HTTPS"] = false and new_env["rack.url_scheme"] = "http" and new_env["SERVER_PORT"] = 80 if env["X-FORWARDED-PROTO"].split(',')[0] == "http" end if @options[:protocol] new_env["HTTPS"] = true and new_env["rack.url_scheme"] = "https" and new_env["SERVER_PORT"] = 443 if @options[:protocol] == "https" new_env["HTTPS"] = false and new_env["rack.url_scheme"] = "http" and new_env["SERVER_PORT"] = 80 if @options[:protocol] == "http" end url = Rack::Request.new(new_env).url prerender_url = get_prerender_service_url() forward_slash = prerender_url[-1, 1] == '/' ? '' : '/' "#{prerender_url}#{forward_slash}#{url}" end |
#build_rack_response_from_prerender(prerendered_response) ⇒ Object
199 200 201 202 203 204 205 |
# File 'lib/prerender_rails.rb', line 199 def build_rack_response_from_prerender(prerendered_response) response = Rack::Response.new(prerendered_response.body, prerendered_response.code, prerendered_response.header) @options[:build_rack_response_from_prerender].call(response, prerendered_response) if @options[:build_rack_response_from_prerender] response end |
#call(env) ⇒ Object
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 |
# File 'lib/prerender_rails.rb', line 81 def call(env) if should_show_prerendered_page(env) cached_response = before_render(env) if cached_response return cached_response.finish end prerendered_response = get_prerendered_page_response(env) if prerendered_response response = build_rack_response_from_prerender(prerendered_response) after_render(env, prerendered_response) return response.finish end end @app.call(env) end |
#get_prerender_service_url ⇒ Object
194 195 196 |
# File 'lib/prerender_rails.rb', line 194 def get_prerender_service_url @options[:prerender_service_url] || ENV['PRERENDER_SERVICE_URL'] || 'http://service.prerender.io/' end |
#get_prerendered_page_response(env) ⇒ Object
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 |
# File 'lib/prerender_rails.rb', line 145 def get_prerendered_page_response(env) begin url = URI.parse(build_api_url(env)) headers = { 'User-Agent' => env['HTTP_USER_AGENT'], 'Accept-Encoding' => 'gzip' } headers['X-Prerender-Token'] = ENV['PRERENDER_TOKEN'] if ENV['PRERENDER_TOKEN'] headers['X-Prerender-Token'] = @options[:prerender_token] if @options[:prerender_token] req = Net::HTTP::Get.new(url.request_uri, headers) req.basic_auth(ENV['PRERENDER_USERNAME'], ENV['PRERENDER_PASSWORD']) if @options[:basic_auth] response = Net::HTTP.start(url.host, url.port) { |http| http.request(req) } if response['Content-Encoding'] == 'gzip' response.body = ActiveSupport::Gzip.decompress(response.body) response['Content-Length'] = response.body.length response.delete('Content-Encoding') end response rescue nil end end |
#should_show_prerendered_page(env) ⇒ Object
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 |
# File 'lib/prerender_rails.rb', line 103 def should_show_prerendered_page(env) user_agent = env['HTTP_USER_AGENT'] buffer_agent = env['X-BUFFERBOT'] is_requesting_prerendered_page = false return false if !user_agent return false if env['REQUEST_METHOD'] != 'GET' request = Rack::Request.new(env) is_requesting_prerendered_page = true if Rack::Utils.parse_query(request.query_string).has_key?('_escaped_fragment_') #if it is a bot...show prerendered page is_requesting_prerendered_page = true if @crawler_user_agents.any? { |crawler_user_agent| user_agent.downcase.include?(crawler_user_agent.downcase) } #if it is BufferBot...show prerendered page is_requesting_prerendered_page = true if buffer_agent #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 is_requesting_prerendered_page end |