laws_of_robots_txt 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e74143066e8e5af59911de84728b59ddcd84d119
+  data.tar.gz: a46779eaa0dd40807372c4dbe194e99be471397c
+SHA512:
+  metadata.gz: ed82e0e6120a5915174814bc5aa7cac722f555b515510495cacca922698edd6be1e9aba62ac3b191581c86236591496e11532a511a27892b66961bae29e23caf
+  data.tar.gz: 014eba62fac7d4b33c4b616a15ad3d91b4718c4b608fe0f8a885fbe97438381d9316174243a4520c783094f313b4697ebb91d4b6d3b6cbe35d72dad3b0acbcfc

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 John Hawthorn
+
+MIT License
+
+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,42 @@
+# LawsOfRobotsTxt
+
+1. A robot may not index staging servers
+2. A robot must obey the sitemap
+3. A robot may not injure SEO or, through inaction, cause SEO to come to harm.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'laws_of_robots_txt'
+
+And then execute:
+
+    $ bundle
+
+Be sure to remove `public/robots.txt`, if it exists
+
+## Usage
+
+LawsOfRobotsTxt installs a rack middleware into your application which renders
+a different `/robots.txt` based on the request's domain.
+
+It looks in `config/robots/` for a file named `<DOMAIN>.txt`, for example,
+`config/robots/www.example.com.txt`. A server restart is required to pick up
+changes.
+
+If no file exists for the requests domain, it renders a default
+
+```
+# Robots not allowed on this domain
+User-Agent: *
+Disallow: /
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/freerunningtech/laws_of_robots_txt/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/laws_of_robots_txt.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'laws_of_robots_txt/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "laws_of_robots_txt"
+  spec.version       = LawsOfRobotsTxt::VERSION
+  spec.authors       = ["John Hawthorn"]
+  spec.email         = ["john@freerunningtechnologies.com"]
+  spec.summary       = %q{Rack middleware providing a per-domain robots.txt}
+  spec.description   = "1. A robot may not index staging servers\n2. A robot must obey the sitemap\n3. A robot may not injure SEO or, through inaction, cause SEO to come to harm."
+  spec.homepage      = "https://github.com/freerunningtech/laws_of_robots_txt"
+  spec.license       = "MIT"
+
+  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"
+  spec.add_development_dependency "rack-test"
+end

data/lib/laws_of_robots_txt.rb

@@ -0,0 +1,4 @@
+require "laws_of_robots_txt/version"
+require "laws_of_robots_txt/middleware"
+require "laws_of_robots_txt/railtie" if defined?(Rails)
+

data/lib/laws_of_robots_txt/middleware.rb

@@ -0,0 +1,28 @@
+require 'rack'
+
+module LawsOfRobotsTxt
+  class Middleware
+    def initialize app, config_dir
+      @app = app
+      @robots_files = Hash[Dir[File.join(config_dir, "*.txt")].map do |filename|
+        domain = File.basename(filename, ".txt")
+        [domain, File.read(filename)]
+      end]
+    end
+    def call env
+      if env["PATH_INFO"] == "/robots.txt"
+        domain = env["SERVER_NAME"]
+        [200, {"Content-Type" => "text/plain"}, [robots_txt(domain)]]
+      else
+        @app.call(env)
+      end
+    end
+    def robots_txt domain
+      if robot_string = @robots_files[domain]
+        robot_string
+      else
+        "# Robots not allowed on this domain\nUser-Agent: *\nDisallow: /\n"
+      end
+    end
+  end
+end

data/lib/laws_of_robots_txt/railtie.rb

@@ -0,0 +1,7 @@
+module LawsOfRobotsTxt
+  class Railtie < Rails::Railtie
+    initializer "laws_of_robots_txt.configure_middleware" do |app|
+      app.middleware.use LawsOfRobotsTxt::Middleware, Rails.root.join("config/robots/").to_s
+    end
+  end
+end

data/lib/laws_of_robots_txt/version.rb

@@ -0,0 +1,3 @@
+module LawsOfRobotsTxt
+  VERSION = "0.0.1"
+end

data/test/fixtures/www.example.com.txt

@@ -0,0 +1,2 @@
+User-agent: *
+Disallow: /private

data/test/laws_of_robots_txt_test.rb

@@ -0,0 +1,81 @@
+$:.unshift File.expand_path("../../lib/", __FILE__)
+
+require 'rack/test'
+require 'rack/lint'
+require 'test/unit'
+require 'laws_of_robots_txt'
+
+class LawsOfRobotsTxtTest < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  class MockApp
+    attr_reader :called
+    def initialize
+      @called = false
+    end
+    def call env
+      @called = true
+      [200, {}, []]
+    end
+  end
+
+  def config_dir
+    File.expand_path("../fixtures/", __FILE__)
+  end
+  def mock_app
+    @mockapp ||= MockApp.new
+  end
+  def build_app
+    app = mock_app
+    app = Rack::Lint.new(app)
+    app = LawsOfRobotsTxt::Middleware.new(app, config_dir)
+    app = Rack::Lint.new(app)
+    app
+  end
+  def app
+    @app ||= build_app
+  end
+  def assert_status expected
+    assert_equal expected, @status
+  end
+  def assert_body expected
+    body_string = ''
+    @body.each{|b| body_string << b}
+    assert_equal body_string, expected
+  end
+  def assert_header name, expected
+    headers = Rack::Utils::HeaderHash.new(@headers)
+    assert_equal headers[name], expected
+  end
+  def make_request url
+    @status, @headers, @body = app.call(Rack::MockRequest.env_for(url))
+  end
+
+  def test_requests_pass_through
+    make_request "http://www.example.com/foobar"
+    assert mock_app.called, "should pass through"
+  end
+
+  def test_defined_robots
+    make_request "http://www.example.com/robots.txt"
+    assert !mock_app.called, "should not pass through"
+
+    assert_status 200
+    assert_header "Content-Type", "text/plain"
+    assert_body File.read("#{config_dir}/www.example.com.txt")
+  end
+
+  def test_undefined_robots
+    make_request "http://www.example.net/robots.txt"
+    assert !mock_app.called, "should not pass through"
+
+    assert_status 200
+    assert_header "Content-Type", "text/plain"
+    assert_body <<EOS
+# Robots not allowed on this domain
+User-Agent: *
+Disallow: /
+EOS
+  end
+end
+

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: laws_of_robots_txt
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- John Hawthorn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-25 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'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  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: |-
+  1. A robot may not index staging servers
+  2. A robot must obey the sitemap
+  3. A robot may not injure SEO or, through inaction, cause SEO to come to harm.
+email:
+- john@freerunningtechnologies.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- laws_of_robots_txt.gemspec
+- lib/laws_of_robots_txt.rb
+- lib/laws_of_robots_txt/middleware.rb
+- lib/laws_of_robots_txt/railtie.rb
+- lib/laws_of_robots_txt/version.rb
+- test/fixtures/www.example.com.txt
+- test/laws_of_robots_txt_test.rb
+homepage: https://github.com/freerunningtech/laws_of_robots_txt
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Rack middleware providing a per-domain robots.txt
+test_files:
+- test/fixtures/www.example.com.txt
+- test/laws_of_robots_txt_test.rb