bidi2pdf 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7d773a323c63404e1c8dee00d180e6f774f5b45c33e59bc759b8186d3398aeed
+  data.tar.gz: 9b3452ac73398cc6037ca3d39b792afafbd2dfd47e55e3fe0c69783627b7fc88
+SHA512:
+  metadata.gz: e656e92c5a4aa8a82ab3d0dde12fdf3cd4a8743ab8dd47a77d229452e5ab0127f40ed5ee84c02c190bb35aed5de7fe14696d30b22de0bc9966cdb9fd94eaf9b9
+  data.tar.gz: 57b04e9c98c91e12ccfb432d292f13186f9a92776a81847736719843dffeed1d07adab9d32dd858709aa9803b8ac476c38cbfc9a87bbed5fc6ce88efec599ecd

data/.idea/.gitignore

@@ -0,0 +1,8 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Editor-based HTTP Client requests
+/httpRequests/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,50 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+RSpec/SubjectStub:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+RSpec/MultipleMemoizedHelpers:
+  Max: 10
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Max: 10
+
+
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec
+
+RSpec/InstanceVariable:
+  Enabled: false
+
+plugins:
+  - rubocop-rake
+  - rubocop-rspec

data/.ruby-gemset

@@ -0,0 +1 @@
+bidi2pdf

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.3.4

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-03-26
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 fastjack
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,119 @@
+# Bidi2pdf
+
+Bidi2pdf is a Ruby gem that generates high-quality PDFs from web pages using Chrome's BiDi (BiDirectional) protocol. It
+offers precise control over PDF generation with support for modern web technologies.
+
+## Features
+
+- **Simple CLI** - Generate PDFs with a single command
+- **Rich Configuration** - Customize with cookies, headers, and authentication
+- **Waiting Conditions** - Wait for window loaded or network idle
+- **Headless Support** - Run without a visible browser
+- **Docker Ready** - Easy containerization
+- **Modern Architecture** - Uses Chrome's BiDi protocol for better control
+
+## Installation
+
+Add to your application's Gemfile:
+
+```ruby
+gem 'bidi2pdf'
+```
+
+Or install manually:
+
+```bash
+$ gem install bidi2pdf
+```
+
+### Dependencies
+
+- **Ruby**: 3.3 or higher
+- **Bidi2pdf** automatically manages ChromeDriver binaries through
+  the [chromedriver-binary](https://github.com/dieter-medium/chromedriver-binary) gem, which:
+  Downloads and installs the ChromeDriver version matching your installed Chrome/Chromium browser
+  Eliminates the need to manually install or update ChromeDriver
+  Ensures compatibility between Chrome and ChromeDriver versions
+
+## Usage
+
+### Basic Command Line Usage
+
+```bash
+bidi2pdf render --url https://example.com --output example.pdf
+```
+
+### Advanced Options
+
+```bash
+bidi2pdf render \
+  --url https://example.com \
+  --output example.pdf \
+  --cookie session=abc123 \
+  --header X-API-KEY=token \
+  --auth admin:password \
+  --wait_network_idle \
+  --wait_window_loaded \
+  --log-level debug
+```
+
+### Ruby API
+
+```ruby
+require 'bidi2pdf'
+
+launcher = Bidi2pdf::Launcher.new(
+  url: 'https://example.com',
+  output: 'example.pdf', # nil for base64 encoded string as result of launcher.launch
+  cookies: { 'session' => 'abc123' },
+  headers: { 'X-API-KEY' => 'token' },
+  auth: { username: 'admin', password: 'password' },
+  wait_window_loaded: true,
+  wait_network_idle: true
+)
+
+launcher.launch
+
+# see Bidi2pdf::SessionRunner for more options
+```
+
+## Docker Support
+
+Build and run with Docker:
+
+```bash
+# Build gem and Docker image
+rake build
+docker build -t bidi2pdf -f docker/Dockerfile .
+
+# Generate PDF using Docker
+docker run -it --rm -v ./output:/reports bidi2pdf \
+  bidi2pdf render --url=https://example.com --output /reports/example.pdf
+```
+
+## Configuration Options
+
+| Option                 | Description                                                                                                         |
+|------------------------|---------------------------------------------------------------------------------------------------------------------|
+| `--url`                | The URL to render (required)                                                                                        |
+| `--output`             | Output PDF filename (default: output.pdf)                                                                           |
+| `--cookie`             | Cookies in name=value format                                                                                        |
+| `--header`             | HTTP headers in name=value format                                                                                   |
+| `--auth`               | Basic auth credentials (user:pass)                                                                                  |
+| `--headless`           | Run Chrome in headless mode (default: true)                                                                         |
+| `--port`               | Port for ChromeDriver (0 = auto)                                                                                    |
+| `--wait_window_loaded` | Wait for the window to be fully loaded. You need to set a variable `window.loaded`. See ./spec/fixtures/sample.html |
+| `--wait_network_idle`  | Wait for network to be idle                                                                                         |
+| `--log_level`          | Log level (debug, info, warn, error, fatal)                                                                         |
+
+## Development
+
+After checking out the repo:
+
+1. Run `bin/setup` to install dependencies
+2. Run `rake spec` to run the tests
+3. Run `bin/console` for an interactive prompt
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]
+
+require "chromedriver/binary"
+load "chromedriver/Rakefile"
+
+desc "Run tests with coverage"
+task :coverage do
+  ENV["COVERAGE"] = "true"
+  Rake::Task["spec"].execute
+  puts "Coverage report generated in coverage/ directory"
+end

data/docker/Dockerfile

@@ -0,0 +1,35 @@
+FROM ruby:3.3
+
+# Install dependencies
+RUN apt-get update && \
+    apt-get install -y \
+    chromium \
+    libglib2.0-0 \
+    libnss3 \
+    libxss1 \
+    libasound2 \
+    libatk-bridge2.0-0 \
+    libgtk-3-0 \
+    libdrm2 \
+    curl \
+    unzip \
+    xvfb \
+    && rm -rf /var/lib/apt/lists/*
+
+# Create a non-root user
+RUN groupadd -r appuser && useradd -r -g appuser -m -d /home/appuser appuser
+
+
+# Set working directory
+WORKDIR /app
+
+# Copy your gem into container
+COPY ./pkg/bidi2pdf-*.gem ./
+
+RUN gem install ./bidi2pdf-*.gem && \
+    chown -R appuser:appuser /app
+
+# Switch to non-root user
+USER appuser
+
+CMD ["/usr/bin/bash"]

data/docker/docker-compose.yml

@@ -0,0 +1 @@
+name: bidi2pdf

data/exe/bidi2pdf

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bidi2pdf"
+require "bidi2pdf/cli"
+
+Bidi2pdf::CLI.start(ARGV)

data/lib/bidi2pdf/bidi/add_headers_interceptor.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Bidi2pdf
+  module Bidi
+    class AddHeadersInterceptor
+      attr_reader :id, :headers
+
+      def initialize(id, headers, client)
+        @id = id
+        @client = client
+        @headers = headers.map do |header|
+          {
+            name: header[:name],
+            value: {
+              type: "string",
+              value: header[:value]
+            }
+          }
+        end
+      end
+
+      def handle_event(response)
+        event_response = response["params"]
+
+        return unless event_response["intercepts"]&.include?(id) && event_response["isBlocked"]
+
+        network_id = event_response["request"]["request"]
+
+        Bidi2pdf.logger.debug "Interceptor #{id} handle event: #{network_id}"
+
+        client.send_cmd "network.continueRequest", {
+          request: network_id,
+          headers: headers
+        }
+      end
+
+      private
+
+      attr_reader :client
+    end
+  end
+end

data/lib/bidi2pdf/bidi/auth_interceptor.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Bidi2pdf
+  module Bidi
+    class AuthInterceptor
+      attr_reader :id, :username, :password, :network_ids
+
+      def initialize(id, username, password, client)
+        @id = id
+        @client = client
+        @username = username
+        @password = password
+        @network_ids = []
+      end
+
+      # rubocop:disable Metrics/AbcSize
+      def handle_event(response)
+        event_response = response["params"]
+
+        return unless event_response["intercepts"]&.include?(id) && event_response["isBlocked"]
+
+        navigation_id = event_response["navigation"]
+        network_id = event_response["request"]["request"]
+        url = event_response["request"]["url"]
+
+        handle_bad_credentials(navigation_id, network_id, url)
+
+        network_ids << network_id
+
+        Bidi2pdf.logger.debug "Auth-Interceptor #{id} handle event: #{navigation_id}/#{network_id}/#{url}"
+
+        client.send_cmd("network.continueWithAuth", {
+          request: network_id,
+          action: "provideCredentials",
+          credentials: {
+            type: "password",
+            username: username,
+            password: password
+          }
+        })
+      end
+
+      # rubocop:enable Metrics/AbcSize
+
+      private
+
+      def handle_bad_credentials(navigation_id, network_id, url)
+        return unless network_ids.include?(network_id)
+
+        network_ids.delete(network_id)
+
+        Bidi2pdf.logger.debug "Auth-Interceptor #{id} already handled event: #{navigation_id}/#{network_id}/#{url}"
+
+        # rubocop: disable Layout/LineLength
+        Bidi2pdf.logger.error "It seems that the same request is being intercepted multiple times. Check your credentials or the URL you are trying to access. If you are using a proxy, make sure it is configured correctly."
+        # rubocop: enable Layout/LineLength
+
+        client.send_cmd("network.continueWithAuth", {
+          request: network_id,
+          action: "cancel"
+        })
+      end
+
+      attr_reader :client
+    end
+  end
+end

data/lib/bidi2pdf/bidi/browser.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "user_context"
+
+module Bidi2pdf
+  module Bidi
+    class Browser
+      def initialize(client)
+        @client = client
+      end
+
+      def create_user_context = UserContext.new(@client)
+    end
+  end
+end

data/lib/bidi2pdf/bidi/browser_tab.rb

@@ -0,0 +1,180 @@
+# frozen_string_literal: true
+
+require "base64"
+
+require_relative "network_events"
+require_relative "print_parameters_validator"
+
+module Bidi2pdf
+  module Bidi
+    class BrowserTab
+      attr_reader :client, :browsing_context_id, :user_context_id, :tabs, :network_events, :open
+
+      def initialize(client, browsing_context_id, user_context_id)
+        @client = client
+        @browsing_context_id = browsing_context_id
+        @user_context_id = user_context_id
+        @tabs = []
+        @network_events = NetworkEvents.new browsing_context_id
+        @open = true
+      end
+
+      def create_browser_tab
+        client.send_cmd_and_wait("browsingContext.create", {
+          type: "tab",
+          userContext: @user_context_id
+        }) do |response|
+          tab_browsing_context_id = response["result"]["context"]
+
+          BrowserTab.new(client, tab_browsing_context_id, user_context_id).tap do |tab|
+            tabs << tab
+            Bidi2pdf.logger.debug "Created new browser tab: #{tab.inspect}"
+          end
+        end
+      end
+
+      def set_cookie(
+        name:,
+        value:,
+        domain:,
+        path: "/",
+        secure: true,
+        http_only: false,
+        same_site: "strict",
+        ttl: 30
+      )
+        expiry = Time.now.to_i + ttl
+        client.send_cmd_and_wait("storage.setCookie", {
+          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
+          }
+        }) do |response|
+          Bidi2pdf.logger.debug "Cookie set: #{response.inspect}"
+        end
+      end
+
+      def add_headers(
+        headers:,
+        url_patterns:
+      )
+        client.add_headers_interceptor(
+          context: browsing_context_id,
+          url_patterns: url_patterns,
+          headers: headers
+        )
+      end
+
+      def basic_auth(username:, password:, url_patterns:)
+        client.add_auth_interceptor(
+          context: browsing_context_id,
+          url_patterns: url_patterns,
+          username: username,
+          password: password
+        )
+      end
+
+      def open_page(url)
+        client.on_event("network.responseStarted", "network.responseCompleted", "network.fetchError",
+                        &network_events.method(:handle_event))
+
+        client.send_cmd_and_wait("browsingContext.navigate", {
+          url: url,
+          context: browsing_context_id,
+          wait: "complete"
+        }) do |response|
+          Bidi2pdf.logger.debug "Navigated to page url: #{url} response: #{response}"
+        end
+      end
+
+      def execute_script(script)
+        client.send_cmd_and_wait("script.evaluate", {
+          expression: script,
+          target: {
+            context: browsing_context_id
+          },
+          awaitPromise: true
+        }) do |response|
+          Bidi2pdf.logger.debug "Script Result: #{response.inspect}"
+
+          response["result"]
+        end
+      end
+
+      def wait_until_all_finished(timeout: 10, poll_interval: 0.1)
+        network_events.wait_until_all_finished(timeout: timeout, poll_interval: poll_interval)
+      end
+
+      def close
+        return unless open
+
+        close_tabs
+        remove_event_listeners
+        close_context
+
+        @open = false
+      end
+
+      # rubocop:disable Metrics/AbcSize
+      def print(outputfile, print_options: { background: true })
+        PrintParametersValidator.validate!(print_options)
+
+        cmd_params = (print_options || {}).merge(context: browsing_context_id)
+
+        client.send_cmd_and_wait("browsingContext.print", cmd_params) do |response|
+          if response["result"]
+            pdf_base64 = response["result"]["data"]
+
+            if outputfile
+              File.binwrite(outputfile, Base64.decode64(pdf_base64))
+              Bidi2pdf.logger.info "PDF saved as '#{outputfile}'."
+            else
+              Bidi2pdf.logger.info "PDF generated successfully."
+            end
+
+            return pdf_base64 unless outputfile
+          else
+            Bidi2pdf.logger.error "Error printing: #{response}"
+          end
+        end
+      end
+
+      # rubocop:enable Metrics/AbcSize
+
+      private
+
+      def close_context
+        client.send_cmd_and_wait("browsingContext.close", { context: browsing_context_id }) do |response|
+          Bidi2pdf.logger.debug "Browsing context closed: #{response}"
+        end
+      end
+
+      def remove_event_listeners
+        Bidi2pdf.logger.debug "Network events: #{network_events.all_events.map(&:to_s)}"
+
+        client.remove_event_listener "network.responseStarted", "network.responseCompleted", "network.fetchError",
+                                     &network_events.method(:handle_event)
+      end
+
+      def close_tabs
+        tabs.each do |tab|
+          tab.close
+          Bidi2pdf.logger.debug "Closed tab: #{tab.browsing_context_id}"
+        end
+      end
+    end
+  end
+end