playwright-ruby-client 0.2.0 → 0.5.4

data/lib/playwright_api/playwright.rb

@@ -15,6 +15,23 @@ module Playwright
   # })();
   # ```
   # 
+  # ```java
+  # import com.microsoft.playwright.*;
+  # 
+  # public class Example {
+  #   public static void main(String[] args) {
+  #     try (Playwright playwright = Playwright.create()) {
+  #       BrowserType chromium = playwright.chromium();
+  #       Browser browser = chromium.launch();
+  #       Page page = browser.newPage();
+  #       page.navigate("http://example.com");
+  #       // other actions...
+  #       browser.close();
+  #     }
+  #   }
+  # }
+  # ```
+  # 
   # ```python async
   # import asyncio
   # from playwright.async_api import async_playwright
@@ -49,7 +66,7 @@ module Playwright
   # ```
   class Playwright < PlaywrightApi
 
-    # This object can be used to launch or connect to Chromium, returning instances of `ChromiumBrowser`.
+    # This object can be used to launch or connect to Chromium, returning instances of `Browser`.
     def chromium # property
       wrap_impl(@impl.chromium)
     end
@@ -113,7 +130,7 @@ module Playwright
       wrap_impl(@impl.devices)
     end
 
-    # This object can be used to launch or connect to Firefox, returning instances of `FirefoxBrowser`.
+    # This object can be used to launch or connect to Firefox, returning instances of `Browser`.
     def firefox # property
       wrap_impl(@impl.firefox)
     end
@@ -121,10 +138,10 @@ module Playwright
     # Selectors can be used to install custom selector engines. See [Working with selectors](./selectors.md) for more
     # information.
     def selectors # property
-      raise NotImplementedError.new('selectors is not implemented yet.')
+      wrap_impl(@impl.selectors)
     end
 
-    # This object can be used to launch or connect to WebKit, returning instances of `WebKitBrowser`.
+    # This object can be used to launch or connect to WebKit, returning instances of `Browser`.
     def webkit # property
       wrap_impl(@impl.webkit)
     end

data/lib/playwright_api/request.rb

@@ -2,10 +2,10 @@ module Playwright
   # Whenever the page sends a request for a network resource the following sequence of events are emitted by `Page`:
   # - [`event: Page.request`] emitted when the request is issued by the page.
   # - [`event: Page.response`] emitted when/if the response status and headers are received for the request.
-  # - [`event: Page.requestfinished`] emitted when the response body is downloaded and the request is complete.
+  # - [`event: Page.requestFinished`] emitted when the response body is downloaded and the request is complete.
   # 
   # If request fails at some point, then instead of `'requestfinished'` event (and possibly instead of 'response' event),
-  # the  [`event: Page.requestfailed`] event is emitted.
+  # the  [`event: Page.requestFailed`] event is emitted.
   # 
   # > NOTE: HTTP Error responses, such as 404 or 503, are still successful responses from HTTP standpoint, so request will
   # complete with `'requestfinished'` event.
@@ -25,6 +25,12 @@ module Playwright
     # });
     # ```
     # 
+    # ```java
+    # page.onRequestFailed(request -> {
+    #   System.out.println(request.url() + " " + request.failure());
+    # });
+    # ```
+    # 
     # ```py
     # page.on("requestfailed", lambda request: print(request.url + " " + request.failure))
     # ```
@@ -84,6 +90,11 @@ module Playwright
     # console.log(response.request().redirectedFrom().url()); // 'http://example.com'
     # ```
     # 
+    # ```java
+    # Response response = page.navigate("http://example.com");
+    # System.out.println(response.request().redirectedFrom().url()); // "http://example.com"
+    # ```
+    # 
     # ```python async
     # response = await page.goto("http://example.com")
     # print(response.request.redirected_from.url) # "http://example.com"
@@ -102,6 +113,11 @@ module Playwright
     # console.log(response.request().redirectedFrom()); // null
     # ```
     # 
+    # ```java
+    # Response response = page.navigate("https://google.com");
+    # System.out.println(response.request().redirectedFrom()); // null
+    # ```
+    # 
     # ```python async
     # response = await page.goto("https://google.com")
     # print(response.request.redirected_from) # None
