rdaneel 0.0.0

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Edgar
+
+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,26 @@
+= R.Daneel
+
+Obey robots.txt on top of em-http-request (http://github.com/igrigorik/em-http-request - Asynchronous HTTP Client)
+
+R Daneel Olivaw is a fictional robot created by Isaac Asimov - http://en.wikipedia.org/wiki/R._Daneel_Olivaw
+
+== Important
+
+The same em-http-request options apply here.
+But when following redirects the method won't check the intermediate robots.txt, just the first one.
+
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Edgar. See LICENSE for details.
+

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rdaneel"
+    gem.summary = %Q{Obey robots.txt on top of em-http-request (Asynchronous HTTP Client)}
+    gem.description = %Q{Add robots.txt support on top of em-http-request}
+    gem.email = "edgargonzalez@gmail.com"
+    gem.homepage = "http://github.com/hasmanydevelopers/RDaneel"
+    gem.authors = ["Edgar Gonzalez"]
+    gem.add_dependency("em-http-request", ">= 0.2.10")
+    gem.add_dependency('robot_rules', '>= 0.9.1')
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rdaneel #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/rdaneel.rb

@@ -0,0 +1,93 @@
+require 'em-http'
+require 'robot_rules'
+require 'net/http'
+
+module Net
+  class DisobeyingRobotsTxt < HTTPBadResponse ; end
+end
+
+class RDaneel
+
+  class << self
+    def robots_cache=(klass, options={})
+      @robots_cache = klass.new(options)
+    end
+
+    def robots_cache
+      @robots_cache
+    end
+  end
+
+  def initialize(uri)
+    @uri = uri.kind_of?(Addressable::URI) ? uri : Addressable::URI::parse(uri)
+  end
+
+  def robots_cache
+    self.class.robots_cache
+  end
+
+  #
+  # The same em-http-request options apply here.
+  # But when following redirects the method won't check the intermediate robots.txt, just the first one.
+  #
+  def get(options = {}, &blk)
+    useragent = "RDaneel"
+    if options[:head]
+      options[:head].keys.each do |k|
+        useragent = options[:head][k] if k.to_s.downcase == "user-agent"
+      end
+    end
+    if robots_cache && robots_file = robots_cache.get(robots_txt_url)
+      if robots_allowed?(robots_file, useragent)
+        http = EventMachine::HttpRequest.new(@uri).get(options)
+        http.callback {blk.call(http)}
+        http.errback {blk.call(http)}
+      else
+        conn = EventMachine::HttpClient.new("")
+        conn.uri = @uri
+        conn.on_error("robots.txt")
+        blk.call(conn)
+      end
+    else
+      robots = EventMachine::HttpRequest.new(robots_txt_url).get
+      robots.callback {
+        robots_file = robots.response
+        robots_cache.put(robots_txt_url, robots_file) if robots_cache
+        if robots_allowed?(robots_file, useragent)
+          http = EventMachine::HttpRequest.new(@uri).get(options)
+          http.callback {blk.call(http)}
+          http.errback {blk.call(http)}
+        else
+          conn = EventMachine::HttpClient.new("")
+          conn.uri = @uri
+          conn.on_error("robots.txt")
+          blk.call(conn)
+        end
+      }
+      robots.errback {
+        http = EventMachine::HttpRequest.new(@uri).get(options)
+        http.callback {blk.call(http)}
+        http.errback {blk.call(http)}
+      }
+    end
+  end
+
+  protected
+
+  def robots_allowed?(robots_file, useragent)
+    rules = RobotRules.new(useragent)
+    rules.parse(@uri.to_s, robots_file)
+    rules.allowed? @uri.to_s
+  end
+
+  def robots_txt_url
+    location = if @uri.port == 80
+      @uri.host
+    else
+      "#{@uri.host}:#{@uri.port}"
+    end
+    "http://#{location}/robots.txt"
+  end
+
+end
+

data/spec/rdaneel_spec.rb

@@ -0,0 +1,96 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'webrick'
+
+describe "RDaneel" do
+
+  describe "when there is no robots.txt" do
+    before(:all) do
+      start_server do |s|
+        s.mount_proc('/hello_world', lambda { |req, resp| resp.status = 200; resp.body = "hello world"})
+      end
+    end
+
+    after(:all) do
+      stop_server
+    end
+
+    it "should follow and get the uri" do
+      EM.run {
+        RDaneel.new("http://127.0.0.1:8080/hello_world").get do |http|
+          http.response_header.status.should == 200
+          http.response.should == "hello world"
+          http.error.should == ''
+          EM.stop
+        end
+      }
+    end
+  end
+
+  describe "when there is a robots.txt that allow the uri requested" do
+    before(:all) do
+      start_server do |s|
+        s.mount_proc('/robots.txt', lambda { |req, resp| resp.status = 200; resp.body = "User-agent: *\nDisallow: /images"})
+        s.mount_proc('/hello_world', lambda { |req, resp| resp.status = 200; resp.body = "hello world"})
+      end
+    end
+
+    after(:all) do
+      stop_server
+    end
+
+    it "should follow and get the uri" do
+      EM.run {
+        RDaneel.new("http://127.0.0.1:8080/hello_world").get do |http|
+          http.response_header.status.should == 200
+          http.response.should == "hello world"
+          http.error.should == ''
+          EM.stop
+        end
+      }
+    end
+  end
+
+  describe "when there is a robots.txt that disallow all content for all bots" do
+    before(:all) do
+      start_server do |s|
+        s.mount_proc('/robots.txt', lambda { |req, resp| resp.status = 200; resp.body = "User-agent: *\nDisallow: /"})
+        s.mount_proc('/hello_world', lambda { |req, resp| resp.status = 200; resp.body = "hello world"})
+      end
+    end
+
+    after(:all) do
+      stop_server
+    end
+
+    it "shouldn't get the uri" do
+      EM.run {
+          RDaneel.new("http://127.0.0.1:8080/hello_world").get do |http|
+          http.error.should == 'robots.txt'
+          http.uri.to_s.should == "http://127.0.0.1:8080/hello_world"
+          EM.stop
+        end
+      }
+    end
+  end
+
+
+
+end
+
+def start_server(options={}, &blk)
+  @server = WEBrick::HTTPServer.new({:Port => 8080}.merge(options))
+  @server_thread = Thread.new {
+    blk.call(@server) if blk
+    @server.start
+  }
+end
+
+def stop_server
+  @server.shutdown
+  @server_thread.join
+end
+
+def robots_txt
+
+end
+

data/spec/spec.opts

@@ -0,0 +1,6 @@
+--color
+--format progress
+--loadby mtime
+--reverse
+--backtrace
+

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'rdaneel'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+
+end
+

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification 
+name: rdaneel
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- Edgar Gonzalez
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-14 00:00:00 -04:30
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: em-http-request
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 2
+        - 10
+        version: 0.2.10
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: robot_rules
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 1
+        version: 0.9.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id003
+description: Add robots.txt support on top of em-http-request
+email: edgargonzalez@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rdaneel.rb
+- spec/rdaneel_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/hasmanydevelopers/RDaneel
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Obey robots.txt on top of em-http-request (Asynchronous HTTP Client)
+test_files: 
+- spec/spec_helper.rb
+- spec/rdaneel_spec.rb