prerender_rails 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e710c94d4517957a7198a878b74edb3d2ce599a
-  data.tar.gz: 3d61079a206b75b6ebf47d2acd64ed1774fa1b25
+  metadata.gz: f5013e7eaea9bbf3be69499894144a70bf904911
+  data.tar.gz: a25e41c1f16f935222447687ff1e85f49e357f34
 SHA512:
-  metadata.gz: e2f1fd70277c97905a06b2e674ca4e882aea82700c8abdc65eb65e6b4f2a016392f1bb97482bcd8e7fc87269f26ef51ced69b8cdfb2e937abff8b85c209c9abe
-  data.tar.gz: d5f453676bf4373c2c6634713684ccd938ca1761cea76518ec29aff5b2f3a5ce5567fc8083befa2df2d6afe31dd8ba78c7f6191f1319df06246d548d415373b4
+  metadata.gz: 4e4005a4509b94bda2ec6783f7b0a2ba5bc6c3203257cb5cb57cbda056c5c52a92f6e0758fcc252eb8fbf0fab5016a2725d0aa29bccafd2518f4ded7954a72bd
+  data.tar.gz: 85ce4274d97f7148160fdba543e7c8c3784d47e48f7c2183d9d040e4b08593158802d8d6c2d5fd2b31b64b1773bf5a41b04c4842d44761e70459c4ed5c04bd5c

data/README.md

@@ -28,22 +28,22 @@ And in `config/environment/production.rb`, add this line:
 
 ### Whitelist
 
-Whitelist a single url path or multiple url paths. If a whitelist is supplied, only url's containing a whitelist path will be prerendered.
+Whitelist a single url path or multiple url paths. Compares using regex, so be specific when possible. If a whitelist is supplied, only url's containing a whitelist path will be prerendered.
 ```ruby
-config.middleware.use Rack::Prerender, whitelist: '/search/tto'
+config.middleware.use Rack::Prerender, whitelist: '^/search'
 ```
 ```ruby
-config.middleware.use Rack::Prerender, whitelist: ['/search', '/profile']
+config.middleware.use Rack::Prerender, whitelist: ['/search', '/users/.*/profile']
 ```
 
 ### Blacklist
 
-Blacklist a single url path or multiple url paths. If a blacklist is supplied, all url's will be prerendered except ones containing a blacklist path.
+Blacklist a single url path or multiple url paths. Compares using regex, so be specific when possible. If a blacklist is supplied, all url's will be prerendered except ones containing a blacklist path.
 ```ruby
-config.middleware.use Rack::Prerender, blacklist: '/search/tto'
+config.middleware.use Rack::Prerender, blacklist: '^/search'
 ```
 ```ruby
-config.middleware.use Rack::Prerender, blacklist: ['/search', '/profile']
+config.middleware.use Rack::Prerender, blacklist: ['/search', '/users/.*/profile']
 ```
 
 ### Using your own prerender service

data/lib/prerender_rails.rb

@@ -55,15 +55,16 @@ module Rack
       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| !request.path.include? whitelisted }
+      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 = request.path.include? blacklisted
-          blacklistedReferer = request.referer.include? blacklisted if request.referer
+          blacklistedUrl = !!regex.match(request.path)
+          blacklistedReferer = !!regex.match(request.referer) if request.referer
 
           blacklistedUrl || blacklistedReferer
         }

data/prerender_rails.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "prerender_rails"
-  spec.version       = "0.0.3"
+  spec.version       = "0.0.4"
   spec.authors       = ["Todd Hooper"]
   spec.email         = ["todd@collectiveip.com"]
   spec.description   = %q{Rails middleware to prerender your javascript heavy pages on the fly by a phantomjs service}

data/test/lib/prerender_rails.rb

@@ -42,6 +42,13 @@ describe Rack::Prerender do
     assert_equal response[2], ""
   end
 
+  it "should continue to app routes if the url is not part of the regex specific whitelist" do
+    request = Rack::MockRequest.env_for "/saved/search/blah", "HTTP_USER_AGENT" => bot
+    response = Rack::Prerender.new(@app, whitelist: ['/search', '/help']).call(request)
+
+    assert_equal response[2], ""
+  end
+
   it "should return a prerendered response if the url is part of the whitelist" do
     request = Rack::MockRequest.env_for "/search/things?query=blah", "HTTP_USER_AGENT" => bot
     stub_request(:get, @prerender.build_api_url(request)).to_return(:body => "<html></html>")
