prerender_rails 0.0.8 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59948717e824a0f84b73f6a8f3b5c1a3cadb294d
-  data.tar.gz: 811bc0d1154cadc3a8ad64fa3ea94bb6db48f2bc
+  metadata.gz: 89e1c2e1dd21adf5e3825a67ad848b35982ed781
+  data.tar.gz: cdec4ea8f7fa82fc8d6a4922910f09fbb9906be8
 SHA512:
-  metadata.gz: 3860c469fdb0f557d85ca341c4869bc47d86da0942a5690ddeced8c3e9e8be4930689f602d5190bcf71a3a24e0e41eefcbb4013e83e77155d7f736ff5b78270c
-  data.tar.gz: 5912a78bd5e7099ff969c49b93c4bdf44c038b6ab05fb8942fdee21cd69c79c3f48950b22df9c867842299d418193860c6d07ef417269f6670943c5044728010
+  metadata.gz: 281e4c4a83be7f2bdd50d2817fff311f7fe9c272d939216b436ef81283ba8030ed23bde71521057ca213a7ce2bf022073cd008b2cd94cc4f8e617c96ff195295
+  data.tar.gz: 305173a965270584c6880ce57e9101126ffbdbc0b3bd570574d24070faf3a246285b5f585f2f2fa8a5d787caaae5668803f8433d691f80f177bc4deffab7606b

data/README.md

@@ -5,6 +5,8 @@ Are you using backbone, angular, emberjs, etc, but you're unsure about the SEO i
 
 Use this gem to install rails middleware that prerenders a javascript-rendered page using an external service and returns the HTML to the search engine crawler for SEO.
 
+`Note:` If you are using a `#` in your urls, make sure to change it to `#!`. [View Google's ajax crawling protocol](https://developers.google.com/webmasters/ajax-crawling/docs/getting-started)
+
 `Note:` Make sure you have more than one webserver thread/process running because the prerender service will make a request to your server to render the HTML.
 
 Add this line to your application's Gemfile:
@@ -19,7 +21,7 @@ And in `config/environment/production.rb`, add this line:
 
 ## How it works
 1. Check to make sure we should show a prerendered page
-	1. Check if the request is from a crawler (agent string)
+	1. Check if the request is from a crawler (`_escaped_fragment_` or agent string)
 	2. Check to make sure we aren't requesting a resource (js, css, etc...)
 	3. (optional) Check to make sure the url is in the whitelist
 	4. (optional) Check to make sure the url isn't in the blacklist
@@ -54,6 +56,16 @@ If you've deployed the prerender service on your own, set the `PRERENDER_SERVICE
 
 	$ export PRERENDER_SERVICE_URL=<new url>
 
+Or on heroku:
+
+	$ heroku config:add PRERENDER_SERVICE_URL=<new url>
+
+As an alternative, you can pass `prerender_service_url` in the options object during initialization of the middleware
+
+``` ruby
+config.middleware.use Rack::Prerender, prerender_service_url: '<new url>'
+```
+
 ## Testing
 
 If you want to make sure your pages are rendering correctly:

data/lib/prerender_rails.rb

@@ -3,13 +3,13 @@ module Rack
     require 'net/http'
 
     def initialize(app, options={})
-      # googlebot, yahoo, and bingbot are not in this list because
-      # we support _escaped_fragment_ instead of checking user
-      # agent for those crawlers
+      # googlebot, yahoo, and bingbot are in this list even though
+      # we support _escaped_fragment_ to ensure it works for people
+      # who might not use the _escaped_fragment_ protocol
       @crawler_user_agents = [
-        # 'googlebot',
-        # 'yahoo',
-        # 'bingbot',
+        'googlebot',
+        'yahoo',
+        'bingbot',
         'baiduspider',
         'facebookexternalhit'
       ]
@@ -79,7 +79,7 @@ module Rack
       request = Rack::Request.new(env)
 
       return true if request.query_string.include? '_escaped_fragment_'
-      
+
       #if it is not a bot...dont prerender
       return false if @crawler_user_agents.all? { |crawler_user_agent| !user_agent.downcase.include?(crawler_user_agent.downcase) }
 
@@ -122,7 +122,7 @@ module Rack
     end
 
     def get_prerender_service_url
-      ENV['PRERENDER_SERVICE_URL'] || 'http://prerender.herokuapp.com/'
+      @options[:prerender_service_url] || ENV['PRERENDER_SERVICE_URL'] || 'http://prerender.herokuapp.com/'
     end
   end
 end

data/prerender_rails.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "prerender_rails"
-  spec.version       = "0.0.8"
+  spec.version       = "0.1.0"
   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

@@ -101,6 +101,12 @@ describe Rack::Prerender do
       assert_equal @prerender.build_api_url(request), 'http://prerenderurl.com/https://google.com/search?q=javascript'
       ENV['PRERENDER_SERVICE_URL'] = nil
     end
+
+    it "should build the correct api url with an initialization variable url" do
+      @prerender = Rack::Prerender.new(@app, prerender_service_url: 'http://prerenderurl.com')
+      request = Rack::MockRequest.env_for "https://google.com/search?q=javascript"
+      assert_equal @prerender.build_api_url(request), 'http://prerenderurl.com/https://google.com/search?q=javascript'
+    end
   end
 
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prerender_rails
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.0
 platform: ruby
 authors:
 - Todd Hooper
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-10 00:00:00.000000000 Z
+date: 2013-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack