ferrum 0.11 → 0.13

data/lib/ferrum/network/intercepted_request.rb

@@ -9,7 +9,8 @@ module Ferrum
 
       def initialize(page, params)
         @status = nil
-        @page, @params = page, params
+        @page = page
+        @params = params
         @request_id = params["requestId"]
         @frame_id = params["frameId"]
         @resource_type = params["resourceType"]
@@ -30,15 +31,12 @@ module Ferrum
       end
 
       def respond(**options)
-        has_body = options.has_key?(:body)
+        has_body = options.key?(:body)
         headers = has_body ? { "content-length" => options.fetch(:body, "").length } : {}
         headers = headers.merge(options.fetch(:responseHeaders, {}))
 
-        options = {responseCode: 200}.merge(options)
-        options = options.merge({
-          requestId: request_id,
-          responseHeaders: header_array(headers),
-        })
+        options = { responseCode: 200 }.merge(options)
+        options = options.merge(requestId: request_id, responseHeaders: header_array(headers))
         options = options.merge(body: Base64.strict_encode64(options.fetch(:body, ""))) if has_body
 
         @status = :responded
@@ -77,7 +75,11 @@ module Ferrum
       end
 
       def inspect
-        %(#<#{self.class} @request_id=#{@request_id.inspect} @frame_id=#{@frame_id.inspect} @resource_type=#{@resource_type.inspect} @request=#{@request.inspect}>)
+        "#<#{self.class} " \
+          "@request_id=#{@request_id.inspect} " \
+          "@frame_id=#{@frame_id.inspect} " \
+          "@resource_type=#{@resource_type.inspect} " \
+          "@request=#{@request.inspect}>"
       end
 
       private

data/lib/ferrum/network/request.rb

@@ -4,47 +4,116 @@ require "time"
 
 module Ferrum
   class Network
+    #
+    # Represents a [Network.Request](https://chromedevtools.github.io/devtools-protocol/1-3/Network/#type-Request)
+    # object.
+    #
     class Request
+      #
+      # Initializes the request object.
+      #
+      # @param [Hash{String => Object}] params
+      #   The parsed JSON attributes.
+      #
       def initialize(params)
         @params = params
         @request = @params["request"]
       end
 
+      #
+      # The request ID.
+      #
+      # @return [String]
+      #
       def id
         @params["requestId"]
       end
 
+      #
+      # The request resouce type.
+      #
+      # @return [String]
+      #
       def type
         @params["type"]
       end
 
+      #
+      # Determines if the request is of the given type.
+      #
+      # @param [String, Symbol] value
+      #   The type value to compare against.
+      #
+      # @return [Boolean]
+      #
       def type?(value)
         type.downcase == value.to_s.downcase
       end
 
+      #
+      # The frame ID of the request.
+      #
+      # @return [String]
+      #
       def frame_id
         @params["frameId"]
       end
 
+      #
+      # The URL for the request.
+      #
+      # @return [String]
+      #
       def url
         @request["url"]
       end
 
+      #
+      # The URL fragment for the request.
+      #
+      # @return [String, nil]
+      #
       def url_fragment
         @request["urlFragment"]
       end
 
+      #
+      # The request method.
+      #
+      # @return [String]
+      #
       def method
         @request["method"]
       end
 
+      #
+      # The request headers.
+      #
+      # @return [Hash{String => String}]
+      #
       def headers
         @request["headers"]
       end
 
+      #
+      # The request timestamp.
+      #
+      # @return [Time]
+      #
       def time
         @time ||= Time.strptime(@params["wallTime"].to_s, "%s")
       end
+
+      #
+      # The optional HTTP `POST` form data.
+      #
+      # @return [String, nil]
+      #   The HTTP `POST` form data.
+      #
+      def post_data
+        @request["postData"]
+      end
+      alias body post_data
     end
   end
 end

data/lib/ferrum/network/response.rb

@@ -2,43 +2,105 @@
 
 module Ferrum
   class Network
+    #
+    # Represents a [Network.Response](https://chromedevtools.github.io/devtools-protocol/1-3/Network/#type-Response)
+    # object.
+    #
     class Response
+      # The response body size.
+      #
+      # @return [Integer, nil]
       attr_reader :body_size
 
+      # The parsed JSON attributes for the [Network.Response](https://chromedevtools.github.io/devtools-protocol/1-3/Network/#type-Response)
+      # object.
+      #
+      # @return [Hash{String => Object}]
+      attr_reader :params
+
+      #
+      # Initializes the respones object.
+      #
+      # @param [Page] page
+      #   The page associated with the network response.
+      #
+      # @param [Hash{String => Object}] params
+      #   The parsed JSON attributes for the [Network.Response](https://chromedevtools.github.io/devtools-protocol/1-3/Network/#type-Response)
+      #
       def initialize(page, params)
         @page = page
         @params = params
         @response = params["response"] || params["redirectResponse"]
       end
 
+      #
+      # The request ID associated with the response.
+      #
+      # @return [String]
+      #
       def id
         @params["requestId"]
       end
 
+      #
+      # The URL of the response.
+      #
+      # @return [String]
+      #
       def url
         @response["url"]
       end
 
+      #
+      # The HTTP status of the response.
+      #
+      # @return [Integer]
+      #
       def status
         @response["status"]
       end
 
+      #
+      # The HTTP status text.
+      #
+      # @return [String]
+      #
       def status_text
         @response["statusText"]
       end
 
+      #
+      # The headers of the response.
+      #
+      # @return [Hash{String => String}]
+      #
       def headers
         @response["headers"]
       end
 
+      #
+      # The total size in bytes of the response.
+      #
+      # @return [Integer]
+      #
       def headers_size
         @response["encodedDataLength"]
       end
-      
+
+      #
+      # The resource type of the response.
+      #
+      # @return [String]
+      #
       def type
         @params["type"]
       end
 
+      #
+      # The `Content-Type` header value of the response.
+      #
+      # @return [String, nil]
+      #
       def content_type
         @content_type ||= headers.find { |k, _| k.downcase == "content-type" }&.last&.sub(/;.*\z/, "")
       end
@@ -52,23 +114,43 @@ module Ferrum
         @body_size = size - headers_size
       end
 
+      #
+      # The response body.
+      #
+      # @return [String]
+      #
       def body
         @body ||= begin
           body, encoded = @page
-                            .command("Network.getResponseBody", requestId: id)
-                            .values_at("body", "base64Encoded")
+                          .command("Network.getResponseBody", requestId: id)
+                          .values_at("body", "base64Encoded")
           encoded ? Base64.decode64(body) : body
         end
       end
 
+      #
+      # @return [Boolean]
+      #
       def main?
         @page.network.response == self
       end
 
+      #
+      # Comapres the respones ID to another response's ID.
+      #
+      # @return [Boolean]
+      #   Indicates whether the response has the same ID as the other response
+      #   object.
+      #
       def ==(other)
         id == other.id
       end
 
+      #
+      # Inspects the response object.
+      #
+      # @return [String]
+      #
       def inspect
         %(#<#{self.class} @params=#{@params.inspect} @response=#{@response.inspect}>)
       end