playwright-ruby-client 0.1.0 → 0.5.3

data/lib/playwright_api/touchscreen.rb

@@ -1,6 +1,6 @@
 module Playwright
   # The Touchscreen class operates in main-frame CSS pixels relative to the top-left corner of the viewport. Methods on the
-  # touchscreen can only be used in browser contexts that have been intialized with `hasTouch` set to true.
+  # touchscreen can only be used in browser contexts that have been initialized with `hasTouch` set to true.
   class Touchscreen < PlaywrightApi
 
     # Dispatches a `touchstart` and `touchend` event with a single touch at the position (`x`,`y`).

data/lib/playwright_api/web_socket.rb

@@ -11,5 +11,20 @@ module Playwright
     def url
       raise NotImplementedError.new('url is not implemented yet.')
     end
+
+    # Waits for event to fire and passes its value into the predicate function. Returns when the predicate returns truthy
+    # value. Will throw an error if the webSocket is closed before the event is fired. Returns the event data value.
+    def expect_event(event, predicate: nil, timeout: nil)
+      raise NotImplementedError.new('expect_event is not implemented yet.')
+    end
+
+    # > NOTE: In most cases, you should use [`method: WebSocket.waitForEvent`].
+    # 
+    # Waits for given `event` to fire. If predicate is provided, it passes event's value into the `predicate` function and
+    # waits for `predicate(event)` to return a truthy value. Will throw an error if the socket is closed before the `event` is
+    # fired.
+    def wait_for_event(event, predicate: nil, timeout: nil)
+      raise NotImplementedError.new('wait_for_event is not implemented yet.')
+    end
   end
 end

data/lib/playwright_api/worker.rb

@@ -15,6 +15,16 @@ module Playwright
   #   console.log('  ' + worker.url());
   # ```
   # 
+  # ```java
+  # page.onWorker(worker -> {
+  #   System.out.println("Worker created: " + worker.url());
+  #   worker.onClose(worker1 -> System.out.println("Worker destroyed: " + worker1.url()));
+  # });
+  # System.out.println("Current workers:");
+  # for (Worker worker : page.workers())
+  #   System.out.println("  " + worker.url());
+  # ```
+  # 
   # ```py
   # def handle_worker(worker):
   #     print("worker created: " + worker.url)
@@ -26,6 +36,20 @@ module Playwright
   # for worker in page.workers:
   #     print("    " + worker.url)
   # ```
+  # 
+  # ```csharp
+  # Page.Worker += (_, worker) =>
+  # {
+  #     Console.WriteLine($"Worker created: {worker.Url}");
+  #     worker.Close += (_, _) => Console.WriteLine($"Worker closed {worker.Url}");
+  # };
+  # 
+  # Console.WriteLine("Current Workers:");
+  # foreach(var pageWorker in Page.Workers)
+  # {
+  #     Console.WriteLine($"\tWorker: {pageWorker.Url}");
+  # }
+  # ```
   class Worker < PlaywrightApi
 
     # Returns the return value of `expression`.
@@ -34,7 +58,7 @@ module Playwright
     # wait for the promise to resolve and return its value.
     # 
     # If the function passed to the [`method: Worker.evaluate`] returns a non-[Serializable] value, then
-    # [`method: Worker.evaluate`] returns `undefined`. Playwright also supports transferring some  additional values that are
+    # [`method: Worker.evaluate`] returns `undefined`. Playwright also supports transferring some additional values that are
     # not serializable by `JSON`: `-0`, `NaN`, `Infinity`, `-Infinity`.
     def evaluate(expression, arg: nil)
       raise NotImplementedError.new('evaluate is not implemented yet.')

data/playwright.gemspec

@@ -17,20 +17,22 @@ Gem::Specification.new do |spec|
 
   spec.files         = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject do |f|
-      f.match(%r{^(test|spec|features)/}) || f.include?(".git") || f.start_with?("development/")
+      f.match(%r{^(test|spec|features)/}) || f.include?(".git") || f.include?(".circleci") || f.start_with?("development/")
     end
   end + `find lib/playwright_api -name *.rb -type f`.split("\n")
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'concurrent-ruby'
+  spec.add_dependency 'concurrent-ruby', '>= 1.1.6'
   spec.add_dependency 'mime-types', '>= 3.0'
   spec.add_development_dependency 'bundler', '~> 2.2.3'
+  spec.add_development_dependency 'chunky_png'
   spec.add_development_dependency 'dry-inflector'
   spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency 'rake', '~> 13.0.3'
   spec.add_development_dependency 'rspec', '~> 3.10.0 '
