puppeteer-ruby 0.0.16 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38a6ae4190bd04cbacb863d04f9862ebc8a37c6811fbfd690426ba051d5ea5d4
-  data.tar.gz: 60b61e143e63ed5e42b0bb6f3d9e5c27262fd2f51064c185e491056a5081707d
+  metadata.gz: 2277fda99720c2566927af9a2acfc56da2b8e87ee10521871c368fd4a05649b2
+  data.tar.gz: 59636e168935b0fb6c964cd62355ae3becf8199ed2ee1af58cb512ccacc9d7cb
 SHA512:
-  metadata.gz: fc3ab652476ee319fab2d691173a0175d4b03d72346329f2fb855a142c3090693f1fb5cfa52abb4badbfbadc7d4eec5028a295f63fb7ddd3e362321564a96b7c
-  data.tar.gz: 6de2484b1b939c3cab1bfa48bb2225c54686f13e7901f3df086d8e5c7b18aa9fc62afb5fd9a785a3fbbf12d2aef50cde1d085f3564ce9afab996f80a39c64936
+  metadata.gz: b45495a2ae160e740e242bc04bb81bfa493c1101583393f78e8e7ff3d065c00594fe0196b8225ac73e281a17428127597d11c8f8323ba6b58d64b437e2979d97
+  data.tar.gz: 72c9bd1ca17f37927ceb51a79904583c638066e29cdb08cc2534e77bcc7b3ee348e53e69546ecd579917bd6d8db9c4413d4a63cf617ffa33b8c69c756603439e

data/.circleci/config.yml

@@ -13,10 +13,10 @@ jobs:
       - run:
           name: rspec
           command: |
-            bundle exec rspec --profile 10 \
+            DEBUG=1 bundle exec rspec --profile 10 \
               --format RspecJunitFormatter \
               --out test_results/rspec.xml \
-              --format progress
+              --format documentation
 
   deploy:
     docker:

data/lib/puppeteer.rb

@@ -2,6 +2,8 @@ require 'concurrent'
 
 class Puppeteer; end
 
+require 'puppeteer/env'
+
 # Custom data types.
 require 'puppeteer/device'
 require 'puppeteer/errors'
@@ -168,7 +170,11 @@ class Puppeteer
     }.compact
     browser = launcher.connect(options)
     if block_given?
-      yield(browser)
+      begin
+        yield(browser)
+      ensure
+        browser.disconnect
+      end
     else
       browser
     end

data/lib/puppeteer/browser.rb

@@ -43,7 +43,7 @@ class Puppeteer::Browser
     @default_context = Puppeteer::BrowserContext.new(@connection, self, nil)
     @contexts = {}
     context_ids.each do |context_id|
-      @contexts[context_id] = Puppeteer::BrowserContext.new(@connection, self. context_id)
+      @contexts[context_id] = Puppeteer::BrowserContext.new(@connection, self, context_id)
     end
     @targets = {}
     @connection.on_event 'Events.Connection.Disconnected' do
@@ -70,6 +70,15 @@ class Puppeteer::Browser
     add_event_listener(EVENT_MAPPINGS[event_name.to_sym], &block)
   end
 
+  # @param event_name [Symbol]
+  def once(event_name, &block)
+    unless EVENT_MAPPINGS.has_key?(event_name.to_sym)
+      raise ArgumentError.new("Unknown event name: #{event_name}. Known events are #{EVENT_MAPPINGS.keys.join(", ")}")
+    end
+
+    observe_first(EVENT_MAPPINGS[event_name.to_sym], &block)
+  end
+
   # @return [Puppeteer::BrowserRunner::BrowserProcess]
   def process
     @process
@@ -94,7 +103,7 @@ class Puppeteer::Browser
   # @param context_id [String]
   def dispose_context(context_id)
     @connection.send_message('Target.disposeBrowserContext', browserContextId: context_id)
-    @contexts.remove(context_id)
+    @contexts.delete(context_id)
   end
 
   class TargetAlreadyExistError < StandardError
@@ -166,7 +175,7 @@ class Puppeteer::Browser
   end
 
   # @return [String]
-  def websocket_endpoint
+  def ws_endpoint
     @connection.url
   end
 
@@ -196,7 +205,7 @@ class Puppeteer::Browser
 
   # @return {!Target}
   def target
-    targets.first { |target| target.type == 'browser' }
+    targets.find { |target| target.type == 'browser' }
   end
 
   # used only in Target#opener
@@ -204,12 +213,11 @@ class Puppeteer::Browser
     @targets[target_id]
   end
 
-  # @param {function(!Target):boolean} predicate
-  # @param {{timeout?: number}=} options
-  # @return {!Promise<!Target>}
+  # @param predicate [Proc(Puppeteer::Target -> Boolean)]
+  # @return [Puppeteer::Target]
   def wait_for_target(predicate:, timeout: nil)
     timeout_in_sec = (timeout || 30000).to_i / 1000.0
-    existing_target = targets.first { |target| predicate.call(target) }
+    existing_target = targets.find { |target| predicate.call(target) }
     return existing_target if existing_target
 
     event_listening_ids = []
@@ -233,11 +241,18 @@ class Puppeteer::Browser
       else
         target_promise.value!
       end
+    rescue Timeout::Error
+      raise Puppeteer::TimeoutError.new("waiting for target failed: timeout #{timeout}ms exceeded")
     ensure
       remove_event_listener(*event_listening_ids)
     end
   end
 
+  # @!method async_wait_for_target(predicate:, timeout: nil)
+  #
+  # @param predicate [Proc(Puppeteer::Target -> Boolean)]
+  define_async_method :async_wait_for_target
+
   # @return {!Promise<!Array<!Puppeteer.Page>>}
   def pages
     browser_contexts.flat_map(&:pages)
@@ -266,7 +281,19 @@ class Puppeteer::Browser
     !@connection.closed?
   end
 
+  class Version
+    def initialize(hash)
+      @protocol_version = hash['protocolVersion']
+      @product = hash['product']
+      @revision = hash['revision']
+      @user_agent = hash['userAgent']
+      @js_version = hash['jsVersion']
+    end
+
+    attr_reader :protocol_version, :product, :revision, :user_agent, :js_version
+  end
+
   private def get_version
-    @connection.send_message('Browser.getVersion')
+    Version.new(@connection.send_message('Browser.getVersion'))
   end
 end

data/lib/puppeteer/browser_context.rb

@@ -1,5 +1,6 @@
 class Puppeteer::BrowserContext
   include Puppeteer::EventCallbackable
+  using Puppeteer::DefineAsyncMethod
 
   # @param {!Puppeteer.Connection} connection
   # @param {!Browser} browser
@@ -10,14 +11,38 @@ class Puppeteer::BrowserContext
     @id = context_id
   end
 
+  EVENT_MAPPINGS = {
+    disconnected: 'Events.BrowserContext.Disconnected',
+    targetcreated: 'Events.BrowserContext.TargetCreated',
+    targetchanged: 'Events.BrowserContext.TargetChanged',
+    targetdestroyed: 'Events.BrowserContext.TargetDestroyed',
+  }
+
+  # @param event_name [Symbol] either of :disconnected, :targetcreated, :targetchanged, :targetdestroyed
+  def on(event_name, &block)
+    unless EVENT_MAPPINGS.has_key?(event_name.to_sym)
+      raise ArgumentError.new("Unknown event name: #{event_name}. Known events are #{EVENT_MAPPINGS.keys.join(", ")}")
+    end
+
+    add_event_listener(EVENT_MAPPINGS[event_name.to_sym], &block)
+  end
+
+  # @param event_name [Symbol]
+  def once(event_name, &block)
+    unless EVENT_MAPPINGS.has_key?(event_name.to_sym)
+      raise ArgumentError.new("Unknown event name: #{event_name}. Known events are #{EVENT_MAPPINGS.keys.join(", ")}")
+    end
+
+    observe_first(EVENT_MAPPINGS[event_name.to_sym], &block)
+  end
+
   # @return {!Array<!Target>} target
   def targets
     @browser.targets.select { |target| target.browser_context == self }
   end
 
-  # @param {function(!Target):boolean} predicate
-  # @param {{timeout?: number}=} options
-  # @return {!Promise<!Target>}
+  # @param predicate [Proc(Puppeteer::Target -> Boolean)]
+  # @return [Puppeteer::Target]
   def wait_for_target(predicate:, timeout: nil)
     @browser.wait_for_target(
       predicate: ->(target) { target.browser_context == self && predicate.call(target) },
@@ -25,13 +50,18 @@ class Puppeteer::BrowserContext
     )
   end
 
+  # @!method async_wait_for_target(predicate:, timeout: nil)
+  #
+  # @param predicate [Proc(Puppeteer::Target -> Boolean)]
+  define_async_method :async_wait_for_target
+
   # @return {!Promise<!Array<!Puppeteer.Page>>}
   def pages
     targets.select { |target| target.type == 'page' }.map(&:page).reject { |page| !page }
   end
 
   def incognito?
-    !@id
+    !!@id
   end
 
   # /**
@@ -82,7 +112,7 @@ class Puppeteer::BrowserContext
   end
 
   def close
-    if !@id
+    unless @id
       raise 'Non-incognito profiles cannot be closed!'
     end
     @browser.dispose_context(@id)

data/lib/puppeteer/connection.rb

@@ -49,13 +49,18 @@ class Puppeteer::Connection
       async_handle_message(message)
     end
     @transport.on_close do |reason, code|
-      handle_close(reason, code)
+      handle_close
     end
 
     @sessions = {}
     @closed = false
   end
 
+  # used only in Browser#connected?
+  def closed?
+    @closed
+  end
+
   private def sleep_before_handling_message(message)
     # Puppeteer doesn't handle any Network monitoring responses.
     # So we don't have to sleep.

data/lib/puppeteer/debug_print.rb

@@ -1,7 +1,7 @@
 require 'logger'
 
 module Puppeteer::DebugPrint
-  if ['1', 'true'].include?(ENV['DEBUG'])
+  if Puppeteer.env.debug?
     def debug_puts(*args, **kwargs)
       @__debug_logger ||= Logger.new(STDOUT)
       @__debug_logger.debug(*args, **kwargs)

data/lib/puppeteer/dom_world.rb

@@ -314,25 +314,28 @@ class Puppeteer::DOMWorld
   #   }
   # }
 
+  class ElementNotFoundError < StandardError
+    def initialize(selector)
+      super("No node found for selector: #{selector}")
+    end
+  end
+
   # @param selector [String]
   # @param delay [Number]
   # @param button [String] "left"|"right"|"middle"
   # @param click_count [Number]
   def click(selector, delay: nil, button: nil, click_count: nil)
-    handle = S(selector)
+    handle = S(selector) or raise ElementNotFoundError.new(selector)
     handle.click(delay: delay, button: button, click_count: click_count)
     handle.dispose
   end
 
-  # /**
-  #  * @param {string} selector
-  #  */
-  # async focus(selector) {
-  #   const handle = await this.$(selector);
-  #   assert(handle, 'No node found for selector: ' + selector);
-  #   await handle.focus();
-  #   await handle.dispose();
-  # }
+  # @param selector [String]
+  def focus(selector)
+    handle = S(selector) or raise ElementNotFoundError.new(selector)
+    handle.focus
+    handle.dispose
+  end
 
   # /**
   #  * @param {string} selector
@@ -347,7 +350,7 @@ class Puppeteer::DOMWorld
   # @param selector [String]
   # @return [Array<String>]
   def select(selector, *values)
-    handle = S(selector)
+    handle = S(selector) or raise ElementNotFoundError.new(selector)
     result = handle.select(*values)
     handle.dispose
 
@@ -356,7 +359,7 @@ class Puppeteer::DOMWorld
 
   # @param selector [String]
   def tap(selector)
-    handle = S(selector)
+    handle = S(selector) or raise ElementNotFoundError.new(selector)
     handle.tap
     handle.dispose
   end
@@ -365,7 +368,7 @@ class Puppeteer::DOMWorld
   # @param text [String]
   # @param delay [Number]
   def type_text(selector, text, delay: nil)
-    handle = S(selector)
+    handle = S(selector) or raise ElementNotFoundError.new(selector)
     handle.type_text(text, delay: delay)
     handle.dispose
   end

data/lib/puppeteer/element_handle.rb

@@ -23,7 +23,7 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
   end
 
   def content_frame
-    node_info = @remote_object.node_info
+    node_info = @remote_object.node_info(@client)
     frame_id = node_info['node']['frameId']
     if frame_id.is_a?(String)
       @frame_manager.frame(frame_id)
@@ -208,10 +208,11 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
   define_async_method :async_type_text
 
   # @param key [String]
+  # @param text [String]
   # @param delay [number|nil]
-  def press(key, delay: nil)
+  def press(key, delay: nil, text: nil)
     focus
-    @page.keyboard.press(key, delay: delay)
+    @page.keyboard.press(key, delay: delay, text: text)
   end
 
   define_async_method :async_press

data/lib/puppeteer/env.rb

@@ -0,0 +1,18 @@
+class Puppeteer::Env
+  # indicates whether DEBUG=1 is specified.
+  #
+  # @return [Boolean]
+  def debug?
+    ['1', 'true'].include?(ENV['DEBUG'].to_s)
+  end
+
+  def ci?
+    ['1', 'true'].include?(ENV['CI'].to_s)
+  end
+end
+
+class Puppeteer
+  def self.env
+    Puppeteer::Env.new
+  end
+end

data/lib/puppeteer/keyboard.rb

@@ -149,9 +149,10 @@ class Puppeteer::Keyboard
   define_async_method :async_type_text
 
   # @param key [String]
+  # @param text [String]
   # @return [Future]
-  def press(key, delay: nil)
-    down(key)
+  def press(key, delay: nil, text: nil)
+    down(key, text: text)
     if delay
       sleep(delay.to_i / 1000.0)
     end

data/lib/puppeteer/mouse.rb

@@ -94,5 +94,21 @@ class Puppeteer::Mouse
     )
   end
 
+  # Dispatches a `mousewheel` event.
+  #
+  # @param delta_x [Integer]
+  # @param delta_y [Integer]
+  def wheel(delta_x: 0, delta_y: 0)
+    @client.send_message('Input.dispatchMouseEvent',
+      type: 'mouseWheel',
+      x: @x,
+      y: @y,
+      deltaX: delta_x,
+      deltaY: delta_y,
+      modifiers: @keyboard.modifiers,
+      pointerType: 'mouse',
+    )
+  end
+
   define_async_method :async_up
 end

data/lib/puppeteer/page.rb

@@ -681,12 +681,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 +727,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 +747,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 +781,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 +1080,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

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.17'
 end

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

@@ -28,5 +28,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec_junit_formatter' # for CircleCI.
   spec.add_development_dependency 'rubocop', '~> 0.86.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.17
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-12 00:00:00.000000000 Z
+date: 2020-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -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
@@ -203,6 +217,7 @@ files:
 - 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