bidi2pdf-rails 0.0.1.pre.alpha → 0.1.1

data/lib/generators/bidi2pdf_rails/templates/bidi2pdf_rails.rb.tt

@@ -2,88 +2,34 @@
 
 Bidi2pdfRails.configure do |config|
   overrides = Rails.application.config.x.bidi2pdf_rails
-
-  config.notification_service = ActiveSupport::Notifications
-
-  config.logger = Rails.logger
-  config.verbosity = overrides.verbosity.nil? ? :none : overrides.verbosity
-  config.default_timeout = 10
-
-  # Logging options
-  config.log_network_events = <%= @log_network_events ? "true" : "false" %>
-  config.log_browser_console = <%= @log_browser_console ? "true" : "false" %>
-
-  # Chrome & BiDi
-  # config.remote_browser_url = nil
-  config.headless = overrides.headless.nil? ? <%= @headless ? "true" : "false" %> : overrides.headless
-  # config.chromedriver_port = 0
-  # config.chrome_session_args = [
-  #   "--disable-gpu",
-  #   "--no-sandbox"
-  # ]
-
-<% if @proxy %>
-  config.proxy_addr = "<%= @proxy_addr %>"
-  config.proxy_port = <%= @proxy_port %>
-  config.proxy_user = nil
-  config.proxy_pass = nil
-<% else %>
-  # config.proxy_addr = nil
-  # config.proxy_port = nil
-  # config.proxy_user = nil
-  # config.proxy_pass = nil
-<% end %>
-
-<% if @configure_viewport %>
-  # Viewport settings
-  config.viewport_width = <%= @viewport_width || 1920 %>
-  config.viewport_height = <%= @viewport_height || 1080 %>
-<% else %>
-  # Viewport settings
-  # config.viewport_width = 1920
-  # config.viewport_height = 1080
-<% end %>
-
-<% if @configure_pdf %>
-  # PDF settings
-  config.pdf_orientation = "<%= @pdf_orientation || "portrait" %>"
-  <% if @pdf_margins %>
-  config.pdf_margin_top = <%= @pdf_margin_top || 10 %>
-  config.pdf_margin_bottom = <%= @pdf_margin_bottom || 10 %>
-  config.pdf_margin_left = <%= @pdf_margin_left || 10 %>
-  config.pdf_margin_right = <%= @pdf_margin_right || 10 %>
-  <% else %>
-  # config.pdf_margin_top = 10
-  # config.pdf_margin_bottom = 10
-  # config.pdf_margin_left = 10
-  # config.pdf_margin_right = 10
-  <% end %>
-  config.pdf_print_background = <%= @pdf_print_background ? "true" : "false" %>
-  config.pdf_scale = <%= @pdf_scale || 1.0 %>
-<% else %>
-  # PDF settings
-  # config.pdf_orientation = "portrait"
-  # config.pdf_margin_top = 10
-  # config.pdf_margin_bottom = 10
-  # config.pdf_margin_left = 10
-  # config.pdf_margin_right = 10
-  # config.pdf_print_background = true
-  # config.pdf_scale = 1.0
+<%
+    Bidi2pdfRails::Config::CONFIG_OPTIONS.each_pair do |top_level_option_name, top_level_option|
+      name = top_level_option[:name]
+%>
+
+  #
+  # <%= name %>
+  #
+  <% top_level_option[:options].each do |option| %>
+  <% if option[:limited_to] %>
+  <%= "# Allowed values: #{option[:limited_to].map { |v| v.inspect }.join(", ")}" %>
+  <% end -%>
+<% if changed_by_user?(top_level_option_name, option[:name]) -%>
+<%= "config.#{top_level_option_name}.#{option[:name]} = #{get_option_value(top_level_option_name, option[:name]) } # #{option[:desc]}" -%>
+<% else -%>
+<%= "# config.#{top_level_option_name}.#{option[:name]} = #{option[:default_as_str] ? option[:default_as_str] : option[:default].inspect} # #{option[:desc]}" -%>
+<% end -%>
+  <% end -%>
 <% end %>
