prerender_rails_embedded 0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NDI1YWQ0YzgxM2FlNDU3NTQ0NTRjODBlZmJmMTVhMjdlMzMyYzA5Ng==
+  data.tar.gz: !binary |-
+    ODRlZjliNDA1NzZjYmU4MjUwY2FlZWM5ODc2ZjllZjc4MjdiZDgzNw==
+SHA512:
+  metadata.gz: !binary |-
+    NTI3ZjVjNjc0OTgwMTExNmE1YjU2NTc1OGVlNTg4NGQwZDFiMzBkOWY0NTM2
+    OWNmNWU0NmYwMTMzNTY2Njk3MmJiYTAzOTc0NGZlN2JhZDUyZjE2NDE0ZGFl
+    ZDE1MjdlMjNkY2IxMDM2ZjA2MDc0MDI5ODNjNjdjMWFlMzBkN2I=
+  data.tar.gz: !binary |-
+    ZTkxZmVkNTg3YjNhNGE3MzBiYmNjNGJlNmMyYTFjZDliNGU5YzQwMDI1MmQw
+    YzdmM2M3MDY0NjcyNGMwMTM3ZDE5OWZjNzQ2MDQ0YjQ2OWNmZjZlZjQ2ZTNm
+    MjM3ZDAyMzBlNzU2NWMyODdjN2Q2MzJiYTg1YWFmNmU3ODJhYWE=

data/.gitignore

@@ -0,0 +1,5 @@
+*.iml
+node_modules/
+.DS_Store
+.idea/
+pkg/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2014 Etalia SA
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1 @@
+A plugin for prerender_rails middleware to render JavaScript web app on the fly calling phantomjs directly

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+ 
+require 'rake/testtask'
+ 
+Rake::TestTask.new do |t|
+  t.libs << 'lib/prerender_rails_embedded'
+  t.test_files = FileList['test/lib/prerender_rails_embedded.rb']
+  t.verbose = true
+end
+ 
+task :default => :test

data/lib/prerender_rails_embedded.js

@@ -0,0 +1,86 @@
+/**
+ * TODO exceptions should exit immediately from phantomjs and they DON'T
+ * TODO add a timeout for too long connections
+ * TODO support 404 and error code in the same way prerender.io (server) does
+ * @type {number}
+ */
+var EVALUATE_JAVASCRIPT_CHECK_TIMEOUT = 50;
+
+var page = require('webpage').create(),
+    system = require('system');
+
+var surrender = {};
+
+surrender.params = function() {
+    if (system.args.length === 1) {
+        throw 'Usage: googlizer.js <some URL>';
+    }
+    return { address: system.args[1]};
+};
+
+surrender.javascriptToExecuteOnPage = function() {
+    try {
+        var doctype = ''
+            , html = document && document.getElementsByTagName('html');
+
+        if(document.doctype) {
+            doctype = "<!DOCTYPE "
+                + document.doctype.name
+                + (document.doctype.publicId ? ' PUBLIC "' + document.doctype.publicId + '"' : '')
+                + (!document.doctype.publicId && document.doctype.systemId ? ' SYSTEM' : '')
+                + (document.doctype.systemId ? ' "' + document.doctype.systemId + '"' : '')
+                + '>';
+        }
+
+        if (html && html[0]) {
+            return {
+                html: doctype + html[0].outerHTML,
+                shouldWaitForPrerenderReady: typeof window.prerenderReady === 'boolean',
+                prerenderReady: window.prerenderReady
+            };
+        }
+
+    } catch (e) {
+        return  {
+            html: '',
+            shouldWaitForPrerenderReady: false,
+            prerenderReady: window.prerenderReady
+        };
+    }
+
+};
+
+surrender.serveHtml = function(html) {
+    system.stdout.writeLine(html);
+    phantom.exit();
+};
+
+surrender.evaluateJavascriptOnPage = function(t) {
+    var _this = t || this
+        , out = page.evaluate(_this.javascriptToExecuteOnPage);
+
+    if(!out.shouldWaitForPrerenderReady || (out.shouldWaitForPrerenderReady && out.prerenderReady)) {
+        _this.serveHtml(out.html);
+    } else {
+        setTimeout(function(){_this.evaluateJavascriptOnPage(_this)}, EVALUATE_JAVASCRIPT_CHECK_TIMEOUT);
+    }
+    return _this;
+};
+
+surrender.run = function() {
+    try {
+        var _this = this;
+        page.address = this.params().address;
+
+        page.open(page.address, function (st) {
+            if (st !== 'success') throw 'FAIL to load the address';
+
+            _this.evaluateJavascriptOnPage();
+        });
+    } catch(e) {
+        console.log(e);
+        phantom.exit(1);
+    }
+};
+
+surrender.run();

data/lib/prerender_rails_embedded.rb

@@ -0,0 +1,13 @@
+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')
+  end
+
+  def self.local_renderer
+    Proc.new do |env|
+      flatten_js_to_html(Rack::Request.new(env).url)
+    end
+  end
+end

data/prerender_rails_embedded.gemspec

@@ -0,0 +1,21 @@
+# 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.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.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.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: prerender_rails_embedded
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Gian Carlo Pace
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-11 00:00:00.000000000 Z
+dependencies:
+- !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'
+description: A plugin for prerender_rails middleware to render JavaScript web app
+  on the fly calling phantomjs directly
+email:
+- giancarlo.pace@etalia.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/prerender_rails_embedded.js
+- lib/prerender_rails_embedded.rb
+- prerender_rails_embedded.gemspec
+homepage: https://github.com/EtaliaSA/prerender_rails_embedded
+licenses:
+- Apache License 2.0
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Prerender your backbone/angular/javascript rendered application on the fly
+  when search engines crawl
+test_files: []
+has_rdoc: