prerender_rails_embedded 0.1 → 0.1.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NDI1YWQ0YzgxM2FlNDU3NTQ0NTRjODBlZmJmMTVhMjdlMzMyYzA5Ng==
+    YzU2Y2U3YWRmMTViMjMxMzFlMzc1ZmMzMGQ3NWVjN2Q5ZTllMjcxNw==
   data.tar.gz: !binary |-
-    ODRlZjliNDA1NzZjYmU4MjUwY2FlZWM5ODc2ZjllZjc4MjdiZDgzNw==
+    NzE3NGZmOWQxMGUwMWYxMDAwMmU2ZTViMzk4ZmQwZjc4MGM4OTQyZA==
 SHA512:
   metadata.gz: !binary |-
-    NTI3ZjVjNjc0OTgwMTExNmE1YjU2NTc1OGVlNTg4NGQwZDFiMzBkOWY0NTM2
-    OWNmNWU0NmYwMTMzNTY2Njk3MmJiYTAzOTc0NGZlN2JhZDUyZjE2NDE0ZGFl
-    ZDE1MjdlMjNkY2IxMDM2ZjA2MDc0MDI5ODNjNjdjMWFlMzBkN2I=
+    YWE3ZTU2NGU0NjcxOWQyMmM2MTBlN2FkYmFkNmNmZDYwMmU3MjQ1ODAyMWYx
+    ZDBlN2QwMmVhYWUyNjU3OWYyZTc5MDhlOTdhZGQwMTg0NzNkMjc2YTdkZDY0
+    MjE2M2QyYTJhOGQyNDQ1N2YyNGNmMWI0MWUwMTA0MjE4NDY0NTM=
   data.tar.gz: !binary |-
-    ZTkxZmVkNTg3YjNhNGE3MzBiYmNjNGJlNmMyYTFjZDliNGU5YzQwMDI1MmQw
-    YzdmM2M3MDY0NjcyNGMwMTM3ZDE5OWZjNzQ2MDQ0YjQ2OWNmZjZlZjQ2ZTNm
-    MjM3ZDAyMzBlNzU2NWMyODdjN2Q2MzJiYTg1YWFmNmU3ODJhYWE=
+    ZTEzZDExYjAzMDc0NTIxYzZkM2U4MGU5OGYzYjY1MzQ2YzJiN2YyYjBjM2Ix
+    ZmE3MzNlODVkZWM2NmQwZDgyMDA0MDU1MDk2OTU3YWI3YTZkYmQxNjFkOTk4
+    MjI4YTUzMDkzYTVjMjM5NzMzNjI0MmU0ZjRkYjNmNTBjNTU5OWU=

data/.gitignore

@@ -3,3 +3,4 @@ node_modules/
 .DS_Store
 .idea/
 pkg/
+Gemfile.lock

data/README.md