+end
 
-  # config.cookies = [
-  #   { name: "session", value: "abc123", domain: "example.com" }
-  # ]
+Rails.application.config.after_initialize do
+  Bidi2pdfRails::MainLogSubscriber.attach_to "bidi2pdf", inherit_all: true # needed for imported methods
+  Bidi2pdfRails::MainLogSubscriber.attach_to "bidi2pdf_rails", inherit_all: true # needed for imported methods
 
-  # config.headers = {
-  #   "X-API-KEY" => "topsecret"
-  # }
+  Bidi2pdfRails::BrowserConsoleLogSubscriber.attach_to "bidi2pdf"
 
-  # config.auth = {
-  #   username: "admin",
-  #   password: "secret"
-  # }
+  Bidi2pdfRails::MainLogSubscriber.silence /network_event_.*\.bidi2pdf/
 
-  # chromedriver install dir
-  # config.install_dir = Rails.root.join("tmp", "bidi2pdf").to_s
+  Bidi2pdfRails::NetworkLogSubscriber.attach_to "bidi2pdf"
 end

data/spec/acceptance/user_can_download_report_pdf_spec.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+require "net/http"
+require "rack/handler/puma"
+require "socket"
+
+RSpec.feature "As a devoloper, I want to generate PDF's with bidi2pdf-rails", :pdf, type: :request do
+  # This feature demonstrates how to use bidi2pdf-rails to generate PDFs
+  # from Rails views, remote URLs, and inline HTML. These specs double as
+  # living documentation for gem users.
+
+  before(:all) do
+    # Prepare the PDF rendering engine (chromium, etc.)
+    Bidi2pdfRails::ChromedriverManagerSingleton.initialize_manager force: true
+  end
+
+  after(:all) do
+    Bidi2pdfRails::ChromedriverManagerSingleton.shutdown
+  end
+
+  scenario "Rendering a controller view to PDF using layout: 'pdf'" do
+    # Controller example:
+    #
+    # def show
+    #   respond_to do |format|
+    #     format.html
+    #     format.pdf { render pdf: 'my-report', layout: 'pdf' }
+    #   end
+    # end
+
+    when_ "I visit the PDF version of a report" do
+      before do
+        @response = get_pdf_response "/reports/1.pdf"
+      end
+
+      then_ "I receive a successful HTTP response" do
+        expect(@response.code).to eq("200")
+      end
+
+      and_ "I receive a PDF file in response" do
+        expect(@response['Content-Type']).to eq("application/pdf")
+      end
+
+      and_ "the PDF contains the expected number of pages" do
+        expect(@response.body).to have_pdf_page_count(5)
+      end
+
+      and_ "the disposition header is set to attachment" do
+        expect(@response['Content-Disposition']).to start_with('inline; filename="my-report.pdf"')
+      end
+
+      and_ "the PDF contains the expected content" do
+        expect(@response.body).to contains_pdf_text("Section Two").at_page(2)
+      end
+    end
+  end
+
+  scenario "Converting a remote URL into a PDF with custom options" do
+    # Controller usage:
+    #
+    # def convert_remote_url
+    #   render pdf: 'convert-remote-url', url: "http://example.com", wait_for_page_loaded: false, print_options: { page: { format: :A4 } }
+    # end
+
+    when_ "I visit the PDF version of a report" do
+      before do
+        @response = get_pdf_response "/convert-remote-url.pdf"
+      end
+
+      then_ "I receive a successful HTTP response" do
+        expect(@response.code).to eq("200")
+      end
+
+      and_ "I receive a PDF file in response" do
+        expect(@response['Content-Type']).to eq("application/pdf")
+      end
+
+      and_ "the PDF contains the expected number of pages" do
+        expect(@response.body).to have_pdf_page_count(1)
+      end
+
+      and_ "the disposition header is set to attachment" do
+        expect(@response['Content-Disposition']).to start_with('inline; filename="convert-remote-url.pdf"')
+      end
+    end
+  end
+
+  scenario "Rendering inline HTML directly to PDF" do
+    # Controller usage:
+    #
+    # def inline_html
+    #   html = <<~HTML
+    #   <html>
+    #   <head>
+    #   </head>
+    #   <body>
+    #    <h1>PDF Rendering Sample</h1>
+    #     <p style="page-break-after: always;">Page break</p>
+    #     <p>Content Page 2</p>
+    #   </body>
+    #  </html>
+    #
+    #   render pdf: 'inline-html', inline: html, wait_for_page_loaded: false, print_options: { page: { format: :A4 } }
+    # end
+
+    when_ "I visit the PDF version of a report" do
+      before do
+        @response = get_pdf_response "/inline-html.pdf"
+      end
+
+      then_ "I receive a successful HTTP response" do
+        expect(@response.code).to eq("200")
+      end
+
+      and_ "I receive a PDF file in response" do
+        expect(@response['Content-Type']).to eq("application/pdf")
+      end
+
+      and_ "the PDF contains the expected number of pages" do
+        expect(@response.body).to have_pdf_page_count(2)
+      end
+
+      and_ "the disposition header is set to attachment" do
+        expect(@response['Content-Disposition']).to start_with('inline; filename="inline-html.pdf"')
+      end
+
+      and_ "the PDF contains the expected content" do
+        expect(@response.body).to contains_pdf_text("PDF Rendering Sample")
+      end
+    end
+  end
+end

