rails_angular_seo 0.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7e73eb69378b9cc7909a5fcbebe0acd2007ee332
+  data.tar.gz: 5164182c7c70d4428cbd6c76552fea53a9d4ea87
+SHA512:
+  metadata.gz: 9110d9537df5cb07ee4d22cd73d0bc08726d18dd58a500f4f51dfd67ad4b5f7d342f4503cb17f4881d3ebe333f135c82c17d986629044bc5e1f761fbf9dc992c
+  data.tar.gz: ed4746c179ad69cc9dc7e5c703f1c6fc7861474862e3ceea326f93651431076e3245771ede822a51327f23fd2ba2d4a8d5aedf5e93aa9da18425f49b60254041

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+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,49 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
+    bourne (1.4.0)
+      mocha (~> 0.13.2)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    i18n (0.6.1)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.7)
+    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)
+    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
+  jeweler (~> 1.8.4)
+  rdoc (~> 3.12)
+  rspec
+  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,49 @@
+= rails_angular_seo
+
+* http://github.com/arunn/rails_angular_seo
+
+== DESCRIPTION:
+
+rails_angular_seo 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 'rails_angular_seo'
+
+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 rails_angular_seo middleware to intercept the right routes, you need to add this to your app initialization:
+
+    config/initializers/rails_angular_seo.rb
+
+    RailsAngularSeo::Middleware.base_path = "/" # replace / for whichever path matches your app's index.html
+    RailsAngularSeo::Middleware.seo_id    = "seo_id" # replace seo_id with whatever ID is used for the HTML DOM element which would be updated with status as "ready" once the ajax load is completed.
+    RailsAngularSeo::Middleware.server_name    = "NAME OF YOUR SERVER"
+
+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 = "rails_angular_seo"
+  gem.homepage = "http://github.com/arunn/rails_angular_seo"
+  gem.license = "MIT"
+  gem.summary = %Q{ rails_angular_seo allows you to make your single-page apps (Backbone, Angular, etc) built on Rails SEO-friendly. }
+  gem.description = %Q{ rails_angular_seo 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 = "arunkumar@chronus.com"
+  gem.authors = ["herval", "arunn"]
+  # 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 = "rails_angular_seo #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.7

data/lib/rails_angular_seo/middleware.rb

@@ -0,0 +1,60 @@
+require 'rails_angular_seo/rails/railtie' if defined?(Rails)
+require 'rails_angular_seo/renderer'
+
+module RailsAngularSeo
+  class NotSeoFriendly < Exception
+  end
+
+  class Middleware
+    class << self
+      attr_accessor :base_path
+      attr_accessor :seo_id
+      attr_accessor :server_name
+      attr_accessor :phantomjs_path
+    end
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      if will_render?(env)
+        self.class.server_name ||= env["HTTP_HOST"]
+        self.class.phantomjs_path ||= 'phantomjs'
+        path = URI("#{env["rack.url_scheme"]}://#{self.class.server_name}#{env["REQUEST_URI"]}")
+        path_without_port = "#{env["rack.url_scheme"]}://#{path.host}#{env["REQUEST_URI"]}"
+        RailsAngularSeo::Renderer.render(self.class.phantomjs_path, self.class.seo_id, path_without_port)
+      else
+        @app.call(env)
+      end
+    end
+
+    private
+
+    def will_render?(env)
+      is_bot?(env) && is_renderable?(env)
+    end
+
+    def is_bot?(env)
+      [
+          "Mozilla/5.0 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)",
+          "Googlebot/2.1 (+http://www.google.com/bot.html)",
+          "compatible; Mediapartners-Google/2.1; +http://www.google.com/bot.html",
+          "AdsBot-Google (+http://www.google.com/adsbot.html)",
+          "Mediapartners-Google",
+          "Mozilla/5.0 (compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm)",
+          "Mozilla/5.0 (compatible; bingbot/2.0 +http://www.bing.com/bingbot.htm)",
+          "Baiduspider+(+http://www.baidu.com/search/spider_jp.html)",
+          "Baiduspider+(+http://www.baidu.com/search/spider.htm)",
+          "BaiDuSpider"
+      ].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/rails_angular_seo/rails/railtie.rb

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

data/lib/rails_angular_seo/renderer.rb

@@ -0,0 +1,10 @@
+module RailsAngularSeo
+  class Renderer
+
+    def self.render(phantomjs_path, seo_id, path_without_port)
+      output = ""
+      output = IO.popen([phantomjs_path, "--ssl-protocol=any", File.expand_path("../../../phantomjs/phantomjs-runner.js", __FILE__), path_without_port, seo_id]){|phantom_output| output = phantom_output.read}
+      [200, { "Content-Type" => "text/html" }, [output]]
+    end
+  end
+end

data/lib/rails_angular_seo.rb

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

data/phantomjs/phantomjs-runner.js

@@ -0,0 +1,46 @@
+var system = require('system');
+var url = system.args[1] || '';
+
+if(url.length > 0) {
+  var page = require('webpage').create();
+  page.viewportSize = {
+    width: 1280,
+    height: 960
+  };
+  page.onResourceError = function(resourceError) {
+    page.reason = resourceError.errorString;
+    page.reason_url = resourceError.url;
+  };
+  page.open(url, function (status) {
+    if (status == 'success') {
+      var try_count = 0;
+      var delay, checker = (function() {
+        var status_element_id = system.args[2] || '';
+        try_count += 1;
+        var html = page.evaluate(function (status_element_id) {
+          var body;
+          if(status_element_id == "")
+          {  body = document.getElementsByTagName('body')[0];}
+          else
+          {  body = document.getElementById(status_element_id);}
+          if(body == null || body.getAttribute('data-status') == null || body.getAttribute('data-status') == 'ready') {
+            return document.getElementsByTagName('html')[0].outerHTML;
+          }
+        }, status_element_id);
+        if(html) {
+          clearTimeout(delay);
+          console.log(html);
+          phantom.exit();
+        }
+        else if(try_count > 50){
+          phantom.exit(1);
+        }
+      });
+      delay = setInterval(checker, 100);
+    }
+    else {
+      console.log("Error opening url \"" + page.reason_url + "\": " + page.reason);
+      phantom.exit(1);
+    }
+  });
+}

data/rails_angular_seo.gemspec

@@ -0,0 +1,65 @@
+# 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 = "rails_angular_seo"
+  s.version = "0.0.7"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["herval", "arunn"]
+  s.date = "2014-10-01"
+  s.description = " rails_angular_seo 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 = "arunkumar@chronus.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.txt"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.txt",
+    "Rakefile",
+    "VERSION",
+    "lib/rails_angular_seo.rb",
+    "lib/rails_angular_seo/middleware.rb",
+    "lib/rails_angular_seo/rails/railtie.rb",
+    "lib/rails_angular_seo/renderer.rb",
+    "phantomjs/phantomjs-runner.js",
+    "rails_angular_seo.gemspec",
+    "spec/middleware_spec.rb",
+    "spec/renderer_spec.rb"
+  ]
+  s.homepage = "http://github.com/arunn/rails_angular_seo"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.15"
+  s.summary = "rails_angular_seo 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_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<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<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,19 @@
+require "RailsAngularSeo/renderer"
+
+describe RailsAngularSeo::Renderer do
+
+  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")
+
+      response = RailsAngularSeo::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,134 @@
+--- !ruby/object:Gem::Specification
+name: rails_angular_seo
+version: !ruby/object:Gem::Version
+  version: 0.0.7
+platform: ruby
+authors:
+- herval
+- arunn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+description: ' rails_angular_seo 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: arunkumar@chronus.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.txt
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.txt
+- Rakefile
+- VERSION
+- lib/rails_angular_seo.rb
+- lib/rails_angular_seo/middleware.rb
+- lib/rails_angular_seo/rails/railtie.rb
+- lib/rails_angular_seo/renderer.rb
+- phantomjs/phantomjs-runner.js
+- rails_angular_seo.gemspec
+- spec/middleware_spec.rb
+- spec/renderer_spec.rb
+homepage: http://github.com/arunn/rails_angular_seo
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 3
+summary: rails_angular_seo allows you to make your single-page apps (Backbone, Angular,
+  etc) built on Rails SEO-friendly.
+test_files: []