bidi2pdf 0.1.3 → 0.1.4

data/lib/bidi2pdf/bidi/commands/add_intercept.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Bidi2pdf
+  module Bidi
+    module Commands
+      class AddIntercept
+        include Base
+
+        BEFORE_REQUEST = "beforeRequestSent"
+        RESPONSE_STARTED = "responseStarted"
+        AUTH_REQUIRED = "authRequired"
+
+        def initialize(context:, phases:, url_patterns:)
+          @context = context
+          @phases = phases
+          @url_patterns = url_patterns
+
+          validate_phases!
+        end
+
+        def method_name
+          "network.addIntercept"
+        end
+
+        def params
+          {
+            context: @context,
+            phases: @phases,
+            urlPatterns: @url_patterns
+          }.compact
+        end
+
+        def validate_phases!
+          valid_phases = [BEFORE_REQUEST, RESPONSE_STARTED, AUTH_REQUIRED]
+
+          raise ArgumentError, "Unsupported phase(s): #{@phases}" unless @phases.all? { |phase| valid_phases.include?(phase) }
+        end
+      end
+    end
+  end
+end

data/lib/bidi2pdf/bidi/commands/base.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Bidi2pdf
+  module Bidi
+    module Commands
+      module Base
+        def method_name = raise(NotImplementedError, "method_name must be implemented in subclass")
+
+        def params = {}
+
+        def as_payload(id)
+          {
+            id: id,
+            method: method_name,
+            params: params
+          }
+        end
+
+        # rubocop: disable Metrics/AbcSize
+        def ==(other)
+          return false unless other.respond_to?(:method_name) && other.respond_to?(:params)
+
+          return false unless method_name == other.method_name
+
+          return false unless params.keys.sort == other.params.keys.sort
+
+          params.all? { |key, value| other.params.key?(key) && value == other.params[key] }
+        end
+
+        # rubocop: enable Metrics/AbcSize
+
+        # Hash equality comparison
+        def eql?(other)
+          return false unless other.is_a?(Bidi2pdf::Bidi::Commands::Base)
+
+          self == other
+        end
+
+        def hash
+          [method_name, params].hash
+        end
+
+        def inspect
+          attributes = redact_sensitive_fields({ method_name: method_name, params: params })
+
+          "#<#{self.class}:#{object_id} #{attributes}>"
+        end
+
+        private
+
+        def redact_sensitive_fields(obj, sensitive_keys = %w[value token password authorization username])
+          case obj
+          when Hash
+            obj.transform_values.with_index do |v, idx|
+              k = obj.keys[idx]
+              sensitive_keys.include?(k.to_s.downcase) ? "[REDACTED]" : redact_sensitive_fields(v, sensitive_keys)
+            end
+          when Array
+            obj.map { |item| redact_sensitive_fields(item, sensitive_keys) }
+          else
+            obj
+          end
+        end
+
+        def raise_timeout_error(id, method, params)
+          @logger.error "Timeout waiting for response to command #{id}, cmd: #{method}, params: #{redact_sensitive_fields(params).inspect}"
+
+          raise CmdTimeoutError, "Timeout waiting for response to command ID #{id}"
+        end
+      end
+    end
+  end
+end

data/lib/bidi2pdf/bidi/commands/browser_close.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Bidi2pdf
+  module Bidi
+    module Commands
+      class BrowserClose
+        include Base
+
+        def method_name
+          "browser.close"
+        end
+      end
+    end
+  end
+end

data/lib/bidi2pdf/bidi/commands/browser_create_user_context.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Bidi2pdf
+  module Bidi
+    module Commands
+      class BrowserCreateUserContext
+        include Base
+
+        def method_name
+          "browser.createUserContext"
+        end
+      end
+    end
+  end
+end

data/lib/bidi2pdf/bidi/commands/browsing_context_close.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Bidi2pdf
+  module Bidi
+    module Commands
+      class BrowsingContextClose
+        include Base
+
+        def initialize(context:)
+          @context = context
+        end
+
+        def params
+          {
+            context: @context
+          }
+        end
+
+        def method_name
+          "browsingContext.close"
+        end
+      end
+    end
+  end
+end

data/lib/bidi2pdf/bidi/commands/browsing_context_navigate.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Bidi2pdf
+  module Bidi
+    module Commands
+      class BrowsingContextNavigate
+        include Base
+
+        def initialize(url:,
+                       context:,
+                       wait: "complete")
+          @url = url
+          @context = context
+          @wait = wait
+        end
+
+        def params
+          {
+            url: @url,
+            context: @context,
+            wait: @wait
+          }
+        end
+
+        def method_name
+          "browsingContext.navigate"
+        end
+      end
+    end
+  end
+end

data/lib/bidi2pdf/bidi/commands/browsing_context_print.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "print_parameters_validator"
+
+module Bidi2pdf
+  module Bidi
+    module Commands
+      class BrowsingContextPrint
+        include Base
+
+        def initialize(context:, print_options:)
+          @context = context
+          @print_options = print_options || { background: true }
+
+          PrintParametersValidator.validate!(@print_options)
+        end
+
+        def params
+          @print_options.merge(context: @context)
+        end
+
+        def method_name
+          "browsingContext.print"
+        end
+      end
+    end
+  end
+end

data/lib/bidi2pdf/bidi/commands/cancel_auth.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Bidi2pdf
+  module Bidi
+    module Commands
+      class CancelAuth
+        include Base
+
+        def initialize(request:)
+          @request = request
+        end
+
+        def params
+          {
+            request: @request,
+            action: "cancel"
+          }
+        end
+
+        def method_name
+          "network.continueWithAuth"
+        end
+      end
+    end
+  end
+end

data/lib/bidi2pdf/bidi/commands/create_tab.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Bidi2pdf
+  module Bidi
+    module Commands
+      class CreateTab < CreateWindow
+        def type = "tab"
+      end
+    end
+  end
+end

data/lib/bidi2pdf/bidi/commands/create_window.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Bidi2pdf
+  module Bidi
+    module Commands
+      class CreateWindow
+        include Base
+
+        def initialize(user_context_id: nil, reference_context: nil, background: false)
+          @user_context_id = user_context_id
+          @reference_context = reference_context
+          @background = background
+        end
+
+        def method_name
+          "browsingContext.create"
+        end
+
+        def params
+          {
+            type: type,
+            userContext: @user_context_id,
+            referenceContext: @reference_context,
+            background: @background
+          }.compact
+        end
+
+        def type = "window"
+      end
+    end
+  end
+end

data/lib/bidi2pdf/bidi/commands/get_user_contexts.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Bidi2pdf
+  module Bidi
+    module Commands
+      class GetUserContexts
+        include Base
+
+        def method_name
+          "browser.getUserContexts"
+        end
+      end
+    end
+  end
+end

data/lib/bidi2pdf/bidi/commands/network_continue.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Bidi2pdf
+  module Bidi
+    module Commands
+      class NetworkContinue
+        include Base
+
+        attr_reader :request, :headers
+
+        def initialize(request:, headers:)
+          @headers = headers
+          @request = request
+        end
+
+        def method_name
+          "network.continueRequest"
+        end
+
+        def params
+          {
+            request: request,
+            headers: headers
+          }.compact
+        end
+      end
+    end
+  end
+end

data/lib/bidi2pdf/bidi/commands/print_parameters_validator.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module Bidi2pdf
+  module Bidi
+    module Commands
+      # Validates parameters for the BiDi method `browsingContext.print`.
+      #
+      # Allowed structure of the params hash:
+      #
+      # {
+      #   background: Boolean (optional, default: false) – print background graphics,
+      #   margin: {
+      #     top: Float >= 0.0 (optional, default: 1.0),
+      #     bottom: Float >= 0.0 (optional, default: 1.0),
+      #     left: Float >= 0.0 (optional, default: 1.0),
+      #     right: Float >= 0.0 (optional, default: 1.0)
+      #   },
+      #   orientation: "portrait" or "landscape" (optional, default: "portrait"),
+      #   page: {
+      #     width: Float >= 0.0352 (optional, default: 21.59),
+      #     height: Float >= 0.0352 (optional, default: 27.94)
+      #   },
+      #   pageRanges: Array of Integers or Strings (optional),
+      #   scale: Float between 0.1 and 2.0 (optional, default: 1.0),
+      #   shrinkToFit: Boolean (optional, default: true)
+      # }
+      #
+      # This validator checks presence, types, allowed ranges, and values,
+      # and raises ArgumentError with a descriptive message if validation fails.
+      class PrintParametersValidator
+        def self.validate!(params)
+          new(params).validate!
+        end
+
+        def initialize(params)
+          @params = params
+        end
+
+        def validate!
+          raise ArgumentError, "params must be a Hash" unless @params.is_a?(Hash)
+
+          validate_boolean(:background)
+          validate_boolean(:shrinkToFit)
+          validate_orientation
+          validate_scale
+          validate_page_ranges
+          validate_margin
+          validate_page_size
+
+          true
+        end
+
+        private
+
+        def validate_boolean(key)
+          return unless @params.key?(key)
+          return if [true, false].include?(@params[key])
+
+          raise ArgumentError, ":#{key} must be a boolean"
+        end
+
+        def validate_orientation
+          return unless @params.key?(:orientation)
+          return if %w[portrait landscape].include?(@params[:orientation])
+
+          raise ArgumentError, ":orientation must be 'portrait' or 'landscape'"
+        end
+
+        def validate_scale
+          return unless @params.key?(:scale)
+
+          scale = @params[:scale]
+          return if scale.is_a?(Numeric) && scale >= 0.1 && scale <= 2.0
+
+          raise ArgumentError, ":scale must be a number between 0.1 and 2.0"
+        end
+
+        def validate_page_ranges
+          return unless @params.key?(:pageRanges)
+          unless @params[:pageRanges].is_a?(Array) &&
+            @params[:pageRanges].all? { |v| v.is_a?(Integer) || v.is_a?(String) }
+            raise ArgumentError, ":pageRanges must be an array of integers or strings"
+          end
+        end
+
+        def validate_margin
+          return unless @params.key?(:margin)
+
+          margin = @params[:margin]
+          raise ArgumentError, ":margin must be a Hash" unless margin.is_a?(Hash)
+
+          %i[top bottom left right].each do |side|
+            next unless margin.key?(side)
+
+            val = margin[side]
+            raise ArgumentError, "margin[:#{side}] must be a float >= 0.0" unless val.is_a?(Numeric) && val >= 0.0
+          end
+        end
+
+        def validate_page_size
+          return unless @params.key?(:page)
+
+          page = @params[:page]
+          raise ArgumentError, ":page must be a Hash" unless page.is_a?(Hash)
+
+          %i[width height].each do |dim|
+            next unless page.key?(dim)
+
+            val = page[dim]
+            raise ArgumentError, "page[:#{dim}] must be a float >= 0.0352" unless val.is_a?(Numeric) && val >= 0.0352
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bidi2pdf/bidi/commands/provide_credentials.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Bidi2pdf
+  module Bidi
+    module Commands
+      class ProvideCredentials
+        include Base
+
+        def initialize(request:, username:, password:)
+          @request = request
+          @username = username
+          @password = password
+        end
+
+        def params
+          {
+            request: @request,
+            action: "provideCredentials",
+            credentials: {
+              type: "password",
+              username: @username,
+              password: @password
+            }
+          }
+        end
+
+        def method_name
+          "network.continueWithAuth"
+        end
+      end
+    end
+  end
+end

data/lib/bidi2pdf/bidi/commands/script_evaluate.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Bidi2pdf
+  module Bidi
+    module Commands
+      class ScriptEvaluate
+        include Base
+
+        def initialize(expression:,
+                       context:,
+                       await_promise: true)
+          @expression = expression
+          @context = context
+          @await_promise = await_promise
+        end
+
+        def params
+          {
+            expression: @expression,
+            target: {
+              context: @context
+            },
+            awaitPromise: @await_promise
+          }
+        end
+
+        def method_name
+          "script.evaluate"
+        end
+      end
+    end
+  end
+end

data/lib/bidi2pdf/bidi/commands/session_end.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Bidi2pdf
+  module Bidi
+    module Commands
+      class SessionEnd
+        include Base
+
+        def method_name
+          "session.end"
+        end
+      end
+    end
+  end
+end

data/lib/bidi2pdf/bidi/commands/session_status.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Bidi2pdf
+  module Bidi
+    module Commands
+      class SessionStatus
+        include Base
+
+        def method_name
+          "session.status"
+        end
+      end
+    end
+  end
+end

data/lib/bidi2pdf/bidi/commands/session_subscribe.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Bidi2pdf
+  module Bidi
+    module Commands
+      class SessionSubscribe
+        include Base
+
+        attr_reader :events
+
+        def initialize(events:)
+          @events = events
+        end
+
+        def method_name
+          "session.subscribe"
+        end
+
+        def params
+          { events: events }.compact
+        end
+      end
+    end
+  end
+end

data/lib/bidi2pdf/bidi/commands/set_tab_cookie.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Bidi2pdf
+  module Bidi
+    module Commands
+      class SetTabCookie
+        include Base
+
+        attr_reader :name, :value, :domain, :path, :secure, :http_only, :same_site, :ttl, :browsing_context_id
+
+        def initialize(name:,
+                       value:,
+                       domain:,
+                       browsing_context_id:,
+                       path: "/",
+                       secure: true,
+                       http_only: false,
+                       same_site: "strict",
+                       ttl: 30)
+          @name = name
+          @value = value
+          @domain = domain
+          @path = path
+          @secure = secure
+          @http_only = http_only
+          @same_site = same_site
+          @ttl = ttl
+          @browsing_context_id = browsing_context_id
+        end
+
+        def expiry
+          Time.now.to_i + ttl
+        end
+
+        def method_name
+          "storage.setCookie"
+        end
+
+        def params
+          {
+            cookie: {
+              name: name,
+              value: {
+                type: "string",
+                value: value
+              },
+              domain: domain,
+              path: path,
+              secure: secure,
+              httpOnly: http_only,
+              sameSite: same_site,
+              expiry: expiry
+            },
+            partition: {
+              type: "context",
+              context: browsing_context_id
+            }
+          }.compact
+        end
+      end
+    end
+  end
+end