prerender_rails 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b499bed6cbc19810019141ab3fab9c7b5235d830
-  data.tar.gz: 92aa1987444e7bfaaf1c6660ff910d0b12749ced
+  metadata.gz: 9131d6f39c2dc688b5255b910007e5a434fe85a5
+  data.tar.gz: fd614761588694380e2abbb6ec3c6a32c64d42f8
 SHA512:
-  metadata.gz: 4f0419580407bfac9f17ab79e0e126e7fd87148461fee08cd45f3fdf44031313431fe90906797595056f2080541d086ca387044d8af922f8828d52fe89a3045a
-  data.tar.gz: a5821d28a7506ab63e78e1c6268443d361e8ea69d6a043bb1226458b1113cf959fa6f4dc7dcd9635ed3f5259e542b62722ca85cfa90452efdf50a272e18aa9cb
+  metadata.gz: cd0a338c2026fa5c6abd80bc97410619df877ff94b2dc44e283b6f7c6119959aebb9b8dd307deec5f42f9a88d019ca3977c74f748175071ae3a28c771b2a1d15
+  data.tar.gz: 4fd993cf3da044b7a2fa60da6e09be5d83cd51cdcceeb855c3f47edf58564d41d0e7b7e63a6ce58f08c3baa9daca80b84ea53ecf536901e68cbef6370d163d37

data/README.md

@@ -1,6 +1,12 @@
-# PrerenderRails
+Prerender Rails
+=========================== 
 
-TODO: Write a gem description
+This gem installs middleware that prerenders a javascript-rendered page and sends the HTML to a search engine crawler for SEO. It checks the agent string on the requesting browser for a crawler, and continues on to your normal routes if the requester is not a crawler.
+
+## How it works
+* Check to make sure the request is from a crawler and we aren't requesting a resource (js, css, etc...)
+* Make a `GET` request to the [prerender service](https://github.com/collectiveip/prerender) for the page's prerendered HTML
+* Return that HTML to the crawler
 
 ## Installation
 
@@ -18,7 +24,15 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+In `config/environment/production.rb`, add this line:
+
+```ruby
+	config.middleware.use Rack::Prerender
+```
+
+If you've deployed the prerender service on your own, set the `PRERENDER_URL` environment variable so that this gem points there instead. Otherwise, it will default to the service already deployed at `http://prerender.herokuapp.com`
+
+	$ export PRERENDER_URL=<new url>
 
 ## Contributing
 
@@ -27,3 +41,27 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2013 Todd Hooper &lt;todd@collectiveip.com&gt;
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/lib/prerender_rails.rb

@@ -26,9 +26,9 @@ module Rack
       request = Rack::Request.new(env)
       user_agent = env['HTTP_USER_AGENT'].downcase
 
-      should_show_based_on_agent_string = user_agent == 'googlebot'
-                        user_agent == 'yahoo'
-                        user_agent == 'bingbot'
+      should_show_based_on_agent_string = user_agent == 'googlebot' ||
+                        user_agent == 'yahoo' ||
+                        user_agent == 'bingbot' ||
                         user_agent == 'baiduspider'
 
       return false if !should_show_based_on_agent_string #short circuit

data/lib/rack/version.rb

@@ -1,3 +1,3 @@
 module PrerenderRails
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prerender_rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Todd Hooper
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-26 00:00:00.000000000 Z
+date: 2013-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler