samao 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 561ab598e5442161a48b2878887296f8047aa269
+  data.tar.gz: 76d3daa2ca3c1407286690404809ee2b58115764
+SHA512:
+  metadata.gz: acab6baf781e25d75cb34d7214ac78cdb79936cca735fa554f152342fd285ed562e30c2ac5983a0c21cd6b3154dacd1830871637fd08be89dfbde109569591ca
+  data.tar.gz: 5a2f6e9d1a9ee336fe2e4234ec8d6336f00748cb5d39a06932987a557ec342c7f223471700502a64d3b02296920e91f3c2484078b23432b189ec2b09fb529abc

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+  - ruby-head
+before_install: gem install bundler -v 1.13.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at liulantao@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Liu Lantao
+
+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,76 @@
+# Samao
+
+Samao is a simple and easy to use web-crawlar written in ruby.
+
+[![Build Status](https://travis-ci.org/Lax/Samao.svg?branch=master)](https://travis-ci.org/Lax/Samao)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'samao'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install samao
+
+## Usage
+
+    #!/usr/bin/env ruby
+    require 'samao'
+
+    # create samao detector
+    samao = Samao::Detector.new
+
+    # set base url and start page
+    samao.base_url 'https://github.com'
+    samao.from '/Lax?tab=repositories'
+    # the following line have the same effect
+    #samao.from  'https://github.com/Lax?tab=repositories'
+
+    # tell samao how to find the next page
+    samao.match :next, 'div.pagination a.next_page'
+
+    # tell samao how to find items.
+    # further more, set the data from matched HTML node/element.
+    samao.add_item 'div#user-repositories-list li a[itemprop="name codeRepository"]' do |item|
+      item.set_url :url, item.raw(:item)['href']
+      item.set :title, item.raw(:item).text.strip
+    end
+
+    # if it need to open content page for more information
+    # default key is :url
+    samao.add_detail :url do |detail|
+    #samao.add_detail do |detail|
+      detail.match :author, 'h1.public .author a' do |item|
+        item.set :author, item.raw(:author).first.text.strip
+      end
+    end
+
+    # run the detector
+    samao.run
+
+    # read items
+    p samao.items
+    ## [{:url=>"https://github.com/Lax/awesome", :title=>"awesome", :author=>"Lax"}, {:url=>"https://github.com/Lax/lax.github.com", :title=>"lax.github.com", :author=>"Lax"}, ..]
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Lax/Samao. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "samao"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/samao/catcher.rb

@@ -0,0 +1,57 @@
+module Samao
+  class Catcher
+    require 'open-uri'
+    require 'nokogiri'
+
+    # accpet url
+    # return Catcher self
+    def initialize(params)
+      @url = params[:url]
+      @code = 0
+
+      @headers = {}
+      @headers["Referer"] = params[:base_url] if params[:base_url]
+
+      self
+    end
+
+    # return Catcher self
+    def run
+      begin
+
+        open(@url, @headers) do |f|
+          begin
+            @doc = Nokogiri::HTML(f)
+            @code = 200
+          rescue
+            @code = 500
+          end
+        end
+      rescue
+        @code = 400
+      end
+
+      self
+    end
+
+    # catcher task is success or not
+    def success?
+      @code == 200
+    end
+
+    # catcher task result with code and doc
+    def result
+      code:@code, doc:@doc
+    end
+
+    # catcher task result doc
+    def doc
+      @doc
+    end
+
+    # catcher task result code
+    def code
+      @code
+    end
+  end
+end

data/lib/samao/detail.rb

@@ -0,0 +1,30 @@
+module Samao
+  class Detail
+    include Matchable
+
+    def initialize(params={})
+      matchable
+
+      @item = params[:item]
+      @url = params[:url]
+      @base_url = params[:base_url]
+      @catcher = Catcher.new(url:@url, base_url: @base_url)
+
+      yield self if block_given?
+
+      self
+    end
+
+    def run
+      if @catcher and @catcher.run.success? and doc = @catcher.doc
+        @selector.each do |name, sel|
+          @item.set_raw name, doc.css(sel)
+          @on[name].call @item if @on[name]
+        end
+      end
+
+      self
+    end
+
+  end
+end

data/lib/samao/detector.rb

@@ -0,0 +1,96 @@
+module Samao
+  class Detector
+    include Matchable
+
+    def initialize(params={})
+      matchable
+
+      @current_url = @base_url = @from = nil
+      @pages = []
+      @items = []
+
+      yield self if block_given?
+
+      self
+    end
+
+    # return Detector self
+    def run
+      while @from and @from.run.success? and @current_doc = @from.doc
+        # find items in current_page
+        if found = @current_doc.css(@selector[:item]) and found.size >= 1
+          @items += found.map do |raw_item|
+            item = Item.new(base_url: @current_url, raw_item:raw_item) do |item|
+              @on[:item].call(item) if @on[:item]
+            end.run
+
+            if @detail_key
+              detail = Detail.new(item: item, url: item.prop(@detail_key)) do |detail|
+                @on[:detail].call(detail) if @on[:detail]
+              end.run
+            end
+
+            item.prop
+          end
+        end
+
+        # find next page[s] in current page
+        if @selector[:next] and next_url = @current_doc.at_css(@selector[:next]) and next_url = URI.join(@current_url, next_url['href'])
+          @on[:next].call(next_url) if @on[:next]
+          from next_url
+        else
+          stop
+        end
+      end
+
+      self
+    end
+
+    def add_detail(detail_key=:url, &block)
+      @detail_key = detail_key
+      @on[:detail] = block if block
+    end
+
+    def add_item(selector, &block)
+      match(:item, selector, &block)
+    end
+
+    # set front page
+    def from(url)
+      if prev_url = @current_url || @base_url
+        url = URI.join(prev_url, url)
+      end
+      url = URI(url) if ! url.is_a? URI
+
+      @from = Catcher.new(url:url, base_url:@current_url)
+      @pages << url
+      @current_url = url
+
+      self
+    end
+
+    # set base url
+    def base_url(url)
+      @base_url = url
+
+      self
+    end
+
+    # get pages
+    def pages
+      @pages
+    end
+
+    # get items
+    def items
+      @items
+    end
+
+  private
+    def stop
+      @from = nil
+
+      self
+    end
+  end
+end

data/lib/samao/item.rb

@@ -0,0 +1,58 @@
+module Samao
+  class Item
+    include Matchable
+
+    def initialize(params={})
+      matchable
+
+      @prop = {}   # usefull properties
+      @raw = {}    # nodes go here.
+
+      @base_url = params[:base_url]
+      set_raw :item, params[:raw_item] if params[:raw_item]
+
+      yield self if block_given?
+
+      self
+    end
+
+    def extract
+      @selector.each do |name, sel|
+        set_raw name, @raw[:item].css(sel)
+        @on[name].call self if @on[name]
+      end
+
+      self
+    end
+    alias :run :extract
+
+    def set(name, value)
+      @prop[name] = value
+    end
+
+    def set_url(name, value)
+      value = URI.join @base_url, value if @base_url
+      set(name, value.to_s)
+    end
+
+    def prop(name=nil)
+      if name
+        return @prop[name]
+      else
+        return @prop
+      end
+    end
+
+    def set_raw(name, value)
+      @raw[name] = value
+    end
+
+    def raw(name=nil)
+      if name
+        return @raw[name]
+      else
+        return @raw
+      end
+    end
+  end
+end

data/lib/samao/matchable.rb

@@ -0,0 +1,21 @@
+module Samao
+  module Matchable
+    def matchable?
+      true
+    end
+
+    def matchable
+      @selector = {}
+      @on = {}
+    end
+
+    def match(name, selector, &block)
+      @selector[name] = selector
+
+      @on[name] = block if block
+
+      self
+    end
+
+  end
+end

data/lib/samao/version.rb

@@ -0,0 +1,3 @@
+module Samao
+  VERSION = "0.1.0"
+end

data/lib/samao.rb

@@ -0,0 +1,12 @@
+require "samao/version"
+
+require "samao/matchable"
+
+require "samao/catcher"
+require "samao/detector"
+require "samao/item"
+require "samao/detail"
+
+module Samao
+  # Your code goes here...
+end

data/samao.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'samao/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "samao"
+  spec.version       = Samao::VERSION
+  spec.authors       = ["Liu Lantao"]
+  spec.email         = ["liulantao@gmail.com"]
+
+  spec.summary       = %q{Samao - Scalable web spider.}
+  spec.description   = %q{Samao is a web crawler written in ruby.}
+  spec.homepage      = "https://github.com/Lax/Samao"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  #if spec.respond_to?(:metadata)
+  #  spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  #else
+  #  raise "RubyGems 2.0 or newer is required to protect against " \
+  #    "public gem pushes."
+  #end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "nokogiri"
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: samao
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Liu Lantao
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  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.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Samao is a web crawler written in ruby.
+email:
+- liulantao@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/samao.rb
+- lib/samao/catcher.rb
+- lib/samao/detail.rb
+- lib/samao/detector.rb
+- lib/samao/item.rb
+- lib/samao/matchable.rb
+- lib/samao/version.rb
+- samao.gemspec
+homepage: https://github.com/Lax/Samao
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Samao - Scalable web spider.
+test_files: []