@@ -124,6 +140,10 @@ module Playwright
     # console.log(request.redirectedFrom().redirectedTo() === request); // true
     # ```
     # 
+    # ```java
+    # System.out.println(request.redirectedFrom().redirectedTo() == request); // true
+    # ```
+    # 
     # ```py
     # assert request.redirected_from.redirected_to == request
     # ```
@@ -156,6 +176,14 @@ module Playwright
     # console.log(request.timing());
     # ```
     # 
+    # ```java
+    # page.onRequestFinished(request -> {
+    #   Timing timing = request.timing();
+    #   System.out.println(timing.responseEnd - timing.startTime);
+    # });
+    # page.navigate("http://example.com");
+    # ```
+    # 
     # ```python async
     # async with page.expect_event("requestfinished") as request_info:
     #     await page.goto("http://example.com")

data/lib/playwright_api/response.rb

@@ -4,59 +4,69 @@ module Playwright
 
     # Returns the buffer with response body.
     def body
-      raise NotImplementedError.new('body is not implemented yet.')
+      wrap_impl(@impl.body)
     end
 
     # Waits for this response to finish, returns failure error if request failed.
     def finished
-      raise NotImplementedError.new('finished is not implemented yet.')
+      wrap_impl(@impl.finished)
     end
 
     # Returns the `Frame` that initiated this response.
     def frame
-      raise NotImplementedError.new('frame is not implemented yet.')
+      wrap_impl(@impl.frame)
     end
 
     # Returns the object with HTTP headers associated with the response. All header names are lower-case.
     def headers
-      raise NotImplementedError.new('headers is not implemented yet.')
+      wrap_impl(@impl.headers)
     end
 
     # Returns the JSON representation of response body.
     # 
     # This method will throw if the response body is not parsable via `JSON.parse`.
     def json
-      raise NotImplementedError.new('json is not implemented yet.')
+      wrap_impl(@impl.json)
     end
 
     # Contains a boolean stating whether the response was successful (status in the range 200-299) or not.
     def ok
-      raise NotImplementedError.new('ok is not implemented yet.')
+      wrap_impl(@impl.ok)
     end
 
     # Returns the matching `Request` object.
     def request
-      raise NotImplementedError.new('request is not implemented yet.')
+      wrap_impl(@impl.request)
     end
 
     # Contains the status code of the response (e.g., 200 for a success).
     def status
-      raise NotImplementedError.new('status is not implemented yet.')
+      wrap_impl(@impl.status)
     end
 
     # Contains the status text of the response (e.g. usually an "OK" for a success).
     def status_text
-      raise NotImplementedError.new('status_text is not implemented yet.')
+      wrap_impl(@impl.status_text)
     end
 
     # Returns the text representation of response body.
     def text
-      raise NotImplementedError.new('text is not implemented yet.')
+      wrap_impl(@impl.text)
     end
 
     # Contains the URL of the response.
     def url
-      raise NotImplementedError.new('url is not implemented yet.')
+      wrap_impl(@impl.url)
+    end
+
+    # @nodoc
+    def after_initialize
+      wrap_impl(@impl.after_initialize)
+    end
+
+    # @nodoc
+    def ok?
+      wrap_impl(@impl.ok?)
     end
 
     # -- inherited from EventEmitter --

data/lib/playwright_api/route.rb

@@ -5,7 +5,7 @@ module Playwright
 
     # Aborts the route's request.
     def abort(errorCode: nil)
-      raise NotImplementedError.new('abort is not implemented yet.')
+      wrap_impl(@impl.abort(errorCode: unwrap_impl(errorCode)))
     end
 
     # Continues route's request with optional overrides.
@@ -23,6 +23,16 @@ module Playwright
     # });
     # ```
     # 
+    # ```java
+    # page.route("**/*", route -> {
+    #   // Override headers
+    #   Map<String, String> headers = new HashMap<>(route.request().headers());
+    #   headers.put("foo", "bar"); // set "foo" header
+    #   headers.remove("origin"); // remove "origin" header
+    #   route.resume(new Route.ResumeOptions().setHeaders(headers));
+    # });
+    # ```
+    # 
     # ```python async
     # async def handle(route, request):
     #     # override headers
