kimurai 1.0.0

data/lib/kimurai/template/helpers/application_helper.rb

@@ -0,0 +1,3 @@
+module ApplicationHelper
+  # Put here custom methods which are will be available for any spider
+end

data/lib/kimurai/template/pipelines/saver.rb

@@ -0,0 +1,11 @@
+class Saver < Kimurai::Pipeline
+  def process_item(item, options: {})
+    # Here you can save item to the database, send it to a remote API or
+    # simply save item to a file format using `save_to` helper:
+
+    # To get the name of a current spider: `spider.class.name`
+    # save_to "db/#{spider.class.name}.json", item, format: :pretty_json
+
+    item
+  end
+end

data/lib/kimurai/template/pipelines/validator.rb

@@ -0,0 +1,24 @@
+class Validator < Kimurai::Pipeline
+  def process_item(item, options: {})
+    # Here you can validate item and raise `DropItemError`
+    # if one of the validations failed. Examples:
+
+    # Check item sku for uniqueness using buit-in `unique?` helper:
+    # unless unique?(:sku, item[:sku])
+    #   raise DropItemError, "Item sku is not unique"
+    # end
+
+    # Drop item if title length shorter than 5 symbols:
+    # if item[:title].size < 5
+    #   raise DropItemError, "Item title is short"
+    # end
+
+    # Drop item if it doesn't contains any images:
+    # unless item[:images].present?
+    #   raise DropItemError, "Item images are not present"
+    # end
+
+    # Pass item to the next pipeline (if it wasn't dropped)
+    item
+  end
+end

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

@@ -0,0 +1,104 @@
+# 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: `$ kimurai generate spider spider_name`
+
+class ApplicationSpider < Kimurai::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",
+
+    # Browser (Capybara session instance) options:
+    browser: {
+      # Array of errors to retry while processing a request
+      # retry_request_errors: [Net::ReadTimeout],
+      # 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
+      },
+      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/kimurai/version.rb

@@ -0,0 +1,3 @@
+module Kimurai
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,349 @@
+--- !ruby/object:Gem::Specification
+name: kimurai
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Victor Afanasev
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-23 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: 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:
+- kimurai
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/kimurai
+- kimurai.gemspec
+- lib/kimurai.rb
+- lib/kimurai/automation/deploy.yml
+- lib/kimurai/automation/setup.yml
+- lib/kimurai/automation/setup/chromium_chromedriver.yml
+- lib/kimurai/automation/setup/firefox_geckodriver.yml
+- lib/kimurai/automation/setup/phantomjs.yml
+- lib/kimurai/automation/setup/ruby_environment.yml
+- lib/kimurai/base.rb
+- lib/kimurai/base/simple_saver.rb
+- lib/kimurai/base/uniq_checker.rb
+- lib/kimurai/base_helper.rb
+- lib/kimurai/browser_builder.rb
+- lib/kimurai/browser_builder/mechanize_builder.rb
+- lib/kimurai/browser_builder/poltergeist_phantomjs_builder.rb
+- lib/kimurai/browser_builder/selenium_chrome_builder.rb
+- lib/kimurai/browser_builder/selenium_firefox_builder.rb
+- lib/kimurai/capybara_configuration.rb
+- lib/kimurai/capybara_ext/driver/base.rb
+- lib/kimurai/capybara_ext/mechanize/driver.rb
+- lib/kimurai/capybara_ext/poltergeist/driver.rb
+- lib/kimurai/capybara_ext/selenium/driver.rb
+- lib/kimurai/capybara_ext/session.rb
+- lib/kimurai/capybara_ext/session/config.rb
+- lib/kimurai/cli.rb
+- lib/kimurai/cli/ansible_command_builder.rb
+- lib/kimurai/cli/generator.rb
+- lib/kimurai/core_ext/array.rb
+- lib/kimurai/core_ext/numeric.rb
+- lib/kimurai/core_ext/string.rb
+- lib/kimurai/pipeline.rb
+- lib/kimurai/runner.rb
+- lib/kimurai/template/.gitignore
+- lib/kimurai/template/.ruby-version
+- lib/kimurai/template/Gemfile
+- lib/kimurai/template/README.md
+- lib/kimurai/template/config/application.rb
+- lib/kimurai/template/config/automation.yml
+- lib/kimurai/template/config/boot.rb
+- lib/kimurai/template/config/initializers/.keep
+- lib/kimurai/template/config/schedule.rb
+- lib/kimurai/template/db/.keep
+- lib/kimurai/template/helpers/application_helper.rb
+- lib/kimurai/template/lib/.keep
+- lib/kimurai/template/log/.keep
+- lib/kimurai/template/pipelines/saver.rb
+- lib/kimurai/template/pipelines/validator.rb
+- lib/kimurai/template/spiders/application_spider.rb
+- lib/kimurai/template/tmp/.keep
+- lib/kimurai/version.rb
+homepage: https://github.com/vifreefly/kimurai
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Modern web scraping framework written in Ruby and based on Capybara/Nokogiri
+test_files: []