playwright-ruby-client 1.15.beta2 → 1.15.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2247f39a5fa4881e45ad884606295d7003b3e42ca9db5436b223d921649e5553
-  data.tar.gz: f7f57d5044c66e300912578faa1d8114ee98f2eb1de736eac3da698e7851b9d6
+  metadata.gz: '028909fb1fc1321105a1172d46c02ccafbb071e5e630b5c5b616a9e76a695a91'
+  data.tar.gz: cadf29fb85714aac062c481b0c677709dc620141af57b0641d065a379210e93b
 SHA512:
-  metadata.gz: 86b2003368d06755bfef64cebe40c716ef9d0156d6bd21f18fddc79cef07ffee5a48f562294c32b956dd664b5480326587736ee56334c76e80e8a8e2b89dfb72
-  data.tar.gz: 20697ed55fb7ce54856d04dc0f9568316d5941b0b103ce5c0138e680a28aeda1b7876a3cf4d358f006a2b5d7115a267ed8e7c689064bf54f65e6797848d69a2f
+  metadata.gz: efe23218fd7aa8a5eee431af6fac5046420b222f67e196cd46cf44127bafe6a4db88f3ae56f71b1fe74d874fd385f1600009335e59be9c2a5bbca0ad4eacd13a
+  data.tar.gz: d0c78be5d3f3c662cd4b68bbbbf5624ce9febdf4be39740812f26573f14e68c5111fef7777b7ae2a5839c1723d3d20b91d680a2d691c791afcec01efe3630de2

data/documentation/docs/api/mouse.md

