render_static 0.0.0

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+gem "selenium-webdriver"
+gem "headless"
+
+group :development do
+  gem "rspec"
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler"
+  gem "jeweler", "~> 1.8.4"
+end

data/Gemfile.lock

@@ -0,0 +1,64 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
+    addressable (2.3.3)
+    bourne (1.4.0)
+      mocha (~> 0.13.2)
+    childprocess (0.3.5)
+      ffi (~> 1.0, >= 1.0.6)
+    diff-lcs (1.1.3)
+    ffi (1.1.5)
+    git (1.2.5)
+    headless (1.0.1)
+    i18n (0.6.1)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.7)
+    libwebsocket (0.1.5)
+      addressable
+    metaclass (0.0.1)
+    mocha (0.13.3)
+      metaclass (~> 0.0.1)
+    multi_json (1.7.2)
+    rake (10.0.4)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.1)
+    rubyzip (0.9.9)
+    selenium-webdriver (2.25.0)
+      childprocess (>= 0.2.5)
+      libwebsocket (~> 0.1.3)
+      multi_json (~> 1.0)
+      rubyzip
+    shoulda (3.4.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (~> 1.0, >= 1.4.1)
+    shoulda-context (1.1.1)
+    shoulda-matchers (1.5.6)
+      activesupport (>= 3.0.0)
+      bourne (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  headless
+  jeweler (~> 1.8.4)
+  rdoc (~> 3.12)
+  rspec
+  selenium-webdriver
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2013 Herval Freire
+
+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/README.txt

@@ -0,0 +1,48 @@
+= render_static
+
+* http://github.com/herval/render_static
+
+== DESCRIPTION:
+
+render_static allows you to make your single-page apps (Backbone, Angular, etc) built on Rails SEO-friendly. It works by injecting a small rack middleware that will render pages as plain html, when the requester has one of the following user-agent headers:
+
+Googlebot
+Googlebot-Mobile
+AdsBot-Google
+Mozilla/5.0 (compatible; Ask Jeeves/Teoma; +http://about.ask.com/en/docs/about/webmasters.shtml)
+Baiduspider
+Mozilla/5.0 (compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm)
+
+Please note that, in order for this to work, you need more than one thread/process of your webserver running, as the middleware will effectively make a second call back to your own app and render the content, streaming it back to the requester (crawler/bot).
+
+
+== TO DO/PROBLEMS:
+
+* Caching support
+* Support for other drivers
+* Log what's going on
+
+== INSTALL:
+
+Add the following to your Gemfile:
+
+    gem 'render_static'
+
+In order to serve a set of routes as a single-page app, your routes.rb usually contains a catch-all route that will direct /* or /something/* to the same index.html file (the root of your js app). In order to allow the render_static middleware to intercept the right routes, you need to add this to your app initialization:
+
+    render_static.rb
+    RenderStatic::Middleware.base_path = "/" # replace / for whichever path matches your app's index.html
+
+render_static will, by default, try to use Firefox as the driver to navigate to content. It will also try to run headlessly - if on a *nix box, you should install xvfb for that to work properly.
+
+And you're done! The middleware will only try to static-render requests made by bots AND that would render application/html content.
+
+You can test that everything is working as expected by CURLing:
+
+    # this will render the usual blank slate client-side apps serve
+    curl http://localhost:3000/some/backbone/route
+
+    # this will render a static representation of your page (just like it would look like in a browser)
+    curl -A "Googlebot" http://localhost:3000/some/backbone/route
+
+

data/Rakefile

@@ -0,0 +1,43 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "render_static"
+  gem.homepage = "http://github.com/herval/render_static"
+  gem.license = "MIT"
+  gem.summary = %Q{ render_static allows you to make your single-page apps (Backbone, Angular, etc) built on Rails SEO-friendly. }
+  gem.description = %Q{ render_static allows you to make your single-page apps (Backbone, Angular, etc) built on Rails SEO-friendly. It works by injecting a small rack middleware that will render pages as plain html, when the requester is one of the most common crawlers/bots out there (Google, Yahoo Baidu and Bing) }
+  gem.email = "hervalfreire@gmail.com"
+  gem.authors = ["herval"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "render_static #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/render_static.rb

@@ -0,0 +1 @@
+require 'render_static/middleware'

data/lib/render_static/middleware.rb

@@ -0,0 +1,49 @@
+require 'render_static/rails/railtie' if defined?(Rails)
+require 'render_static/renderer'
+
+module RenderStatic
+  class NotSeoFriendly < Exception
+  end
+
+  class Middleware
+    class << self
+      attr_accessor :base_path
+    end
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      if will_render?(env)
+        RenderStatic::Renderer.render(env)
+      else
+        @app.call(env)
+      end
+    end
+
+    private
+
+    def will_render?(env)
+      is_bot?(env) && is_renderable?(env)
+    end
+
+    def is_bot?(env)
+      [
+          "Googlebot",
+          "Googlebot-Mobile",
+          "AdsBot-Google",
+          "Mozilla/5.0 (compatible; Ask Jeeves/Teoma; +http://about.ask.com/en/docs/about/webmasters.shtml)",
+          "Baiduspider",
+          "Mozilla/5.0 (compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm)",
+      ].include?(env["HTTP_USER_AGENT"])
+    end
+
+    def is_renderable?(env)
+      path = env["PATH_INFO"]
+      content_type = path.index(".") && path.split(".").last
+
+      path.start_with?(self.class.base_path) & [nil, "htm", "html"].include?(content_type) && env["REQUEST_METHOD"] == "GET"
+    end
+  end
+end

data/lib/render_static/rails/railtie.rb

@@ -0,0 +1,9 @@
+require 'rails'
+
+module RenderStatic
+  class Railtie < Rails::Railtie
+    initializer "render_static.insert_middleware" do |app|
+      app.config.middleware.use RenderStatic::Middleware
+    end
+  end
+end

data/lib/render_static/renderer.rb

@@ -0,0 +1,16 @@
+require 'selenium-webdriver'
+require 'headless'
+
+module RenderStatic
+  class Renderer
+
+    def self.render(env)
+      Headless.ly do
+        browser = Selenium::WebDriver.for(:firefox)
+        path = "#{env["rack.url_scheme"]}://#{env["HTTP_HOST"]}#{env["REQUEST_PATH"]}"
+        browser.navigate.to(path)
+        [200, { "Content-Type" => "text/html" }, [browser.page_source]] # TODO status code not supported by selenium
+      end
+    end
+  end
+end

data/render_static.gemspec

@@ -0,0 +1,70 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "render_static"
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["herval"]
+  s.date = "2013-05-08"
+  s.description = " render_static allows you to make your single-page apps (Backbone, Angular, etc) built on Rails SEO-friendly. It works by injecting a small rack middleware that will render pages as plain html, when the requester is one of the most common crawlers/bots out there (Google, Yahoo Baidu and Bing) "
+  s.email = "hervalfreire@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.txt"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.txt",
+    "Rakefile",
+    "VERSION",
+    "lib/render_static.rb",
+    "lib/render_static/middleware.rb",
+    "lib/render_static/rails/railtie.rb",
+    "lib/render_static/renderer.rb",
+    "render_static.gemspec",
+    "spec/middleware_spec.rb",
+    "spec/renderer_spec.rb"
+  ]
+  s.homepage = "http://github.com/herval/render_static"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.15"
+  s.summary = "render_static allows you to make your single-page apps (Backbone, Angular, etc) built on Rails SEO-friendly."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<selenium-webdriver>, [">= 0"])
+      s.add_runtime_dependency(%q<headless>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+    else
+      s.add_dependency(%q<selenium-webdriver>, [">= 0"])
+      s.add_dependency(%q<headless>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    end
+  else
+    s.add_dependency(%q<selenium-webdriver>, [">= 0"])
+    s.add_dependency(%q<headless>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+  end
+end
+

data/spec/middleware_spec.rb

@@ -0,0 +1,69 @@
+require "render_static/middleware"
+
+describe RenderStatic::Middleware do
+  let(:app) { stub }
+  let(:middleware) { RenderStatic::Middleware.new(app) }
+  let(:request) {
+    {
+        "PATH_INFO" => "/somewhere/",
+        "REQUEST_METHOD" => "GET"
+    }
+  }
+
+  before do
+    RenderStatic::Middleware.base_path = "/somewhere/"
+  end
+
+  describe "a non-bot user agent" do
+    it "passes-through" do
+      env = request.merge("HTTP_USER_AGENT" => "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_8_3) AppleWebKit/537.31 (KHTML, like Gecko) Chrome/26.0.1410.65 Safari/537.31")
+
+      app.should_receive(:call).with(env)
+      RenderStatic::Renderer.should_not_receive(:render)
+
+      middleware.call(env)
+    end
+  end
+
+  describe "a bot user agent" do
+    it "does not render if path doesn't match" do
+      env = request.merge("HTTP_USER_AGENT" => "Googlebot", "PATH_INFO" => "/somewhere_else/a.html")
+
+      app.should_receive(:call).with(env)
+      RenderStatic::Renderer.should_not_receive(:render)
+      middleware.call(env)
+    end
+
+    it "requests the same url and renders it" do
+      env = request.merge("HTTP_USER_AGENT" => "Googlebot", "PATH_INFO" => "/somewhere/index.html")
+
+      app.should_not_receive(:call)
+      RenderStatic::Renderer.should_receive(:render).with(env)
+      middleware.call(env)
+    end
+
+    it "renders content without an explicit type" do
+      env = request.merge("HTTP_USER_AGENT" => "Googlebot", "PATH_INFO" => "/somewhere/index")
+
+      app.should_not_receive(:call)
+      RenderStatic::Renderer.should_receive(:render).with(env)
+      middleware.call(env)
+    end
+
+    it "only renders GETs" do
+      env = request.merge("REQUEST_METHOD" => "POST", "PATH_INFO" => "/somewhere/index")
+
+      app.should_receive(:call)
+      RenderStatic::Renderer.should_not_receive(:render)
+      middleware.call(env)
+    end
+
+    it "does not render non-html content" do
+      env = request.merge("HTTP_USER_AGENT" => "Googlebot", "PATH_INFO" => "/somewhere/a.js")
+
+      app.should_receive(:call).with(env)
+      RenderStatic::Renderer.should_not_receive(:render)
+      middleware.call(env)
+    end
+  end
+end

data/spec/renderer_spec.rb

@@ -0,0 +1,27 @@
+require "render_static/renderer"
+
+describe RenderStatic::Renderer do
+  class Headless
+    def self.ly &block
+      yield
+    end
+  end
+
+  describe ".render" do
+    it "requests the content" do
+      env = { "HTTP_HOST" => "localhost:3000", "REQUEST_PATH" => "/abc", "rack.url_scheme" => "https" }
+
+      navigate = stub
+      browser = stub(navigate: navigate, page_source: "loaded page")
+      Selenium::WebDriver.should_receive(:for).with(:firefox) { browser }
+
+      navigate.should_receive(:to).with("https://localhost:3000/abc")
+
+      response = RenderStatic::Renderer.render(env)
+
+      response[0].should == 200
+      response[1].should == {"Content-Type"=>"text/html"}
+      response[2].should == ["loaded page"]
+    end
+  end
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: render_static
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- herval
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: &2165685120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2165685120
+- !ruby/object:Gem::Dependency
+  name: headless
+  requirement: &2165684400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2165684400
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2165683640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2165683640
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &2165721660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2165721660
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &2165720560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: *2165720560
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2165718900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2165718900
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2165718360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: *2165718360
+description: ! ' render_static allows you to make your single-page apps (Backbone,
+  Angular, etc) built on Rails SEO-friendly. It works by injecting a small rack middleware
+  that will render pages as plain html, when the requester is one of the most common
+  crawlers/bots out there (Google, Yahoo Baidu and Bing) '
+email: hervalfreire@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.txt
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.txt
+- Rakefile
+- VERSION
+- lib/render_static.rb
+- lib/render_static/middleware.rb
+- lib/render_static/rails/railtie.rb
+- lib/render_static/renderer.rb
+- render_static.gemspec
+- spec/middleware_spec.rb
+- spec/renderer_spec.rb
+homepage: http://github.com/herval/render_static
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1724286605502739496
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: render_static allows you to make your single-page apps (Backbone, Angular,
+  etc) built on Rails SEO-friendly.
+test_files: []