+  spec.add_development_dependency 'rspec_junit_formatter' # for CircleCI.
   spec.add_development_dependency 'rubocop', '~> 1.7.0'
   spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'sinatra'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: playwright-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.5.3
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-18 00:00:00.000000000 Z
+date: 2021-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.6
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.2.3
+- !ruby/object:Gem::Dependency
+  name: chunky_png
+  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: dry-inflector
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.10.0
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  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: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -187,26 +215,26 @@ files:
 - lib/playwright/channel_owner.rb
 - lib/playwright/channel_owners/android.rb
 - lib/playwright/channel_owners/android_device.rb
+- lib/playwright/channel_owners/artifact.rb
 - lib/playwright/channel_owners/binding_call.rb
 - lib/playwright/channel_owners/browser.rb
 - lib/playwright/channel_owners/browser_context.rb
 - lib/playwright/channel_owners/browser_type.rb
-- lib/playwright/channel_owners/chromium_browser.rb
-- lib/playwright/channel_owners/chromium_browser_context.rb
 - lib/playwright/channel_owners/console_message.rb
-- lib/playwright/channel_owners/download.rb
+- lib/playwright/channel_owners/dialog.rb
 - lib/playwright/channel_owners/electron.rb
 - lib/playwright/channel_owners/element_handle.rb
-- lib/playwright/channel_owners/firefox_browser.rb
 - lib/playwright/channel_owners/frame.rb
 - lib/playwright/channel_owners/js_handle.rb
 - lib/playwright/channel_owners/page.rb
 - lib/playwright/channel_owners/playwright.rb
 - lib/playwright/channel_owners/request.rb
 - lib/playwright/channel_owners/response.rb
+- lib/playwright/channel_owners/route.rb
 - lib/playwright/channel_owners/selectors.rb
-- lib/playwright/channel_owners/webkit_browser.rb
+- lib/playwright/channel_owners/stream.rb
 - lib/playwright/connection.rb
+- lib/playwright/download.rb
 - lib/playwright/errors.rb
 - lib/playwright/event_emitter.rb
 - lib/playwright/event_emitter_proxy.rb
@@ -222,6 +250,7 @@ files:
 - lib/playwright/keyboard_impl.rb
 - lib/playwright/mouse_impl.rb
 - lib/playwright/playwright_api.rb
+- lib/playwright/route_handler_entry.rb
 - lib/playwright/select_option_values.rb
 - lib/playwright/timeout_settings.rb
 - lib/playwright/touchscreen_impl.rb
@@ -229,20 +258,20 @@ files:
 - lib/playwright/url_matcher.rb
 - lib/playwright/utils.rb
 - lib/playwright/version.rb
+- lib/playwright/video.rb
 - lib/playwright/wait_helper.rb
 - lib/playwright_api/accessibility.rb
 - lib/playwright_api/android.rb
 - lib/playwright_api/android_device.rb
 - lib/playwright_api/android_input.rb
-- lib/playwright_api/binding_call.rb
+- lib/playwright_api/android_socket.rb
+- lib/playwright_api/android_web_view.rb
 - lib/playwright_api/browser.rb
 - lib/playwright_api/browser_context.rb
 - lib/playwright_api/browser_type.rb
 - lib/playwright_api/cdp_session.rb
-- lib/playwright_api/chromium_browser_context.rb
 - lib/playwright_api/console_message.rb
 - lib/playwright_api/dialog.rb
-- lib/playwright_api/download.rb
 - lib/playwright_api/element_handle.rb
 - lib/playwright_api/file_chooser.rb
 - lib/playwright_api/frame.rb
@@ -256,7 +285,6 @@ files:
 - lib/playwright_api/route.rb
 - lib/playwright_api/selectors.rb
 - lib/playwright_api/touchscreen.rb
-- lib/playwright_api/video.rb
 - lib/playwright_api/web_socket.rb
 - lib/playwright_api/worker.rb
 - playwright.gemspec
@@ -279,7 +307,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: The Ruby binding of playwright driver

data/lib/playwright/channel_owners/chromium_browser.rb

@@ -1,8 +0,0 @@
-require_relative './browser'
-
-module Playwright
-  module ChannelOwners
-    class ChromiumBrowser < Browser
-    end
-  end
-end

data/lib/playwright/channel_owners/chromium_browser_context.rb

@@ -1,8 +0,0 @@
-require_relative './browser_context'
-
-module Playwright
-  module ChannelOwners
-    class ChromiumBrowserContext < BrowserContext
-    end
-  end
-end

data/lib/playwright/channel_owners/download.rb

@@ -1,27 +0,0 @@
-module Playwright
-  define_channel_owner :Download do
-    def url
-      @initializer['url']
-    end
-
-    def suggested_filename
-      @initializer['suggestedFilename']
-    end
-
-    def delete
-      @channel.send_message_to_server('delete')
-    end
-
-    def failure
-      @channel.send_message_to_server('failure')
-    end
-
-    def path
-      @channel.send_message_to_server('path')
-    end
-
-    def save_as(path)
-      @channel.send_message_to_server('saveAs', path: path)
-    end
-  end
-end

