simple-scraper 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 738f971a98b52a7e72b34a7d04c1265d61e5f58358f1353308547b2d3e2ac40a
+  data.tar.gz: 53c9617d9fc9ee52006b47c7474b1ed4612ac05441c59bf08a9f9d7c0b9087ea
+SHA512:
+  metadata.gz: 9b1acd300ae5549d8c4287f224b493bc5e1bdf6f4e99b23957eea18b85cf07ac07ba1701ad6012e867bc0fa0259b3a6a1caa927ed72c1c6ddaa66ffb3f908550
+  data.tar.gz: 167ac5fb740df8131272e4296d8c66d5a179b6bd526e78d00f3ddee6be9721830fa59b1db5d91b0b43d84f686480e1951ad36106910244f577c906d4d3342857

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.byebug_history
+*.gem
+/pkg/*
+.ruby-gemset
+.ruby-version
+/coverage

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,33 @@
+
+AllCops:
+  TargetRubyVersion: 2.6.1
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 200
+
+Metrics/ClassLength:
+  Max: 350
+
+Metrics/ModuleLength:
+  Max: 350
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 30
+
+Metrics/CyclomaticComplexity:
+  Max: 7
+
+Metrics/BlockLength:
+  Max: 30

data/.simplecov

@@ -0,0 +1,4 @@
+SimpleCov.start do
+  add_filter '/spec/'
+  add_group 'lib', 'lib'
+end

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.1
+before_install: gem install bundler -v 1.17.3

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in web-scraper.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,71 @@
+PATH
+  remote: .
+  specs:
+    simple-scraper (1.0.0)
+      httparty (~> 0.16.4)
+      nokogiri (~> 1.6)
+      parallel (~> 1.11)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    hashdiff (0.3.8)
+    httparty (0.16.4)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    json (2.2.0)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.0331)
+    mini_portile2 (2.4.0)
+    multi_xml (0.6.0)
+    nokogiri (1.10.3)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.17.0)
+    public_suffix (3.0.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    safe_yaml (1.0.5)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    vcr (3.0.3)
+    webmock (3.5.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  simple-scraper!
+  simplecov (~> 0.16.1)
+  vcr (~> 3.0)
+  webmock (~> 3.5)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Codica.com
+
+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,127 @@
+# Simple Scraper
+
+This is a fairly simple gem that will help you simplify the parsing of web pages.
+
+## How it works
+
+Gem is based on several libraries that do most of the work:
+- [HTTParty](https://github.com/jnunemaker/httparty) is an HTTP client
+- [Parallel](https://github.com/grosser/parallel) allows performing queries in multiple threads
+- [Nokogiri](https://github.com/sparklemotion/nokogiri) is an HTML, XML, SAX, and Reader parser
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple-scraper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself in the following way:
+
+    $ gem install simple-scraper
+
+## Usage
+
+```ruby
+require 'simple/scraper'
+
+scraper = Simple::Scraper::Parser.new(
+    title: { selector: "//h1[@class='title']", handler: ->(els) { els.first.text }, default: 'Ruby' },
+    summary: { selector: "//h2[@class='summary']", handler: ->(els) { els.first.text } },
+    link: { selector: "//a[@class='link']", handler: ->(els) { els.first['href'] } },
+    text_array: { selector: "//*[@class='link']", handler: ->(els) { els.map(&:text) } }
+)
+
+result1 = scraper.parse('https://www.codica.com/')
+result2 = scraper.parse(['https://www.codica.com/1', 'https://www.codica.com/2'])
+```
+The response will be similar to:
+```json
+[
+  {
+    "title": "scraped title text",
+    "summary": "scraped summary text",
+    "link": "https://www.codica.com/blog/top-ruby-gems-we-cant-live-without/",
+    "text_array": ["text", "text" ...]
+  },
+  ...
+]
+```
+Or just find a page:
+```ruby
+Simple::Scraper::Finder.find(url: 'https://www.codica.com/', query: {}, headers: {}) do |page|
+  # page is an instance of Nokogiri::HTML::Document
+end
+```
+
+### Scraper attributes
+
+- *`title, summary, link, text_array`* - Random hash keys, they may be whatever you want.
+- *`selector`* - XPath. With its help you can find desired elements on the page.
+- *`handler`* - Any ruby object that can respond to `#call` method (`proc`, `lambda` or plain ruby class that has defined `#call` method). One argument will be passed to the handler which is an array of the elements found on the page. Each element is an instance of `Nokogiri::XML::Element`. You can read [Nokogiri](https://github.com/sparklemotion/nokogiri) documentation for more info.
+- *`default`* - In case scraper cannot find the desired element using `selector`, the value provided for the `default` attribute will be returned.
+
+### Query parameters and headers
+
+```ruby
+query = { page: 2 }
+headers = { 'Authorization': 'Bearer' }
+result = scraper.parse('https://www.codica.com/', query: query, headers: headers)
+```
+
+## Configuration
+
+### Proxy
+
+```ruby
+Simple::Scraper.configure do |config|
+  config.proxy_addr = 'proxy.something.com'
+  config.proxy_port = 80
+  config.proxy_user = 'user:'
+  config.proxy_pass = 'password'
+end
+```
+
+### Logging
+
+```ruby
+Simple::Scraper.configure do |config|
+  config.logger = Logger.new('path/to/my/logs')
+end
+```
+> By default the logging is turned off
+
+### Multithreading
+
+```ruby
+Simple::Scraper.configure do |config|
+  config.number_of_threads = 20
+end
+```
+> By default scraper works in 1 thread.
+
+### Reset
+
+You might need to reset configuration to defaults
+
+```ruby
+Simple::Scraper.reset
+```
+
+> Now you can provide new configuration if needed
+
+## License
+Copyright © 2015-2019 Codica. It is released under the [MIT License](https://opensource.org/licenses/MIT).
+
+## About Codica
+
+[![Codica logo](https://www.codica.com/assets/images/logo/logo.svg)](https://www.codica.com)
+
+simple-scraper is maintained and funded by Codica. The names and logos for Codica are trademarks of Codica.
+
+We love open source software! See [our other projects](https://github.com/codica2) or [hire us](https://www.codica.com/) to design, develop, and grow your product.

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 'simple/scraper'
+
+# 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/lib/simple/scraper.rb

@@ -0,0 +1,32 @@
+require 'nokogiri'
+require 'httparty'
+require 'parallel'
+
+require 'simple/scraper/version'
+require 'simple/scraper/configuration'
+require 'simple/scraper/finder'
+require 'simple/scraper/parser'
+
+module Simple
+  module Scraper
+    class << self
+      attr_writer :configuration, :logger
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.reset
+      @configuration = Configuration.new
+    end
+
+    def self.configure
+      yield(configuration)
+    end
+
+    def self.logger
+      configuration.logger
+    end
+  end
+end

data/lib/simple/scraper/configuration.rb

@@ -0,0 +1,21 @@
+module Simple
+  module Scraper
+    class Configuration
+      attr_accessor :proxy_addr,
+                    :proxy_port,
+                    :proxy_user,
+                    :proxy_pass,
+                    :number_of_threads,
+                    :logger
+
+      def initialize
+        @proxy_addr = nil
+        @proxy_port = nil
+        @proxy_user = nil
+        @proxy_pass = nil
+        @logger = nil
+        @number_of_threads = 1
+      end
+    end
+  end
+end

data/lib/simple/scraper/finder.rb

@@ -0,0 +1,23 @@
+module Simple
+  module Scraper
+    class Finder
+      def self.find(url:, query: {}, headers: {})
+        default_options[:query] = query
+        default_options[:headers] = headers
+        yield(Nokogiri::HTML(HTTParty.get(url, default_options)))
+      rescue StandardError => e
+        Simple::Scraper.logger&.error e
+      end
+
+      def self.default_options
+        @default_options ||= {
+          http_proxyaddr: Simple::Scraper.configuration.proxy_addr,
+          http_proxyport: Simple::Scraper.configuration.proxy_port,
+          http_proxyuser: Simple::Scraper.configuration.proxy_user,
+          http_proxypass: Simple::Scraper.configuration.proxy_pass,
+          verify: false
+        }
+      end
+    end
+  end
+end

data/lib/simple/scraper/parser.rb

@@ -0,0 +1,24 @@
+module Simple
+  module Scraper
+    class Parser
+      attr_reader :attributes
+
+      def initialize(attributes)
+        @attributes = attributes || {}
+      end
+
+      def parse(urls, query: {}, headers: {})
+        Parallel.map(Array(urls), in_threads: Simple::Scraper.configuration.number_of_threads) do |url|
+          Finder.find(url: url, query: query, headers: headers) do |page|
+            attributes.each_with_object({}) do |(key, options), hsh|
+              hsh[key] = options[:handler].call(page.xpath(options[:selector]))
+            rescue StandardError => e
+              Simple::Scraper.logger&.error e
+              hsh[key] = options[:default]
+            end
+          end
+        end.compact
+      end
+    end
+  end
+end

data/lib/simple/scraper/version.rb

@@ -0,0 +1,5 @@
+module Simple
+  module Scraper
+    VERSION = '1.0.0'.freeze
+  end
+end

data/simple-scraper.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple/scraper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'simple-scraper'
+  spec.version       = Simple::Scraper::VERSION
+  spec.authors       = ['Igor Tikhonenko']
+  spec.email         = ['tikhonenkoigor@gmail.com']
+
+  spec.summary       = 'Library for parsing/scraping web pages.'
+  spec.description   = 'Library was built on top of nokogiri, parallel and httparty gems that do most of the work'
+  spec.homepage      = 'https://github.com/codica2/simple-scraper'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |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_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'vcr', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 3.5'
+  spec.add_development_dependency 'simplecov', '~> 0.16.1'
+  spec.add_dependency 'httparty', '~> 0.16.4'
+  spec.add_dependency 'nokogiri', '~> 1.6'
+  spec.add_dependency 'parallel', '~> 1.11'
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: simple-scraper
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Igor Tikhonenko
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.4
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+description: Library was built on top of nokogiri, parallel and httparty gems that
+  do most of the work
+email:
+- tikhonenkoigor@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".simplecov"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simple/scraper.rb
+- lib/simple/scraper/configuration.rb
+- lib/simple/scraper/finder.rb
+- lib/simple/scraper/parser.rb
+- lib/simple/scraper/version.rb
+- simple-scraper.gemspec
+homepage: https://github.com/codica2/simple-scraper
+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: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Library for parsing/scraping web pages.
+test_files: []