rack-seo 0.0.1

data/.gitignore

@@ -0,0 +1,63 @@
+# rcov generated
+coverage
+coverage.data
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+bin/
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# For TextMate
+*.tmproj
+tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1,38 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p194@rack-seo"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.18.3 ()" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+  if [[ $- == *i* ]] # check for interactive shells
+  then echo "Using: $(tput setaf 2)$GEM_HOME$(tput sgr0)" # show the user the ruby and gemset they are using in green
+  else echo "Using: $GEM_HOME" # don't use colors in non-interactive shells
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create use  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+gemspec
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rack-test", :require => "rack/test"
+  gem "pry"
+  gem "rspec", "~> 2.8.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler"
+  gem "jeweler", "~> 1.8.4"
+  gem "simplecov", :require => false
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Xavier Riley
+
+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,145 @@
+# Rack SEO
+
+Rack SEO takes a page, analyses the content and provides relevant meta tags based on the words in the page.
+It's easy to configure (via a YAML file) so you can control all your SEO
+meta tags from one place. Works for any 
+existing Rack application (including Rails, Sinatra, Padrino etc.)
+
+### Dear God, why?
+
+SEO tags are a common client request and it seems like a lot of
+time and effort is wasted on sub-par solutions. Often, these tags 
+are based on content that already appears in the page and this gem helps to
+streamline that process. Also, it gets the implementation out of your app logic 
+so you can concentrate on doing more interesting stuff whilst keeping our search bot overlords happy.
+
+If that still doesn't convince you, that's fine. My only other
+reason was that my New Year's resolutions for 2013 included `write a gem` 
+and `write some Rack Middleware` so here it is.
+
+## Features
+
+* Provides keyword relevant title, meta-description and meta-keyword tags for every page
+* Use CSS selectors to pull any content into the title tag
+* Use CSS selectors to specify where to look for the meta description and keyword content e.g. "#intro"
+* Fully configurable for each path your app, with wildcard matching using regular expressions
+
+## Installation
+
+```bash
+#Assuming Mac OSX and Homebrew 
+brew update
+brew install libxml2 # (you might need to brew link libxml2 as well)
+brew install glib   
+
+#Follow instructions to install the summarize gem
+#Don't just gem install as it's out of date on Rubygems
+git clone https://github.com/ssoper/summarize.git
+cd summarize
+rake build
+gem build summarize.gemspec
+gem install summarize-1.0.4.gem
+
+gem install rack-seo
+```
+
+## Usage
+
+In your Gemfile:
+```
+gem 'rack-seo'
+```
+
+then run `bundle install`
+
+and in your config.ru:
+```
+use Rack::RackSeo
+```
+
+or to specify your own config file
+```
+use Rack::RackSeo :config => "/path/to/config/rack_seo.yml"
+```
+
+## The config file
+
+You can put the YAML config wherever you like but I would suggest
+`config/rack_seo.yml` for convention. The format is as follows:
+
+```yaml
+---
+# default is the fallback for any paths that you have not specified
+# explicitly.
+default: 
+  # title_format is a ruby string which parses out anything between {{
+  # and }} as a CSS selector (using Nokogiri) and pulls out the inner_text
+  title_format: "{{h1}} - Acme Ltd"
+  # meta_description_selector lets you specify where to pull the text
+  # content from to extract the summary text. The default is #content,
+  # falling back to the <body> tag if that isn't present. You can
+  # specify your own below. It pulls out the inner text and should only
+  # match one div or item.
+  meta_description_selector: "#my_juicy_keyword_rich_summary_div"
+  # Same as the description selector, but automatically generates a
+  # comma separated list from the content provided
+  meta_keywords_selector: "#my_tag_stuffed_p_tag"
+# The custom key (optional) contains any paths you'd like to specify.
+# These are tested against the current path, longest first to match the
+# most specific by default.
+custom:
+  -
+    matcher: '/blog'
+    title_format: "The Acme Company Blog - {{#content h1}}"
+    meta_description_selector: "#post_content"
+    meta_keywords_selector: "#comments"
+  -
+    matcher: '/contact-us'
+    # Plain old strings are fine too
+    title_format: "How to contact us about faulty anvils"
+    # You can skip the other selectors if you're happy with the
+    # #content/<body> defaults
+  -
+    # Matching wildcards works through regular expressions, though
+    # it's not pretty
+    matcher: !ruby/regexp '/\/news\/.*/'
+    title_format: "{{.article_body h3}} - Acme News"
+```  
+
+## Caveats
+
+* Processes on every request, so be sure to use caching in production
+* Uses the `summarize` gem, which is a wrapper around ["The Open Text
+Summarizer"](http://libots.sourceforge.net/). This has dependencies of
+its own (see installation) so will probably not work out of the box on
+Heroku.
+
+## Credits
+
+I originally did a proof of concept for this using the [Rack
+Pagespeed](http://rack-pagespeed.heroku.com/)
+middleware so thanks to @julio_ody for his work on that.
+
+The clever stuff (text summarization and keyword extraction) is all
+handled by the summarize gem at the moment so credit to @ssoper and
+LibOTS for their work. Other summarizers (maybe even in pure Ruby) are
+a focus going forward.
+
+## Contributing to Rack SEO
+
+Contributors are very welcome! Use Github issues for feature requests and other suggestions/improvements.
+This project uses RSpec for tests.
+
+* 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 Xavier Riley. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/config/rack_seo.default.yml

@@ -0,0 +1,5 @@
+--- 
+default: 
+  title_format: "{{h1}}"
+  meta_description_selector: "#content"
+  meta_keywords_selector: "#content"

data/generators/rack_seo.sample.yml

@@ -0,0 +1,32 @@
+---
+# default is the fallback for any paths that you have not specified
+# explicitly.
+default: 
+  # title_format is a ruby string which parses out anything between {{
+  # and }} as a CSS selector (using Nokogiri)
+  title_format: "{{h1}} - Acme Ltd"
+  # meta_description_selector lets you specify where to pull the text
+  # content from to extract the summary text. The default is #content,
+  # falling back to the <body> tag if that isn't present. You can
+  # specify your own below. It pulls out the inner text and should only
+  # match one div or item.
+  meta_description_selector: "#my_juicy_keyword_rich_summary_div"
+  # Same as the description selector, but automatically generates a
+  # comma separated list from the content provided
+  meta_keywords_selector: "#my_tag_stuffed_p_tag"
+# The custom key (optional) contains any paths you'd like to specify.
+# These are tested against the current path, longest first to match the
+# most specific by default.
+custom:
+  -
+    matcher: '/blog'
+    title_format: "The Acme Company Blog - {{#content h1}}"
+    meta_description_selector: "#post_content"
+    meta_keywords_selector: "#comments"
+  -
+    matcher: '/contact-us'
+    # Plain old strings are fine too
+    title_format: "How to contact us about faulty anvils"
+    # You can skip the other selectors if you're happy with the
+    # #content/<body> defaults
+

data/lib/rack-seo/base.rb

@@ -0,0 +1,57 @@
+module Rack
+  module RackSeo
+    class Base
+      attr_accessor :config
+      attr_accessor :current_path
+      attr_accessor :dispatcher
+
+      def initialize app, options, &block
+        @app = app
+        if options[:config]
+          @config = YAML.load(IO.read(options[:config]))
+        else
+          @config = YAML.load(IO.read("config/rack_seo.default.yml"))
+        end
+      end
+
+      def call env
+        # Setup document body ready to process
+        status, headers, response = @app.call(env)
+        return [status, headers, response] unless headers['Content-Type'] =~ /html/
+        body = ""; response.each do |part| body << part end
+
+        document = Rack::RackSeo::Document.new(body)
+        current_path = env['PATH_INFO'] || '/'
+        execute!(document, current_path)
+
+        body = document.to_html
+        headers['Content-Length'] = body.length.to_s if headers['Content-Length'] # still UTF-8 unsafe
+        [status, headers, [body]]        
+      end
+
+      def execute!(document, current_path = '/')
+        @dispatcher = RackSeo::Dispatcher.new(@config, current_path)
+        set_meta_title(document, @dispatcher.title_format)
+        set_meta_description(document, @dispatcher.description_selector)
+        set_meta_keywords(document, @dispatcher.keywords_selector)
+      end
+
+      def set_meta_title(document, title_format)
+        content = Rack::RackSeo::TitleFormatter.parse_meta_title(document, title_format)
+        content = Rack::RackSeo::Sanitize.sanitize_meta_title(content)
+        document.title_content = content
+      end
+
+      def set_meta_description(document, description_selector)
+        content = Rack::RackSeo::Summarizer.extract_description(document, description_selector)
+        document.description_content = content
+      end
+
+      def set_meta_keywords(document, keywords_selector)
+        content = Rack::RackSeo::Summarizer.extract_keywords(document, keywords_selector)
+        document.keywords_content = content
+      end
+
+    end
+  end
+end

data/lib/rack-seo/dispatcher.rb

@@ -0,0 +1,19 @@
+class Rack::RackSeo::Dispatcher
+  attr_accessor :title_format
+  attr_accessor :description_selector
+  attr_accessor :keywords_selector
+
+  def initialize(config, current_path)
+    if config["custom"]
+      matching_path = config["custom"].detect do |custom_path|
+        (custom_path["matcher"].is_a?(String) && current_path.include?(custom_path["matcher"])) or
+        (custom_path["matcher"].is_a?(Regexp) && current_path =~ custom_path["matcher"])
+      end
+    end
+    matching_path ||= {}
+    @title_format = matching_path["title_format"] || config["default"]["title_format"]
+    @description_selector = matching_path["meta_description_selector"] || config["default"]["meta_description_selector"]
+    @keywords_selector = matching_path["meta_keywords_selector"] || config["default"]["meta_keywords_selector"]
+  end
+
+end

data/lib/rack-seo/document.rb

@@ -0,0 +1,107 @@
+class Rack::RackSeo::Document < Nokogiri::HTML::Document
+  # This is a wrapper for the Nokogiri parsed page
+  # Provides some convenience methods for working 
+  # with seo meta tags
+  attr_accessor :title, :desc, :keywords
+
+  class << self
+    def new(*args)
+      doc = parse(args.first)
+      setup_meta_tags(doc)
+    end
+
+    def parse(string_or_io, url = nil, encoding = 'utf-8', options = Nokogiri::XML::ParseOptions::RECOVER)
+      super(string_or_io, url, encoding, options)
+    end
+  end
+
+  def title_content
+    self.title_tag.text
+  end
+
+  def title_content=(content)
+    title_tag.content = content
+  end
+
+  def title_tag
+    self.at('title')
+  end
+
+  def description_content=(content)
+    self.description_tag['content'] = content unless description_tag.nil?
+  end
+
+  def description_content
+    self.description_tag.attr('content') unless description_tag.nil?
+  end
+
+  def description_tag
+    self.at_css("meta[name='description']")
+  end
+
+  def keywords_content=(content)
+    keywords_tag['content'] = content unless keywords_tag.nil?
+  end
+
+  def keywords_content
+    keywords_tag.attr('content') unless keywords_tag.nil?
+  end
+
+  def keywords_tag
+    self.at_css("meta[name='keywords']")
+  end
+
+  class << self
+    private
+
+    def setup_meta_tags(document)
+      create_html_root_node(document) unless document.root.name == "html" 
+      create_doc_head(document) unless document.at_css("head")
+      create_meta_title(document) unless document.at_css("title")
+      create_meta_desc(document) unless document.at_css("meta[name='description']")
+      create_meta_desc_content(document) unless document.at_css("meta[name='description']")['content']
+      create_meta_keywords(document) unless document.at_css("meta[name='keywords']")
+      create_meta_keywords_content(document) unless document.at_css("meta[name='keywords']")['keywords']
+      document
+    end
+
+    def create_html_root_node(document)
+      document.root.wrap('<html></html>')
+    end
+
+    def create_doc_head(document)
+      doc_head = Nokogiri::XML::Element.new('head', document)
+      document.root.children.first.before doc_head
+    end
+
+    def create_meta_title(document)
+      meta_title = Nokogiri::XML::Element.new('title', document)
+      document.at('head').add_child meta_title
+    end
+
+    def create_meta_desc(document)
+      meta_desc = Nokogiri::XML::Element.new('meta', document)
+      meta_desc['name'] = "description"
+      meta_desc['content'] ||= ""
+      document.at('head').children.first.after meta_desc
+    end
+
+    def create_meta_keywords(document)
+      meta_keywords = Nokogiri::XML::Element.new('meta', document)
+      meta_keywords['name'] = "keywords"
+      meta_keywords['content'] ||= ""
+      document.at('head').children.last.after meta_keywords
+    end
+
+    def create_meta_desc_content(document)
+      meta_desc = document.description_tag
+      meta_desc['content'] ||= ""
+    end
+
+    def create_meta_keywords_content(document)
+      meta_keywords = document.keywords_tag
+      meta_keywords['content'] ||= ""
+    end
+  end
+
+end

data/lib/rack-seo/sanitize.rb

@@ -0,0 +1,15 @@
+module Rack::RackSeo::Sanitize
+  def self.sanitize_meta_title(title)
+    title.to_s.gsub(/\s+/, ' ').strip
+  end
+
+  def sanitize_meta_description(meta_description)
+    meta_description.to_s.gsub(/[\s]+/, ' ').gsub(/[\r|\n]+/, ' ').strip
+  end
+
+  def sanitize_meta_keywords(keywords)
+    keywords.split(",").collect { |keyword| 
+      keyword.downcase.gsub(/\s+/, '')
+    }.reject(&:empty?).join(',')
+  end
+end

data/lib/rack-seo/summarizer.rb

@@ -0,0 +1,40 @@
+class Rack::RackSeo::Summarizer
+  class << self
+    include Rack::RackSeo::Sanitize
+
+    def extract_description(document, selector)
+      sanitize_meta_description get_description(document, selector)
+    end
+
+    def extract_keywords(document, selector)
+      sanitize_meta_keywords get_keywords(document, selector)
+    end
+  end
+
+  private
+  def self.get_description(document, selector)
+    get_selected_elements(document, selector).map {|element|
+      element.inner_text
+    }.join(' ').summarize(:ratio => 1).strip
+  end
+
+  def self.get_keywords(document, selector)
+    get_selected_elements(document, selector).map {|element|
+      element.inner_text
+    }.join(' ').summarize(:topics => true).last
+  end
+
+  def self.get_selected_elements(document, selector)
+    begin
+      elements = document.css(selector) 
+    rescue Nokogiri::CSS::SyntaxError => e
+      document.css('body')
+    end
+
+    if elements.nil? || elements.empty? 
+      document.css('body')
+    else
+      elements
+    end
+  end
+end

data/lib/rack-seo/title_formatter.rb

@@ -0,0 +1,9 @@
+class Rack::RackSeo::TitleFormatter
+
+  def self.parse_meta_title(document, title_format)
+    title_format.gsub(/{{([^\}]+)}}/) do
+      "#{document.css($1).first.text rescue nil}"
+    end
+  end
+
+end

data/lib/rack-seo/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module Seo
+    VERSION = "0.0.1"
+  end
+end

data/lib/rack-seo.rb

@@ -0,0 +1,16 @@
+require 'nokogiri'
+require 'yaml'
+require 'summarize'
+require 'rack'
+require 'rack-seo/version'
+require 'rack-seo/base'
+require 'rack-seo/dispatcher'
+require 'rack-seo/document'
+require 'rack-seo/sanitize'
+require 'rack-seo/summarizer'
+require 'rack-seo/title_formatter'
+
+module Rack
+  module RackSeo
+  end
+end

data/lib/tasks/setup.rake

@@ -0,0 +1,6 @@
+namespace :rack_seo do
+  desc "Copies a default config to config/rack_seo.yml"
+  task :generate_config => :environment do
+    FileUtils.copy(File.expand_path("../../generators/rack_seo.sample.yml", __FILE__), Dir.pwd("config/rack_seo.yml"))
+  end
+end 

data/rack-seo.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack-seo/version'
+
+Gem::Specification.new do |gem|
+  gem.name = "rack-seo"
+  gem.version       = Rack::Seo::VERSION
+  gem.homepage = "http://github.com/xavriley/rack-seo"
+  gem.license = "MIT"
+  gem.summary = "Generate and manage meta tags on the fly using Rack Middleware"
+  gem.description = %q{Lets you extract sensible default content for meta tags using the markup from that page.}
+  gem.email = ["xavriley@github.com"]
+  gem.authors = ["Xavier Riley"]
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  
+  gem.add_dependency('nokogiri', ["~> 1.5.0"])
+  gem.add_dependency('summarize', ["~> 1.0.3"])
+end
+