tsumamigui 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c58ebec9f2629957128d3d826729a1a0888ec250
+  data.tar.gz: 4a59da2a971ba30319f665b5c3ea1703952e2b0b
+SHA512:
+  metadata.gz: 6af52cd0b719b0cf62274391fb8743003263753f97e3850ca3d58f35d21ef97d58d4dfab0fb1b7b7fb057691b0f20672220501062101b96d37d5d990bb4a1831
+  data.tar.gz: c9d9a48d63cfb512379159d03ee82e80c3a10cb070f81c8b26387e3a115cb6c06b6cdcd2669a135dba90ff3e353726abf0b4685ec81f0ddb20f76cace8dbfbca

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.ruby-version
+/vendor/bundle/
+
+# rspec failure tracking
+.rspec_status

data/.pryrc

@@ -0,0 +1,6 @@
+if defined?(PryByebug)
+  Pry.commands.alias_command 'c', 'continue'
+  Pry.commands.alias_command 's', 'step'
+  Pry.commands.alias_command 'n', 'next'
+  Pry.commands.alias_command 'f', 'finish'
+end

data/.rspec

@@ -0,0 +1,4 @@
+--require spec_helper
+--format documentation
+--color
+--order random

data/.rubocop.yml

@@ -0,0 +1,21 @@
+AllCops:
+    DisplayCopNames: true
+    Exclude:
+        - 'vendor/**/*'
+Style/Documentation:
+    Enabled: false
+Style/AsciiComments:
+    Enabled: false
+Style/StringLiterals:
+    Enabled: false
+Style/NumericLiterals:
+    Enabled: false
+Style/FrozenStringLiteralComment:
+    Enabled: false
+Metrics/BlockLength:
+    Exclude:
+        - 'spec/**/*'
+Layout/SpaceAroundEqualsInParameterDefault:
+    EnforcedStyle: no_space
+Layout/SpaceInsideHashLiteralBraces:
+    EnforcedStyle: no_space

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 obiyuta
+
+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,78 @@
+# Tsumamigui
+![circleci](https://circleci.com/gh/obiyuta/tsumamigui.svg?&style=shield&circle-token=8e2bda0f04504c2fe43d3fe70ea8ab1b6184806f) [![Code Climate](https://codeclimate.com/github/obiyuta/tsumamigui/badges/gpa.svg)](https://codeclimate.com/github/obiyuta/tsumamigui) [![Test Coverage](https://codeclimate.com/github/obiyuta/tsumamigui/badges/coverage.svg)](https://codeclimate.com/github/obiyuta/tsumamigui/coverage) [![Dependency Status](https://gemnasium.com/badges/github.com/obiyuta/tsumamigui.svg)](https://gemnasium.com/github.com/obiyuta/tsumamigui) [![Inline docs](http://inch-ci.org/github/obiyuta/tsumamigui.svg?branch=master)](http://inch-ci.org/github/obiyuta/tsumamigui)
+
+Tsumamigui（つまみぐい） is a simple and hussle-free Ruby web scraping library.
+
+## Requirement
+
+Ruby 2.1+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tsumamigui'
+```
+
+Or install it yourself as:
+
+```
+$ gem install tsumamigui
+```
+
+## Usage
+
+You just give it a URL(or URLs) and Xpath to data you want to get with its label as a hash.
+Then you can get scraped and parsed data as array.
+
+```ruby
+Tsumamigui.scrape('http://example.com', {h1: 'html/body/div/h1/text()'})
+
+# Returns:
+# [
+#   {h1: 'Example Domain', scraped_from: 'http://example.com'}
+# ]
+```
+
+You can specify multiple URLs if you want to scrape different pages which they have the same HTML structure.
+
+```ruby
+urls = ['http://example.com/page/1', 'http://example.com/page/2']
+Tsumamigui.scrape(urls, {h1: 'html/body/div/h1/text()'})
+
+# Returns:
+# [
+#   {h1: 'Example Domain 1', scraped_from: 'http://example.com/page/1'}
+#   {h1: 'Example Domain 2', scraped_from: 'http://example.com/page/2'}
+# ]
+```
+___Important:___ Tsumamigui requests each urls at intervals of 1.0~3.0sec automatically.
+
+## TODO
+
+- [ ] Custom request headers.
+- [ ] SSL support. (unchecked)
+
+etc...
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/obiyuta/tsumamigui](https://github.com/obiyuta/tsumamigui). 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.
+
+### Guideline
+
+1. Fork it ( http://github.com/obiyuta/tsumamigui )
+1. Create your feature branch (git checkout -b my-new-feature)
+1. Write codes and specs.
+   - Run test suite with `bundle exec rspec` and confirm that it passes
+   - Run lint checker with the `bundle exec rubocop` and confirm that it passes 
+1. Commit your changes (git commit -am 'Add some feature')
+1. Push to the branch (git push origin my-new-feature)
+1. Create new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+Copyright (c) 2017 Obi Yuta. See MIT-LICENSE for details.

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 'tsumamigui'
+
+# 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(__FILE__)

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/circle.yml

@@ -0,0 +1,45 @@
+machine:
+  timezone: Asia/Tokyo
+  ruby:
+    version: 2.4.1
+  environment:
+    CC_TEST_REPORTER_ID: fb2b65ee179ec4ba3ac0f60d2047823566cc14dac0578c4c401532e682f5d435
+database:
+  override:
+    - echo 'Skipping DB step.'
+dependencies:
+  cache_directories:
+    - 'vendor/bundle'
+    - 'vendor/bundle_2.3.4'
+    - 'vendor/bundle_2.2.7'
+    - 'vendor/bundle_2.1.6'
+  pre:
+    - rvm install 2.3.4
+    - rvm install 2.2.7
+    - rvm install 2.1.6
+  override:
+    - bundle install --path vendor/bundle
+    - rvm-exec 2.3.4 bash -c 'bundle install --path vendor/bundle_2.3.4'
+    - rvm-exec 2.2.7 bash -c 'bundle install --path vendor/bundle_2.2.7'
+    - rvm-exec 2.1.6 bash -c 'bundle install --path vendor/bundle_2.1.6'
+  post:
+    - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+    - chmod +x ./cc-test-reporter
+test:
+  pre:
+    - ./cc-test-reporter before-build
+  override:
+    - bundle config --local path vendor/bundle_2.3.4
+    - rvm-exec 2.3.4 bash -c 'bundle exec rspec'
+    - bundle config --local path vendor/bundle_2.2.7
+    - rvm-exec 2.2.7 bash -c 'bundle exec rspec'
+    - bundle config --local path vendor/bundle_2.1.6
+    - rvm-exec 2.1.6 bash -c 'bundle exec rspec'
+    - bundle config --local path vendor/bundle
+    - bundle exec rubocop
+    - bundle exec rspec
+  post:
+    - ./cc-test-reporter after-build --exit-code $EXIT_CODE
+general:
+  artifacts:
+    - coverage

data/lib/tsumamigui.rb

@@ -0,0 +1,21 @@
+require 'tsumamigui/version'
+require 'tsumamigui/request'
+require 'tsumamigui/parser'
+
+module Tsumamigui
+  class << self
+    # @param [String] url
+    # @param [Array<String>] url
+    # @param [Hash] xpath key and xpath to it
+    # @return [Array] parsed contents
+    # @example
+    #   Tsumamigui.scrape('http://example.com', title: '//div[0]/@content')
+    #   # you can specify muitiple urls at once
+    #   urls = ['http://example.com', 'http://example.com/sample']
+    #   Tsumamigui.scrape(urls, title: '//div[0]/@content')
+    def scrape(url, xpath)
+      documents = Request.run(url)
+      Parser.parse(documents, xpath)
+    end
+  end
+end

data/lib/tsumamigui/error.rb

@@ -0,0 +1,4 @@
+module Tsumamigui
+  class RequestError < StandardError; end
+  class ParserError < StandardError; end
+end

data/lib/tsumamigui/parser.rb

@@ -0,0 +1,52 @@
+require 'nokogiri'
+require 'tsumamigui/error'
+
+module Tsumamigui
+  class Parser
+    attr_reader :xpath
+
+    class << self
+      # @param [Array<Tsumamigui::Response>] responses
+      # @param [Hash] xpath
+      # @return [Array<Hash>]
+      def parse(responses, xpath)
+        new(xpath).send(:parse, responses)
+      end
+    end
+
+    # @param [Hash] xpath Name and xpath to it
+    def initialize(xpath)
+      @xpath = xpath
+    end
+
+    private
+
+    # @return [Array<Tsumamigui::Response>] responses
+    # @raise [Tsumamigui::ParserError]
+    def parse(responses)
+      results = []
+      responses.each do |res|
+        url, html, charset = res.to_array
+        result = extract(Nokogiri::HTML.parse(html, nil, charset))
+        result[:scraped_from] = url
+        results.push(result)
+      end
+      results
+    rescue => e
+      raise ParserError, e.message
+    end
+
+    # @param [Object] document Nokogiri::HTML::Document
+    # @return [Hash]
+    # @raise [Tsumamigui::ParserError]
+    def extract(doc)
+      result = {}
+      @xpath.each do |k, v|
+        result[k] = doc.xpath(v).to_s
+      end
+      result
+    rescue => e
+      raise ParserError, e.message
+    end
+  end
+end

data/lib/tsumamigui/request.rb

@@ -0,0 +1,66 @@
+require 'open-uri'
+require 'tsumamigui/error'
+require 'tsumamigui/response'
+
+module Tsumamigui
+  class Request
+    class << self
+      # @param [String] urls
+      # @param [Array<String>] urls
+      # @return [Array<Tsumamigui::Response>]
+      def run(*urls)
+        new(urls).send(:run)
+      end
+    end
+
+    INTERVAL = 1.0..3.0 # sec
+
+    attr_reader :urls
+
+    # @param [String] urls
+    # @param [Array<String>] urls
+    def initialize(*urls)
+      @urls = urls.flatten
+      raise ArgumentError, 'No argument is specified' if @urls.empty?
+      @urls
+    end
+
+    private
+
+    # @return [Array<Tsumamigui::Response>]
+    def run
+      results = []
+      @urls.each do |url|
+        results.push(fetch(url))
+      end
+      results
+    end
+
+    # @param [String] url
+    # @return [Tsumamigui::Response] response
+    # @raise [Tsumamigui::RequestError]
+    def fetch(url)
+      charset = nil
+      sleep(sleep_interval)
+      html = open(url, request_options) do |f|
+        charset = f.charset
+        f.read
+      end
+
+      Response.new(url, html, charset)
+    rescue => e
+      raise RequestError, e.message
+    end
+
+    # @return [Float] sec 1.0-3.0秒
+    def sleep_interval
+      Random.rand(INTERVAL)
+    end
+
+    # @return [Hash] options
+    def request_options
+      homepage = 'https://github.com/obiyuta/tsumamigui'
+      {'User-Agent' => "Tsumamigui/#{Tsumamigui::VERSION} (+#{homepage})"}
+    end
+  end
+end

data/lib/tsumamigui/response.rb

@@ -0,0 +1,21 @@
+module Tsumamigui
+  class Response
+    attr_reader :url
+    attr_reader :html
+    attr_reader :charset
+
+    # @param [String] url
+    # @param [String] html
+    # @param [String] charset
+    def initialize(url, html, charset)
+      @url = url
+      @html = html
+      @charset = charset
+    end
+
+    # @return [Array]
+    def to_array
+      [@url, @html, @charset]
+    end
+  end
+end

data/lib/tsumamigui/version.rb

@@ -0,0 +1,3 @@
+module Tsumamigui
+  VERSION = '0.1.0'.freeze
+end

data/tsumamigui.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tsumamigui/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'tsumamigui'
+  spec.version       = Tsumamigui::VERSION
+  spec.authors       = ['obiyuta']
+  spec.email         = ['obi.yuta@gmail.com']
+
+  spec.summary       = 'The simple and hussle-free Ruby web scraper'
+  spec.description   = 'Tsumamigui（つまみぐい） is a simple and hussle-free Ruby web scraping library.'
+  spec.homepage      = 'https://github.com/obiyuta/tsumamigui'
+  spec.license       = 'MIT'
+
+  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'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 1.0.0'
+end

metadata

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification
+name: tsumamigui
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- obiyuta
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-12 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: 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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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-byebug
+  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: yard
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: Tsumamigui（つまみぐい） is a simple and hussle-free Ruby web scraping library.
+email:
+- obi.yuta@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".pryrc"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- circle.yml
+- lib/tsumamigui.rb
+- lib/tsumamigui/error.rb
+- lib/tsumamigui/parser.rb
+- lib/tsumamigui/request.rb
+- lib/tsumamigui/response.rb
+- lib/tsumamigui/version.rb
+- tsumamigui.gemspec
+homepage: https://github.com/obiyuta/tsumamigui
+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.6.11
+signing_key: 
+specification_version: 4
+summary: The simple and hussle-free Ruby web scraper
+test_files: []