seojs 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1accd1613c1b3854ef08a9d85086245760c0f2ff
+  data.tar.gz: a058817ed7c61d7939a708ace59c0a8f5e395106
+SHA512:
+  metadata.gz: 28dc3156768a0024bec8651eb7d4d13b59da29f9a00327f7876a6e3a0fd3f43852ee169f9e954bc9f4c44b8154db1d5d23add8034741c04d32e57e8b20d8e106
+  data.tar.gz: 4771403b96a4816e0dd94f7e55b3e62355c54024f327db28f548447a48e41ac16d1fbe2a0192b0e6d4b474d2298c9c5447fca59edc137c87d8677506840c3574

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,18 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+
+gem 'rack-rewrite'
+gem 'rack-proxy'
+
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 1.8.7"
+  #gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,77 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    addressable (2.3.5)
+    atomic (1.1.14)
+    builder (3.2.2)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.19)
+    httpauth (0.2.0)
+    i18n (0.6.5)
+    jeweler (1.8.7)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.8.0)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    minitest (4.7.5)
+    multi_json (1.8.0)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rack-proxy (0.5.1)
+      rack
+    rack-rewrite (1.4.01)
+    rake (10.1.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.1.5)
+    shoulda-matchers (2.3.0)
+      activesupport (>= 3.0.0)
+    thread_safe (0.1.3)
+      atomic
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  jeweler (~> 1.8.7)
+  rack-proxy
+  rack-rewrite
+  rdoc (~> 3.12)
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 SEO.js
+
+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,62 @@
+# SEO.js for Rails
+
+Welcome to [SEO.js](http://getseojs.com/) for Rails! SEO.js makes your BackboneJS, AngularJS or EmberJS apps crawlable by Google to make them appear in search results. Integrating it to your Rails or Sinatra app is easy.
+
+
+## Installation 
+To get started add **seojs** to your ```Gemfile```:
+
+``` ruby
+gem 'seojs'
+```
+
+Next you need an **API token**. To get it sign up at http://getseojs.com/. While you're there add your site in the dashboard so the snapshots can already be prepared.
+
+### Rails
+
+To configure the API token for SEO.js create a new file in your project ```config/initializers/seojs.rb``` with the following content:
+
+``` ruby
+Seojs.token = "your_secret_api_token"
+```
+
+If you are running your app on Heroku you can also just set ```SEOJS_TOKEN``` environment variable:
+
+``` bash
+heroku config:set SEOJS_TOKEN=your_secret_api_token
+```
+
+### Sinatra
+
+Add this to your ```config.ru``` (or other rackup file):
+``` ruby
+require 'seojs'
+Seojs.token = "your_secret_api_token"
+use Seojs::Middleware
+```
+
+That's it! Requests to your app containing the *\_escaped_fragment\_* query parameter will now be forwarded to the SEO.js CDN where HTML snapshots of your pages are kept. To tell search engines to look for these snapshots you need to add the fragment meta tag to the head section of your application's layout (probably at ```app/views/layouts/application.html.erb```):
+
+``` html
+<head>
+  <meta name="fragment" content="!">
+  ...
+</head>
+```
+
+This method works both with **HTML5 pushState URLs** as well as **Hashbang URLs** (/some/action#!route)
+
+## Contributing to seojs
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2013 SEO.js. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,53 @@
+# 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 = "seojs"
+  gem.homepage = "http://github.com/seojs/seojs-ruby"
+  gem.license = "MIT"
+  gem.summary = %Q{Integrate SEO.js to your Rack or Rails project}
+  gem.description = %Q{SEO.js makes your BackboneJS, AngularJS or EmberJS apps crawlable by Google to make them appear in search results.}
+  gem.email = "hello@getseojs.com"
+  gem.authors = ["getseojs.com"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+#require 'rcov/rcovtask'
+#Rcov::RcovTask.new do |test|
+#  test.libs << 'test'
+#  test.pattern = 'test/**/test_*.rb'
+#  test.verbose = true
+#  test.rcov_opts << '--exclude "gems/*"'
+#end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "seojs #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.3

data/lib/seojs/middleware.rb

@@ -0,0 +1,57 @@
+require 'seojs/rack/proxy'
+require 'seojs/rack/cascade'
+
+module Seojs
+  class Middleware
+
+    def initialize(app)
+      @app   = app
+      
+      backend = "#{Seojs.url}/v3"
+      puts "middleware init: #{Seojs.url}"
+
+      @rack_rewrite = ::Rack::Rewrite.new(app) do |env|
+        r301 %r{(.*_escaped_fragment_.*)}, lambda { |match, rack_env|
+          "#{backend}/#{rack_env['rack.url_scheme']}://#{rack_env['SERVER_NAME']}:#{rack_env['SERVER_PORT']}#{match[0]}"
+        }
+      end
+
+      proxy_app = Rack::Proxy.new(backend: backend, streaming: false)
+
+      @rack_proxy = Rack::Cascade.new([proxy_app, app], [200, 301, 302, 304])
+    end
+
+    def call(env)
+      @env = env
+      
+      puts "middlware call: #{Seojs.url}"
+
+      if test?
+        [ 200, {"Content-Type" => "text/html"}, self ]
+      elsif Seojs.strategy == :redirect && Seojs.token && escaped_fragment_query?
+        @rack_rewrite.call(env)
+      elsif Seojs.strategy == :forward && Seojs.token && escaped_fragment_query?
+        @rack_proxy.call(env)
+      else
+        @app.call(env)
+      end
+    end
+
+    def each(&block)
+      if test?
+        block.call "SEO.js Middleware Found!"
+      end
+    end
+    
+    private
+
+      def escaped_fragment_query?
+        @env['ORIGINAL_FULLPATH'].match(/_escaped_fragment_/)
+      end
+
+      def test?
+        @env["PATH_INFO"] == "/seojs/test"
+      end
+    
+  end
+end

data/lib/seojs/rack/cascade.rb

@@ -0,0 +1,18 @@
+require 'rack/cascade'
+
+module Seojs
+  module Rack
+    class Cascade < ::Rack::Cascade
+      def call(env)
+        result = NotFound
+
+        @apps.each do |app|
+          result = app.call(env)
+          break if @catch.include?(result[0].to_i)
+        end
+
+        result
+      end
+    end
+  end
+end

data/lib/seojs/rack/proxy.rb

@@ -0,0 +1,34 @@
+require 'rack/proxy'
+
+module Seojs
+  module Rack
+    class Proxy < ::Rack::Proxy
+
+      def rewrite_env(rack_env)
+        rack_env.dup.tap do |env|
+          env['PATH_INFO'] = "#{@backend.request_uri}/#{env['rack.url_scheme']}://#{env['SERVER_NAME']}:#{env['SERVER_PORT']}#{env['PATH_INFO']}"
+          env['SERVER_NAME'] = @backend.host
+          env['SERVER_PORT'] = @backend.port
+          env['HTTP_HOST'] = "#{@backend.host}:#{@backend.port}"
+        end
+      end
+      
+      def perform_request(env)
+        byebug
+        super(env)
+      end
+      
+      def call(env)
+        # Timeout.timeout(20) do
+          code, headers, body = super(env)
+          body = [body] unless body.respond_to?(:each)
+          return [code, headers, body]
+        # end
+        [500, {}, ["Request timed out"]]
+      rescue Exception => e
+        [500, {}, [e.to_s]]
+      end
+
+    end
+  end
+end

data/lib/seojs/railtie.rb

@@ -0,0 +1,9 @@
+require 'rack/rewrite'
+
+module Seojs
+  class Railtie < ::Rails::Railtie
+    initializer "seojs.add_middleware" do |app|
+      app.config.middleware.use "Seojs::Middleware"
+    end
+  end
+end

data/lib/seojs.rb

@@ -0,0 +1,35 @@
+module Seojs
+  @strategy = :forward
+
+  def self.strategy=(value)
+    allowed_values = [:forward, :redirect]
+    unless allowed_values.map(&:to_s).include?(value.to_s)
+      puts "Seojs.strategy must be one of the following values:\n\t#{allowed_values}"
+      return
+    else
+      @strategy = value.to_sym
+    end
+  end
+
+  def self.strategy
+    @strategy
+  end
+  
+  def self.token=(value)
+    @url = "http://cdn.getseojs.com/snapshots/#{value}"
+  end
+  
+  def self.url=(value)
+    @url = value
+  end
+  
+  def self.url
+    @url
+  end
+  
+  self.token = ENV['SEOJS_TOKEN'] if ENV['SEOJS_TOKEN']
+  self.url = ENV['SEOJS_URL'] if ENV['SEOJS_URL']
+end
+
+require 'seojs/middleware'
+require 'seojs/railtie' if defined?(Rails::Railtie)

data/seojs.gemspec

@@ -0,0 +1,69 @@
+# 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 = "seojs"
+  s.version = "0.0.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["getseojs.com"]
+  s.date = "2013-09-30"
+  s.description = "SEO.js makes your BackboneJS, AngularJS or EmberJS apps crawlable by Google to make them appear in search results."
+  s.email = "hello@getseojs.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/seojs.rb",
+    "lib/seojs/middleware.rb",
+    "lib/seojs/rack/cascade.rb",
+    "lib/seojs/rack/proxy.rb",
+    "lib/seojs/railtie.rb",
+    "seojs.gemspec",
+    "test/helper.rb",
+    "test/test_seojs.rb"
+  ]
+  s.homepage = "http://github.com/seojs/seojs-ruby"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.0.5"
+  s.summary = "Integrate SEO.js to your Rack or Rails project"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rack-rewrite>, [">= 0"])
+      s.add_runtime_dependency(%q<rack-proxy>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.7"])
+    else
+      s.add_dependency(%q<rack-rewrite>, [">= 0"])
+      s.add_dependency(%q<rack-proxy>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
+    end
+  else
+    s.add_dependency(%q<rack-rewrite>, [">= 0"])
+    s.add_dependency(%q<rack-proxy>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,18 @@
+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 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'seojs'
+
+class Test::Unit::TestCase
+end

data/test/test_seojs.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestSeojs < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: seojs
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- getseojs.com
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack-rewrite
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-proxy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+description: SEO.js makes your BackboneJS, AngularJS or EmberJS apps crawlable by
+  Google to make them appear in search results.
+email: hello@getseojs.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/seojs.rb
+- lib/seojs/middleware.rb
+- lib/seojs/rack/cascade.rb
+- lib/seojs/rack/proxy.rb
+- lib/seojs/railtie.rb
+- seojs.gemspec
+- test/helper.rb
+- test/test_seojs.rb
+homepage: http://github.com/seojs/seojs-ruby
+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.5
+signing_key: 
+specification_version: 4
+summary: Integrate SEO.js to your Rack or Rails project
+test_files: []