playwright-ruby-client 0.0.3 → 0.0.8

data/lib/playwright_api/route.rb

@@ -1,5 +1,6 @@
 module Playwright
-  # Whenever a network route is set up with `page.route(url, handler)` or `browserContext.route(url, handler)`, the `Route` object allows to handle the route.
+  # Whenever a network route is set up with [`method: Page.route`] or [`method: BrowserContext.route`], the `Route` object
+  # allows to handle the route.
   class Route < PlaywrightApi
 
     # Aborts the route's request.
@@ -8,6 +9,7 @@ module Playwright
     end
 
     # Continues route's request with optional overrides.
+    # 
     #
     # ```js
     # await page.route('**/*', (route, request) => {
@@ -20,12 +22,40 @@ module Playwright
     #   route.continue({headers});
     # });
     # ```
-    def continue(overrides: nil)
-      raise NotImplementedError.new('continue is not implemented yet.')
+    # 
+    # ```python async
+    # async def handle(route, request):
+    #     # override headers
+    #     headers = {
+    #         **request.headers,
+    #         "foo": "bar" # set "foo" header
+    #         "origin": None # remove "origin" header
+    #     }
+    #     await route.continue(headers=headers)
+    # }
+    # await page.route("**/*", handle)
+    # ```
+    # 
+    # ```python sync
+    # def handle(route, request):
+    #     # override headers
+    #     headers = {
+    #         **request.headers,
+    #         "foo": "bar" # set "foo" header
+    #         "origin": None # remove "origin" header
+    #     }
+    #     route.continue(headers=headers)
+    # }
+    # page.route("**/*", handle)
+    # ```
+    def continue_(headers: nil, method: nil, postData: nil, url: nil)
+      raise NotImplementedError.new('continue_ is not implemented yet.')
     end
 
     # Fulfills route's request with given response.
+    # 
     # An example of fulfilling all requests with 404 responses:
+    # 
     #
     # ```js
     # await page.route('**/*', route => {
@@ -36,12 +66,41 @@ module Playwright
     #   });
     # });
     # ```
+    # 
+    # ```python async
+    # await page.route("**/*", lambda route: route.fulfill(
+    #     status=404,
+    #     content_type="text/plain",
+    #     body="not found!"))
+    # ```
+    # 
+    # ```python sync
+    # page.route("**/*", lambda route: route.fulfill(
+    #     status=404,
+    #     content_type="text/plain",
+    #     body="not found!"))
+    # ```
+    # 
     # An example of serving static file:
+    # 
     #
     # ```js
     # await page.route('**/xhr_endpoint', route => route.fulfill({ path: 'mock_data.json' }));
     # ```
-    def fulfill(response)
+    # 
+    # ```python async
+    # await page.route("**/xhr_endpoint", lambda route: route.fulfill(path="mock_data.json"))
+    # ```
+    # 
+    # ```python sync
+    # page.route("**/xhr_endpoint", lambda route: route.fulfill(path="mock_data.json"))
+    # ```
+    def fulfill(
+          body: nil,
+          contentType: nil,
+          headers: nil,
+          path: nil,
+          status: nil)
       raise NotImplementedError.new('fulfill is not implemented yet.')
     end
 

data/lib/playwright_api/selectors.rb

@@ -1,8 +1,10 @@
 module Playwright
-  # Selectors can be used to install custom selector engines. See Working with selectors for more information.
+  # Selectors can be used to install custom selector engines. See
+  # [Working with selectors](./selectors.md#working-with-selectors) for more information.
   class Selectors < PlaywrightApi
 
     # An example of registering selector engine that queries elements based on a tag name:
+    # 
     #
     # ```js
     # const { selectors, firefox } = require('playwright');  // Or 'chromium' or 'webkit'.
@@ -10,12 +12,6 @@ module Playwright
     # (async () => {
     #   // Must be a function that evaluates to a selector engine instance.
     #   const createTagNameEngine = () => ({