@@ -66,3 +66,14 @@ def up(button: nil, clickCount: nil)
 ```
 
 Dispatches a `mouseup` event.
+
+## wheel
+
+```
+def wheel(deltaX, deltaY)
+```
+
+Dispatches a `wheel` event.
+
+> NOTE: Wheel events may cause scrolling if they are not handled, and this method does not wait for the scrolling to
+finish before returning.

data/documentation/docs/api/request.md

@@ -65,7 +65,15 @@ def headers_array
 ```
 
 An array with all the request HTTP headers associated with this request. Unlike [Request#all_headers](./request#all_headers), header
-names are not lower-cased. Headers with multiple entries, such as `Set-Cookie`, appear in the array multiple times.
+names are NOT lower-cased. Headers with multiple entries, such as `Set-Cookie`, appear in the array multiple times.
+
+## header_value
+
+```
+def header_value(name)
+```
+
+Returns the value of the header matching the name. The name is case insensitive.
 
 ## navigation_request?
 
@@ -179,8 +187,7 @@ Returns the matching [Response](./response) object, or `null` if the response wa
 def sizes
 ```
 
-Returns resource size information for given request. Requires the response to be finished via
-[Response#finished](./response#finished) to ensure the info is available.
+Returns resource size information for given request.
 
 ## timing
 

data/documentation/docs/api/response.md

@@ -28,7 +28,7 @@ Returns the buffer with response body.
 def finished
 ```
 
-Waits for this response to finish, returns failure error if request failed.
+Waits for this response to finish, returns always `null`.
 
 ## frame
 
@@ -53,7 +53,25 @@ def headers_array
 ```
 
 An array with all the request HTTP headers associated with this response. Unlike [Response#all_headers](./response#all_headers), header
-names are not lower-cased. Headers with multiple entries, such as `Set-Cookie`, appear in the array multiple times.
+names are NOT lower-cased. Headers with multiple entries, such as `Set-Cookie`, appear in the array multiple times.
+
+## header_value
+
+```
+def header_value(name)
+```
+
+Returns the value of the header matching the name. The name is case insensitive. If multiple headers have the same name
+(except `set-cookie`), they are returned as a list separated by `, `. For `set-cookie`, the `\n` separator is used. If
+no headers are found, `null` is returned.
+
+## header_values
+
+```
+def header_values(name)
+```
+
+Returns all values of the headers matching the name, for example `set-cookie`. The name is case insensitive.
 
 ## json
 

data/documentation/docs/include/api_coverage.md

@@ -7,6 +7,7 @@
 * frame
 * headers
 * headers_array
+* header_value
 * navigation_request?
 * method
 * post_data
@@ -28,6 +29,8 @@
 * frame
 * headers
 * headers_array
+* header_value
+* header_values
 * json
 * ok
 * request
@@ -67,6 +70,7 @@
 * down
 * move
 * up
+* wheel
 
 ## Touchscreen
 

data/lib/playwright/channel_owners/request.rb

@@ -1,14 +1,12 @@
 require 'base64'
-require_relative '../http_headers'
 
 module Playwright
   # @ref https://github.com/microsoft/playwright-python/blob/master/playwright/_impl/_network.py
   define_channel_owner :Request do
-    include HttpHeaders::Parser
-
     private def after_initialize
       @redirected_from = ChannelOwners::Request.from_nullable(@initializer['redirectedFrom'])
       @redirected_from&.send(:update_redirected_to, self)
+      @provisional_headers = RawHeaders.new(@initializer['headers'])
       @timing = {
         startTime: 0,
         domainLookupStart: -1,
@@ -81,26 +79,43 @@ module Playwright
     attr_reader :redirected_from, :redirected_to, :timing
 
     def headers
-      parse_headers_as_array(@initializer['headers'], true).to_h
+      @provisional_headers.headers
     end
 
-    private def raw_headers
-      @raw_headers ||= response&.send(:raw_request_headers)
+    # @return [RawHeaders|nil]
+    private def actual_headers
+      @actual_headers ||= response&.send(:raw_request_headers)
     end
 
     def all_headers
-      if raw_headers
-        parse_headers_as_array(raw_headers, true).to_h
+      if actual_headers
+        actual_headers.headers
       else
-        parse_headers_as_array(@initializer['headers'], true).to_h
+        @provisional_headers.headers
       end
     end
 
     def headers_array
-      if raw_headers
-        parse_headers_as_array(raw_headers, false)
+      if actual_headers
+        actual_headers.headers_array
+      else
+        @provisional_headers.headers_array
+      end
+    end
+
+    def header_value(name)
+      if actual_headers
+        actual_headers.get(name)
+      else
+        @provisional_headers.get(name)
+      end
+    end
+
+    def header_values(name)
+      if actual_headers
+        actual_headers.get_all(name)
       else
-        parse_headers_as_array(@initializer['headers'], false)
+        @provisional_headers.get_all(name)
       end
     end
 

data/lib/playwright/channel_owners/response.rb

@@ -1,13 +1,11 @@
 require 'base64'
 require 'json'
-require_relative '../http_headers'
 
 module Playwright
   # @ref https://github.com/microsoft/playwright-python/blob/master/playwright/_impl/_network.py
   define_channel_owner :Response do
-    include HttpHeaders::Parser
-
     private def after_initialize
+      @provisional_headers = RawHeaders.new(@initializer['headers'])
       @request = ChannelOwners::Request.from(@initializer['request'])
       timing = @initializer['timing']
       @request.send(:update_timings,
@@ -42,27 +40,36 @@ module Playwright
     end
 
     def headers
-      parse_headers_as_array(@initializer['headers'], true).to_h
+      @provisional_headers.headers
     end
 
-    private def raw_headers
-      @raw_headers ||= raw_response_headers
+    # @return [RawHeaders]
+    private def actual_headers
+      @actual_headers ||= raw_response_headers
     end
 
     private def raw_request_headers
-      @channel.send_message_to_server('rawRequestHeaders')
+      RawHeaders.new(@channel.send_message_to_server('rawRequestHeaders'))
     end
 
     private def raw_response_headers
-      @channel.send_message_to_server('rawResponseHeaders')
+      RawHeaders.new(@channel.send_message_to_server('rawResponseHeaders'))
     end
 
     def all_headers
-      parse_headers_as_array(raw_headers, true).to_h
+      actual_headers.headers
     end
 
     def headers_array
-      parse_headers_as_array(raw_headers, false)
+      actual_headers.headers_array
+    end
+
+    def header_value(name)
+      actual_headers.get(name)
+    end
+
+    def header_values(name)
+      actual_headers.get_all(name)
     end
 
     def server_addr

data/lib/playwright/http_headers.rb

@@ -10,16 +10,5 @@ module Playwright
         { name: key, value: value }
       end
     end
-
-    module Parser
-      def parse_headers_as_array(serialized_headers, downcase)
-        serialized_headers.map do |header|
-          name = downcase ? header['name'].downcase : header['name']
-          value = header['value']
-
-          [name, value]
-        end
-      end
-    end
   end
 end

data/lib/playwright/mouse_impl.rb

@@ -44,5 +44,14 @@ module Playwright
     def dblclick(x, y, button: nil, delay: nil)
       click(x, y, button: button, clickCount: 2, delay: delay)
     end
+
+    def wheel(deltaX, deltaY)
+      params = {
+        deltaX: deltaX,
+        deltaY: deltaY,
+      }
+      @channel.send_message_to_server('mouseWheel', params)
+      nil
+    end
   end
 end

data/lib/playwright/raw_headers.rb

@@ -0,0 +1,61 @@
+module Playwright
+  class RawHeaders
+    def initialize(headers_array)
+      h_array = []
+      h_map = {}
+      headers_array.each do |header|
+        name = header['name']
+        key = name.downcase
+        value = header['value']
+
+        h_array << [name, value]
+        h_map[key] ||= []
+        h_map[key] << value
+      end
+
+      @headers_array = h_array
+      @headers_map = h_map
+    end
+
+    # @return [String|nil]
+    def get(name)
+      key = name.downcase
+      values = @headers_map[key]
+      if values
+        join(key, values)
+      else
+        nil
+      end
+    end
+
+    # @return [Array<String>]
+    def get_all(name)
+      values = @headers_map[name.downcase]
+      if values
+        values.dup
+      else
+        []
+      end
+    end
+
+    def headers
+      @headers_map.map do |key, values|
+        [key, join(key, values)]
+      end.to_h
+    end
+
+    def headers_array
+      @headers_array.map do |name, value|
+        { name: name, value: value }
+      end
+    end
+
+    private def join(key, values)
+      if key == 'set-cookie'
+        values.join("\n")
+      else
+        values.join(", ")
+      end
+    end
+  end
+end

data/lib/playwright/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Playwright
-  VERSION = '1.15.beta2'
+  VERSION = '1.15.beta3'
   COMPATIBLE_PLAYWRIGHT_VERSION = '1.15.0'
 end

data/lib/playwright.rb

@@ -20,6 +20,7 @@ require 'playwright/channel_owner'
 require 'playwright/http_headers'
 require 'playwright/input_files'
 require 'playwright/connection'
+require 'playwright/raw_headers'
 require 'playwright/route_handler'
 require 'playwright/select_option_values'
 require 'playwright/timeout_settings'

data/lib/playwright_api/cdp_session.rb

@@ -12,7 +12,7 @@ module Playwright
   #   https://github.com/aslushnikov/getting-started-with-cdp/blob/master/README.md
   #
   # ```python sync
-  # client = page.context().new_cdp_session(page)
+  # client = page.context.new_cdp_session(page)
   # client.send("Animation.enable")
   # client.on("Animation.animationCreated", lambda: print("animation created!"))
   # response = client.send("Animation.getPlaybackRate")

data/lib/playwright_api/mouse.rb

@@ -45,5 +45,13 @@ module Playwright
     def up(button: nil, clickCount: nil)
       wrap_impl(@impl.up(button: unwrap_impl(button), clickCount: unwrap_impl(clickCount)))
     end
+
+    # Dispatches a `wheel` event.
+    #
+    # > NOTE: Wheel events may cause scrolling if they are not handled, and this method does not wait for the scrolling to
+    # finish before returning.
+    def wheel(deltaX, deltaY)
+      wrap_impl(@impl.wheel(unwrap_impl(deltaX), unwrap_impl(deltaY)))
+    end
   end
 end

data/lib/playwright_api/request.rb

@@ -41,11 +41,16 @@ module Playwright
     end
 
     # An array with all the request HTTP headers associated with this request. Unlike [`method: Request.allHeaders`], header
-    # names are not lower-cased. Headers with multiple entries, such as `Set-Cookie`, appear in the array multiple times.
+    # names are NOT lower-cased. Headers with multiple entries, such as `Set-Cookie`, appear in the array multiple times.
     def headers_array
       wrap_impl(@impl.headers_array)
     end
 
+    # Returns the value of the header matching the name. The name is case insensitive.
+    def header_value(name)
+      wrap_impl(@impl.header_value(unwrap_impl(name)))
+    end
+
     # Whether this request is driving frame's navigation.
     def navigation_request?
       wrap_impl(@impl.navigation_request?)
@@ -120,8 +125,7 @@ module Playwright
       wrap_impl(@impl.response)
     end
 
-    # Returns resource size information for given request. Requires the response to be finished via
-    # [`method: Response.finished`] to ensure the info is available.
+    # Returns resource size information for given request.
     def sizes
       wrap_impl(@impl.sizes)
     end
@@ -146,8 +150,8 @@ module Playwright
     end
 
     # @nodoc
-    def parse_headers_as_array(serialized_headers, downcase)
-      wrap_impl(@impl.parse_headers_as_array(unwrap_impl(serialized_headers), unwrap_impl(downcase)))
+    def header_values(name)
+      wrap_impl(@impl.header_values(unwrap_impl(name)))
     end
 
     # -- inherited from EventEmitter --

data/lib/playwright_api/response.rb

@@ -12,7 +12,7 @@ module Playwright
       wrap_impl(@impl.body)
     end
 
-    # Waits for this response to finish, returns failure error if request failed.
+    # Waits for this response to finish, returns always `null`.
     def finished
       wrap_impl(@impl.finished)
     end
@@ -28,11 +28,23 @@ module Playwright
     end
 
     # An array with all the request HTTP headers associated with this response. Unlike [`method: Response.allHeaders`], header
-    # names are not lower-cased. Headers with multiple entries, such as `Set-Cookie`, appear in the array multiple times.
+    # names are NOT lower-cased. Headers with multiple entries, such as `Set-Cookie`, appear in the array multiple times.
     def headers_array
       wrap_impl(@impl.headers_array)
     end
 
+    # Returns the value of the header matching the name. The name is case insensitive. If multiple headers have the same name
+    # (except `set-cookie`), they are returned as a list separated by `, `. For `set-cookie`, the `\n` separator is used. If
+    # no headers are found, `null` is returned.
+    def header_value(name)
+      wrap_impl(@impl.header_value(unwrap_impl(name)))
+    end
+
+    # Returns all values of the headers matching the name, for example `set-cookie`. The name is case insensitive.
+    def header_values(name)
+      wrap_impl(@impl.header_values(unwrap_impl(name)))
+    end
+
     # Returns the JSON representation of response body.
     #
     # This method will throw if the response body is not parsable via `JSON.parse`.
@@ -85,11 +97,6 @@ module Playwright
       wrap_impl(@impl.ok?)
     end
 
-    # @nodoc
-    def parse_headers_as_array(serialized_headers, downcase)
-      wrap_impl(@impl.parse_headers_as_array(unwrap_impl(serialized_headers), unwrap_impl(downcase)))
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def off(event, callback)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: playwright-ruby-client
 version: !ruby/object:Gem::Version
-  version: 1.15.beta2
+  version: 1.15.beta3
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-09 00:00:00.000000000 Z
+date: 2021-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -315,6 +315,7 @@ files:
 - lib/playwright/locator_impl.rb
 - lib/playwright/mouse_impl.rb
 - lib/playwright/playwright_api.rb
+- lib/playwright/raw_headers.rb
 - lib/playwright/route_handler.rb
 - lib/playwright/select_option_values.rb
 - lib/playwright/timeout_settings.rb