data/lib/playwright/channel_owners/firefox_browser.rb

@@ -1,8 +0,0 @@
-require_relative './browser'
-
-module Playwright
-  module ChannelOwners
-    class FirefoxBrowser < Browser
-    end
-  end
-end

data/lib/playwright/channel_owners/webkit_browser.rb

@@ -1,8 +0,0 @@
-require_relative './browser'
-
-module Playwright
-  module ChannelOwners
-    class WebKitBrowser < Browser
-    end
-  end
-end

data/lib/playwright_api/binding_call.rb

@@ -1,27 +0,0 @@
-module Playwright
-  # @nodoc
-  class BindingCall < PlaywrightApi
-
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
-    end
-
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
-    end
-
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
-    private def event_emitter_proxy
-      @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
-    end
-  end
-end

data/lib/playwright_api/chromium_browser_context.rb

@@ -1,59 +0,0 @@
-require_relative './browser_context.rb'
-
-module Playwright
-  # - extends: `BrowserContext`
-  # 
-  # Chromium-specific features including background pages, service worker support, etc.
-  # 
-  #
-  # ```js
-  # const backgroundPage = await context.waitForEvent('backgroundpage');
-  # ```
-  # 
-  # ```python async
-  # background_page = await context.wait_for_event("backgroundpage")
-  # ```
-  # 
-  # ```python sync
-  # background_page = context.wait_for_event("backgroundpage")
-  # ```
-  class ChromiumBrowserContext < BrowserContext
-
-    # All existing background pages in the context.
-    def background_pages
-      raise NotImplementedError.new('background_pages is not implemented yet.')
-    end
-
-    # Returns the newly created session.
-    def new_cdp_session(page)
-      raise NotImplementedError.new('new_cdp_session is not implemented yet.')
-    end
-
-    # All existing service workers in the context.
-    def service_workers
-      raise NotImplementedError.new('service_workers is not implemented yet.')
-    end
-
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
-    end
-
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
-    end
-
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
-    private def event_emitter_proxy
-      @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
-    end
-  end
-end

data/lib/playwright_api/download.rb

@@ -1,100 +0,0 @@
-module Playwright
-  # `Download` objects are dispatched by page via the [`event: Page.download`] event.
-  # 
-  # All the downloaded files belonging to the browser context are deleted when the browser context is closed. All downloaded
-  # files are deleted when the browser closes.
-  # 
-  # Download event is emitted once the download starts. Download path becomes available once download completes:
-  # 
-  #
-  # ```js
-  # const [ download ] = await Promise.all([
-  #   page.waitForEvent('download'), // wait for download to start
-  #   page.click('a')
-  # ]);
-  # // wait for download to complete
-  # const path = await download.path();
-  # ```
-  # 
-  # ```python async
-  # async with page.expect_download() as download_info:
-  #     await page.click("a")
-  # download = await download_info.value
-  # # waits for download to complete
-  # path = await download.path()
-  # ```
-  # 
-  # ```python sync
-  # with page.expect_download() as download_info:
-  #     page.click("a")
-  # download = download_info.value
-  # # wait for download to complete
-  # path = download.path()
-  # ```
-  # 
-  # > NOTE: Browser context **must** be created with the `acceptDownloads` set to `true` when user needs access to the
-  # downloaded content. If `acceptDownloads` is not set, download events are emitted, but the actual download is not
-  # performed and user has no access to the downloaded files.
-  class Download < PlaywrightApi
-
-    # Returns readable stream for current download or `null` if download failed.
-    def create_read_stream
-      raise NotImplementedError.new('create_read_stream is not implemented yet.')
-    end
-
-    # Deletes the downloaded file.
-    def delete
-      wrap_impl(@impl.delete)
-    end
-
-    # Returns download error if any.
-    def failure
-      wrap_impl(@impl.failure)
-    end
-
-    # Returns path to the downloaded file in case of successful download.
-    def path
-      wrap_impl(@impl.path)
-    end
-
-    # Saves the download to a user-specified path.
-    def save_as(path)
-      wrap_impl(@impl.save_as(unwrap_impl(path)))
-    end
-
-    # Returns suggested filename for this download. It is typically computed by the browser from the
-    # [`Content-Disposition`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition) response header
-    # or the `download` attribute. See the spec on [whatwg](https://html.spec.whatwg.org/#downloading-resources). Different
-    # browsers can use different logic for computing it.
-    def suggested_filename
-      wrap_impl(@impl.suggested_filename)
-    end
-
-    # Returns downloaded url.
-    def url
-      wrap_impl(@impl.url)
-    end
-
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
-    end
-
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
-    end
-
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
-    private def event_emitter_proxy
-      @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
-    end
-  end
-end