tanakai 1.5.0

data/lib/tanakai/template/spiders/application_spider.rb

@@ -0,0 +1,143 @@
+# ApplicationSpider is a default base spider class. You can set here
+# default settings for all spiders inherited from ApplicationSpider.
+# To generate a new spider, run: `$ tanakai generate spider spider_name`
+
+class ApplicationSpider < Tanakai::Base
+  include ApplicationHelper
+
+  # Default engine for spiders (available engines: :mechanize, :poltergeist_phantomjs,
+  # :selenium_firefox, :selenium_chrome)
+  @engine = :poltergeist_phantomjs
+
+  # Pipelines list, by order.
+  # To process item through pipelines pass item to the `send_item` method
+  @pipelines = [:validator, :saver]
+
+  # Default config. Set here options which are default for all spiders inherited
+  # from ApplicationSpider. Child's class config will be deep merged with this one
+  @config = {
+    # Custom headers, format: hash. Example: { "some header" => "some value", "another header" => "another value" }
+    # Works only for :mechanize and :poltergeist_phantomjs engines (Selenium doesn't allow to set/get headers)
+    # headers: {},
+
+    # Custom User Agent, format: string or lambda.
+    # Use lambda if you want to rotate user agents before each run:
+    # user_agent: -> { ARRAY_OF_USER_AGENTS.sample }
+    # Works for all engines
+    # user_agent: "Mozilla/5.0 Firefox/61.0",
+
+    # Custom cookies, format: array of hashes.
+    # Format for a single cookie: { name: "cookie name", value: "cookie value", domain: ".example.com" }
+    # Works for all engines
+    # cookies: [],
+
+    # Proxy, format: string or lambda. Format of a proxy string: "ip:port:protocol:user:password"
+    # `protocol` can be http or socks5. User and password are optional.
+    # Use lambda if you want to rotate proxies before each run:
+    # proxy: -> { ARRAY_OF_PROXIES.sample }
+    # Works for all engines, but keep in mind that Selenium drivers doesn't support proxies
+    # with authorization. Also, Mechanize doesn't support socks5 proxy format (only http)
+    # proxy: "3.4.5.6:3128:http:user:pass",
+
+    # If enabled, browser will ignore any https errors. It's handy while using a proxy
+    # with self-signed SSL cert (for example Crawlera or Mitmproxy)
+    # Also, it will allow to visit webpages with expires SSL certificate.
+    # Works for all engines
+    ignore_ssl_errors: true,
+
+    # Custom window size, works for all engines
+    # window_size: [1366, 768],
+
+    # Skip images downloading if true, works for all engines
+    disable_images: true,
+
+    # Selenium engines only: headless mode, `:native` or `:virtual_display` (default is :native)
+    # Although native mode has a better performance, virtual display mode
+    # sometimes can be useful. For example, some websites can detect (and block)
+    # headless chrome, so you can use virtual_display mode instead
+    # headless_mode: :native,
+
+    # This option tells the browser not to use a proxy for the provided list of domains or IP addresses.
+    # Format: array of strings. Works only for :selenium_firefox and selenium_chrome
+    # proxy_bypass_list: [],
+
+    # Option to provide custom SSL certificate. Works only for :poltergeist_phantomjs and :mechanize
+    # ssl_cert_path: "path/to/ssl_cert",
+
+    # Inject some JavaScript code to the browser.
+    # Format: array of strings, where each string is a path to JS file.
+    # Works only for poltergeist_phantomjs engine (Selenium doesn't support JS code injection)
+    # extensions: ["lib/code_to_inject.js"],
+
+    # Automatically skip duplicated (already visited) urls when using `request_to` method.
+    # Possible values: `true` or `hash` with options.
+    # In case of `true`, all visited urls will be added to the storage's scope `:requests_urls`
+    # and if url already contains in this scope, request will be skipped.
+    # You can configure this setting by providing additional options as hash:
+    # `skip_duplicate_requests: { scope: :custom_scope, check_only: true }`, where:
+    # `scope:` - use custom scope than `:requests_urls`
+    # `check_only:` - if true, then scope will be only checked for url, url will not
+    # be added to the scope if scope doesn't contains it.
+    # works for all drivers
+    # skip_duplicate_requests: true,
+
+    # Automatically skip provided errors while requesting a page.
+    # If raised error matches one of the errors in the list, then this error will be caught,
+    # and request will be skipped.
+    # It is a good idea to skip errors like NotFound(404), etc.
+    # Format: array where elements are error classes or/and hashes. You can use hash format
+    # for more flexibility: `{ error: "RuntimeError", message: "404 => Net::HTTPNotFound" }`.
+    # Provided `message:` will be compared with a full error message using `String#include?`. Also
+    # you can use regex instead: `{ error: "RuntimeError", message: /404|403/ }`.
+    # skip_request_errors: [{ error: RuntimeError, message: "404 => Net::HTTPNotFound" }],
+
+    # Automatically retry provided errors with a few attempts while requesting a page.
+    # If raised error matches one of the errors in the list, then this error will be caught
+    # and the request will be processed again within a delay. There are 3 attempts:
+    # first: delay 15 sec, second: delay 30 sec, third: delay 45 sec.
+    # If after 3 attempts there is still an exception, then the exception will be raised.
+    # It is a good idea to try to retry errros like `ReadTimeout`, `HTTPBadGateway`, etc.
+    # Format: same like for `skip_request_errors` option.
+    # retry_request_errors: [Net::ReadTimeout],
+
+    # Handle page encoding while parsing html response using Nokogiri. There are two modes:
+    # Auto (`:auto`) (try to fetch correct encoding from <meta http-equiv="Content-Type"> or <meta charset> tags)
+    # Set required encoding manually, example: `encoding: "GB2312"` (Set required encoding manually)
+    # Default this option is unset.
+    # encoding: nil,
+
+    # Restart browser if one of the options is true:
+    restart_if: {
+      # Restart browser if provided memory limit (in kilobytes) is exceeded (works for all engines)
+      # memory_limit: 350_000,
+
+      # Restart browser if provided requests limit is exceeded (works for all engines)
+      # requests_limit: 100
+    },
+
+    # Perform several actions before each request:
+    before_request: {
+      # Change proxy before each request. The `proxy:` option above should be presented
+      # and has lambda format. Works only for poltergeist and mechanize engines
+      # (Selenium doesn't support proxy rotation).
+      # change_proxy: true,
+
+      # Change user agent before each request. The `user_agent:` option above should be presented
+      # and has lambda format. Works only for poltergeist and mechanize engines
+      # (selenium doesn't support to get/set headers).
+      # change_user_agent: true,
+
+      # Clear all cookies before each request, works for all engines
+      # clear_cookies: true,
+
+      # If you want to clear all cookies + set custom cookies (`cookies:` option above should be presented)
+      # use this option instead (works for all engines)
+      # clear_and_set_cookies: true,
+
+      # Global option to set delay between requests.
+      # Delay can be `Integer`, `Float` or `Range` (`2..5`). In case of a range,
+      # delay number will be chosen randomly for each request: `rand (2..5) # => 3`
+      # delay: 1..3
+    }
+  }
+end

data/lib/tanakai/version.rb

@@ -0,0 +1,3 @@
+module Tanakai
+  VERSION = "1.5.0"
+end

data/lib/tanakai.rb

@@ -0,0 +1,54 @@
+require 'ostruct'
+require 'logger'
+require 'json'
+require 'active_support'
+require 'active_support/core_ext'
+require 'rbcat'
+
+require_relative 'tanakai/version'
+
+require_relative 'tanakai/core_ext/numeric'
+require_relative 'tanakai/core_ext/string'
+require_relative 'tanakai/core_ext/array'
+require_relative 'tanakai/core_ext/hash'
+
+require_relative 'tanakai/browser_builder'
+require_relative 'tanakai/base_helper'
+require_relative 'tanakai/pipeline'
+require_relative 'tanakai/base'
+
+module Tanakai
+  class << self
+    def configuration
+      @configuration ||= OpenStruct.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def env
+      ENV.fetch("TANAKAI_ENV") { "development" }
+    end
+
+    def time_zone
+      ENV["TZ"]
+    end
+
+    def time_zone=(value)
+      ENV.store("TZ", value)
+    end
+
+    def list
+      Base.descendants.map do |klass|
+        next unless klass.name
+        [klass.name, klass]
+      end.compact.to_h
+    end
+
+    def find_by_name(name)
+      return unless name
+      Base.descendants.find { |klass| klass.name == name }
+    end
+  end
+end

data/tanakai.gemspec

@@ -0,0 +1,50 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "tanakai/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "tanakai"
+  spec.version       = Tanakai::VERSION
+  spec.authors       = ["Victor Afanasev", "Glauco Custódio"]
+  spec.email         = ["vicfreefly@gmail.com"]
+
+  spec.summary       = "Maintained fork of Kimurai, a modern web scraping framework written in Ruby and based on Capybara/Nokogiri"
+  spec.homepage      = "https://github.com/glaucocustodio/tanakai"
+  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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = "tanakai"
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 2.5.0"
+
+  spec.add_dependency "thor"
+  spec.add_dependency "cliver"
+  spec.add_dependency "activesupport"
+  spec.add_dependency "murmurhash3"
+  spec.add_dependency "nokogiri"
+
+  spec.add_dependency "capybara", ">= 2.15", "< 4.0"
+  spec.add_dependency "capybara-mechanize"
+  spec.add_dependency "poltergeist"
+  spec.add_dependency "selenium-webdriver"
+  spec.add_dependency "apparition"
+  spec.add_dependency "cuprite"
+
+  spec.add_dependency "headless"
+  spec.add_dependency "pmap"
+
+  spec.add_dependency "whenever"
+
+  spec.add_dependency "rbcat", "~> 0.2"
+  spec.add_dependency "pry"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,382 @@
+--- !ruby/object:Gem::Specification
+name: tanakai
+version: !ruby/object:Gem::Version
+  version: 1.5.0
+platform: ruby
+authors:
+- Victor Afanasev
+- Glauco Custódio
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  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: cliver
+  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: activesupport
+  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: murmurhash3
+  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: 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: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.15'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.15'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: capybara-mechanize
+  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: poltergeist
+  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: selenium-webdriver
+  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: apparition
+  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: cuprite
+  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: headless
+  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: pmap
+  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: whenever
+  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: rbcat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description:
+email:
+- vicfreefly@gmail.com
+executables:
+- tanakai
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/tanakai
+- lib/tanakai.rb
+- lib/tanakai/automation/deploy.yml
+- lib/tanakai/automation/setup.yml
+- lib/tanakai/automation/setup/chromium_chromedriver.yml
+- lib/tanakai/automation/setup/firefox_geckodriver.yml
+- lib/tanakai/automation/setup/phantomjs.yml
+- lib/tanakai/automation/setup/ruby_environment.yml
+- lib/tanakai/base.rb
+- lib/tanakai/base/saver.rb
+- lib/tanakai/base/storage.rb
+- lib/tanakai/base_helper.rb
+- lib/tanakai/browser_builder.rb
+- lib/tanakai/browser_builder/apparition_builder.rb
+- lib/tanakai/browser_builder/cuprite_builder.rb
+- lib/tanakai/browser_builder/mechanize_builder.rb
+- lib/tanakai/browser_builder/poltergeist_phantomjs_builder.rb
+- lib/tanakai/browser_builder/selenium_chrome_builder.rb
+- lib/tanakai/browser_builder/selenium_firefox_builder.rb
+- lib/tanakai/capybara_configuration.rb
+- lib/tanakai/capybara_ext/apparition/driver.rb
+- lib/tanakai/capybara_ext/cuprite/driver.rb
+- lib/tanakai/capybara_ext/driver/base.rb
+- lib/tanakai/capybara_ext/mechanize/driver.rb
+- lib/tanakai/capybara_ext/poltergeist/driver.rb
+- lib/tanakai/capybara_ext/selenium/driver.rb
+- lib/tanakai/capybara_ext/session.rb
+- lib/tanakai/capybara_ext/session/config.rb
+- lib/tanakai/cli.rb
+- lib/tanakai/cli/ansible_command_builder.rb
+- lib/tanakai/cli/generator.rb
+- lib/tanakai/core_ext/array.rb
+- lib/tanakai/core_ext/hash.rb
+- lib/tanakai/core_ext/numeric.rb
+- lib/tanakai/core_ext/string.rb
+- lib/tanakai/pipeline.rb
+- lib/tanakai/runner.rb
+- lib/tanakai/template/.gitignore
+- lib/tanakai/template/Gemfile
+- lib/tanakai/template/README.md
+- lib/tanakai/template/config/application.rb
+- lib/tanakai/template/config/automation.yml
+- lib/tanakai/template/config/boot.rb
+- lib/tanakai/template/config/initializers/.keep
+- lib/tanakai/template/config/schedule.rb
+- lib/tanakai/template/db/.keep
+- lib/tanakai/template/helpers/application_helper.rb
+- lib/tanakai/template/lib/.keep
+- lib/tanakai/template/log/.keep
+- lib/tanakai/template/pipelines/saver.rb
+- lib/tanakai/template/pipelines/validator.rb
+- lib/tanakai/template/spiders/application_spider.rb
+- lib/tanakai/template/tmp/.keep
+- lib/tanakai/version.rb
+- tanakai.gemspec
+homepage: https://github.com/glaucocustodio/tanakai
+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.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Maintained fork of Kimurai, a modern web scraping framework written in Ruby
+  and based on Capybara/Nokogiri
+test_files: []