kimurai 1.3.2 → 2.0.0

data/lib/kimurai/capybara_ext/mechanize/driver.rb

@@ -1,71 +1,72 @@
 require 'mechanize'
 require_relative '../driver/base'
 
-class Capybara::Mechanize::Driver
-  # Extend capybara-mechnize to support Poltergeist-like methods
-  # https://www.rubydoc.info/gems/poltergeist/Capybara/Poltergeist/Driver
+module Capybara
+  module Mechanize
+    class Driver
+      def set_proxy(ip, port, _type, user = nil, password = nil)
+        # type is always "http", "socks" is not supported (yet)
+        browser.agent.set_proxy(ip, port, user, password)
+      end
 
-  def set_proxy(ip, port, type, user = nil, password = nil)
-    # type is always "http", "socks" is not supported (yet)
-    browser.agent.set_proxy(ip, port, user, password)
-  end
+      ###
 
-  ###
+      def headers
+        browser.agent.request_headers
+      end
 
-  def headers
-    browser.agent.request_headers
-  end
+      def headers=(headers)
+        browser.agent.request_headers = headers
+      end
 
-  def headers=(headers)
-    browser.agent.request_headers = headers
-  end
+      def add_header(name, value)
+        browser.agent.request_headers[name] = value
+      end
 
-  def add_header(name, value)
-    browser.agent.request_headers[name] = value
-  end
+      ###
 
-  ###
+      def get_cookies
+        browser.agent.cookies
+      end
 
-  def get_cookies
-    browser.agent.cookies
-  end
-
-  def set_cookie(name, value, options = {})
-    options[:name]  ||= name
-    options[:value] ||= value
+      def set_cookie(name, value, options = {})
+        options[:name]  ||= name
+        options[:value] ||= value
 
-    cookie = Mechanize::Cookie.new(options.merge path: "/")
-    browser.agent.cookie_jar << cookie
-  end
+        cookie = Mechanize::Cookie.new(options.merge(path: '/'))
+        browser.agent.cookie_jar << cookie
+      end
 
-  def set_cookies(cookies)
-    cookies.each do |cookie|
-      set_cookie(cookie[:name], cookie[:value], cookie)
-    end
-  end
+      def set_cookies(cookies)
+        cookies.each do |cookie|
+          set_cookie(cookie[:name], cookie[:value], cookie)
+        end
+      end
 
-  def clear_cookies
-    browser.agent.cookie_jar.clear!
-  end
+      def clear_cookies
+        browser.agent.cookie_jar.clear!
+      end
 
-  ###
+      ###
 
-  def quit
-    browser.agent.shutdown
-  end
+      def quit
+        browser.agent.shutdown
+      end
 
-  ###
+      ###
 
-  # Reset parent method `current_memory` for mechanize (we can't measure memory of Mechanize driver)
-  def current_memory
-    nil
-  end
+      # Reset parent method `current_memory` for mechanize (we can't measure memory of Mechanize driver)
+      def current_memory
+        nil
+      end
 
-  def pid
-    nil
-  end
+      def pid
+        nil
+      end
 
-  def port
-    nil
+      def port
+        nil
+      end
+    end
   end
 end

data/lib/kimurai/capybara_ext/selenium/driver.rb

@@ -1,34 +1,38 @@
 require_relative '../driver/base'
 
-class Capybara::Selenium::Driver
-  def get_cookies
-    browser.manage.all_cookies
-  end
-
-  def set_cookie(name, value, options = {})
-    options[:name]  ||= name
-    options[:value] ||= value
-
-    browser.manage.add_cookie(options)
-  end
-
-  def set_cookies(cookies)
-    cookies.each do |cookie|
-      set_cookie(cookie[:name], cookie[:value], cookie)
+module Capybara
+  module Selenium
+    class Driver
+      def get_cookies
+        browser.manage.all_cookies
+      end
+
+      def set_cookie(name, value, options = {})
+        options[:name]  ||= name
+        options[:value] ||= value
+
+        browser.manage.add_cookie(options)
+      end
+
+      def set_cookies(cookies)
+        cookies.each do |cookie|
+          set_cookie(cookie[:name], cookie[:value], cookie)
+        end
+      end
+
+      def clear_cookies
+        browser.manage.delete_all_cookies
+      end
+
+      ###
+
+      def pid
+        @pid ||= `lsof -i tcp:#{port} -t`.strip.to_i
+      end
+
+      def port
+        @port ||= browser.send(:bridge).instance_variable_get('@http').instance_variable_get('@server_url').port
+      end
     end
   end
-
-  def clear_cookies
-    browser.manage.delete_all_cookies
-  end
-
-  ###
-
-  def pid
-    @pid ||= `lsof -i tcp:#{port} -t`.strip.to_i
-  end
-
-  def port
-    @port ||= browser.send(:bridge).instance_variable_get("@http").instance_variable_get("@server_url").port
-  end
 end

data/lib/kimurai/capybara_ext/session/config.rb

@@ -1,6 +1,6 @@
 module Capybara
   class SessionConfig
-    attr_accessor :cookies, :proxy, :user_agent
+    attr_accessor :cookies, :proxy, :user_agent, :encoding
     attr_writer :retry_request_errors, :skip_request_errors
 
     def retry_request_errors

data/lib/kimurai/capybara_ext/session.rb

@@ -7,11 +7,12 @@ module Capybara
   class Session
     attr_accessor :spider
 
-    alias_method :original_visit, :visit
+    alias original_visit visit
     def visit(visit_uri, delay: config.before_request[:delay], skip_request_options: false, max_retries: 3)
       if spider
         process_delay(delay) if delay
-        retries, sleep_interval = 0, 0
+        retries = 0
+        sleep_interval = 0
 
         begin
           check_request_options(visit_uri) unless skip_request_options
@@ -19,7 +20,7 @@ module Capybara
           spider.class.update(:visits, :requests) if spider.with_info
 
           original_visit(visit_uri)
-        rescue => e
+        rescue StandardError => e
           if match_error?(e, type: :to_skip)
             logger.error "Browser: skip request error: #{e.inspect}, url: #{visit_uri}"
             spider.add_event(:requests_errors, e.inspect) if spider.with_info
@@ -29,7 +30,7 @@ module Capybara
             spider.add_event(:requests_errors, e.inspect) if spider.with_info
 
             if (retries += 1) <= max_retries
-              logger.info "Browser: sleep #{(sleep_interval += 15)} seconds and process retry № #{retries} to the url: #{visit_uri}"
+              logger.info "Browser: sleep #{sleep_interval += 15} seconds and process retry № #{retries} to the url: #{visit_uri}"
               sleep sleep_interval and retry
             else
               logger.error "Browser: all retries (#{retries - 1}) to the url #{visit_uri} are gone"
@@ -48,7 +49,7 @@ module Capybara
             logger.info "Info: visits: requests: #{spider.class.visits[:requests]}, responses: #{spider.class.visits[:responses]}"
           end
 
-          if memory = driver.current_memory
+          if (memory = driver.current_memory)
             logger.debug "Browser: driver.current_memory: #{memory}"
           end
         end
@@ -62,7 +63,7 @@ module Capybara
         begin
           @driver.quit
         # handle Net::ReadTimeout error for Selenium like drivers
-        rescue Net::ReadTimeout => e
+        rescue Net::ReadTimeout
           @driver.quit
         end
 
@@ -74,13 +75,8 @@ module Capybara
     end
 
     def restart!
-      if mode.match?(/poltergeist/)
-        @driver.browser.restart
-        @driver.requests, @driver.responses = 0, 0
-      else
-        destroy_driver!
-        driver
-      end
+      destroy_driver!
+      driver
 
       logger.info "Browser: driver has been restarted: name: #{mode}, pid: #{driver.pid}, port: #{driver.port}"
     end
@@ -88,7 +84,16 @@ module Capybara
     def current_response(response_type = :html)
       case response_type
       when :html
