puppeteer-ruby 0.0.22 → 0.28.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 627b2272803511db582250101edac0b5f1f0191abdf86255c6f16d0f088cc82e
-  data.tar.gz: 70458a316f8ecce1b784bd84595c3f0fa248c77e671e4458384c494a1471c196
+  metadata.gz: 61aae6f779d8c0b4566cb9fd8966ba7d5941bda2b0c43754d61616dab29ca555
+  data.tar.gz: f5394e8ac944d188795e8a4eff87a60b2b226b659d8183ac1003d2d9f1c9c27b
 SHA512:
-  metadata.gz: 2baf0cb4769fc7100495b3dc590293085e3219c661bd164cdb28f0aad1975f18cba17890029156a08873f879ef370c196c3d995bfd040d073d42d0b49acbeef3
-  data.tar.gz: 67a23e46e7d439b76f438c59d062fe5daea0d216469e79ea1b4af2b8d60c4f9070455de22e51b9523fde2a67692919420bce2b05becf948120b71d426c4c560f
+  metadata.gz: e51fc1ffce61bf542d4057803ae3f2ac811285b54a221d4bc2ce6cfccc18e9de2828ba98de82d246efa7b1fdf58c44cce8e9205ac1343889f173462b8dd8f546
+  data.tar.gz: 4b5706d9f926372415acafa3c0d9339d653dd35542642a48593d400fd929ec03f1f32cd5624d99b0c1e870471f591c385b18b02b742d8b83d501fef599f64ffc

data/.circleci/config.yml

@@ -1,30 +1,41 @@
 version: 2.1
-orbs:
-  ruby: circleci/ruby@0.1.2
+
+rspec_chrome_job: &rspec_chrome_job
+  steps:
+    - checkout
+    - run:
+        command: gem install bundler:2.2.3 && bundle install
+    - run:
+        name: rspec
+        command: |
+          DEBUG=1 bundle exec rspec --profile 10 \
+            --format RspecJunitFormatter \
+            --out test_results/rspec.xml \
+            --format documentation
 
 jobs:
-  rspec:
+  rspec_chrome_ruby2_6:
     docker:
       - image: circleci/ruby:2.6.6-buster-node-browsers
-    executor: ruby/default
-    steps:
-      - checkout
-      - ruby/bundle-install
-      - run:
-          name: rspec
-          command: |
-            DEBUG=1 bundle exec rspec --profile 10 \
-              --format RspecJunitFormatter \
-              --out test_results/rspec.xml \
-              --format documentation
+    <<: *rspec_chrome_job
+
+  rspec_chrome_ruby2_7:
+    docker:
+      - image: circleci/ruby:2.7.2-buster-node-browsers
+    <<: *rspec_chrome_job
+
+  rspec_chrome_ruby3_0:
+    docker:
+      - image: circleci/ruby:3.0.0-rc1-buster-node-browsers
+    <<: *rspec_chrome_job
 
   rspec_firefox:
     docker:
-      - image: circleci/ruby:2.6.6-buster-node-browsers
-    executor: ruby/default
+      - image: circleci/ruby:2.7.2-buster-node-browsers
     steps:
       - checkout
-      - ruby/bundle-install
+      - run:
+          command: gem install bundler:2.2.3 && bundle install
       - run:
           name: install firefox-nightly
           command: |
@@ -43,13 +54,10 @@ jobs:
   deploy:
     docker:
       - image: circleci/ruby:2.6.3-stretch-node
-    executor: ruby/default
     steps:
       - checkout
       - run:
-          name: Which bundler?
-          command: bundle -v
-      - ruby/bundle-install
+          command: gem install bundler:2.2.3 && bundle install
       - run:
           name: rake build
           command: rake build
@@ -70,7 +78,9 @@ jobs:
 workflows:
   ci:
     jobs:
-      - rspec
+      - rspec_chrome_ruby2_6
+      - rspec_chrome_ruby2_7
+      - rspec_chrome_ruby3_0
       - rspec_firefox
   rubygems-deploy:
     jobs:

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,17 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+### Step To Reproduce / Observed behavior
+
+
+### Expected behavior
+
+### Environment
+
+Paste the output of `ruby --version`

data/.github/workflows/docs.yml

@@ -16,12 +16,12 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.6
+          ruby-version: 2.7
 
       - name: Install dependencies
         run: |
           gem uninstall bundler
-          gem install bundler -v 1.17
+          gem install bundler -v 2.2.3
           bundle install
 
       - name: Deploy Configuration

data/.github/workflows/reviewdog.yml

@@ -12,4 +12,4 @@ jobs:
         with:
           github_token: ${{ secrets.github_token }}
           reporter: github-pr-review
-          rubocop_version: 0.90.0
+          rubocop_version: 1.8.0

data/.rubocop.yml

@@ -116,6 +116,43 @@ Style/DefWithParentheses:
 Style/MethodDefParentheses:
   Enabled: true
 
+Style/MethodCallWithArgsParentheses:
+  Enabled: true
+  IgnoredMethods:
+    # Gemfile, gemspec
+    - source
+    - add_dependency
+    - add_development_dependency
+
+    # include/require
+    - require
+    - require_relative
+    - include
+
+    # fundamental methods
+    - raise
+    - sleep
+
+    # RSpec
+    - describe
+    - it
+    - to
+    - not_to
+    - be
+    - eq
+
+    # async/await
+    - define_async_method
+    - await
+    - future
+
+    # utils
+    - debug_print
+    - debug_puts
+
+Style/MethodCallWithoutArgsParentheses:
+  Enabled: true
+
 Style/RedundantFreeze:
   Enabled: true
 

data/CHANGELOG.md

@@ -0,0 +1,81 @@
+### master [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.28.1...master)]
+
+* xxx
+
+### 0.28.1 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.0.27...0.28.1)]
+
+New features:
+
+* Add `Page#emulate_idle_state`
+* Change versioning rule.
+
+### 0.0.27 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.0.26...0.0.27)]
+
+New features:
+
+* Now puppeteer-ruby is Ruby 3.0 compatible!
+
+### 0.0.26 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.0.25...0.0.26)]
+
+Bugfix:
+
+* Fix `Page#screenshot` working correctly with `quality` parameter.
+
+### 0.0.25 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.0.23...0.0.25)]
+
+New feature:
+
+* **Cookie** feature: `Page#set_cookie`, `Page#cookies`
+
+### 0.0.23 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.0.22...0.0.23)]
+
+New feature:
+
+* **GeoLocation** feature
+* grant/clear permission
+
+Bugfix/Improvement:
+
+* Refactoring for events ([#31](https://github.com/YusukeIwaki/puppeteer-ruby/pull/31))
+* Improve SEND/RECV handling in CDPSession ([#34](https://github.com/YusukeIwaki/puppeteer-ruby/pull/34))
+
+### 0.0.22 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.0.21...0.0.22)]
+
+Bugfix
+
+* Make `Puppeteer#default_args` to work
+* Respect Firefox launch options
+* Respect `default_viewport: nil`
+
+### 0.0.21 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.0.20...0.0.21)]
+
+Bugfix/Improvement:
+
+* Update DeviceDescriptors (list of emulatable devices)
+* Fix bug on inputing "(" ([#25](https://github.com/YusukeIwaki/puppeteer-ruby/pull/25))
+
+### 0.0.20 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.0.19...0.0.20)]
+
+New feature
+
+* Dialog-handling feature
+
+### 0.0.19 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.0.18...0.0.19)]
+
+New feature
+
+* **Firefox support**
+
+Bugfix/Improvement
+
+* Allow `Page#keyboard` with block ([#18](https://github.com/YusukeIwaki/puppeteer-ruby/pull/18))
+
+### 0.0.18 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.0.17...0.0.18)]
+
+New feature
+
+* **Firefox support**
+
+Bugfix/Improvement
+
+* Allow `Page#keyboard` with block ([#18](https://github.com/YusukeIwaki/puppeteer-ruby/pull/18))

data/Dockerfile

@@ -1,4 +1,4 @@
-FROM circleci/ruby:2.6.6-buster-node-browsers
+FROM circleci/ruby:3.0.0-rc1-buster-node-browsers
 
 USER root
 

data/README.md

@@ -72,6 +72,21 @@ end
 
 More usage examples can be found [here](https://github.com/YusukeIwaki/puppeteer-ruby-example)
 
+## :whale: Running in Docker
+
+Following packages are required.
+
+* Google Chrome or Chromium
+  * In Debian-based images, `google-chrome-stable`
+  * In Alpine-based images, `chromium`
+
+Also, CJK font will be required for Chinese, Japanese, Korean sites.
+
+### References
+
+* Puppeteer official README: https://github.com/puppeteer/puppeteer/blob/main/docs/troubleshooting.md#running-puppeteer-in-docker
+* puppeteer-ruby example: https://github.com/YusukeIwaki/puppeteer-ruby-example/tree/master/docker_chromium
+
 ## :bulb: Collaboration with Selenium or Capybara
 
 It is really remarkable that we can use puppeteer functions in existing Selenium or Capybara codes, with a few configuration in advance.

data/lib/puppeteer.rb

@@ -6,7 +6,9 @@ require 'puppeteer/env'
 
 # Custom data types.
 require 'puppeteer/device'
+require 'puppeteer/events'
 require 'puppeteer/errors'
+require 'puppeteer/geolocation'
 require 'puppeteer/viewport'
 
 # Modules
@@ -27,6 +29,7 @@ require 'puppeteer/devices'
 require 'puppeteer/dialog'
 require 'puppeteer/dom_world'
 require 'puppeteer/emulation_manager'
+require 'puppeteer/exception_details'
 require 'puppeteer/execution_context'
 require 'puppeteer/file_chooser'
 require 'puppeteer/frame'

data/lib/puppeteer/browser.rb

@@ -36,7 +36,6 @@ class Puppeteer::Browser
     @ignore_https_errors = ignore_https_errors
     @default_viewport = default_viewport
     @process = process
-    # @screenshot_task_queue = TaskQueue.new
     @connection = connection
     @close_callback = close_callback
 
@@ -46,37 +45,30 @@ class Puppeteer::Browser
       @contexts[context_id] = Puppeteer::BrowserContext.new(@connection, self, context_id)
     end
     @targets = {}
-    @connection.on_event 'Events.Connection.Disconnected' do
-      emit_event 'Events.Browser.Disconnected'
+    @connection.on_event(ConnectionEmittedEvents::Disconnected) do
+      emit_event(BrowserEmittedEvents::Disconnected)
     end
-    @connection.on_event 'Target.targetCreated', &method(:handle_target_created)
-    @connection.on_event 'Target.targetDestroyed', &method(:handle_target_destroyed)
-    @connection.on_event 'Target.targetInfoChanged', &method(:handle_target_info_changed)
+    @connection.on_event('Target.targetCreated', &method(:handle_target_created))
+    @connection.on_event('Target.targetDestroyed', &method(:handle_target_destroyed))
+    @connection.on_event('Target.targetInfoChanged', &method(:handle_target_info_changed))
   end
 
-  EVENT_MAPPINGS = {
-    disconnected: 'Events.Browser.Disconnected',
-    targetcreated: 'Events.Browser.TargetCreated',
-    targetchanged: 'Events.Browser.TargetChanged',
-    targetdestroyed: 'Events.Browser.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(", ")}")
+    unless BrowserEmittedEvents.values.include?(event_name.to_s)
+      raise ArgumentError.new("Unknown event name: #{event_name}. Known events are #{BrowserEmittedEvents.values.to_a.join(", ")}")
     end
 
-    add_event_listener(EVENT_MAPPINGS[event_name.to_sym], &block)
+    super(event_name.to_s, &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(", ")}")
+    unless BrowserEmittedEvents.values.include?(event_name.to_s)
+      raise ArgumentError.new("Unknown event name: #{event_name}. Known events are #{BrowserEmittedEvents.values.to_a.join(", ")}")
     end
 
-    observe_first(EVENT_MAPPINGS[event_name.to_sym], &block)
+    super(event_name.to_s, &block)
   end
 
   # @return [Puppeteer::BrowserRunner::BrowserProcess]
@@ -132,13 +124,12 @@ class Puppeteer::Browser
       session_factory: -> { @connection.create_session(target_info) },
       ignore_https_errors: @ignore_https_errors,
       default_viewport: @default_viewport,
-      screenshot_task_queue: @screenshot_task_queue,
     )
     #   assert(!this._targets.has(event.targetInfo.targetId), 'Target should not exist before targetCreated');
     @targets[target_info.target_id] = target
     if await target.initialized_promise
-      emit_event 'Events.Browser.TargetCreated', target
-      context.emit_event 'Events.BrowserContext.TargetCreated', target
+      emit_event(BrowserEmittedEvents::TargetCreated, target)
+      context.emit_event(BrowserContextEmittedEvents::TargetCreated, target)
     end
   end
 
@@ -150,8 +141,8 @@ class Puppeteer::Browser
     @targets.delete(target_id)
     target.closed_callback
     if await target.initialized_promise
-      emit_event 'Events.Browser.TargetDestroyed', target
-      target.browser_context.emit_event 'Events.BrowserContext.TargetDestroyed', target
+      emit_event(BrowserEmittedEvents::TargetDestroyed, target)
+      target.browser_context.emit_event(BrowserContextEmittedEvents::TargetDestroyed, target)
     end
   end
 
@@ -169,8 +160,8 @@ class Puppeteer::Browser
     was_initialized = target.initialized?
     target.handle_target_info_changed(target_info)
     if was_initialized && previous_url != target.url
-      emit_event 'Events.Browser.TargetChanged', target
-      target.browser_context.emit_event 'Events.BrowserContext.TargetChanged', target
+      emit_event(BrowserEmittedEvents::TargetChanged, target)
+      target.browser_context.emit_event(BrowserContextEmittedEvents::TargetChanged, target)
     end
   end
 
@@ -222,12 +213,12 @@ class Puppeteer::Browser
 
     event_listening_ids = []
     target_promise = resolvable_future
-    event_listening_ids << add_event_listener('Events.Browser.TargetCreated') do |target|
+    event_listening_ids << add_event_listener(BrowserEmittedEvents::TargetCreated) do |target|
       if predicate.call(target)
         target_promise.fulfill(target)
       end
     end
-    event_listening_ids << add_event_listener('Events.Browser.TargetChanged') do |target|
+    event_listening_ids << add_event_listener(BrowserEmittedEvents::TargetChanged) do |target|
       if predicate.call(target)
         target_promise.fulfill(target)
       end

data/lib/puppeteer/browser_context.rb

@@ -11,29 +11,22 @@ 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(", ")}")
+    unless BrowserContextEmittedEvents.values.include?(event_name.to_s)
+      raise ArgumentError.new("Unknown event name: #{event_name}. Known events are #{BrowserContextEmittedEvents.values.to_a.join(", ")}")
     end
 
-    add_event_listener(EVENT_MAPPINGS[event_name.to_sym], &block)
+    super(event_name.to_s, &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(", ")}")
+    unless BrowserContextEmittedEvents.values.include?(event_name.to_s)
+      raise ArgumentError.new("Unknown event name: #{event_name}. Known events are #{BrowserContextEmittedEvents.values.to_a.join(", ")}")
     end
 
-    observe_first(EVENT_MAPPINGS[event_name.to_sym], &block)
+    super(event_name.to_s, &block)
   end
 
   # @return {!Array<!Target>} target
@@ -64,42 +57,48 @@ class Puppeteer::BrowserContext
     !!@id
   end
 
-  # /**
-  #  * @param {string} origin
-  #  * @param {!Array<string>} permissions
-  #  */
-  # async overridePermissions(origin, permissions) {
-  #   const webPermissionToProtocol = new Map([
-  #     ['geolocation', 'geolocation'],
-  #     ['midi', 'midi'],
-  #     ['notifications', 'notifications'],
-  #     ['push', 'push'],
-  #     ['camera', 'videoCapture'],
-  #     ['microphone', 'audioCapture'],
-  #     ['background-sync', 'backgroundSync'],
-  #     ['ambient-light-sensor', 'sensors'],
-  #     ['accelerometer', 'sensors'],
-  #     ['gyroscope', 'sensors'],
-  #     ['magnetometer', 'sensors'],
-  #     ['accessibility-events', 'accessibilityEvents'],
-  #     ['clipboard-read', 'clipboardRead'],
-  #     ['clipboard-write', 'clipboardWrite'],
-  #     ['payment-handler', 'paymentHandler'],
-  #     // chrome-specific permissions we have.
-  #     ['midi-sysex', 'midiSysex'],
-  #   ]);
-  #   permissions = permissions.map(permission => {
-  #     const protocolPermission = webPermissionToProtocol.get(permission);
-  #     if (!protocolPermission)
-  #       throw new Error('Unknown permission: ' + permission);
-  #     return protocolPermission;
-  #   });
-  #   await this._connection.send('Browser.grantPermissions', {origin, browserContextId: this._id || undefined, permissions});
-  # }
-
-  # async clearPermissionOverrides() {
-  #   await this._connection.send('Browser.resetPermissions', {browserContextId: this._id || undefined});
-  # }
+  WEB_PERMISSION_TO_PROTOCOL = {
+    'geolocation' => 'geolocation',
+    'midi' => 'midi',
+    'notifications' => 'notifications',
+    # TODO: push isn't a valid type?
+    # 'push' => 'push',
+    'camera' => 'videoCapture',
+    'microphone' => 'audioCapture',
+    'background-sync' => 'backgroundSync',
+    'ambient-light-sensor' => 'sensors',
+    'accelerometer' => 'sensors',
+    'gyroscope' => 'sensors',
+    'magnetometer' => 'sensors',
+    'accessibility-events' => 'accessibilityEvents',
+    'clipboard-read' => 'clipboardReadWrite',
+    'clipboard-write' => 'clipboardReadWrite',
+    'payment-handler' => 'paymentHandler',
+    'idle-detection' => 'idleDetection',
+    # chrome-specific permissions we have.
+    'midi-sysex' => 'midiSysex',
+  }.freeze
+
+  # @param origin [String]
+  # @param permissions [Array<String>]
+  def override_permissions(origin, permissions)
+    protocol_permissions = permissions.map do |permission|
+      WEB_PERMISSION_TO_PROTOCOL[permission] or raise ArgumentError.new("Unknown permission: #{permission}")
+    end
+    @connection.send_message('Browser.grantPermissions', {
+      origin: origin,
+      browserContextId: @id,
+      permissions: protocol_permissions,
+    }.compact)
+  end
+
+  def clear_permission_overrides
+    if @id
+      @connection.send_message('Browser.resetPermissions', browserContextId: @id)
+    else
+      @connection.send_message('Browser.resetPermissions')
+    end
+  end
 
   # @return [Future<Puppeteer::Page>]
   def new_page