ember-seo 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c9f2e60d41909d4f87c46a90319513956fbcd9f4
+  data.tar.gz: 7f245a81ae5ce9620faf217598b9e53082c2e5c7
+SHA512:
+  metadata.gz: 950cb5691db08403e12eef0d1d391ac662ef573551f5d106c6e8218053d592c20fd00c111e2225ccdc300f4a3008d736196d4b31bf696e8115d4148a8d884946
+  data.tar.gz: 5b310d03146c42d2463cfb81b36bd260447b67456bcf6521f62734bef1a5e75fe23af82f3fc786d124e22bc0f3b6f49e3a536a2efc585d43f4bed920478bcd54

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Vic Ramon
+
+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,64 @@
+## Ember SEO
+
+**Status**
+
+This gem successfully creates a snapshot of your site on your local server and properly serves it up with escaped fragement. However, I am unsure if the escaped fragment pattern is exactly correct and if this will actually work with Google.
+
+Additionally, hashbang urls are really ugly, so I'd like for the router to determine if the request is from a Google bot and only then use hashbangs.
+
+
+**Introduction**
+
+This gem helps make Ember sites SEO friendly by:
+
+* implementing hashbang urls in your Ember app
+* providing a rake task that crawls your site and takes a static snapshot
+* serving the correct static files to Google by properly handling requests with `_escaped_fragment_`
+
+### Installation
+
+#### Bundle & Install
+
+Add it to your Gemfile:
+
+`gem 'ember-seo'`
+
+Run the generator:
+
+`rails g ember_seo:install`
+
+This creates Rails routes, a Rails controller to display your static site, and app/models/hashbang.js which has a hashbang location helper. If you're not using Ember Appkit Rails then you should move hashbang.js to app/assets/javascripts/models.
+
+
+#### Setup
+
+Modify your Ember router to use hashbang:
+
+```
+var Router = Ember.Router.extend({
+  location: 'hashbang'
+});
+```
+
+Set the starting paths for the crawler in your environment file:
+
+```
+config.ember_seo_starting_paths = ['/', '/posts', '/etc']
+```
+
+## Usage
+
+Make sure your server is running on localhost:3000 then run the crawler:
+
+```
+rake ember_seo:scrape
+```
+
+This takes a snapshot of your site and saves it to public/static.
+
+Now visit a url in your app, for example:
+
+`http://localhost:3000/#!/posts`, and replace `#!` with `?_escaped_fragment=` like so:
+`http://localhost:3000/?_escaped_fragment_=posts` and you should see the correct static file. View
+the source of the page to ensure that you are viewing the static file and not your Ember
+application.

data/lib/ember-seo.rb

@@ -0,0 +1 @@
+Dir[File.join(File.dirname(__FILE__),'tasks/*.rake')].each { |f| load f } if defined?(Rake)

data/lib/generators/ember_seo/install_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators'
+
+module EmberSeo
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      source_root File.expand_path("../templates", __FILE__)
+      desc "Sets up app for Ember Seo gem"
+
+      def generate
+        copy_file "../templates/static_controller.rb", "app/controllers/static_controller.rb"
+        copy_file "../templates/hashbang.js", "app/models/hashbang.js"
+        copy_file "../templates/static_constraint.rb", "lib/constraints/static_constraint.rb"
+
+        inject_into_file 'config/routes.rb', after: "routes.draw do\n" do
+          "\n  get '/', to: 'static#show', constraints: Constraint::Static.new" +
+          "\n  get '*path', to: 'static#show', constraints: Constraint::Static.new\n"
+        end
+
+      end
+
+    end
+  end
+end

data/lib/generators/ember_seo/templates/hashbang.js

@@ -0,0 +1,28 @@
+Ember.Location.registerImplementation("hashbang", Ember.HashLocation.extend({
+  getURL: function() {
+    return Ember.get(this, "location").hash.substr(2);
+  },
+  setURL: function(path) {
+    Ember.get(this, "location").hash = "!" + path;
+    return Ember.set(this, "lastSetURL", path);
+  },
+  onUpdateURL: function(callback) {
+    var guid, self;
+    self = this;
+    guid = Ember.guidFor(this);
+    return Ember.$(window).bind("hashchange.ember-location-" + guid, function() {
+      return Ember.run(function() {
+        var path;
+        path = location.hash.substr(2);
+        if (Ember.get(self, "lastSetURL") === path) {
+          return;
+        }
+        Ember.set(self, "lastSetURL", null);
+        return callback(path);
+      });
+    });
+  },
+  formatURL: function(url) {
+    return "#!" + url;
+  }
+}));

data/lib/generators/ember_seo/templates/location.js.coffee

