bad_bot 0.9

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Tiago Scolari
+
+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.rdoc

@@ -0,0 +1,53 @@
+= BadBot
+
+This gem simply gives you the ability to avoid certain pieces of your view from being indexed by search bots.
+
+Even if this is generally not recommended, there are situations that you really don't want parts to be indexed. Instead of loading all this stuff from a javascript, BadBot simply gives you an option for doing this instead:
+
+  <%= no_bot do %>
+    stuff i dont wat to be indexed
+  <% end %>
+
+in case of a search bot request, the content of the block won't be rendered.
+
+
+== Configuration
+
+Include the gem in your gemfile: `gem 'bad_bot'`. And load it in a controller, for example `ApplicationController`:
+
+  class ApplicationController < ActionController::Base
+    include BadBot::Detector
+  end
+
+== Usage
+
+Once your controller is configured, you can call on you views/controller the `no_bot` and `is_bot?` methods:
+
+  Stories
+  <% no_bot do %>
+    1 of 10 pages
+  <% end %>
+  ...
+
+
+  Stories
+  <% unless is_bot? %>
+    1 of 10 pages
+  <% end %>
+
+== Customization
+
+By default it will only trigger for Google, Yahoo and Bing.
+
+You can add new user-agents to the robots list by using the `BadBot::Bots.setup` method. 
+
+  # some_initializer.rb
+  BadBot::Bots.instance.setup do |robots|
+    robots << 'otherbot'
+    robots << 'otherbot2'
+  end
+
+== Caution
+
+How you will use this is entirely up to you. You can get punished by search engines if you make bad use of it.
+My intent on creating this was to remove some useless words that kept showing as the highest keywords in webmasters tool.

data/Rakefile

@@ -0,0 +1,27 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'BadBot'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/bad_bot.rb

@@ -0,0 +1,4 @@
+module BadBot
+  require 'bad_bot/detector'
+  require 'bad_bot/bots'
+end

data/lib/bad_bot/bots.rb

@@ -0,0 +1,39 @@
+module BadBot
+  require 'singleton' 
+
+  # Bots list
+  #
+  #
+  class Bots
+    include Singleton
+
+    def initialize
+      @bots = ['msnbot', 'googlebot', 'slurp', 'yahoo']
+    end
+
+    # Public: Configures the search robots array:
+    # Example
+    #   BadBot.Bot.insance.setup do |bots|
+    #     bots << 'googlebot'
+    #     bots << 'yahoo'
+    #     bots << 'custom stuff'
+    #   end
+    #
+    def setup
+      yield(@bots)
+    end
+
+    # Public: Returns the array of bots
+    #
+    def bots
+      @bots
+    end
+
+    # Public: Convert the array of bots into a regular
+    # expression for searching
+    def bots_to_regexp
+      Regexp.union(bots)
+    end
+
+  end
+end

data/lib/bad_bot/detector.rb

@@ -0,0 +1,48 @@
+module BadBot
+  # Detector
+  # Gives the controller the ability to detect and behave
+  # different for requests that come from search bots.
+  #
+  # Example:
+  #   class ApplicationController < ...
+  #     include BadBot::Detector
+  #   end
+  #   ...
+  #   <div>
+  #     <% no_bot do %>
+  #       stuff that is not worth to crawl
+  #     <% end %>
+  #   </div>
+  #
+  #
+  module Detector
+    extend ActiveSupport::Concern
+
+    included do
+      before_filter :detect_search_bots
+      helper_method :no_bot, :is_bot?
+    end
+
+    # Public: Helper that only executes the block in case 
+    # this is not a request made by a search bot
+    #
+    def no_bot(&block)
+      block.call unless(is_bot?)
+    end
+
+    # Public: Helper that returns true or false, if the the
+    # request if from a search bot or not.
+    #
+    def is_bot?
+      @search_bot
+    end
+
+    private
+
+    # Private: Detects if the request comes from a search bot or not
+    #
+    def detect_search_bots
+      @search_bot ||= (request.user_agent =~ BadBot::Bots.instance.bots_to_regexp ? true : false)
+    end
+  end
+end

data/lib/bad_bot/version.rb

@@ -0,0 +1,3 @@
+module BadBot
+  VERSION = "0.9"
+end

data/lib/tasks/bad_bot_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :bad_bot do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: bad_bot
+version: !ruby/object:Gem::Version
+  version: '0.9'
+  prerelease: 
+platform: ruby
+authors:
+- Tiago Scolari
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70109398068500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *70109398068500
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70109398067600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70109398067600
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: &70109398066260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70109398066260
+- !ruby/object:Gem::Dependency
+  name: turnip
+  requirement: &70109398065160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70109398065160
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: &70109398063960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70109398063960
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: &70109398062880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70109398062880
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70109398062380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70109398062380
+description: Avoid bad keywords from being indexed by google and other robots.
+email:
+- tscolari@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/bad_bot/bots.rb
+- lib/bad_bot/detector.rb
+- lib/bad_bot/version.rb
+- lib/bad_bot.rb
+- lib/tasks/bad_bot_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+homepage: http://github.com/tscolari/bad_bot
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -496881733477053487
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -496881733477053487
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Get better ranking on search engines, by preventing bad stuff from being
+  indexed.
+test_files: []