@@ -50,6 +57,14 @@ describe Rack::Prerender do
     assert_equal response[2].body, ["<html></html>"]
   end
 
+  it "should return a prerendered response if the url is part of the regex specific whitelist" do
+    request = Rack::MockRequest.env_for "/search/things?query=blah", "HTTP_USER_AGENT" => bot
+    stub_request(:get, @prerender.build_api_url(request)).to_return(:body => "<html></html>")
+    response = Rack::Prerender.new(@app, whitelist: ['^/search.*query', '/help']).call(request)
+
+    assert_equal response[2].body, ["<html></html>"]
+  end
+
   it "should continue to app routes if the url is part of the blacklist" do
     request = Rack::MockRequest.env_for "/search/things?query=blah", "HTTP_USER_AGENT" => bot
     response = Rack::Prerender.new(@app, blacklist: ['/search', '/help']).call(request)
@@ -57,6 +72,13 @@ describe Rack::Prerender do
     assert_equal response[2], ""
   end
 
+  it "should continue to app routes if the url is part of the regex specific blacklist" do
+    request = Rack::MockRequest.env_for "/search/things?query=blah", "HTTP_USER_AGENT" => bot
+    response = Rack::Prerender.new(@app, blacklist: ['^/search', '/help']).call(request)
+
+    assert_equal response[2], ""
+  end
+
   it "should return a prerendered response if the url is not part of the blacklist" do
     request = Rack::MockRequest.env_for "/profile/blah", "HTTP_USER_AGENT" => bot
     stub_request(:get, @prerender.build_api_url(request)).to_return(:body => "<html></html>")
@@ -65,6 +87,14 @@ describe Rack::Prerender do
     assert_equal response[2].body, ["<html></html>"]
   end
 
+  it "should return a prerendered response if the url is not part of the regex specific blacklist" do
+    request = Rack::MockRequest.env_for "/profile/search/blah", "HTTP_USER_AGENT" => bot
+    stub_request(:get, @prerender.build_api_url(request)).to_return(:body => "<html></html>")
+    response = Rack::Prerender.new(@app, blacklist: ['^/search', '/help']).call(request)
+
+    assert_equal response[2].body, ["<html></html>"]
+  end
+
   it "should continue to app routes if the referer is part of the blacklist" do
     request = Rack::MockRequest.env_for "/api/results", "HTTP_USER_AGENT" => bot, "HTTP_REFERER" => '/search'
     response = Rack::Prerender.new(@app, blacklist: ['/search', '/help']).call(request)
@@ -72,6 +102,13 @@ describe Rack::Prerender do
     assert_equal response[2], ""
   end
 
+  it "should continue to app routes if the referer is part of the regex specific blacklist" do
+    request = Rack::MockRequest.env_for "/api/results", "HTTP_USER_AGENT" => bot, "HTTP_REFERER" => '/search'
+    response = Rack::Prerender.new(@app, blacklist: ['^/search', '/help']).call(request)
+
+    assert_equal response[2], ""
+  end
+
   it "should return a prerendered response if the referer is not part of the blacklist" do
     request = Rack::MockRequest.env_for "/api/results", "HTTP_USER_AGENT" => bot, "HTTP_REFERER" => '/search'
     stub_request(:get, @prerender.build_api_url(request)).to_return(:body => "<html></html>")
@@ -79,6 +116,14 @@ describe Rack::Prerender do
 
     assert_equal response[2].body, ["<html></html>"]
   end
+
+  it "should return a prerendered response if the referer is not part of the regex specific blacklist" do
+    request = Rack::MockRequest.env_for "/api/results", "HTTP_USER_AGENT" => bot, "HTTP_REFERER" => '/profile/search'
+    stub_request(:get, @prerender.build_api_url(request)).to_return(:body => "<html></html>")
+    response = Rack::Prerender.new(@app, blacklist: ['^/search', '/help']).call(request)
+
+    assert_equal response[2].body, ["<html></html>"]
+  end
  
   describe '#buildApiUrl' do
     it "should build the correct api url with the default url" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prerender_rails
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Todd Hooper