prerendercloud 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 98602daa331bbef3797fbdbbd3799aa02377b788
-  data.tar.gz: 5bbc10e89fe00c5f0126af4dadc2e45c826d298b
+  metadata.gz: f83eade04762849473e28d6066c6e143da296e0b
+  data.tar.gz: a4abe2d1c5ca27b28bbe8275c3c678d7cae57f1c
 SHA512:
-  metadata.gz: 1e200a693d0a2ee900220ebca72c7966ef0ad9f27ac422608beeb6469a136bc09c0d5ec7da6449493fdba07ba1df1640c545a568cc2b4f6c93f0b117fbdd39d6
-  data.tar.gz: 10aeb898918c7eac2df37181e284bf435ebf9c7a2c645a84fc2099cd6746d9523f2ad338bac8707bdf09c7852926f62878f7b2a99c3e1f82db531ab03c815fe1
+  metadata.gz: 3770ad267d006931870230dc2ec647d4941f8c1fa983e24ec8c6777c5f76170396a745fc90a7f2cd86c23eb597ec52f90a0f21a9c0dfc5b41e857873b9deaa53
+  data.tar.gz: b28db95acb7e77148964215051e4a9b676e976f7b6075505e9851e830163fa9a646d362f3cb1de4c4f9bf9a375202d490681cb8397e23299c52c6f5907901181

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    prerendercloud (0.1.0)
+    prerendercloud (0.1.1)
       activesupport
       rack
 

data/README.md

@@ -37,3 +37,23 @@ but it's here if you want it:
 ```ruby
 config.middleware.use Rack::Prerendercloud, bots_only: true
 ```
+
+### Blacklist
+
+Prevent certain paths from being prerendered (e.g. JSON API endpoints)
+
+Pass an array of Regexps or Strings.
+
+```ruby
+config.middleware.use Rack::Prerender, blacklist: [/^\/api/, '/housing_prices.json']
+```
+
+### Whitelist
+
+Only allow certain paths to be prerendered
+
+Pass an array of Regexps or Strings.
+
+```ruby
+config.middleware.use Rack::Prerender, whitelist: [/^\/users/, '/ips-v4']
+```

data/lib/prerendercloud.rb

@@ -125,19 +125,29 @@ module Rack
       is_requesting_prerendered_page = true if Rack::Utils.parse_query(request.query_string).has_key?('_escaped_fragment_')
 
       # if whitelist exists and path is not whitelisted...don't prerender
-      return false if @options[:whitelist].is_a?(Array) && @options[:whitelist].all? { |whitelisted| !Regexp.new(whitelisted).match(request.fullpath) }
+      return false if @options[:whitelist].is_a?(Array) && @options[:whitelist].all? do |whitelisted|
+        if whitelisted.is_a?(Regexp)
+          !whitelisted.match(request.fullpath)
+        else
+          whitelisted != request.fullpath;
+        end
+      end
 
       # if blacklist exists and path is blacklisted(url or referer)...don't prerender
-      if @options[:blacklist].is_a?(Array) && @options[:blacklist].any? { |blacklisted|
+      if @options[:blacklist].is_a?(Array) && @options[:blacklist].any? do |blacklisted|
           blacklistedUrl = false
           blacklistedReferer = false
-          regex = Regexp.new(blacklisted)
 
-          blacklistedUrl = !!regex.match(request.fullpath)
-          blacklistedReferer = !!regex.match(request.referer) if request.referer
+          if blacklisted.is_a?(Regexp)
+            blacklistedUrl = !!blacklisted.match(request.fullpath)
+            blacklistedReferer = !!blacklisted.match(request.referer) if request.referer
+          else
+            blacklistedUrl = blacklisted == request.fullpath
+            blacklistedReferer = request.referer && blacklisted == request.referer
+          end
 
           blacklistedUrl || blacklistedReferer
-        }
+        end
         return false
       end
 

