rack_phantom 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7b24aff91966a742772634e4476f18f033a7d90e
+  data.tar.gz: 3eeb030ab9e14d4905975328c09c911fbc23fcb1
+SHA512:
+  metadata.gz: 0e8ed289c296b7eb6ff2cf190f1029192de33efcb42b9e39578b2f1ca1ed312844d1abdb3eafc55c8cec83dcbb4a2fb75a9f780a9d611c5b5a46662c476e1988
+  data.tar.gz: 6ae87b22d1b4c2ace8bef14f9fd9020a2167dc264fc60c30abfa48e4ec046d42937cd08a335106ae4100cdef9486dcf691ce68f15b8db1caab5631e3b338992d

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode # JRuby in 1.9 mode

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack_phantom.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Selva
+
+MIT License
+
+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.md

@@ -0,0 +1,33 @@
+# RackPhantom
+
+Rack middlware to render single page apps (or any html page with javascript) with phantomjs and return plain html for bots.
+
+## Travis
+
+[![Build Status](https://travis-ci.org/selvakn/rack_phantom.png)](https://travis-ci.org/selvakn/rack_phantom)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack_phantom'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack_phantom
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/js/render.js

@@ -0,0 +1,12 @@
+var system = require('system');
+var page = require('webpage').create();
+
+page.content = system.args[1];
+
+var result = page.evaluate(function(){
+  return document.documentElement.outerHTML;
+});
+
+console.log(result);
+
+phantom.exit();

data/lib/rack_phantom.rb

@@ -0,0 +1,48 @@
+require 'rack_phantom/version'
+require 'phantomjs'
+
+module RackPhantom
+  BOTS = [
+      'AdsBot-Google',
+      'Baiduspider',
+      'Googlebot',
+      'Googlebot-Mobile',
+      'Mozilla/5.0 (compatible; bingbot/2.0; +http://www.bing.com/bingbot.htm)',
+      'Mozilla/5.0 (compatible; Ask Jeeves/Teoma; +http://about.ask.com/en/docs/about/webmasters.shtml)'
+  ]
+
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      status, headers, response = @app.call(env)
+
+      return [status, headers, response] unless render?(headers, env)
+
+      html = Phantomjs.run('js/render.js', %['#{response}'])
+      [status, headers, html]
+    end
+
+    private
+    def render?(headers, env)
+      html_response?(headers) && bot?(env) && get?(env)
+    end
+
+    def html_response?(headers)
+      headers['Content-Type'].include? 'text/html'
+    end
+
+    def get?(env)
+      env['REQUEST_METHOD'] == 'GET'
+    end
+
+    def bot?(env)
+      BOTS.include? env['HTTP_USER_AGENT']
+    end
+  end
+end
+
+
+require 'rack_phantom/railtie' if defined?(Rails)

data/lib/rack_phantom/railtie.rb

@@ -0,0 +1,7 @@
+module RackPhantom
+  class Railtie < Rails::Railtie
+    initializer "rack_phantom.configure_rails_initialization" do |app|
+      app.middleware.use RackPhantom::Middleware
+    end
+  end
+end

data/lib/rack_phantom/version.rb

@@ -0,0 +1,3 @@
+module RackPhantom
+  VERSION = '0.1.0'
+end

data/rack_phantom.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack_phantom/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rack_phantom'
+  spec.version       = RackPhantom::VERSION
+  spec.authors       = ['Selva']
+  spec.email         = ['k.n.selvakumar@gmail.com']
+  spec.description   = 'Rack middlware to render single page apps (or any html page with javascript) with phantomjs and return plain html for bots.'
+  spec.summary       = ''
+  spec.homepage      = 'https://github.com/selvakn/rack_phantom'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = %w(lib)
+
+  spec.add_dependency 'rack', '~> 1.5.2'
+  spec.add_dependency 'phantomjs.rb', '~> 1.0.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'rspec'
+end

data/spec/rack_phantom_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe RackPhantom do
+
+  let(:html) { %q{<html><head><script>document.write("Hello World");</script></head><body></body></html>} }
+  let(:real_app) { ->(env) { [200, {'Content-Type' => 'text/html'}, html] } }
+  let(:app) { RackPhantom::Middleware.new(real_app) }
+
+
+  context 'for bots' do
+    it 'should execute javascript' do
+      get '/', {}, as_bot
+      last_response.should be_ok
+      last_response.body.strip.should == evaluated_html
+    end
+
+    it 'escapes the single quotes'
+
+    def evaluated_html
+      %q{<html><head><script>document.write("Hello World");</script></head><body>Hello World</body></html>}
+    end
+  end
+
+
+  context 'for non bots' do
+    it 'should not render' do
+      get '/'
+      last_response.body.strip.should == html
+    end
+  end
+
+  context 'for POST requests' do
+    it 'should not render' do
+      post '/', {}, as_bot
+      last_response.body.strip.should == html
+    end
+  end
+
+  context 'for non html responses' do
+    let(:json) { '{}' }
+    let(:real_app) { ->(env) { [200, {'Content-Type' => 'application/json'}, json] } }
+
+    it 'should not render' do
+      get '/'
+      last_response.body.strip.should == json
+    end
+  end
+
+  def as_bot
+    {'HTTP_USER_AGENT' => 'Googlebot'}
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'bundler'
+Bundler.require
+require 'rack/test'
+
+require 'rack_phantom'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.order = 'random'
+
+  config.include Rack::Test::Methods
+
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: rack_phantom
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Selva
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+- !ruby/object:Gem::Dependency
+  name: phantomjs.rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rack-test
+  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: 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'
+description: Rack middlware to render single page apps (or any html page with javascript)
+  with phantomjs and return plain html for bots.
+email:
+- k.n.selvakumar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- js/render.js
+- lib/rack_phantom.rb
+- lib/rack_phantom/railtie.rb
+- lib/rack_phantom/version.rb
+- rack_phantom.gemspec
+- spec/rack_phantom_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/selvakn/rack_phantom
+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.0.3
+signing_key: 
+specification_version: 4
+summary: ''
+test_files:
+- spec/rack_phantom_spec.rb
+- spec/spec_helper.rb