-    #     // Creates a selector that matches given target when queried at the root.
-    #     // Can return undefined if unable to create one.
-    #     create(root, target) {
-    #       return root.querySelector(target.tagName) === target ? target.tagName : undefined;
-    #     },
-    # 
     #     // Returns the first element matching given selector in the root's subtree.
     #     query(root, selector) {
     #       return root.querySelector(selector);
@@ -44,8 +40,34 @@ module Playwright
     #   await browser.close();
     # })();
     # ```
+    # 
+    # ```python async
+    # # FIXME: add snippet
+    # ```
+    # 
+    # ```python sync
+    # # FIXME: add snippet
+    # ```
     def register(name, script, contentScript: nil)
       raise NotImplementedError.new('register is not implemented yet.')
     end
+
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def on(event, callback)
+      wrap_impl(@impl.on(unwrap_impl(event), unwrap_impl(callback)))
+    end
+
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      wrap_impl(@impl.off(unwrap_impl(event), unwrap_impl(callback)))
+    end
+
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def once(event, callback)
+      wrap_impl(@impl.once(unwrap_impl(event), unwrap_impl(callback)))
+    end
   end
 end

data/lib/playwright_api/touchscreen.rb

@@ -1,5 +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.
+  # 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.
   class Touchscreen < PlaywrightApi
 
     # Dispatches a `touchstart` and `touchend` event with a single touch at the position (`x`,`y`).

data/lib/playwright_api/video.rb

@@ -1,12 +1,22 @@
 module Playwright
   # When browser context is created with the `videosPath` option, each page has a video object associated with it.
+  # 
   #
   # ```js
   # console.log(await page.video().path());
   # ```
+  # 
+  # ```python async
+  # print(await page.video.path())
+  # ```
+  # 
+  # ```python sync
+  # print(page.video.path())
+  # ```
   class Video < PlaywrightApi
 
-    # Returns the file system path this video will be recorded to. The video is guaranteed to be written to the filesystem upon closing the browser context.
+    # Returns the file system path this video will be recorded to. The video is guaranteed to be written to the filesystem
+    # upon closing the browser context.
     def path
       raise NotImplementedError.new('path is not implemented yet.')
     end

data/lib/playwright_api/web_socket.rb

@@ -1,5 +1,5 @@
 module Playwright
-  # The WebSocket class represents websocket connections in the page.
+  # The `WebSocket` class represents websocket connections in the page.
   class WebSocket < PlaywrightApi
 
     # Indicates that the web socket has been closed.
@@ -12,10 +12,10 @@ module Playwright
       raise NotImplementedError.new('url is not implemented yet.')
     end
 
-    # Returns the event data value.
-    # 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.
-    def wait_for_event(event, optionsOrPredicate: nil)
-      raise NotImplementedError.new('wait_for_event is not implemented yet.')
+    # 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, optionsOrPredicate: nil)
+      raise NotImplementedError.new('expect_event is not implemented yet.')
     end
   end
 end

data/lib/playwright_api/worker.rb

@@ -1,5 +1,8 @@
 module Playwright
-  # The Worker class represents a WebWorker. `worker` event is emitted on the page object to signal a worker creation. `close` event is emitted on the worker object when the worker is gone.
+  # The Worker class represents a [WebWorker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API). `worker`
+  # event is emitted on the page object to signal a worker creation. `close` event is emitted on the worker object when the
+  # worker is gone.
+  # 
   #
   # ```js
   # page.on('worker', worker => {
@@ -11,18 +14,39 @@ module Playwright
   # for (const worker of page.workers())
   #   console.log('  ' + worker.url());
   # ```
+  # 
+  # ```py
+  # def handle_worker(worker):
+  #     print("worker created: " + worker.url)
+  #     worker.on("close", lambda: print("worker destroyed: " + worker.url))
+  # 
+  # page.on('worker', handle_worker)
+  # 
+  # print("current workers:")
+  # for worker in page.workers:
+  #     print("    " + worker.url)
+  # ```
   class Worker < PlaywrightApi
 
     # Returns the return value of `pageFunction`