@@ -0,0 +1,20 @@
+Ember.Location.registerImplementation "hashbang", Ember.HashLocation.extend
+  getURL: ->
+    Ember.get(this, "location").hash.substr 2
+
+  setURL: (path) ->
+    Ember.get(this, "location").hash = "!" + path
+    Ember.set(this, "lastSetURL", path)
+
+  onUpdateURL: (callback) ->
+    self = this
+    guid = Ember.guidFor(this)
+    Ember.$(window).bind "hashchange.ember-location-" + guid, ->
+      Ember.run ->
+        path = location.hash.substr(2)
+        return if Ember.get(self, "lastSetURL") is path
+        Ember.set(self, "lastSetURL", null)
+        callback path
+
+  formatURL: (url) ->
+    "#!" + url

data/lib/generators/ember_seo/templates/static_constraint.rb

@@ -0,0 +1,7 @@
+module Constraint
+  class Static
+    def matches?(request)
+      request.url.include?("_escaped_fragment_")
+    end
+  end
+end

data/lib/generators/ember_seo/templates/static_controller.rb

@@ -0,0 +1,9 @@
+class StaticController < ApplicationController
+
+  def show
+    file_name = request.params["_escaped_fragment_"]
+    file_name = "index" unless file_name.present?
+    render file: "public/static/#{file_name}.html", layout: false
+  end
+
+end

data/lib/site_crawler.rb

@@ -0,0 +1,72 @@
+require 'static_file_saver'
+require 'capybara/dsl'
+require 'capybara/poltergeist'
+
+class SiteCrawler
+  include ::Capybara::DSL
+
+  attr_accessor :start_paths, :saved_paths, :queued_paths, :current_path, :current_path_bang
+
+  def initialize(start_paths=['/'])
+    self.start_paths = start_paths
+    self.saved_paths = []
+    self.queued_paths= []
+    capybara_setup
+  end
+
+  def start_crawl
+    start_message
+    crawl(@start_paths)
+  end
+
+  def crawl(paths)
+    paths.each do |path|
+      @current_path = path
+      @current_path_bang = "#!#{@current_path}"
+      if !saved_paths.include? @current_path
+        visit_page
+        save_page
+      end
+    end
+    queued_paths.present? ? crawl(queued_paths) : done_message
+  end
+
+  private
+
+  def visit_page
+    puts "visiting #{current_path}..."
+    visit(@current_path_bang)
+    @document = Nokogiri::HTML.parse(source)
+    queue_links
+  end
+
+  def save_page
+    @document.css('script').remove
+    StaticFileSaver.new(@current_path_bang, @document).save
+    saved_paths << current_path
+    queued_paths.delete(current_path)
+  end
+
+  def capybara_setup
+    Capybara.current_driver = :poltergeist
+    Capybara.app_host = 'http://localhost:3000/'
+  end
+
+  def queue_links
+    @document.css('a').each do |link|
+      path = link['href'].gsub("#!",'')
+      if !queued_paths.include? path and !path.include?('mailto:')
+        queued_paths << path
+      end
+    end
+  end
+
+  def start_message
+    puts "Ember SEO Crawling...\n\n"
+  end
+
+  def done_message
+    puts "\nDone crawling."
+  end
+
+end

data/lib/static_file_saver.rb

@@ -0,0 +1,32 @@
+class StaticFileSaver
+  attr_accessor :path, :document
+
+  def initialize(ember_path, document)
+    self.path = static_file_path_for(ember_path)
+    self.document = document
+  end
+
+  def save
+    create_directory
+    create_file
+  end
+
+  private
+
+  def create_file
+    File.open(@path + ".html", "w+") do |f|
+      f.write(@document.to_s)
+    end
+  end
+
+  def create_directory
+    FileUtils.mkdir_p(File.dirname(@path))
+  end
+
+  def static_file_path_for(path)
+    file_name = path.gsub("#!",'')
+    file_name << 'index' if path[path.length-1] == '/'
+    "public/static" + file_name
+  end
+
+end

data/lib/tasks/ember-seo.rake

@@ -0,0 +1,10 @@
+require 'site_crawler'
+
+namespace :ember_seo do
+
+  desc "Take a static snapshot of your site"
+  task :scrape do
+    SiteCrawler.new(Rails.application.config.ember_seo_starting_paths).start_crawl
+  end
+
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: ember-seo
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Vic Ramon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-31 00:00:00.000000000 Z
+dependencies:
+- !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: 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: pry
+  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: poltergeist
+  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: capybara
+  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'
+description: Ember Seo helps you make you Ember app crawlable by Google.
+email: vic@vicramon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/ember-seo.rb
+- lib/generators/ember_seo/install_generator.rb
+- lib/generators/ember_seo/templates/hashbang.js
+- lib/generators/ember_seo/templates/location.js.coffee
+- lib/generators/ember_seo/templates/static_constraint.rb
+- lib/generators/ember_seo/templates/static_controller.rb
+- lib/site_crawler.rb
+- lib/static_file_saver.rb
+- lib/tasks/ember-seo.rake
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Ember Seo helps you make you Ember app crawlable by Google.
+test_files: []