@@ -48,8 +58,8 @@ module Playwright
     # }
     # page.route("**/*", handle)
     # ```
-    def continue_(headers: nil, method: nil, postData: nil, url: nil)
-      raise NotImplementedError.new('continue_ is not implemented yet.')
+    def continue(headers: nil, method: nil, postData: nil, url: nil)
+      wrap_impl(@impl.continue(headers: unwrap_impl(headers), method: unwrap_impl(method), postData: unwrap_impl(postData), url: unwrap_impl(url)))
     end
 
     # Fulfills route's request with given response.
@@ -67,6 +77,15 @@ module Playwright
     # });
     # ```
     # 
+    # ```java
+    # page.route("**/*", route -> {
+    #   route.fulfill(new Route.FulfillOptions()
+    #     .setStatus(404)
+    #     .setContentType("text/plain")
+    #     .setBody("Not Found!"));
+    # });
+    # ```
+    # 
     # ```python async
     # await page.route("**/*", lambda route: route.fulfill(
     #     status=404,
@@ -88,6 +107,11 @@ module Playwright
     # await page.route('**/xhr_endpoint', route => route.fulfill({ path: 'mock_data.json' }));
     # ```
     # 
+    # ```java
+    # page.route("**/xhr_endpoint", route -> route.fulfill(
+    #   new Route.FulfillOptions().setPath(Paths.get("mock_data.json")));
+    # ```
+    # 
     # ```python async
     # await page.route("**/xhr_endpoint", lambda route: route.fulfill(path="mock_data.json"))
     # ```
@@ -101,12 +125,34 @@ module Playwright
           headers: nil,
           path: nil,
           status: nil)
-      raise NotImplementedError.new('fulfill is not implemented yet.')
+      wrap_impl(@impl.fulfill(body: unwrap_impl(body), contentType: unwrap_impl(contentType), headers: unwrap_impl(headers), path: unwrap_impl(path), status: unwrap_impl(status)))
     end
 
     # A request to be routed.
     def request
-      raise NotImplementedError.new('request is not implemented yet.')
+      wrap_impl(@impl.request)
+    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/selectors.rb

@@ -41,6 +41,32 @@ module Playwright
     # })();
     # ```
     # 
+    # ```java
+    # // Script that evaluates to a selector engine instance.
+    # String createTagNameEngine = "{\n" +
+    #   "  // Returns the first element matching given selector in the root's subtree.\n" +
+    #   "  query(root, selector) {\n" +
+    #   "    return root.querySelector(selector);\n" +
+    #   "  },\n" +
+    #   "  // Returns all elements matching given selector in the root's subtree.\n" +
+    #   "  queryAll(root, selector) {\n" +
+    #   "    return Array.from(root.querySelectorAll(selector));\n" +
+    #   "  }\n" +
+    #   "}";
+    # // Register the engine. Selectors will be prefixed with "tag=".
+    # playwright.selectors().register("tag", createTagNameEngine);
+    # Browser browser = playwright.firefox().launch();
+    # Page page = browser.newPage();
+    # page.setContent("<div><button>Click me</button></div>");
+    # // Use the selector prefixed with its name.
+    # ElementHandle button = page.querySelector("tag=button");
+    # // Combine it with other selector engines.
+    # page.click("tag=div >> text=\"Click me\"");
+    # // Can use it in any methods supporting selectors.
+    # int buttonCount = (int) page.evalOnSelectorAll("tag=button", "buttons => buttons.length");
+    # browser.close();
+    # ```
+    # 
     # ```python async
     # # FIXME: add snippet
     # ```
@@ -49,7 +75,7 @@ module Playwright
     # # FIXME: add snippet
     # ```
     def register(name, contentScript: nil, path: nil, script: nil)
-      raise NotImplementedError.new('register is not implemented yet.')
+      wrap_impl(@impl.register(unwrap_impl(name), contentScript: unwrap_impl(contentScript), path: unwrap_impl(path), script: unwrap_impl(script)))
     end
 
     # -- inherited from EventEmitter --

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/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.2.0
+  version: 0.5.4
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-20 00:00:00.000000000 Z
+date: 2021-05-03 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