data/spec/acceptance/user_can_generate_pdf_from_protected_remote_url_spec.rb

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+require "net/http"
+require "rack/handler/puma"
+require "socket"
+require "base64"
+
+RSpec.feature "As a user, I want to generate a PDF from a protected remote URL", :pdf, type: :request do
+  before(:all) do
+    # Bidi2pdfRails.config.general_options.headless = false
+    Bidi2pdfRails::ChromedriverManagerSingleton.initialize_manager force: true
+  end
+
+  after(:all) do
+    Bidi2pdfRails::ChromedriverManagerSingleton.shutdown
+  end
+
+  scenario "Using basic auth for remote PDF rendering" do
+    # Controller setup:
+    #
+    # You can configure basic auth in two ways:
+    #
+    # 1. In an initializer (global config):
+    #
+    #   Bidi2pdfRails.configure do |config|
+    #     config.render_remote_settings.basic_auth_user = ->(_controller) { "admin" }
+    #     config.render_remote_settings.basic_auth_pass = ->(_controller) { "secret" }
+    #   end
+    #
+    # 2. Inline within controller action:
+    #
+    #   render pdf: 'convert-remote-url-basic-auth',
+    #          url: basic_auth_endpoint_url(only_path: false),
+    #          auth: { username: "admin", password: "secret" }
+
+    when_ "I request a PDF generated from a basic-auth protected page" do
+      before do
+        with_render_setting :basic_auth_user, ->(_controller) { "admin" }
+        # in prod better to use:
+        # Bidi2pdfRails.config.render_remote_settings.basic_auth_pass = ->(_controller) { Rails.application.credentials.dig('bidi2pdf_rails', 'basic_auth_pass') }
+        with_render_setting :basic_auth_pass, ->(_controller) { "secret" }
+
+        @response = get_pdf_response "/convert-remote-url-basic-auth"
+      end
+
+      then_ "I receive a successful HTTP response" do
+        expect(@response.code).to eq("200")
+      end
+
+      and_ "I receive a PDF file in response" do
+        expect(@response['Content-Type']).to eq("application/pdf")
+      end
+
+      and_ "the PDF contains the expected number of pages" do
+        expect(@response.body).to have_pdf_page_count(1)
+      end
+
+      and_ "the disposition header is set to attachment" do
+        expect(@response['Content-Disposition']).to start_with('inline; filename="convert-remote-url-basic-auth.pdf"')
+      end
+
+      and_ "the PDF contains the expected content" do
+        expect(@response.body).to contains_pdf_text("This page is secured with: HTTPBasicAuthentication").at_page(1)
+      end
+    end
+  end
+
+  scenario "Using a session cookie for remote PDF rendering" do
+    # Controller setup:
+    #
+    # You can configure cookies in two ways:
+    #
+    # 1. In an initializer (global config):
+    #
+    #   Bidi2pdfRails.configure do |config|
+    #     config.render_remote_settings.cookies = = ->(controller) { { "auth_token" => signed_cookie_value("valid-authentication-token", controller) } }
+    #   end
+    #
+    # 2. Inline within controller action:
+    #
+    #     render pdf: 'convert-remote-url-cookie',
+    #            url: cookie_endpoint_url(only_path: false),
+    #            wait_for_page_loaded: false,
+    #            cookies: { "auth_token" => signed_cookie_value("valid-authentication-token", controller) }
+    #
+
+    when_ "I request a PDF from a page that requires a session cookie" do
+      def signed_cookie_value(value, controller)
+        request = controller.request
+        secret = request.key_generator.generate_key(request.signed_cookie_salt)
+        # Sign the value
+        verifier = ActiveSupport::MessageVerifier.new(secret)
+        verifier.generate(value)
+      end
+
+      before do
+        with_render_setting :cookies, ->(controller) { { "auth_token" => signed_cookie_value("valid-authentication-token", controller) } }
+
+        @response = get_pdf_response "/convert-remote-url-cookie"
+      end
+
+      then_ "I receive a successful HTTP response" do
+        expect(@response.code).to eq("200")
+      end
+
+      and_ "I receive a PDF file in response" do
+        expect(@response['Content-Type']).to eq("application/pdf")
+      end
+
+      and_ "the PDF contains the expected number of pages" do
+        expect(@response.body).to have_pdf_page_count(1)
+      end
+
+      and_ "the disposition header is set to attachment" do
+        expect(@response['Content-Disposition']).to start_with('inline; filename="convert-remote-url-cookie.pdf"')
+      end
+
+      and_ "the PDF contains the expected content" do
+        expect(@response.body).to contains_pdf_text("Protected Resource This page is secured with: CookieAuthentication").at_page(1)
+      end
+    end
+  end
+
+  scenario "Using custom headers for remote PDF rendering" do
+    # Controller setup:
+    #
+    # You can configure headers in two ways:
+    #
+    # 1. In an initializer (global config):
+    #
+    #   Bidi2pdfRails.configure do |config|
+    #    config.render_remote_settings.headers = ->(controller) { { "X-API-Key" => "your-secret-api-key" } }
+    #   end
+    #
+    # 2. Inline within controller action:
+    #
+    #     render pdf: 'convert-remote-url-cookie',
+    #            url: api_endpoint_url(only_path: false),
+    #            wait_for_page_loaded: false,
+    #            headers: { "X-API-Key" => "your-secret-api-key" }
+    #
+
+    when_ "I request a PDF from a page that requires an auth header" do
+      before do
+        @old_headers = Bidi2pdfRails.config.render_remote_settings.headers
+        with_render_setting :headers, ->(_controller) { { "X-API-Key" => "your-secret-api-key" } }
+
+        @response = get_pdf_response "/convert-remote-url-header"
+      end
+
+      then_ "I receive a successful HTTP response" do
+        expect(@response.code).to eq("200")
+      end
+
+      and_ "I receive a PDF file in response" do
+        expect(@response['Content-Type']).to eq("application/pdf")
+      end
+
+      and_ "the PDF contains the expected number of pages" do
+        expect(@response.body).to have_pdf_page_count(1)
+      end
+
+      and_ "the disposition header is set to attachment" do
+        expect(@response['Content-Disposition']).to start_with('inline; filename="convert-remote-url-cookie.pdf"')
+      end
+
+      and_ "the PDF contains the expected content" do
+        expect(@response.body).to contains_pdf_text("Protected Resource This page is secured with: API KeyAuthentication").at_page(1)
+      end
+    end
+  end
+end

