puppeteer-ruby 0.0.16 → 0.0.21

data/lib/puppeteer/page.rb

@@ -101,7 +101,9 @@ class Puppeteer::Page
     end
     # client.on('Runtime.consoleAPICalled', event => this._onConsoleAPI(event));
     # client.on('Runtime.bindingCalled', event => this._onBindingCalled(event));
-    # client.on('Page.javascriptDialogOpening', event => this._onDialog(event));
+    @client.on_event 'Page.javascriptDialogOpening' do |event|
+      handle_dialog_opening(event)
+    end
     # client.on('Runtime.exceptionThrown', exception => this._handleException(exception.exceptionDetails));
     # client.on('Inspector.targetCrashed', event => this._onTargetCrashed());
     # client.on('Performance.metrics', event => this._emitMetrics(event));
@@ -129,7 +131,7 @@ class Puppeteer::Page
   EVENT_MAPPINGS = {
     close: 'Events.Page.Close',
     # console: 'Events.Page.Console',
-    # dialog: 'Events.Page.Dialog',
+    dialog: 'Events.Page.Dialog',
     domcontentloaded: 'Events.Page.DOMContentLoaded',
     # error:
     frameattached: 'Events.Page.FrameAttached',
@@ -266,7 +268,13 @@ class Puppeteer::Page
     @frame_manager.main_frame
   end
 
-  attr_reader :keyboard, :touch_screen, :coverage, :accessibility
+  attr_reader :touch_screen, :coverage, :accessibility
+
+  def keyboard(&block)
+    @keyboard.instance_eval(&block) unless block.nil?
+
+    @keyboard
+  end
 
   def frames
     @frame_manager.frames
@@ -626,20 +634,17 @@ class Puppeteer::Page
   #   this.emit(Events.Page.Console, message);
   # }
 
-  # _onDialog(event) {
-  #   let dialogType = null;
-  #   if (event.type === 'alert')
-  #     dialogType = Dialog.Type.Alert;
-  #   else if (event.type === 'confirm')
-  #     dialogType = Dialog.Type.Confirm;
-  #   else if (event.type === 'prompt')
-  #     dialogType = Dialog.Type.Prompt;
-  #   else if (event.type === 'beforeunload')
-  #     dialogType = Dialog.Type.BeforeUnload;
-  #   assert(dialogType, 'Unknown javascript dialog type: ' + event.type);
-  #   const dialog = new Dialog(this._client, dialogType, event.message, event.defaultPrompt);
-  #   this.emit(Events.Page.Dialog, dialog);
-  # }
+  private def handle_dialog_opening(event)
+    dialog_type = event['type']
+    unless %w(alert confirm prompt beforeunload).include?(dialog_type)
+      raise ArgumentError.new("Unknown javascript dialog type: #{dialog_type}")
+    end
+    dialog = Puppeteer::Dialog.new(@client,
+              type: dialog_type,
+              message: event['message'],
+              default_value: event['defaultPrompt'])
+    emit_event('Events.Page.Dialog', dialog)
+  end
 
   # @return [String]
   def url
@@ -681,12 +686,14 @@ class Puppeteer::Page
     ).first
   end
 
-  # @param timeout [number|nil]
-  # @param wait_until [string|nil] 'load' | 'domcontentloaded' | 'networkidle0' | 'networkidle2'
   private def wait_for_navigation(timeout: nil, wait_until: nil)
     main_frame.send(:wait_for_navigation, timeout: timeout, wait_until: wait_until)
   end
 
+  # @!method async_wait_for_navigation(timeout: nil, wait_until: nil)
+  #
+  # @param timeout [number|nil]
+  # @param wait_until [string|nil] 'load' | 'domcontentloaded' | 'networkidle0' | 'networkidle2'
   define_async_method :async_wait_for_navigation
 
   private def wait_for_network_manager_event(event_name, predicate:, timeout:)
@@ -725,13 +732,6 @@ class Puppeteer::Page
     end
   end
 
-  # - Waits until request URL matches
-  #  `wait_for_request(url: 'https://example.com/awesome')`
-  # - Waits until request matches the given predicate
-  #  `wait_for_request(predicate: -> (req){ req.url.start_with?('https://example.com/search') })`
-  #
-  # @param url [String]
-  # @param predicate [Proc(Puppeteer::Request -> Boolean)]
   private def wait_for_request(url: nil, predicate: nil, timeout: nil)
     if !url && !predicate
       raise ArgumentError.new('url or predicate must be specified')
@@ -752,10 +752,20 @@ class Puppeteer::Page
     )
   end
 
-  define_async_method :async_wait_for_request
-
+  # @!method async_wait_for_request(url: nil, predicate: nil, timeout: nil)
+  #
+  # Waits until request URL matches or request matches the given predicate.
+  #
+  # Waits until request URL matches
+  #  wait_for_request(url: 'https://example.com/awesome')
+  #
+  # Waits until request matches the given predicate
+  #  wait_for_request(predicate: -> (req){ req.url.start_with?('https://example.com/search') })
+  #
   # @param url [String]
   # @param predicate [Proc(Puppeteer::Request -> Boolean)]
+  define_async_method :async_wait_for_request
+
   private def wait_for_response(url: nil, predicate: nil, timeout: nil)
     if !url && !predicate
       raise ArgumentError.new('url or predicate must be specified')
@@ -776,6 +786,10 @@ class Puppeteer::Page
     )
   end
 
+  # @!method async_wait_for_response(url: nil, predicate: nil, timeout: nil)
+  #
+  # @param url [String]
+  # @param predicate [Proc(Puppeteer::Request -> Boolean)]
   define_async_method :async_wait_for_response
 
   # @param timeout [number|nil]
@@ -1071,8 +1085,19 @@ class Puppeteer::Page
   define_async_method :async_select
 
   # @param selector [String]
-  def tap(selector)
-    main_frame.tap(selector)
+  def tap(selector: nil, &block)
+    # resolves double meaning of tap.
+    if selector.nil? && block
+      # Original usage of Object#tap.
+      #
+      # browser.new_page.tap do |page|
+      #   ...
+      # end
+      super(&block)
+    else
+      # Puppeteer's Page#tap.
+      main_frame.tap(selector)
+    end
   end
 
   define_async_method :async_tap
@@ -1096,6 +1121,11 @@ class Puppeteer::Page
 
   define_async_method :async_wait_for_selector
 
+  # @param milliseconds [Integer] the number of milliseconds to wait.
+  def wait_for_timeout(milliseconds)
+    main_frame.wait_for_timeout(milliseconds)
+  end
+
   # @param xpath [String]
   # @param visible [Boolean] Wait for element visible (not 'display: none' nor 'visibility: hidden') on true. default to false.
   # @param hidden [Boolean] Wait for element invisible ('display: none' nor 'visibility: hidden') on true. default to false.
@@ -1106,12 +1136,13 @@ class Puppeteer::Page
 
   define_async_method :async_wait_for_xpath
 
-  # @param {Function|string} pageFunction
-  # @param {!{polling?: string|number, timeout?: number}=} options
-  # @param {!Array<*>} args
-  # @return {!Promise<!Puppeteer.JSHandle>}
-  def wait_for_function(page_function, options = {}, *args)
-    main_frame.wait_for_function(page_function, options, *args)
+  # @param page_function [String]
+  # @param args [Integer|Array]
+  # @param polling [String]
+  # @param timeout [Integer]
+  # @return [Puppeteer::JSHandle]
+  def wait_for_function(page_function, args: [], polling: nil, timeout: nil)
+    main_frame.wait_for_function(page_function, args: args, polling: polling, timeout: timeout)
   end
 
   define_async_method :async_wait_for_function

data/lib/puppeteer/remote_object.rb

@@ -6,6 +6,7 @@ class Puppeteer::RemoteObject
   # @param payload [Hash]
   def initialize(payload)
     @object_id = payload['objectId']
+    @type = payload['type']
     @sub_type = payload['subtype']
     @unserializable_value = payload['unserializableValue']
     @value = payload['value']
@@ -42,6 +43,21 @@ class Puppeteer::RemoteObject
     end
   end
 
+  # @return [String]
+  def type_str
+    # used in JSHandle#to_s
+    # original logic:
+    #   if (this._remoteObject.objectId) {
+    #     const type =  this._remoteObject.subtype || this._remoteObject.type;
+    #     return 'JSHandle@' + type;
+    #   }
+    if @object_id
+      @sub_type || @type
+    else
+      nil
+    end
+  end
+
   # used in JSHandle#properties
   def properties(client)
     # original logic:
@@ -64,7 +80,18 @@ class Puppeteer::RemoteObject
 
   # used in ElementHandle#_box_model
   def box_model(client)
-    client.send_message('DOM.getBoxModel', objectId: @object_id)
+    result = client.send_message('DOM.getBoxModel', objectId: @object_id)
+
+    # Firefox returns width/height = 0, content/padding/border/margin = [nil, nil, nil, nil, nil, nil, nil, nil]
+    # while Chrome throws Error(Could not compute box model)
+    model = result['model']
+    if model['width'] == 0 && model['height'] == 0 &&
+      %w(content padding border margin).all? { |key| model[key].all?(&:nil?) }
+
+      debug_puts('Could not compute box model in Firefox.')
+      return nil
+    end
+    result
   rescue => err
     debug_puts(err)
     nil

data/lib/puppeteer/request.rb

@@ -106,17 +106,15 @@ class Puppeteer::Request
   #
   # Example:
   #
-  # ````
-  # page.on 'request' do |req|
-  #   # Override headers
-  #   headers = req.headers.merge(
-  #     foo: 'bar', # set "foo" header
-  #     origin: nil, # remove "origin" header
-  #   )
-  #   req.continue(headers: headers)
-  # end
-  # ```
-  #`
+  #   page.on 'request' do |req|
+  #     # Override headers
+  #     headers = req.headers.merge(
+  #       foo: 'bar', # set "foo" header
+  #       origin: nil, # remove "origin" header
+  #     )
+  #     req.continue(headers: headers)
+  #   end
+  #
   # @param error_code [String|Symbol]
   def continue(url: nil, method: nil, post_data: nil, headers: nil)
     # Request interception is not supported for data: urls.
@@ -152,15 +150,13 @@ class Puppeteer::Request
   #
   # Example:
   #
-  # ```
-  # page.on 'request' do |req|
-  #   req.respond(
-  #     status: 404,
-  #     content_type: 'text/plain',
-  #     body: 'Not Found!'
-  #   )
-  # end
-  # ````
+  #   page.on 'request' do |req|
+  #     req.respond(
+  #       status: 404,
+  #       content_type: 'text/plain',
+  #       body: 'Not Found!'
+  #     )
+  #   end
   #
   # @param status [Integer]
   # @param headers [Hash<String, String>]
@@ -211,16 +207,14 @@ class Puppeteer::Request
   #
   # Example:
   #
-  # ````
-  # page.on 'request' do |req|
-  #   if req.url.include?("porn")
-  #     req.abort
-  #   else
-  #     req.continue
+  #   page.on 'request' do |req|
+  #     if req.url.include?("porn")
+  #       req.abort
+  #     else
+  #       req.continue
+  #     end
   #   end
-  # end
-  # ```
-  #`
+  #
   # @param error_code [String|Symbol]
   def abort(error_code: :failed)
     # Request interception is not supported for data: urls.

data/lib/puppeteer/version.rb

@@ -1,3 +1,3 @@
 class Puppeteer
-  VERSION = '0.0.16'
+  VERSION = '0.0.21'
 end

data/lib/puppeteer/wait_task.rb

@@ -25,7 +25,7 @@ class Puppeteer::WaitTask
     @dom_world = dom_world
     @polling = polling
     @timeout = timeout
-    @predicate_body = predicate_body
+    @predicate_body = "return (#{predicate_body})(...args);"
     @args = args
     @run_count = 0
     @dom_world._wait_tasks.add(self)

data/lib/puppeteer/web_socket.rb

@@ -16,10 +16,14 @@ class Puppeteer::WebSocket
 
     def write(data)
       @socket.write(data)
+    rescue Errno::EPIPE
+      raise EOFError.new('already closed')
     end
 
     def readpartial(maxlen = 1024)
       @socket.readpartial(maxlen)
+    rescue Errno::ECONNRESET
+      raise EOFError.new('closed by remote')
     end
   end
 
@@ -40,6 +44,9 @@ class Puppeteer::WebSocket
     rescue EOFError
       # Google Chrome was gone.
       # We have nothing todo. Just finish polling.
+      if @ready_state < STATE_CLOSING
+        handle_on_close(reason: 'Going Away', code: 1001)
+      end
     end
   end
 

data/puppeteer-ruby.gemspec

@@ -26,7 +26,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rspec_junit_formatter' # for CircleCI.
-  spec.add_development_dependency 'rubocop', '~> 0.86.0'
+  spec.add_development_dependency 'rubocop', '~> 0.90.0'
   spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'sinatra'
   spec.add_development_dependency 'yard'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppeteer-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.21
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-12 00:00:00.000000000 Z
+date: 2020-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.86.0
+        version: 0.90.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.86.0
+        version: 0.90.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +150,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  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
@@ -179,11 +193,13 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- Dockerfile
 - Gemfile
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- docker-compose.yml
 - lib/puppeteer.rb
 - lib/puppeteer/browser.rb
 - lib/puppeteer/browser_context.rb
@@ -197,12 +213,14 @@ files:
 - lib/puppeteer/define_async_method.rb
 - lib/puppeteer/device.rb
 - lib/puppeteer/devices.rb
+- lib/puppeteer/dialog.rb
 - lib/puppeteer/dom_world.rb
 - lib/puppeteer/element_handle.rb
 - lib/puppeteer/element_handle/bounding_box.rb
 - lib/puppeteer/element_handle/box_model.rb
 - lib/puppeteer/element_handle/point.rb
 - lib/puppeteer/emulation_manager.rb
+- lib/puppeteer/env.rb
 - lib/puppeteer/errors.rb
 - lib/puppeteer/event_callbackable.rb
 - lib/puppeteer/execution_context.rb
@@ -219,6 +237,7 @@ files:
 - lib/puppeteer/launcher/browser_options.rb
 - lib/puppeteer/launcher/chrome.rb
 - lib/puppeteer/launcher/chrome_arg_options.rb
+- lib/puppeteer/launcher/firefox.rb
 - lib/puppeteer/launcher/launch_options.rb
 - lib/puppeteer/lifecycle_watcher.rb
 - lib/puppeteer/mouse.rb