@@ -1 +1,99 @@
-A plugin for prerender_rails middleware to render JavaScript web app on the fly calling phantomjs directly
+Prerender Rails Embedded
+========================
+A rails gem to use [prerender_rails](https://github.com/prerender/prerender_rails) middleware
+to render JavaScript web app calling phantomjs on the fly without installing other services.
+
+### <a id='middleware'></a>
+## Overview
+
+With **Prerender Rails Embedded** can be avoided a new node.js server installation in a
+rails environment because rails will launch a `phantomjs` binary to render the js page.
+
+Just to try out the [prerender.io/server](https://prerender.io/server) technology
+and for low traffic situation, this plugin is not meant to support heavy traffic loads.
+
+### <a id='installation'></a>
+## Installation
+
+Add in your `Gemfile` a line with
+
+```ruby
+    gem 'prerender_rails_embedded'
+```
+
+and launch a
+
+    bundle install
+
+to install it. Then in the `config/environment/production.rb` it should be added:
+
+```ruby
+    config.middleware.use Rack::Prerender before_render: PrerenderRailsEmbedded.local_renderer
+```
+
+### <a id='test'></a>
+### Test
+
+To test the correct functioning of the `prerender_rails_embedded` gem just start rails
+with `rails s` and launch a curl to a (js generated) url like this:
+
+    curl -H "User-Agent: Mozilla/5.0 baiduspider" \
+        "http://localhost:4000/articles/a0af82a84-d386-4690-9f68-81ac768bc6d3"
+
+It should show a completely rendered page in standard output.
+
+### Warning
+
+**WEBrick** and **Thin** don't support multiple nested requests so, using them it will
+hang the request until a timeout is issued by the web server. To test it out you should
+consider using [unicorn](http://unicorn.bogomips.org/) with more than one worker thread.
+
+Just add `gen unicorn` to your `Gemfile` launch `bundle install` create a `config/unicorn.rb`
+file with content (adjusting it to your needs)
+
+```ruby
+    # config/unicorn.rb
+    worker_processes 3
+    timeout 30
+    preload_app true
+
+    before_fork do |server, worker|
+
+      Signal.trap 'TERM' do
+        puts 'Unicorn master intercepting TERM and sending myself QUIT instead'
+        Process.kill 'QUIT', Process.pid
+      end
+
+      defined?(ActiveRecord::Base) and
+        ActiveRecord::Base.connection.disconnect!
+    end
+
+    after_fork do |server, worker|
+
+      Signal.trap 'TERM' do
+        puts 'Unicorn worker intercepting TERM and doing nothing. Wait for master to sent QUIT'
+      end
+
+      defined?(ActiveRecord::Base) and
+        ActiveRecord::Base.establish_connection
+    end
+```
+
+and launch the web server with the command:
+
+```shell
+    bundle exec unicorn -p 3000 -c ./config/unicorn.rb
+```
+
+### <a id='todos'></a>
+## TODOs
+
+This has been a very quick development so there are
+
+ * exceptions should exit immediately from phantomjs and in some cases they DON'T
+ * add a timeout for too long phantojs processing
+ * support 404 and error code in the same way prerender.io (server) does
+
+### Future enhancements
+ * add memory/disk cache deciding a correct eviction policy to avoid rendering pages
+  multiple times.

data/lib/prerender_rails_embedded.rb

@@ -2,7 +2,7 @@ module PrerenderRailsEmbedded
   require 'phantomjs'
 
   def self.flatten_js_to_html(url)
-    Phantomjs.run("#{File.dirname(__FILE__)}/prerender_rails_embedded.js", url, '--load-images=false', '--ignore-ssl-errors=true', '--ssl-protocol=tlsv1', '--disk-cache=yes', '--max-disk-cache-size=524228')
+    Phantomjs.run('--load-images=false', '--ignore-ssl-errors=true', '--ssl-protocol=tlsv1', '--disk-cache=yes', '--max-disk-cache-size=524228', "#{File.dirname(__FILE__)}/prerender_rails_embedded.js", url)
   end
 
   def self.local_renderer

data/prerender_rails_embedded.gemspec

@@ -1,19 +1,19 @@
 # coding: utf-8
 
 Gem::Specification.new do |spec|
-  spec.name          = "prerender_rails_embedded"
-  spec.version       = "0.1"
-  spec.authors       = ["Gian Carlo Pace"]
-  spec.email         = ["giancarlo.pace@etalia.net"]
+  spec.name          = 'prerender_rails_embedded'
+  spec.version       = '0.1.1'
+  spec.authors       = ['Gian Carlo Pace']
+  spec.email         = %w(giancarlo.pace@etalia.net)
   spec.description   = %q{A plugin for prerender_rails middleware to render JavaScript web app on the fly calling phantomjs directly}
   spec.summary       = %q{Prerender your backbone/angular/javascript rendered application on the fly when search engines crawl}
-  spec.homepage      = "https://github.com/EtaliaSA/prerender_rails_embedded"
-  spec.license       = "Apache License 2.0"
+  spec.homepage      = 'https://github.com/EtaliaSA/prerender_rails_embedded'
+  spec.license       = 'Apache License 2.0'
 
   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 = ["lib"]
+  spec.require_paths = %w(lib)
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prerender_rails_embedded
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: 0.1.1
 platform: ruby
 authors:
 - Gian Carlo Pace
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-11 00:00:00.000000000 Z
+date: 2014-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler