morito 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bc8084f99cd40ba2b8f121d0af27cc5c7161ad15
+  data.tar.gz: 03c0f154b98907acc7606097724a05b31e6e57d5
+SHA512:
+  metadata.gz: 3dee2cc8743162be7c3ac36c17f15d67d035dcd911a1c344f20adca5f48f2117cff77a77b92cde2d97ef49f47de63c92c2220568231f9694f54ee808803485cd
+  data.tar.gz: a8062db1f264247a2ff2f3630b94142f046227f5b56bdba63cc45b028395d6c01047da745cd205a585ef6d83221685343c8c06e17c15f312e77074d4950d7e9b

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 negipo
+
+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,33 @@
+# Morito
+
+robots.txt parser client
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'morito'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install morito
+
+## Usage
+
+```ruby
+client = Morito::Client.new('some user agent')
+client.allowed?('http://example.com/some/path') # => true / false
+client.allowed?('http://example.com/some/path', cache: false) # => true / false without cache
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/negipo/morito/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 a new Pull Request

data/Rakefile

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

data/lib/morito/client.rb

@@ -0,0 +1,13 @@
+module Morito
+  class Client
+    def initialize(user_agent)
+      @user_agent = user_agent
+    end
+
+    def allowed?(requesting_url, cache: true)
+      uri = URI.parse(requesting_url)
+      robots_txt_body = Morito::Connector.new(uri, cache: cache).get
+      Morito::Processor.new(robots_txt_body).allowed?(@user_agent, uri.path)
+    end
+  end
+end

data/lib/morito/connector.rb

@@ -0,0 +1,46 @@
+require 'faraday'
+require 'uri'
+
+module Morito
+  class Connector
+    PATH = '/robots.txt'
+
+    attr_reader :uri
+
+    def initialize(uri, cache: true)
+      @uri = uri
+      @cache = cache
+    end
+
+    def get
+      if @cache
+        self.class.with_cache(base_url) do
+          raw_get
+        end
+      else
+        raw_get
+      end
+    end
+
+    private
+
+    def self.with_cache(base_url, &block)
+      @cache ||= {}
+      @cache[base_url] ||= yield
+    end
+
+    def raw_get
+      @get ||= connection.get(PATH).body
+    end
+
+    def connection
+      Faraday.new(url: base_url) do |connection|
+        connection.adapter :net_http
+      end
+    end
+
+    def base_url
+      "#{@uri.scheme}://#{@uri.host}:#{@uri.port}"
+    end
+  end
+end

data/lib/morito/processor.rb

@@ -0,0 +1,58 @@
+module Morito
+  class Processor
+    def initialize(body)
+      @body = body || ''
+    end
+
+    def allowed?(user_agent, path)
+      disallows = disallows_for(user_agent)
+
+      if disallows.empty?
+        true
+      else
+        regexp = Regexp.new("\\A(?:#{disallows.join('|')})")
+        regexp !~ path
+      end
+    end
+
+    private
+
+    def disallows_for(user_agent)
+      build
+      @disallows['*'] + @disallows[user_agent]
+    end
+
+    def build
+      return if @disallows
+      @disallows = Hash.new {|h, k| h[k] = [] }
+
+      parser = LineParser.new
+      @body.split(/\n+/).each do |line|
+        parser.parse(line)
+        @disallows[parser.user_agent] << parser.disallow if parser.disallow?
+      end
+
+      @disallows
+    end
+
+    class LineParser
+      attr_reader :user_agent, :disallow
+
+      def parse(line)
+        case line
+        when /\AUser-agent:\s+(.+?)\s*(?:#.+)?\z/i
+          @user_agent = $1
+          @disallow = nil
+        when /\ADisallow:\s+(.+?)\s*(?:#.+)?\z/i
+          @disallow = $1
+        else
+          @disallow = nil
+        end
+      end
+
+      def disallow?
+        @user_agent && @disallow
+      end
+    end
+  end
+end

data/lib/morito/version.rb

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

data/lib/morito.rb

@@ -0,0 +1,4 @@
+require 'morito/version'
+require 'morito/processor'
+require 'morito/connector'
+require 'morito/client'

data/morito.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'morito/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "morito"
+  spec.version       = Morito::VERSION
+  spec.authors       = ["negipo"]
+  spec.email         = ["negipo@gmail.com"]
+  spec.summary       = %q{A client to handle robots.txt}
+  spec.homepage      = "https://github.com/negipo/morito"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.required_ruby_version = '>= 2.0'
+
+  spec.add_dependency "faraday"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
+end

data/spec/morito/client_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe Morito::Client do
+  before do
+    stub_request(:any, //).to_return(body: body)
+  end
+
+  let(:client) { described_class.new(user_agent) }
+  let(:body) do
+    <<-EOS
+User-agent: *
+Disallow: /private
+
+User-agent: restricted agent # Comment
+Disallow: /
+EOS
+  end
+
+  describe '#allowed?' do
+    subject { client.allowed?(requesting_url) }
+
+    context 'with public path' do
+      let(:requesting_url) { 'http://example.com/public/path' }
+
+      context 'with some agent' do
+        let(:user_agent) { 'some agent' }
+        it { should == true }
+      end
+
+      context 'with restricted agent' do
+        let(:user_agent) { 'restricted agent' }
+        it { should == false }
+      end
+    end
+
+    context 'with private path' do
+      let(:requesting_url) { 'http://example.com/private/path' }
+
+      context 'with some agent' do
+        let(:user_agent) { 'some agent' }
+        it { should == false }
+      end
+
+      context 'with restricted agent' do
+        let(:user_agent) { 'restricted agent' }
+        it { should == false }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'webmock/rspec'
+require 'morito'
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: morito
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- negipo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: 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: 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: webmock
+  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: 
+email:
+- negipo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/morito.rb
+- lib/morito/client.rb
+- lib/morito/connector.rb
+- lib/morito/processor.rb
+- lib/morito/version.rb
+- morito.gemspec
+- spec/morito/client_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/negipo/morito
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A client to handle robots.txt
+test_files:
+- spec/morito/client_spec.rb
+- spec/spec_helper.rb