data/spec/acceptance/user_can_inject_css_before_pdf_printing_spec.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+require "net/http"
+require "rack/handler/puma"
+require "socket"
+require "base64"
+
+RSpec.feature "As a user, I want to inject css into a website before printing a PDF", :pdf, type: :request do
+  before(:all) do
+    # Bidi2pdfRails.config.general_options.headless = false
+    Bidi2pdfRails::ChromedriverManagerSingleton.initialize_manager force: true
+  end
+
+  after(:all) do
+    Bidi2pdfRails::ChromedriverManagerSingleton.shutdown
+  end
+
+  scenario "Using raw CSS" do
+    # Controller setup:
+    #
+    # You can configure basic auth in two ways:
+    #
+    # 1. In an initializer (global config):
+    #
+    #   Bidi2pdfRails.configure do |config|
+    #     config.pdf_settings.custom_css = <<~CSS
+    #       p {
+    #         page-break-after: always;
+    #       }
+    #     CSS
+    #   end
+    #
+    # 2. Inline within controller action:
+    #   css = <<~CSS
+    #     p {
+    #       page-break-after: always;
+    #     }
+    #   CSS
+    #   render pdf: 'inject-css-raw',
+    #          custom_css: css,
+    #          layout: 'simple',
+    #          template: 'reports/simple',
+    #          wait_for_page_loaded: false,
+    #          print_options: { page: { format: :A4 } }
+    #
+
+    when_ "I request a PDF from a page and inject raw css" do
+      before do
+        with_pdf_settings :custom_css, <<-CSS
+          p {
+             page-break-after: always;
+          }
+        CSS
+
+        @response = get_pdf_response "/inject/raw-css"
+      end
+
+      then_ "I receive a successful HTTP response" do
+        expect(@response.code).to eq("200")
+      end
+
+      and_ "I receive a PDF file in response" do
+        expect(@response['Content-Type']).to eq("application/pdf")
+      end
+
+      and_ "the PDF contains the expected number of pages" do
+        expected_page_count = 6
+        expect(@response.body).to have_pdf_page_count(expected_page_count)
+      end
+
+      and_ "the disposition header is set to attachment" do
+        expect(@response['Content-Disposition']).to start_with('inline; filename="inject-raw-css.pdf"')
+      end
+
+      and_ 'the last page contains the expected content ("6")' do
+        expect(@response.body).to contains_pdf_text("6").at_page(6)
+      end
+    end
+  end
+
+  scenario "Using an external stylesheet" do
+    # Controller setup:
+    #
+    # You can configure cookies in two ways:
+    #
+    # 1. In an initializer (global config):
+    #
+    #   Bidi2pdfRails.configure do |config|
+    #     config.pdf_settings.custom_css_url = ->(controller) { controller.view_context.asset_url 'stylesheets/simple.css' }
+    #   end
+    #
+    # 2. Inline within controller action:
+    #
+    #   render pdf: 'inject-css-url',
+    #          custom_css_url: view_context.asset_url('stylesheets/simple.css'),
+    #          layout: 'simple',
+    #          template: 'reports/simple',
+    #          wait_for_page_loaded: false,
+    #          print_options: { page: { format: :A4 } }
+    #
+
+    when_ "I request a PDF from a page and inject an external stylesheet" do
+      before do
+        with_pdf_settings :custom_css_url, ->(controller) { controller.view_context.asset_url 'stylesheets/simple.css' }
+
+        @response = get_pdf_response "/inject/url-css"
+      end
+
+      then_ "I receive a successful HTTP response" do
+        expect(@response.code).to eq("200")
+      end
+
+      and_ "I receive a PDF file in response" do
+        expect(@response['Content-Type']).to eq("application/pdf")
+      end
+
+      and_ "the PDF contains the expected number of pages" do
+        expected_page_count = 6
+        expect(@response.body).to have_pdf_page_count(expected_page_count)
+      end
+
+      and_ "the disposition header is set to attachment" do
+        expect(@response['Content-Disposition']).to start_with('inline; filename="inject-url-css.pdf"')
+      end
+
+      and_ 'the last page contains the expected content ("6")' do
+        expect(@response.body).to contains_pdf_text(6).at_page(6)
+      end
+    end
+  end
+end