-    # If the function passed to the `worker.evaluate` returns a Promise, then `worker.evaluate` would wait for the promise to resolve and return its value.
-    # If the function passed to the `worker.evaluate` returns a non-Serializable value, then `worker.evaluate` returns `undefined`. DevTools Protocol also supports transferring some additional values that are not serializable by `JSON`: `-0`, `NaN`, `Infinity`, `-Infinity`, and bigint literals.
+    # 
+    # If the function passed to the `worker.evaluate` returns a [Promise], then `worker.evaluate` would wait for the promise
+    # to resolve and return its value.
+    # 
+    # If the function passed to the `worker.evaluate` returns a non-[Serializable] value, then `worker.evaluate` returns
+    # `undefined`. DevTools Protocol also supports transferring some additional values that are not serializable by `JSON`:
+    # `-0`, `NaN`, `Infinity`, `-Infinity`, and bigint literals.
     def evaluate(pageFunction, arg: nil)
       raise NotImplementedError.new('evaluate is not implemented yet.')
     end
 
     # Returns the return value of `pageFunction` as in-page object (JSHandle).
-    # The only difference between `worker.evaluate` and `worker.evaluateHandle` is that `worker.evaluateHandle` returns in-page object (JSHandle).
-    # If the function passed to the `worker.evaluateHandle` returns a Promise, then `worker.evaluateHandle` would wait for the promise to resolve and return its value.
+    # 
+    # The only difference between `worker.evaluate` and `worker.evaluateHandle` is that `worker.evaluateHandle` returns
+    # in-page object (JSHandle).
+    # 
+    # If the function passed to the `worker.evaluateHandle` returns a [Promise], then `worker.evaluateHandle` would wait for
+    # the promise to resolve and return its value.
     def evaluate_handle(pageFunction, arg: nil)
       raise NotImplementedError.new('evaluate_handle is not implemented yet.')
     end

data/playwright.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'concurrent-ruby'
+  spec.add_dependency 'mime-types', '>= 3.0'
   spec.add_development_dependency 'bundler', '~> 2.2.3'
   spec.add_development_dependency 'dry-inflector'
   spec.add_development_dependency 'pry-byebug'
@@ -32,4 +33,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.10.0 '
   spec.add_development_dependency 'rubocop', '~> 1.7.0'
   spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'sinatra'
+  spec.add_development_dependency 'webrick'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: playwright-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.8
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-11 00:00:00.000000000 Z
+date: 2021-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +136,34 @@ 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: webrick
+  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'
 description: 
 email:
 - q7w8e9w8q7w8e9@yahoo.co.jp
@@ -137,19 +179,24 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- docs/api_coverage.md
 - lib/playwright.rb
 - lib/playwright/channel.rb
 - lib/playwright/channel_owner.rb
 - lib/playwright/channel_owners/android.rb
+- lib/playwright/channel_owners/android_device.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/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
@@ -160,10 +207,29 @@ files:
 - lib/playwright/errors.rb
 - lib/playwright/event_emitter.rb
 - lib/playwright/events.rb
+- lib/playwright/input_files.rb
+- lib/playwright/input_type.rb
+- lib/playwright/input_types/android_input.rb
+- lib/playwright/input_types/keyboard.rb
+- lib/playwright/input_types/mouse.rb
+- lib/playwright/input_types/touchscreen.rb
+- lib/playwright/javascript.rb
+- lib/playwright/javascript/expression.rb
+- lib/playwright/javascript/function.rb
+- lib/playwright/javascript/value_parser.rb
+- lib/playwright/javascript/value_serializer.rb
 - lib/playwright/playwright_api.rb
+- lib/playwright/select_option_values.rb
+- lib/playwright/timeout_settings.rb
 - lib/playwright/transport.rb
+- lib/playwright/url_matcher.rb
+- lib/playwright/utils.rb
 - lib/playwright/version.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/browser.rb
 - lib/playwright_api/browser_context.rb