-        Nokogiri::HTML(body)
+        if config.encoding
+          if config.encoding == :auto
+            charset = body.force_encoding('ISO-8859-1').encode('UTF-8')[/<meta.*?charset="?([\w+\d+-]*)/i, 1]
+            Nokogiri::HTML(body, nil, charset)
+          else
+            Nokogiri::HTML(body, nil, config.encoding)
+          end
+        else
+          Nokogiri::HTML(body)
+        end
       when :json
         JSON.parse(body)
       end
@@ -99,23 +104,22 @@ module Capybara
     # Handy method to perform some processing in the new tab within block and then automatically close this tab:
     # Usage (url):
     # browser.within_new_window_by(url: "https://google.com") do
-      # do some stuff and then automatically close this tab and return back to the first tab
+    # do some stuff and then automatically close this tab and return back to the first tab
     # end
     # Usage (action) (when new tab opening by some action, for example by clicking
     # on a particular element):
     # action = -> { browser.find("//some/element/path").click }
     # browser.within_new_window_by(action: action) do
-      # do some stuff and then automatically close this tab and return back to the first tab
+    # do some stuff and then automatically close this tab and return back to the first tab
     # end
     def within_new_window_by(action: nil, url: nil)
-      case
-      when action
+      if action
         opened_window = window_opened_by { action.call }
         within_window(opened_window) do
           yield
           current_window.close
         end
-      when url
+      elsif url
         within_window(open_new_window) do
           visit(url)
 
@@ -128,14 +132,14 @@ module Capybara
     ###
 
     def scroll_to_bottom
-      execute_script("window.scrollBy(0,10000)")
+      execute_script('window.scrollBy(0,10000)')
     end
 
     private
 
     def skip_error_on_failure?(e)
       config.retry_request_errors.any? do |error|
-        error[:skip_on_failure] && e.class.ancestors.include?(error[:error]) if error.kind_of?(Hash)
+        error[:skip_on_failure] && e.class.ancestors.include?(error[:error]) if error.is_a?(Hash)
       end
     end
 
@@ -147,10 +151,10 @@ module Capybara
         end
 
       errors.any? do |error|
-        if error.kind_of?(Hash)
+        if error.is_a?(Hash)
           match_class = e.class.ancestors.include?(error[:error])
           if error[:message].present?
-            if error[:message].kind_of?(Regexp)
+            if error[:message].is_a?(Regexp)
               e.message&.match?(error[:message])
             else
               e.message&.include?(error[:message])
@@ -165,14 +169,14 @@ module Capybara
     end
 
     def process_delay(delay)
-      interval = (delay.class == Range ? rand(delay) : delay)
+      interval = (delay.instance_of?(Range) ? rand(delay) : delay)
       logger.debug "Browser: sleep #{interval.round(2)} #{'second'.pluralize(interval)} before request..."
       sleep interval
     end
 
     def check_request_options(url_to_visit)
       # restart_if
-      if memory_limit = config.restart_if[:memory_limit]
+      if (memory_limit = config.restart_if[:memory_limit])
         memory = driver.current_memory
         if memory && memory >= memory_limit
           logger.warn "Browser: memory_limit #{memory_limit} of driver.current_memory (#{memory}) is exceeded (engine: #{mode})"
@@ -180,7 +184,7 @@ module Capybara
         end
       end
 
-      if requests_limit = config.restart_if[:requests_limit]
+      if (requests_limit = config.restart_if[:requests_limit])
         requests = driver.requests
         if requests >= requests_limit
           logger.warn "Browser: requests_limit #{requests_limit} of driver.requests (#{requests}) is exceeded (engine: #{mode})"
@@ -200,7 +204,7 @@ module Capybara
 
       if config.before_request[:clear_cookies]
         driver.clear_cookies
-        logger.debug "Browser: cleared cookies before request"
+        logger.debug 'Browser: cleared cookies before request'
       end
 
       if config.before_request[:clear_and_set_cookies]
@@ -208,29 +212,27 @@ module Capybara
 
         # (Selenium only) if browser is not visited yet any page, visit url_to_visit
         # first and then set cookies (needs after browser restart):
-        if driver.visited.nil? && mode.match?(/selenium/)
-          visit(url_to_visit, skip_request_options: true)
-        end
+        visit(url_to_visit, skip_request_options: true) if driver.visited.nil? && mode.match?(/selenium/)
 
         config.cookies.each do |cookie|
           driver.set_cookie(cookie[:name], cookie[:value], cookie)
         end
 
-        logger.debug "Browser: cleared and set cookies before request"
+        logger.debug 'Browser: cleared and set cookies before request'
       end
 
       # user_agent
       if config.before_request[:change_user_agent]
-        driver.add_header("User-Agent", config.user_agent.call)
-        logger.debug "Browser: changed user_agent before request"
+        driver.add_header('User-Agent', config.user_agent.call)
+        logger.debug 'Browser: changed user_agent before request'
       end
 
       # proxy
-      if config.before_request[:change_proxy]
-        proxy_string = config.proxy.call
-        driver.set_proxy(*proxy_string.split(":"))
-        logger.debug "Browser: changed proxy before request"
-      end
+      return unless config.before_request[:change_proxy]
+
+      proxy_string = config.proxy.call
+      driver.set_proxy(*proxy_string.split(':'))
+      logger.debug 'Browser: changed proxy before request'
     end
 
     def logger

data/lib/kimurai/cli/generator.rb

@@ -4,20 +4,20 @@ module Kimurai
       include Thor::Actions
 
       def self.source_root
-        File.dirname(File.expand_path('..', __FILE__))
+        File.dirname(File.expand_path(__dir__))
       end
 
       def generate_project(project_name)
-        directory "template", project_name
+        directory 'template', project_name
         inside(project_name) do
-          run "bundle install"
-          run "git init"
+          run 'bundle install'
+          run 'git init'
         end
       end
 
       def generate_spider(spider_name, in_project:)
         spider_path = in_project ? "spiders/#{spider_name}.rb" : "./#{spider_name}.rb"
-        raise "Spider #{spider_path} already exists" if File.exists? spider_path
+        raise "Spider #{spider_path} already exists" if File.exist? spider_path
 
         spider_class = to_spider_class(spider_name)
         create_file spider_path do
@@ -33,24 +33,24 @@ module Kimurai
           RUBY
         end
 
-        unless in_project
-          insert_into_file spider_path, "  @engine = :mechanize\n", after: "@name = \"#{spider_name}\"\n"
-          prepend_to_file spider_path, "require 'kimurai'\n\n"
-          append_to_file spider_path, "\n#{spider_class}.crawl!"
-        end
+        return if in_project
+
+        insert_into_file spider_path, "  @engine = :mechanize\n", after: "@name = \"#{spider_name}\"\n"
+        prepend_to_file spider_path, "require 'kimurai'\n\n"
+        append_to_file spider_path, "\n#{spider_class}.crawl!"
       end
 
       def generate_schedule
-        copy_file "template/config/schedule.rb", "./schedule.rb"
+        copy_file 'template/config/schedule.rb', './schedule.rb'
       end
 
       private
 
       def to_spider_class(string)
-        string.sub(/^./) { $&.capitalize }
-          .gsub(/(?:_|(\/))([a-z\d]*)/) { "#{$1}#{$2.capitalize}" }
-          .gsub(/(?:-|(\/))([a-z\d]*)/) { "Dash#{$2.capitalize}" }
-          .gsub(/(?:\.|(\/))([a-z\d]*)/) { "#{$1}#{$2.capitalize}" }
+        string.sub(/^./) { ::Regexp.last_match(0).capitalize }
+              .gsub(%r{(?:_|(/))([a-z\d]*)}) { "#{::Regexp.last_match(1)}#{::Regexp.last_match(2).capitalize}" }
+              .gsub(%r{(?:-|(/))([a-z\d]*)}) { "Dash#{::Regexp.last_match(2).capitalize}" }
+              .gsub(%r{(?:\.|(/))([a-z\d]*)}) { "#{::Regexp.last_match(1)}#{::Regexp.last_match(2).capitalize}" }
       end
     end
   end