data/prerendercloud.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "prerendercloud"
-  spec.version       = "0.1.1"
+  spec.version       = "0.2.0"
   spec.authors       = ["Jonathan Otto"]
   spec.email         = ["support@prerender.cloud"]
   spec.description   = %q{Rack middleware to server-side render your JavaScript apps by prerender.cloud}

data/test/lib/prerendercloud.rb

@@ -89,14 +89,6 @@ describe Rack::Prerendercloud do
   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?_escaped_fragment_=", "HTTP_USER_AGENT" => bot
-    response = Rack::Prerendercloud.new(@app, whitelist: ['^/search', '/help']).call(request)
-
-    assert_equal "", response[2]
-  end
-
-
   it "should set use_ssl to true for https prerender_service_url" do
     @prerender = Rack::Prerendercloud.new(@app, prerender_service_url: 'https://service.prerender.cloud/')
 
@@ -108,10 +100,18 @@ describe Rack::Prerendercloud do
   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?_escaped_fragment_=", "HTTP_USER_AGENT" => bot
+    response = Rack::Prerendercloud.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 regex specific whitelist" do
     request = Rack::MockRequest.env_for "/search/things/123/page?_escaped_fragment_=", "HTTP_USER_AGENT" => bot
     stub_request(:get, @prerender.build_api_url(request)).to_return(:body => "<html></html>")
-    response = Rack::Prerendercloud.new(@app, whitelist: ['^/search.*page', '/help']).call(request)
+    response = Rack::Prerendercloud.new(@app, whitelist: [/^\/search.*page/, '/help']).call(request)
 
     assert_equal ["<html></html>"], response[2].body
   end
@@ -119,14 +119,14 @@ describe Rack::Prerendercloud do
 
   it "should continue to app routes if the url is part of the regex specific blacklist" do
     request = Rack::MockRequest.env_for "/search/things/123/page", "HTTP_USER_AGENT" => bot
-    response = Rack::Prerendercloud.new(@app, blacklist: ['^/search', '/help']).call(request)
+    response = Rack::Prerendercloud.new(@app, blacklist: [/^\/search/, '/help']).call(request)
 
     assert_equal "", response[2]
   end
 
   it "should continue to app routes if the hashbang url is part of the regex specific blacklist" do
     request = Rack::MockRequest.env_for "?_escaped_fragment_=/search/things/123/page", "HTTP_USER_AGENT" => bot
-    response = Rack::Prerendercloud.new(@app, blacklist: ['/search', '/help']).call(request)
+    response = Rack::Prerendercloud.new(@app, blacklist: [/\/search/, '/help']).call(request)
 
     assert_equal "", response[2]
   end
@@ -134,24 +134,30 @@ describe Rack::Prerendercloud do
   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::Prerendercloud.new(@app, blacklist: ['^/search', '/help']).call(request)
+    response = Rack::Prerendercloud.new(@app, blacklist: [/^\/search/, '/help']).call(request)
 
     assert_equal ["<html></html>"], response[2].body
   end
 
 
-  it "should continue to app routes if the referer is part of the regex specific blacklist" do
+  it "should continue to app routes if the referer is part of the regex specific blacklist (regex match)" do
     request = Rack::MockRequest.env_for "/api/results", "HTTP_USER_AGENT" => bot, "HTTP_REFERER" => '/search'
-    response = Rack::Prerendercloud.new(@app, blacklist: ['^/search', '/help']).call(request)
+    response = Rack::Prerendercloud.new(@app, blacklist: [/^\/search/, '/help']).call(request)
 
     assert_equal "", response[2]
   end
 
+  it "should continue to app routes if the referer is part of the regex specific blacklist (string match)" do
+    request = Rack::MockRequest.env_for "/api/results", "HTTP_USER_AGENT" => bot, "HTTP_REFERER" => '/search'
+    response = Rack::Prerendercloud.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 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::Prerendercloud.new(@app, blacklist: ['^/search', '/help']).call(request)
+    response = Rack::Prerendercloud.new(@app, blacklist: [/^\/search/, '/help']).call(request)
 
     assert_equal ["<html></html>"], response[2].body
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prerendercloud
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Jonathan Otto